diff --git a/.gitignore b/.gitignore index f4d61822a8..1be602aaf1 100644 --- a/.gitignore +++ b/.gitignore @@ -9,4 +9,7 @@ _dependentPackages/ .vscode/ *.DS_Store build-errors.txt -build-log.txt \ No newline at end of file +build-log.txt +tools/dts-utilities* +tools/version-remover* +tools/whats-new* \ No newline at end of file diff --git a/docs/docs-ref-autogen/common/toc.yml b/docs/docs-ref-autogen/common/toc.yml index 32f485a9ea..da30e3acd1 100644 --- a/docs/docs-ref-autogen/common/toc.yml +++ b/docs/docs-ref-autogen/common/toc.yml @@ -501,6 +501,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/common_preview/toc.yml b/docs/docs-ref-autogen/common_preview/toc.yml index 32f485a9ea..da30e3acd1 100644 --- a/docs/docs-ref-autogen/common_preview/toc.yml +++ b/docs/docs-ref-autogen/common_preview/toc.yml @@ -501,6 +501,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/excel/excel/excel.cardlayout.yml b/docs/docs-ref-autogen/excel/excel/excel.cardlayout.yml index 13bd37ee71..ad538d6d8e 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.cardlayout.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.cardlayout.yml @@ -4,7 +4,16 @@ uid: excel!Excel.CardLayout:type package: excel! fullName: Excel.CardLayout summary: Represents the layout of a card in card view. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout), [Excel.EntityArrayCardLayout](/javascript/api/excel/excel.entityarraycardlayout)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout), + [Excel.EntityArrayCardLayout](/javascript/api/excel/excel.entityarraycardlayout) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excel/excel.cardlayoutsection.yml b/docs/docs-ref-autogen/excel/excel/excel.cardlayoutsection.yml index 5491f6727f..cca1b0c56e 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.cardlayoutsection.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.cardlayoutsection.yml @@ -4,7 +4,17 @@ uid: excel!Excel.CardLayoutSection:type package: excel! fullName: Excel.CardLayoutSection summary: Represents the layout of a section of a card in card view. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection), [Excel.CardLayoutTwoColumnSection](/javascript/api/excel/excel.cardlayouttwocolumnsection)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), + [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection), + [Excel.CardLayoutTwoColumnSection](/javascript/api/excel/excel.cardlayouttwocolumnsection) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excel/excel.cellcontrol.yml b/docs/docs-ref-autogen/excel/excel/excel.cellcontrol.yml index ecd03dccf2..5e5954d3df 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.cellcontrol.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.cellcontrol.yml @@ -4,7 +4,47 @@ uid: excel!Excel.CellControl:type package: excel! fullName: Excel.CellControl summary: Represents an interactable control inside of a cell. -remarks: "\\[ [API set: ExcelApi 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\n\n\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.UnknownCellControl](/javascript/api/excel/excel.unknowncellcontrol), [Excel.EmptyCellControl](/javascript/api/excel/excel.emptycellcontrol), [Excel.MixedCellControl](/javascript/api/excel/excel.mixedcellcontrol), [Excel.CheckboxCellControl](/javascript/api/excel/excel.checkboxcellcontrol)\r\n\r\n#### Examples\n\n```TypeScript\n// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml\n\n// Add checkboxes to the table.\nawait Excel.run(async (context) => {\n const sheet = context.workbook.worksheets.getActiveWorksheet();\n\n // Get the second column in the table, without the header.\n const range = sheet.tables.getItem(\"FruitTable\").columns.getItem(\"Analysis\").getDataBodyRange();\n\n // Change the boolean values to checkboxes.\n range.control = {\n type: Excel.CellControlType.checkbox\n };\n await context.sync();\n});\n```" +remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + + + Learn more about the types in this type alias through the following links. + + + [Excel.UnknownCellControl](/javascript/api/excel/excel.unknowncellcontrol), + [Excel.EmptyCellControl](/javascript/api/excel/excel.emptycellcontrol), + [Excel.MixedCellControl](/javascript/api/excel/excel.mixedcellcontrol), + [Excel.CheckboxCellControl](/javascript/api/excel/excel.checkboxcellcontrol) + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml + + + // Add checkboxes to the table. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Get the second column in the table, without the header. + const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange(); + + // Change the boolean values to checkboxes. + range.control = { + type: Excel.CellControlType.checkbox + }; + await context.sync(); + }); + + ``` isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excel/excel.cellvalue.yml b/docs/docs-ref-autogen/excel/excel/excel.cellvalue.yml index 62429faa0a..57f85ca484 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.cellvalue.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.cellvalue.yml @@ -4,7 +4,30 @@ uid: excel!Excel.CellValue:type package: excel! fullName: Excel.CellValue summary: Represents the value in a cell. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), [Excel.ExternalCodeServiceObjectCellValue](/javascript/api/excel/excel.externalcodeserviceobjectcellvalue), [Excel.FormattedNumberCellValue](/javascript/api/excel/excel.formattednumbercellvalue), [Excel.FunctionCellValue](/javascript/api/excel/excel.functioncellvalue), [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), [Excel.LocalImageCellValue](/javascript/api/excel/excel.localimagecellvalue), [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), + [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), + [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), + [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), + [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), + [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), + [Excel.ExternalCodeServiceObjectCellValue](/javascript/api/excel/excel.externalcodeserviceobjectcellvalue), + [Excel.FormattedNumberCellValue](/javascript/api/excel/excel.formattednumbercellvalue), + [Excel.FunctionCellValue](/javascript/api/excel/excel.functioncellvalue), + [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), + [Excel.LocalImageCellValue](/javascript/api/excel/excel.localimagecellvalue), + [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), + [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), + [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), + [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), + [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excel/excel.cellvalueandpropertymetadata.yml b/docs/docs-ref-autogen/excel/excel/excel.cellvalueandpropertymetadata.yml index 566432a914..5f661bb32f 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.cellvalueandpropertymetadata.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.cellvalueandpropertymetadata.yml @@ -6,7 +6,16 @@ fullName: Excel.CellValueAndPropertyMetadata summary: >- Represents the value and metadata of a property. The metadata applies to the property (and not the value), but it is combined with the value in this type. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValue](/javascript/api/excel/excel.cellvalue), [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CellValue](/javascript/api/excel/excel.cellvalue), + [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excel/excel.compactlayout.yml b/docs/docs-ref-autogen/excel/excel/excel.compactlayout.yml index 3f25496779..5bb689c662 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.compactlayout.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.compactlayout.yml @@ -6,7 +6,15 @@ fullName: Excel.CompactLayout summary: >- Represents the layout used when there is limited space to represent the entity. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excel/excel.customfunctionmanager.yml b/docs/docs-ref-autogen/excel/excel/excel.customfunctionmanager.yml index 43b3d0f2bc..085d0f6fbc 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.customfunctionmanager.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.customfunctionmanager.yml @@ -5,10 +5,10 @@ package: excel! fullName: Excel.CustomFunctionManager summary: Manages settings on custom functions. remarks: >- - \[ [API set: ExcelApi BETA (PREVIEW - ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + \[ [API set: ExcelApi + 1.20](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] -isPreview: true +isPreview: false isDeprecated: false type: class properties: @@ -21,7 +21,7 @@ properties: process to the Office host application's process. remarks: '' - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'context: RequestContext;' @@ -37,7 +37,7 @@ methods: must call `context.sync()` before reading the properties. remarks: '' - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'load(propertyNames?: string | string[]): Excel.CustomFunctionManager;' @@ -58,11 +58,11 @@ methods: Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. remarks: >- - \[ [API set: ExcelApi BETA (PREVIEW - ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \[ [API set: ExcelApi + 1.20](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] - isPreview: true + isPreview: false isDeprecated: false syntax: content: |- @@ -91,11 +91,11 @@ methods: fullName: newObject(context) summary: Create a new instance of the `Excel.CustomFunctionManager` object. remarks: >- - \[ [API set: ExcelApi BETA (PREVIEW - ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \[ [API set: ExcelApi + 1.20](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] - isPreview: true + isPreview: false isDeprecated: false syntax: content: >- @@ -114,11 +114,11 @@ methods: fullName: setVisibility(customFunctionVisibilityOptions) summary: Show or hide custom functions in Excel AutoComplete. remarks: >- - \[ [API set: ExcelApi BETA (PREVIEW - ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \[ [API set: ExcelApi + 1.20](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] - isPreview: true + isPreview: false isDeprecated: false syntax: content: >- @@ -146,7 +146,7 @@ methods: shallow copies of any loaded child properties from the original object. remarks: '' - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'toJSON(): Excel.Interfaces.CustomFunctionManagerData;' diff --git a/docs/docs-ref-autogen/excel/excel/excel.customfunctionvisibilityoptions.yml b/docs/docs-ref-autogen/excel/excel/excel.customfunctionvisibilityoptions.yml index 30cddeb9ae..69a2c25bc7 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.customfunctionvisibilityoptions.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.customfunctionvisibilityoptions.yml @@ -5,10 +5,10 @@ package: excel! fullName: Excel.CustomFunctionVisibilityOptions summary: Represents which custom functions to show or hide in Excel AutoComplete. remarks: >- - \[ [API set: ExcelApi BETA (PREVIEW - ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + \[ [API set: ExcelApi + 1.20](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] -isPreview: true +isPreview: false isDeprecated: false type: interface properties: @@ -18,11 +18,11 @@ properties: fullName: hide summary: A list of custom functions to hide from Excel AutoComplete. remarks: >- - \[ [API set: ExcelApi BETA (PREVIEW - ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \[ [API set: ExcelApi + 1.20](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'hide?: string[];' @@ -34,11 +34,11 @@ properties: fullName: show summary: A list of custom functions to show in Excel AutoComplete. remarks: >- - \[ [API set: ExcelApi BETA (PREVIEW - ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \[ [API set: ExcelApi + 1.20](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] - isPreview: true + isPreview: false isDeprecated: false syntax: content: 'show?: string[];' diff --git a/docs/docs-ref-autogen/excel/excel/excel.entitypropertytype.yml b/docs/docs-ref-autogen/excel/excel/excel.entitypropertytype.yml index 41a8cc7fcf..bc54a6eff6 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.entitypropertytype.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.entitypropertytype.yml @@ -4,7 +4,16 @@ uid: excel!Excel.EntityPropertyType:type package: excel! fullName: Excel.EntityPropertyType summary: Represents the value of a property. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), [Excel.CellValue](/javascript/api/excel/excel.cellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), + [Excel.CellValue](/javascript/api/excel/excel.cellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excel/excel.errorcellvalue.yml b/docs/docs-ref-autogen/excel/excel/excel.errorcellvalue.yml index cd381f72c8..f5e56306dd 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.errorcellvalue.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.errorcellvalue.yml @@ -4,7 +4,64 @@ uid: excel!Excel.ErrorCellValue:type package: excel! fullName: Excel.ErrorCellValue summary: Represents a cell value which contains an error. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\n\n\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue), [Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue), [Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue), [Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue), [Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue), [Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue), [Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue), [Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue), [Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue), [Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue), [Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue), [Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue), [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue), [Excel.PythonErrorCellValue](/javascript/api/excel/excel.pythonerrorcellvalue), [Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue), [Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue), [Excel.TimeoutErrorCellValue](/javascript/api/excel/excel.timeouterrorcellvalue), [Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue)\r\n\r\n#### Examples\n\n```TypeScript\n// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml\n\n// This function sets the value of cell A1 to a #BUSY! error using data types.\nawait Excel.run(async (context) => {\n // Retrieve the Sample worksheet and cell A1 on that sheet.\n const sheet = context.workbook.worksheets.getItemOrNullObject(\"Sample\");\n const range = sheet.getRange(\"A1\");\n\n // Get the error data type and set its type to `busy`.\n const error: Excel.ErrorCellValue = {\n type: Excel.CellValueType.error,\n errorType: Excel.ErrorCellValueType.busy\n };\n\n // Set cell A1 as the busy error.\n range.valuesAsJson = [[error]];\n await context.sync();\n});\n```" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + + + Learn more about the types in this type alias through the following links. + + + [Excel.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue), + [Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue), + [Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue), + [Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue), + [Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue), + [Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue), + [Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue), + [Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue), + [Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue), + [Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue), + [Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue), + [Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue), + [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue), + [Excel.PythonErrorCellValue](/javascript/api/excel/excel.pythonerrorcellvalue), + [Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue), + [Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue), + [Excel.TimeoutErrorCellValue](/javascript/api/excel/excel.timeouterrorcellvalue), + [Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue) + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml + + + // This function sets the value of cell A1 to a #BUSY! error using data types. + + await Excel.run(async (context) => { + // Retrieve the Sample worksheet and cell A1 on that sheet. + const sheet = context.workbook.worksheets.getItemOrNullObject("Sample"); + const range = sheet.getRange("A1"); + + // Get the error data type and set its type to `busy`. + const error: Excel.ErrorCellValue = { + type: Excel.CellValueType.error, + errorType: Excel.ErrorCellValueType.busy + }; + + // Set cell A1 as the busy error. + range.valuesAsJson = [[error]]; + await context.sync(); + }); + + ``` isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excel/excel.functioncellvalue.yml b/docs/docs-ref-autogen/excel/excel/excel.functioncellvalue.yml index 50b7239609..b1f83d2ff4 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.functioncellvalue.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.functioncellvalue.yml @@ -4,7 +4,15 @@ uid: excel!Excel.FunctionCellValue:type package: excel! fullName: Excel.FunctionCellValue summary: Represents a cell value which can be evaluated as a function. -remarks: "\\[ [API set: ExcelApi 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.JavaScriptCustomFunctionReferenceCellValue](/javascript/api/excel/excel.javascriptcustomfunctionreferencecellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.JavaScriptCustomFunctionReferenceCellValue](/javascript/api/excel/excel.javascriptcustomfunctionreferencecellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excel/excel.referencedvalue.yml b/docs/docs-ref-autogen/excel/excel/excel.referencedvalue.yml index 57044e8ebe..168b4928ba 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.referencedvalue.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.referencedvalue.yml @@ -4,7 +4,20 @@ uid: excel!Excel.ReferencedValue:type package: excel! fullName: Excel.ReferencedValue summary: Represents the value in a cell. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), + [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), + [Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue), + [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), + [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), + [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excel/excel.runoptions.yml b/docs/docs-ref-autogen/excel/excel/excel.runoptions.yml index c650e6bd70..300015ddf7 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.runoptions.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.runoptions.yml @@ -34,6 +34,28 @@ properties: content: 'delayForCellEdit?: boolean;' return: type: boolean + - name: mergeUndoGroup + uid: excel!Excel.RunOptions#mergeUndoGroup:member + package: excel! + fullName: mergeUndoGroup + summary: >- + Determines whether the batch requests should be merged to one undo group. + + + When false, each `context.sync()` call creates an undo record. When true, + all `context.sync()` calls in a single `Excel.run` are merged into one + `undo` group. + remarks: >- + \[ [API set: ExcelApi + 1.20](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'mergeUndoGroup?: boolean;' + return: + type: boolean extends: >- <> diff --git a/docs/docs-ref-autogen/excel/toc.yml b/docs/docs-ref-autogen/excel/toc.yml index 8ad4fa35ed..cf353de498 100644 --- a/docs/docs-ref-autogen/excel/toc.yml +++ b/docs/docs-ref-autogen/excel/toc.yml @@ -1701,6 +1701,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/excel_1_1/toc.yml b/docs/docs-ref-autogen/excel_1_1/toc.yml index 54dd570eed..476f1cb55d 100644 --- a/docs/docs-ref-autogen/excel_1_1/toc.yml +++ b/docs/docs-ref-autogen/excel_1_1/toc.yml @@ -643,6 +643,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/excel_1_10/toc.yml b/docs/docs-ref-autogen/excel_1_10/toc.yml index a4d398de63..41de40d21f 100644 --- a/docs/docs-ref-autogen/excel_1_10/toc.yml +++ b/docs/docs-ref-autogen/excel_1_10/toc.yml @@ -1327,6 +1327,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/excel_1_11/toc.yml b/docs/docs-ref-autogen/excel_1_11/toc.yml index d39938f79e..9caf6b8117 100644 --- a/docs/docs-ref-autogen/excel_1_11/toc.yml +++ b/docs/docs-ref-autogen/excel_1_11/toc.yml @@ -1339,6 +1339,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/excel_1_12/toc.yml b/docs/docs-ref-autogen/excel_1_12/toc.yml index 2952ccac91..d4c6476a4c 100644 --- a/docs/docs-ref-autogen/excel_1_12/toc.yml +++ b/docs/docs-ref-autogen/excel_1_12/toc.yml @@ -1385,6 +1385,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/excel_1_13/toc.yml b/docs/docs-ref-autogen/excel_1_13/toc.yml index 63ae2d0961..5721747c83 100644 --- a/docs/docs-ref-autogen/excel_1_13/toc.yml +++ b/docs/docs-ref-autogen/excel_1_13/toc.yml @@ -1395,6 +1395,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/excel_1_14/toc.yml b/docs/docs-ref-autogen/excel_1_14/toc.yml index 9152b5fa60..53a585fdd4 100644 --- a/docs/docs-ref-autogen/excel_1_14/toc.yml +++ b/docs/docs-ref-autogen/excel_1_14/toc.yml @@ -1413,6 +1413,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/excel_1_15/toc.yml b/docs/docs-ref-autogen/excel_1_15/toc.yml index 1825a57b7c..18b023f13a 100644 --- a/docs/docs-ref-autogen/excel_1_15/toc.yml +++ b/docs/docs-ref-autogen/excel_1_15/toc.yml @@ -1417,6 +1417,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/excel_1_16/excel/excel.cardlayout.yml b/docs/docs-ref-autogen/excel_1_16/excel/excel.cardlayout.yml index 4de2b1d604..07ebbc46e3 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel/excel.cardlayout.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel/excel.cardlayout.yml @@ -4,7 +4,15 @@ uid: excel!Excel.CardLayout:type package: excel! fullName: Excel.CardLayout summary: Represents the layout of a card in card view. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_16/excel/excel.cardlayoutsection.yml b/docs/docs-ref-autogen/excel_1_16/excel/excel.cardlayoutsection.yml index b54480411d..97e90f572d 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel/excel.cardlayoutsection.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel/excel.cardlayoutsection.yml @@ -4,7 +4,16 @@ uid: excel!Excel.CardLayoutSection:type package: excel! fullName: Excel.CardLayoutSection summary: Represents the layout of a section of a card in card view. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), + [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_16/excel/excel.cellvalue.yml b/docs/docs-ref-autogen/excel_1_16/excel/excel.cellvalue.yml index 63e5befd22..b679b81429 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel/excel.cellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel/excel.cellvalue.yml @@ -4,7 +4,26 @@ uid: excel!Excel.CellValue:type package: excel! fullName: Excel.CellValue summary: Represents the value in a cell. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), + [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), + [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), + [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), + [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), + [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), + [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), + [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), + [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), + [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), + [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), + [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_16/excel/excel.cellvalueandpropertymetadata.yml b/docs/docs-ref-autogen/excel_1_16/excel/excel.cellvalueandpropertymetadata.yml index 566432a914..5f661bb32f 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel/excel.cellvalueandpropertymetadata.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel/excel.cellvalueandpropertymetadata.yml @@ -6,7 +6,16 @@ fullName: Excel.CellValueAndPropertyMetadata summary: >- Represents the value and metadata of a property. The metadata applies to the property (and not the value), but it is combined with the value in this type. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValue](/javascript/api/excel/excel.cellvalue), [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CellValue](/javascript/api/excel/excel.cellvalue), + [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_16/excel/excel.compactlayout.yml b/docs/docs-ref-autogen/excel_1_16/excel/excel.compactlayout.yml index 3f25496779..5bb689c662 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel/excel.compactlayout.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel/excel.compactlayout.yml @@ -6,7 +6,15 @@ fullName: Excel.CompactLayout summary: >- Represents the layout used when there is limited space to represent the entity. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_16/excel/excel.entitypropertytype.yml b/docs/docs-ref-autogen/excel_1_16/excel/excel.entitypropertytype.yml index 41a8cc7fcf..bc54a6eff6 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel/excel.entitypropertytype.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel/excel.entitypropertytype.yml @@ -4,7 +4,16 @@ uid: excel!Excel.EntityPropertyType:type package: excel! fullName: Excel.EntityPropertyType summary: Represents the value of a property. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), [Excel.CellValue](/javascript/api/excel/excel.cellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), + [Excel.CellValue](/javascript/api/excel/excel.cellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_16/excel/excel.errorcellvalue.yml b/docs/docs-ref-autogen/excel_1_16/excel/excel.errorcellvalue.yml index e5addcc22f..b88b1959c2 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel/excel.errorcellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel/excel.errorcellvalue.yml @@ -4,7 +4,62 @@ uid: excel!Excel.ErrorCellValue:type package: excel! fullName: Excel.ErrorCellValue summary: Represents a cell value which contains an error. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\n\n\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue), [Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue), [Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue), [Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue), [Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue), [Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue), [Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue), [Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue), [Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue), [Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue), [Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue), [Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue), [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue), [Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue), [Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue), [Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue)\r\n\r\n#### Examples\n\n```TypeScript\n// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml\n\n// This function sets the value of cell A1 to a #BUSY! error using data types.\nawait Excel.run(async (context) => {\n // Retrieve the Sample worksheet and cell A1 on that sheet.\n const sheet = context.workbook.worksheets.getItemOrNullObject(\"Sample\");\n const range = sheet.getRange(\"A1\");\n\n // Get the error data type and set its type to `busy`.\n const error: Excel.ErrorCellValue = {\n type: Excel.CellValueType.error,\n errorType: Excel.ErrorCellValueType.busy\n };\n\n // Set cell A1 as the busy error.\n range.valuesAsJson = [[error]];\n await context.sync();\n});\n```" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + + + Learn more about the types in this type alias through the following links. + + + [Excel.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue), + [Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue), + [Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue), + [Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue), + [Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue), + [Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue), + [Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue), + [Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue), + [Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue), + [Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue), + [Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue), + [Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue), + [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue), + [Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue), + [Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue), + [Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue) + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml + + + // This function sets the value of cell A1 to a #BUSY! error using data types. + + await Excel.run(async (context) => { + // Retrieve the Sample worksheet and cell A1 on that sheet. + const sheet = context.workbook.worksheets.getItemOrNullObject("Sample"); + const range = sheet.getRange("A1"); + + // Get the error data type and set its type to `busy`. + const error: Excel.ErrorCellValue = { + type: Excel.CellValueType.error, + errorType: Excel.ErrorCellValueType.busy + }; + + // Set cell A1 as the busy error. + range.valuesAsJson = [[error]]; + await context.sync(); + }); + + ``` isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_16/excel/excel.referencedvalue.yml b/docs/docs-ref-autogen/excel_1_16/excel/excel.referencedvalue.yml index 57044e8ebe..168b4928ba 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel/excel.referencedvalue.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel/excel.referencedvalue.yml @@ -4,7 +4,20 @@ uid: excel!Excel.ReferencedValue:type package: excel! fullName: Excel.ReferencedValue summary: Represents the value in a cell. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), + [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), + [Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue), + [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), + [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), + [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_16/toc.yml b/docs/docs-ref-autogen/excel_1_16/toc.yml index 622459e492..8d9be7691f 100644 --- a/docs/docs-ref-autogen/excel_1_16/toc.yml +++ b/docs/docs-ref-autogen/excel_1_16/toc.yml @@ -1545,6 +1545,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/excel_1_17/excel/excel.cardlayout.yml b/docs/docs-ref-autogen/excel_1_17/excel/excel.cardlayout.yml index 4de2b1d604..07ebbc46e3 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel/excel.cardlayout.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel/excel.cardlayout.yml @@ -4,7 +4,15 @@ uid: excel!Excel.CardLayout:type package: excel! fullName: Excel.CardLayout summary: Represents the layout of a card in card view. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_17/excel/excel.cardlayoutsection.yml b/docs/docs-ref-autogen/excel_1_17/excel/excel.cardlayoutsection.yml index b54480411d..97e90f572d 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel/excel.cardlayoutsection.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel/excel.cardlayoutsection.yml @@ -4,7 +4,16 @@ uid: excel!Excel.CardLayoutSection:type package: excel! fullName: Excel.CardLayoutSection summary: Represents the layout of a section of a card in card view. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), + [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_17/excel/excel.cellvalue.yml b/docs/docs-ref-autogen/excel_1_17/excel/excel.cellvalue.yml index 63e5befd22..b679b81429 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel/excel.cellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel/excel.cellvalue.yml @@ -4,7 +4,26 @@ uid: excel!Excel.CellValue:type package: excel! fullName: Excel.CellValue summary: Represents the value in a cell. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), + [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), + [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), + [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), + [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), + [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), + [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), + [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), + [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), + [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), + [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), + [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_17/excel/excel.cellvalueandpropertymetadata.yml b/docs/docs-ref-autogen/excel_1_17/excel/excel.cellvalueandpropertymetadata.yml index 566432a914..5f661bb32f 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel/excel.cellvalueandpropertymetadata.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel/excel.cellvalueandpropertymetadata.yml @@ -6,7 +6,16 @@ fullName: Excel.CellValueAndPropertyMetadata summary: >- Represents the value and metadata of a property. The metadata applies to the property (and not the value), but it is combined with the value in this type. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValue](/javascript/api/excel/excel.cellvalue), [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CellValue](/javascript/api/excel/excel.cellvalue), + [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_17/excel/excel.compactlayout.yml b/docs/docs-ref-autogen/excel_1_17/excel/excel.compactlayout.yml index 3f25496779..5bb689c662 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel/excel.compactlayout.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel/excel.compactlayout.yml @@ -6,7 +6,15 @@ fullName: Excel.CompactLayout summary: >- Represents the layout used when there is limited space to represent the entity. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_17/excel/excel.entitypropertytype.yml b/docs/docs-ref-autogen/excel_1_17/excel/excel.entitypropertytype.yml index 41a8cc7fcf..bc54a6eff6 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel/excel.entitypropertytype.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel/excel.entitypropertytype.yml @@ -4,7 +4,16 @@ uid: excel!Excel.EntityPropertyType:type package: excel! fullName: Excel.EntityPropertyType summary: Represents the value of a property. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), [Excel.CellValue](/javascript/api/excel/excel.cellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), + [Excel.CellValue](/javascript/api/excel/excel.cellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_17/excel/excel.errorcellvalue.yml b/docs/docs-ref-autogen/excel_1_17/excel/excel.errorcellvalue.yml index e5addcc22f..b88b1959c2 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel/excel.errorcellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel/excel.errorcellvalue.yml @@ -4,7 +4,62 @@ uid: excel!Excel.ErrorCellValue:type package: excel! fullName: Excel.ErrorCellValue summary: Represents a cell value which contains an error. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\n\n\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue), [Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue), [Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue), [Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue), [Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue), [Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue), [Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue), [Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue), [Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue), [Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue), [Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue), [Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue), [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue), [Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue), [Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue), [Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue)\r\n\r\n#### Examples\n\n```TypeScript\n// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml\n\n// This function sets the value of cell A1 to a #BUSY! error using data types.\nawait Excel.run(async (context) => {\n // Retrieve the Sample worksheet and cell A1 on that sheet.\n const sheet = context.workbook.worksheets.getItemOrNullObject(\"Sample\");\n const range = sheet.getRange(\"A1\");\n\n // Get the error data type and set its type to `busy`.\n const error: Excel.ErrorCellValue = {\n type: Excel.CellValueType.error,\n errorType: Excel.ErrorCellValueType.busy\n };\n\n // Set cell A1 as the busy error.\n range.valuesAsJson = [[error]];\n await context.sync();\n});\n```" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + + + Learn more about the types in this type alias through the following links. + + + [Excel.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue), + [Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue), + [Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue), + [Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue), + [Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue), + [Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue), + [Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue), + [Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue), + [Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue), + [Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue), + [Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue), + [Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue), + [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue), + [Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue), + [Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue), + [Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue) + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml + + + // This function sets the value of cell A1 to a #BUSY! error using data types. + + await Excel.run(async (context) => { + // Retrieve the Sample worksheet and cell A1 on that sheet. + const sheet = context.workbook.worksheets.getItemOrNullObject("Sample"); + const range = sheet.getRange("A1"); + + // Get the error data type and set its type to `busy`. + const error: Excel.ErrorCellValue = { + type: Excel.CellValueType.error, + errorType: Excel.ErrorCellValueType.busy + }; + + // Set cell A1 as the busy error. + range.valuesAsJson = [[error]]; + await context.sync(); + }); + + ``` isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_17/excel/excel.referencedvalue.yml b/docs/docs-ref-autogen/excel_1_17/excel/excel.referencedvalue.yml index 57044e8ebe..168b4928ba 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel/excel.referencedvalue.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel/excel.referencedvalue.yml @@ -4,7 +4,20 @@ uid: excel!Excel.ReferencedValue:type package: excel! fullName: Excel.ReferencedValue summary: Represents the value in a cell. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), + [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), + [Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue), + [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), + [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), + [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_17/toc.yml b/docs/docs-ref-autogen/excel_1_17/toc.yml index d891d3708f..f80ce32eae 100644 --- a/docs/docs-ref-autogen/excel_1_17/toc.yml +++ b/docs/docs-ref-autogen/excel_1_17/toc.yml @@ -1551,6 +1551,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/excel_1_18/excel/excel.cardlayout.yml b/docs/docs-ref-autogen/excel_1_18/excel/excel.cardlayout.yml index 4de2b1d604..07ebbc46e3 100644 --- a/docs/docs-ref-autogen/excel_1_18/excel/excel.cardlayout.yml +++ b/docs/docs-ref-autogen/excel_1_18/excel/excel.cardlayout.yml @@ -4,7 +4,15 @@ uid: excel!Excel.CardLayout:type package: excel! fullName: Excel.CardLayout summary: Represents the layout of a card in card view. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_18/excel/excel.cardlayoutsection.yml b/docs/docs-ref-autogen/excel_1_18/excel/excel.cardlayoutsection.yml index b54480411d..97e90f572d 100644 --- a/docs/docs-ref-autogen/excel_1_18/excel/excel.cardlayoutsection.yml +++ b/docs/docs-ref-autogen/excel_1_18/excel/excel.cardlayoutsection.yml @@ -4,7 +4,16 @@ uid: excel!Excel.CardLayoutSection:type package: excel! fullName: Excel.CardLayoutSection summary: Represents the layout of a section of a card in card view. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), + [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_18/excel/excel.cellcontrol.yml b/docs/docs-ref-autogen/excel_1_18/excel/excel.cellcontrol.yml index ecd03dccf2..5e5954d3df 100644 --- a/docs/docs-ref-autogen/excel_1_18/excel/excel.cellcontrol.yml +++ b/docs/docs-ref-autogen/excel_1_18/excel/excel.cellcontrol.yml @@ -4,7 +4,47 @@ uid: excel!Excel.CellControl:type package: excel! fullName: Excel.CellControl summary: Represents an interactable control inside of a cell. -remarks: "\\[ [API set: ExcelApi 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\n\n\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.UnknownCellControl](/javascript/api/excel/excel.unknowncellcontrol), [Excel.EmptyCellControl](/javascript/api/excel/excel.emptycellcontrol), [Excel.MixedCellControl](/javascript/api/excel/excel.mixedcellcontrol), [Excel.CheckboxCellControl](/javascript/api/excel/excel.checkboxcellcontrol)\r\n\r\n#### Examples\n\n```TypeScript\n// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml\n\n// Add checkboxes to the table.\nawait Excel.run(async (context) => {\n const sheet = context.workbook.worksheets.getActiveWorksheet();\n\n // Get the second column in the table, without the header.\n const range = sheet.tables.getItem(\"FruitTable\").columns.getItem(\"Analysis\").getDataBodyRange();\n\n // Change the boolean values to checkboxes.\n range.control = {\n type: Excel.CellControlType.checkbox\n };\n await context.sync();\n});\n```" +remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + + + Learn more about the types in this type alias through the following links. + + + [Excel.UnknownCellControl](/javascript/api/excel/excel.unknowncellcontrol), + [Excel.EmptyCellControl](/javascript/api/excel/excel.emptycellcontrol), + [Excel.MixedCellControl](/javascript/api/excel/excel.mixedcellcontrol), + [Excel.CheckboxCellControl](/javascript/api/excel/excel.checkboxcellcontrol) + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml + + + // Add checkboxes to the table. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Get the second column in the table, without the header. + const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange(); + + // Change the boolean values to checkboxes. + range.control = { + type: Excel.CellControlType.checkbox + }; + await context.sync(); + }); + + ``` isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_18/excel/excel.cellvalue.yml b/docs/docs-ref-autogen/excel_1_18/excel/excel.cellvalue.yml index 63e5befd22..b679b81429 100644 --- a/docs/docs-ref-autogen/excel_1_18/excel/excel.cellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_18/excel/excel.cellvalue.yml @@ -4,7 +4,26 @@ uid: excel!Excel.CellValue:type package: excel! fullName: Excel.CellValue summary: Represents the value in a cell. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), + [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), + [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), + [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), + [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), + [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), + [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), + [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), + [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), + [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), + [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), + [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_18/excel/excel.cellvalueandpropertymetadata.yml b/docs/docs-ref-autogen/excel_1_18/excel/excel.cellvalueandpropertymetadata.yml index 566432a914..5f661bb32f 100644 --- a/docs/docs-ref-autogen/excel_1_18/excel/excel.cellvalueandpropertymetadata.yml +++ b/docs/docs-ref-autogen/excel_1_18/excel/excel.cellvalueandpropertymetadata.yml @@ -6,7 +6,16 @@ fullName: Excel.CellValueAndPropertyMetadata summary: >- Represents the value and metadata of a property. The metadata applies to the property (and not the value), but it is combined with the value in this type. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValue](/javascript/api/excel/excel.cellvalue), [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CellValue](/javascript/api/excel/excel.cellvalue), + [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_18/excel/excel.compactlayout.yml b/docs/docs-ref-autogen/excel_1_18/excel/excel.compactlayout.yml index 3f25496779..5bb689c662 100644 --- a/docs/docs-ref-autogen/excel_1_18/excel/excel.compactlayout.yml +++ b/docs/docs-ref-autogen/excel_1_18/excel/excel.compactlayout.yml @@ -6,7 +6,15 @@ fullName: Excel.CompactLayout summary: >- Represents the layout used when there is limited space to represent the entity. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_18/excel/excel.entitypropertytype.yml b/docs/docs-ref-autogen/excel_1_18/excel/excel.entitypropertytype.yml index 41a8cc7fcf..bc54a6eff6 100644 --- a/docs/docs-ref-autogen/excel_1_18/excel/excel.entitypropertytype.yml +++ b/docs/docs-ref-autogen/excel_1_18/excel/excel.entitypropertytype.yml @@ -4,7 +4,16 @@ uid: excel!Excel.EntityPropertyType:type package: excel! fullName: Excel.EntityPropertyType summary: Represents the value of a property. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), [Excel.CellValue](/javascript/api/excel/excel.cellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), + [Excel.CellValue](/javascript/api/excel/excel.cellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_18/excel/excel.errorcellvalue.yml b/docs/docs-ref-autogen/excel_1_18/excel/excel.errorcellvalue.yml index e5addcc22f..b88b1959c2 100644 --- a/docs/docs-ref-autogen/excel_1_18/excel/excel.errorcellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_18/excel/excel.errorcellvalue.yml @@ -4,7 +4,62 @@ uid: excel!Excel.ErrorCellValue:type package: excel! fullName: Excel.ErrorCellValue summary: Represents a cell value which contains an error. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\n\n\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue), [Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue), [Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue), [Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue), [Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue), [Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue), [Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue), [Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue), [Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue), [Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue), [Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue), [Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue), [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue), [Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue), [Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue), [Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue)\r\n\r\n#### Examples\n\n```TypeScript\n// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml\n\n// This function sets the value of cell A1 to a #BUSY! error using data types.\nawait Excel.run(async (context) => {\n // Retrieve the Sample worksheet and cell A1 on that sheet.\n const sheet = context.workbook.worksheets.getItemOrNullObject(\"Sample\");\n const range = sheet.getRange(\"A1\");\n\n // Get the error data type and set its type to `busy`.\n const error: Excel.ErrorCellValue = {\n type: Excel.CellValueType.error,\n errorType: Excel.ErrorCellValueType.busy\n };\n\n // Set cell A1 as the busy error.\n range.valuesAsJson = [[error]];\n await context.sync();\n});\n```" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + + + Learn more about the types in this type alias through the following links. + + + [Excel.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue), + [Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue), + [Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue), + [Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue), + [Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue), + [Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue), + [Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue), + [Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue), + [Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue), + [Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue), + [Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue), + [Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue), + [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue), + [Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue), + [Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue), + [Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue) + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml + + + // This function sets the value of cell A1 to a #BUSY! error using data types. + + await Excel.run(async (context) => { + // Retrieve the Sample worksheet and cell A1 on that sheet. + const sheet = context.workbook.worksheets.getItemOrNullObject("Sample"); + const range = sheet.getRange("A1"); + + // Get the error data type and set its type to `busy`. + const error: Excel.ErrorCellValue = { + type: Excel.CellValueType.error, + errorType: Excel.ErrorCellValueType.busy + }; + + // Set cell A1 as the busy error. + range.valuesAsJson = [[error]]; + await context.sync(); + }); + + ``` isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_18/excel/excel.referencedvalue.yml b/docs/docs-ref-autogen/excel_1_18/excel/excel.referencedvalue.yml index 57044e8ebe..168b4928ba 100644 --- a/docs/docs-ref-autogen/excel_1_18/excel/excel.referencedvalue.yml +++ b/docs/docs-ref-autogen/excel_1_18/excel/excel.referencedvalue.yml @@ -4,7 +4,20 @@ uid: excel!Excel.ReferencedValue:type package: excel! fullName: Excel.ReferencedValue summary: Represents the value in a cell. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), + [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), + [Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue), + [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), + [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), + [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_18/toc.yml b/docs/docs-ref-autogen/excel_1_18/toc.yml index 22acdcc167..08b4c10a7e 100644 --- a/docs/docs-ref-autogen/excel_1_18/toc.yml +++ b/docs/docs-ref-autogen/excel_1_18/toc.yml @@ -1569,6 +1569,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/excel_1_19/excel/excel.cardlayout.yml b/docs/docs-ref-autogen/excel_1_19/excel/excel.cardlayout.yml index 4de2b1d604..07ebbc46e3 100644 --- a/docs/docs-ref-autogen/excel_1_19/excel/excel.cardlayout.yml +++ b/docs/docs-ref-autogen/excel_1_19/excel/excel.cardlayout.yml @@ -4,7 +4,15 @@ uid: excel!Excel.CardLayout:type package: excel! fullName: Excel.CardLayout summary: Represents the layout of a card in card view. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_19/excel/excel.cardlayoutsection.yml b/docs/docs-ref-autogen/excel_1_19/excel/excel.cardlayoutsection.yml index 5491f6727f..cca1b0c56e 100644 --- a/docs/docs-ref-autogen/excel_1_19/excel/excel.cardlayoutsection.yml +++ b/docs/docs-ref-autogen/excel_1_19/excel/excel.cardlayoutsection.yml @@ -4,7 +4,17 @@ uid: excel!Excel.CardLayoutSection:type package: excel! fullName: Excel.CardLayoutSection summary: Represents the layout of a section of a card in card view. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection), [Excel.CardLayoutTwoColumnSection](/javascript/api/excel/excel.cardlayouttwocolumnsection)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), + [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection), + [Excel.CardLayoutTwoColumnSection](/javascript/api/excel/excel.cardlayouttwocolumnsection) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_19/excel/excel.cellcontrol.yml b/docs/docs-ref-autogen/excel_1_19/excel/excel.cellcontrol.yml index ecd03dccf2..5e5954d3df 100644 --- a/docs/docs-ref-autogen/excel_1_19/excel/excel.cellcontrol.yml +++ b/docs/docs-ref-autogen/excel_1_19/excel/excel.cellcontrol.yml @@ -4,7 +4,47 @@ uid: excel!Excel.CellControl:type package: excel! fullName: Excel.CellControl summary: Represents an interactable control inside of a cell. -remarks: "\\[ [API set: ExcelApi 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\n\n\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.UnknownCellControl](/javascript/api/excel/excel.unknowncellcontrol), [Excel.EmptyCellControl](/javascript/api/excel/excel.emptycellcontrol), [Excel.MixedCellControl](/javascript/api/excel/excel.mixedcellcontrol), [Excel.CheckboxCellControl](/javascript/api/excel/excel.checkboxcellcontrol)\r\n\r\n#### Examples\n\n```TypeScript\n// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml\n\n// Add checkboxes to the table.\nawait Excel.run(async (context) => {\n const sheet = context.workbook.worksheets.getActiveWorksheet();\n\n // Get the second column in the table, without the header.\n const range = sheet.tables.getItem(\"FruitTable\").columns.getItem(\"Analysis\").getDataBodyRange();\n\n // Change the boolean values to checkboxes.\n range.control = {\n type: Excel.CellControlType.checkbox\n };\n await context.sync();\n});\n```" +remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + + + Learn more about the types in this type alias through the following links. + + + [Excel.UnknownCellControl](/javascript/api/excel/excel.unknowncellcontrol), + [Excel.EmptyCellControl](/javascript/api/excel/excel.emptycellcontrol), + [Excel.MixedCellControl](/javascript/api/excel/excel.mixedcellcontrol), + [Excel.CheckboxCellControl](/javascript/api/excel/excel.checkboxcellcontrol) + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml + + + // Add checkboxes to the table. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Get the second column in the table, without the header. + const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange(); + + // Change the boolean values to checkboxes. + range.control = { + type: Excel.CellControlType.checkbox + }; + await context.sync(); + }); + + ``` isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_19/excel/excel.cellvalue.yml b/docs/docs-ref-autogen/excel_1_19/excel/excel.cellvalue.yml index ef4aaccfd2..4722937ebb 100644 --- a/docs/docs-ref-autogen/excel_1_19/excel/excel.cellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_19/excel/excel.cellvalue.yml @@ -4,7 +4,28 @@ uid: excel!Excel.CellValue:type package: excel! fullName: Excel.CellValue summary: Represents the value in a cell. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), [Excel.FormattedNumberCellValue](/javascript/api/excel/excel.formattednumbercellvalue), [Excel.FunctionCellValue](/javascript/api/excel/excel.functioncellvalue), [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), + [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), + [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), + [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), + [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), + [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), + [Excel.FormattedNumberCellValue](/javascript/api/excel/excel.formattednumbercellvalue), + [Excel.FunctionCellValue](/javascript/api/excel/excel.functioncellvalue), + [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), + [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), + [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), + [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), + [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), + [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_19/excel/excel.cellvalueandpropertymetadata.yml b/docs/docs-ref-autogen/excel_1_19/excel/excel.cellvalueandpropertymetadata.yml index 566432a914..5f661bb32f 100644 --- a/docs/docs-ref-autogen/excel_1_19/excel/excel.cellvalueandpropertymetadata.yml +++ b/docs/docs-ref-autogen/excel_1_19/excel/excel.cellvalueandpropertymetadata.yml @@ -6,7 +6,16 @@ fullName: Excel.CellValueAndPropertyMetadata summary: >- Represents the value and metadata of a property. The metadata applies to the property (and not the value), but it is combined with the value in this type. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValue](/javascript/api/excel/excel.cellvalue), [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CellValue](/javascript/api/excel/excel.cellvalue), + [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_19/excel/excel.compactlayout.yml b/docs/docs-ref-autogen/excel_1_19/excel/excel.compactlayout.yml index 3f25496779..5bb689c662 100644 --- a/docs/docs-ref-autogen/excel_1_19/excel/excel.compactlayout.yml +++ b/docs/docs-ref-autogen/excel_1_19/excel/excel.compactlayout.yml @@ -6,7 +6,15 @@ fullName: Excel.CompactLayout summary: >- Represents the layout used when there is limited space to represent the entity. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_19/excel/excel.entitypropertytype.yml b/docs/docs-ref-autogen/excel_1_19/excel/excel.entitypropertytype.yml index 41a8cc7fcf..bc54a6eff6 100644 --- a/docs/docs-ref-autogen/excel_1_19/excel/excel.entitypropertytype.yml +++ b/docs/docs-ref-autogen/excel_1_19/excel/excel.entitypropertytype.yml @@ -4,7 +4,16 @@ uid: excel!Excel.EntityPropertyType:type package: excel! fullName: Excel.EntityPropertyType summary: Represents the value of a property. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), [Excel.CellValue](/javascript/api/excel/excel.cellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), + [Excel.CellValue](/javascript/api/excel/excel.cellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_19/excel/excel.errorcellvalue.yml b/docs/docs-ref-autogen/excel_1_19/excel/excel.errorcellvalue.yml index e5addcc22f..b88b1959c2 100644 --- a/docs/docs-ref-autogen/excel_1_19/excel/excel.errorcellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_19/excel/excel.errorcellvalue.yml @@ -4,7 +4,62 @@ uid: excel!Excel.ErrorCellValue:type package: excel! fullName: Excel.ErrorCellValue summary: Represents a cell value which contains an error. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\n\n\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue), [Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue), [Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue), [Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue), [Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue), [Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue), [Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue), [Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue), [Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue), [Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue), [Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue), [Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue), [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue), [Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue), [Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue), [Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue)\r\n\r\n#### Examples\n\n```TypeScript\n// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml\n\n// This function sets the value of cell A1 to a #BUSY! error using data types.\nawait Excel.run(async (context) => {\n // Retrieve the Sample worksheet and cell A1 on that sheet.\n const sheet = context.workbook.worksheets.getItemOrNullObject(\"Sample\");\n const range = sheet.getRange(\"A1\");\n\n // Get the error data type and set its type to `busy`.\n const error: Excel.ErrorCellValue = {\n type: Excel.CellValueType.error,\n errorType: Excel.ErrorCellValueType.busy\n };\n\n // Set cell A1 as the busy error.\n range.valuesAsJson = [[error]];\n await context.sync();\n});\n```" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + + + Learn more about the types in this type alias through the following links. + + + [Excel.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue), + [Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue), + [Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue), + [Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue), + [Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue), + [Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue), + [Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue), + [Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue), + [Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue), + [Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue), + [Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue), + [Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue), + [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue), + [Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue), + [Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue), + [Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue) + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml + + + // This function sets the value of cell A1 to a #BUSY! error using data types. + + await Excel.run(async (context) => { + // Retrieve the Sample worksheet and cell A1 on that sheet. + const sheet = context.workbook.worksheets.getItemOrNullObject("Sample"); + const range = sheet.getRange("A1"); + + // Get the error data type and set its type to `busy`. + const error: Excel.ErrorCellValue = { + type: Excel.CellValueType.error, + errorType: Excel.ErrorCellValueType.busy + }; + + // Set cell A1 as the busy error. + range.valuesAsJson = [[error]]; + await context.sync(); + }); + + ``` isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_19/excel/excel.functioncellvalue.yml b/docs/docs-ref-autogen/excel_1_19/excel/excel.functioncellvalue.yml index 50b7239609..b1f83d2ff4 100644 --- a/docs/docs-ref-autogen/excel_1_19/excel/excel.functioncellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_19/excel/excel.functioncellvalue.yml @@ -4,7 +4,15 @@ uid: excel!Excel.FunctionCellValue:type package: excel! fullName: Excel.FunctionCellValue summary: Represents a cell value which can be evaluated as a function. -remarks: "\\[ [API set: ExcelApi 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.JavaScriptCustomFunctionReferenceCellValue](/javascript/api/excel/excel.javascriptcustomfunctionreferencecellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.JavaScriptCustomFunctionReferenceCellValue](/javascript/api/excel/excel.javascriptcustomfunctionreferencecellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_19/excel/excel.referencedvalue.yml b/docs/docs-ref-autogen/excel_1_19/excel/excel.referencedvalue.yml index 57044e8ebe..168b4928ba 100644 --- a/docs/docs-ref-autogen/excel_1_19/excel/excel.referencedvalue.yml +++ b/docs/docs-ref-autogen/excel_1_19/excel/excel.referencedvalue.yml @@ -4,7 +4,20 @@ uid: excel!Excel.ReferencedValue:type package: excel! fullName: Excel.ReferencedValue summary: Represents the value in a cell. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), + [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), + [Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue), + [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), + [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), + [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_19/toc.yml b/docs/docs-ref-autogen/excel_1_19/toc.yml index 030fcc2ec8..8a801877aa 100644 --- a/docs/docs-ref-autogen/excel_1_19/toc.yml +++ b/docs/docs-ref-autogen/excel_1_19/toc.yml @@ -1615,6 +1615,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/excel_1_2/toc.yml b/docs/docs-ref-autogen/excel_1_2/toc.yml index 71be964e24..9476f987ec 100644 --- a/docs/docs-ref-autogen/excel_1_2/toc.yml +++ b/docs/docs-ref-autogen/excel_1_2/toc.yml @@ -740,6 +740,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/excel_1_20/custom-functions-runtime.yml b/docs/docs-ref-autogen/excel_1_20/custom-functions-runtime.yml new file mode 100644 index 0000000000..bc11232f89 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/custom-functions-runtime.yml @@ -0,0 +1,55 @@ +### YamlMime:TSPackage +uid: custom-functions-runtime! +name: custom-functions-runtime +type: package +summary: '' +interfaces: + - custom-functions-runtime!CustomFunctions.CancelableInvocation:interface + - custom-functions-runtime!CustomFunctions.Invocation:interface + - custom-functions-runtime!CustomFunctions.StreamingInvocation:interface +classes: + - custom-functions-runtime!CustomFunctions.Error:class +enums: + - custom-functions-runtime!CustomFunctions.ErrorCode:enum +functions: + - name: CustomFunctions.associate(id, functionObject) + uid: custom-functions-runtime!CustomFunctions.associate:function(1) + package: custom-functions-runtime! + summary: >- + Associates the JavaScript function to the name given by the "id" property + in the metadata JSON file. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'export function associate(id: string, functionObject: Function): void;' + parameters: + - id: id + description: '' + type: string + - id: functionObject + description: '' + type: Function + return: + type: void + description: '' + - name: CustomFunctions.associate(mappings) + uid: custom-functions-runtime!CustomFunctions.associate:function(2) + package: custom-functions-runtime! + summary: >- + Associates the JavaScript functions to the names given by the "id" + properties in the metadata JSON file. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'export function associate(mappings: { [key: string]: Function }): void;' + parameters: + - id: mappings + description: '' + type: '{ [key: string]: Function }' + return: + type: void + description: '' diff --git a/docs/docs-ref-autogen/excel_1_20/custom-functions-runtime/customfunctions.cancelableinvocation.yml b/docs/docs-ref-autogen/excel_1_20/custom-functions-runtime/customfunctions.cancelableinvocation.yml new file mode 100644 index 0000000000..670ca4b8ab --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/custom-functions-runtime/customfunctions.cancelableinvocation.yml @@ -0,0 +1,40 @@ +### YamlMime:TSType +name: CustomFunctions.CancelableInvocation +uid: custom-functions-runtime!CustomFunctions.CancelableInvocation:interface +package: custom-functions-runtime! +fullName: CustomFunctions.CancelableInvocation +summary: >- + Provides information about the invocation of a cancelable custom function. A + cancelable custom function can provide a handler for the onCanceled event. + + + To indicate that a function is cancelable, in the metadata JSON file, the + function options should specify: `{ "cancelable": true }` + + + If the metadata JSON file is being generated from JSDoc comments, include the + tag `@cancelable`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +events: + - name: onCanceled + uid: >- + custom-functions-runtime!CustomFunctions.CancelableInvocation#onCanceled:member + package: custom-functions-runtime! + fullName: onCanceled + summary: Event handler called when the custom function is canceled. + remarks: >- + \[ [API set: CustomFunctionsRuntime + 1.1](/javascript/api/requirement-sets/excel/custom-functions-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'onCanceled?: () => void;' + return: + type: () => void +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/custom-functions-runtime/customfunctions.error.yml b/docs/docs-ref-autogen/excel_1_20/custom-functions-runtime/customfunctions.error.yml new file mode 100644 index 0000000000..87834dce6e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/custom-functions-runtime/customfunctions.error.yml @@ -0,0 +1,103 @@ +### YamlMime:TSType +name: CustomFunctions.Error +uid: custom-functions-runtime!CustomFunctions.Error:class +package: custom-functions-runtime! +fullName: CustomFunctions.Error +summary: Use this class to handle errors and write custom error messages. +remarks: >- + \[ [API set: CustomFunctionsRuntime + 1.2](/javascript/api/requirement-sets/excel/custom-functions-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + /** + * Returns the #NUM! error as part of a 2-dimensional array. + * @customfunction + * @param {number} first First parameter. + * @param {number} second Second parameter. + * @param {number} third Third parameter. + * @returns {number[][]} Three results, as a 2-dimensional array. + */ + function returnInvalidNumberError(first, second, third) { + // Use the `CustomFunctions.Error` object to retrieve an invalid number error. + const error = new CustomFunctions.Error( + CustomFunctions.ErrorCode.invalidNumber, // Corresponds to the #NUM! error in the Excel UI. + ); + + // Enter logic that processes the first, second, and third input parameters. + // Imagine that the second calculation results in an invalid number error. + const firstResult = first; + const secondResult = error; + const thirdResult = third; + + // Return the results of the first and third parameter calculations + // and a #NUM! error in place of the second result. + return [[firstResult], [secondResult], [thirdResult]]; + }; + + ``` + +isPreview: false +isDeprecated: false +type: class +constructors: + - name: (constructor)(code, message) + uid: custom-functions-runtime!CustomFunctions.Error:constructor(1) + package: custom-functions-runtime! + fullName: (constructor)(code, message) + summary: Constructs a new instance of the `Error` class + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'constructor(code: ErrorCode, message?: string);' + parameters: + - id: code + description: '' + type: >- + + - id: message + description: '' + type: string +properties: + - name: code + uid: custom-functions-runtime!CustomFunctions.Error#code:member + package: custom-functions-runtime! + fullName: code + summary: The error code returned by your custom function. + remarks: >- + \[ [API set: CustomFunctionsRuntime + 1.2](/javascript/api/requirement-sets/excel/custom-functions-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'code: ErrorCode;' + return: + type: + - name: message + uid: custom-functions-runtime!CustomFunctions.Error#message:member + package: custom-functions-runtime! + fullName: message + summary: >- + Your custom error message, such as "This stock price is unavailable". + Custom messages are only available with certain error codes. + remarks: >- + \[ [API set: CustomFunctionsRuntime + 1.2](/javascript/api/requirement-sets/excel/custom-functions-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'message?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/custom-functions-runtime/customfunctions.errorcode.yml b/docs/docs-ref-autogen/excel_1_20/custom-functions-runtime/customfunctions.errorcode.yml new file mode 100644 index 0000000000..e130f1b8f5 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/custom-functions-runtime/customfunctions.errorcode.yml @@ -0,0 +1,103 @@ +### YamlMime:TSEnum +name: CustomFunctions.ErrorCode +uid: custom-functions-runtime!CustomFunctions.ErrorCode:enum +package: custom-functions-runtime! +fullName: CustomFunctions.ErrorCode +summary: >- + Error codes for custom functions. The error codes will appear in the cell that + invoked the function. + + + Custom error messages appear in addition to these error codes. Custom messages + display in the error indicator menu, which is accessed by hovering over the + error flag on each cell with an error. +remarks: |- + + + #### Examples + + ```TypeScript + /** + * Returns the #NUM! error as part of a 2-dimensional array. + * @customfunction + * @param {number} first First parameter. + * @param {number} second Second parameter. + * @param {number} third Third parameter. + * @returns {number[][]} Three results, as a 2-dimensional array. + */ + function returnInvalidNumberError(first, second, third) { + // Use the `CustomFunctions.Error` object to retrieve an invalid number error. + const error = new CustomFunctions.Error( + CustomFunctions.ErrorCode.invalidNumber, // Corresponds to the #NUM! error in the Excel UI. + ); + + // Enter logic that processes the first, second, and third input parameters. + // Imagine that the second calculation results in an invalid number error. + const firstResult = first; + const secondResult = error; + const thirdResult = third; + + // Return the results of the first and third parameter calculations + // and a #NUM! error in place of the second result. + return [[firstResult], [secondResult], [thirdResult]]; + }; + ``` + +isPreview: false +isDeprecated: false +fields: + - name: divisionByZero + uid: custom-functions-runtime!CustomFunctions.ErrorCode.divisionByZero:member + package: custom-functions-runtime! + summary: >- + This error code indicates that the function used is dividing by zero or + empty cells. A custom error message can't be used. + value: '"#DIV/0!"' + - name: invalidName + uid: custom-functions-runtime!CustomFunctions.ErrorCode.invalidName:member + package: custom-functions-runtime! + summary: >- + This error code indicates that there is a typo in the function name. Note + that this error code is supported as a custom function input error, but + not as a custom function output error. A custom error message can't be + used. + value: '"#NAME?"' + - name: invalidNumber + uid: custom-functions-runtime!CustomFunctions.ErrorCode.invalidNumber:member + package: custom-functions-runtime! + summary: >- + This error code indicates that there is a problem with a number in the + function. A custom error message can't be used. + value: '"#NUM!"' + - name: invalidReference + uid: custom-functions-runtime!CustomFunctions.ErrorCode.invalidReference:member + package: custom-functions-runtime! + summary: >- + This error code indicates that the function refers to an invalid cell. + Note that this error code is supported as a custom function input error, + but not as a custom function output error. A custom error message can't be + used. + value: '"#REF!"' + - name: invalidValue + uid: custom-functions-runtime!CustomFunctions.ErrorCode.invalidValue:member + package: custom-functions-runtime! + summary: >- + This error code indicates that a value in the function is of the wrong + data type. A custom error message can be used in addition to the error + code, if desired. + value: '"#VALUE!"' + - name: notAvailable + uid: custom-functions-runtime!CustomFunctions.ErrorCode.notAvailable:member + package: custom-functions-runtime! + summary: >- + This error code indicates that the function or service isn't available. A + custom error message can be used in addition to the error code, if + desired. + value: '"#N/A"' + - name: nullReference + uid: custom-functions-runtime!CustomFunctions.ErrorCode.nullReference:member + package: custom-functions-runtime! + summary: >- + This error code indicates that the ranges in the function don't intersect. + A custom error message can't be used. + value: '"#NULL!"' diff --git a/docs/docs-ref-autogen/excel_1_20/custom-functions-runtime/customfunctions.invocation.yml b/docs/docs-ref-autogen/excel_1_20/custom-functions-runtime/customfunctions.invocation.yml new file mode 100644 index 0000000000..1a61079888 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/custom-functions-runtime/customfunctions.invocation.yml @@ -0,0 +1,225 @@ +### YamlMime:TSType +name: CustomFunctions.Invocation +uid: custom-functions-runtime!CustomFunctions.Invocation:interface +package: custom-functions-runtime! +fullName: CustomFunctions.Invocation +summary: Provides information about the invocation of a custom function. +remarks: |- + + + #### Examples + + ```TypeScript + /** + * Return the address of the cell that invoked the custom function. + * @customfunction + * @param {number} first First parameter. + * @param {number} second Second parameter. + * @param {CustomFunctions.Invocation} invocation Invocation object. + * @requiresAddress + */ + function getAddress(first, second, invocation) { + const address = invocation.address; + return address; + } + ``` + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: address + uid: custom-functions-runtime!CustomFunctions.Invocation#address:member + package: custom-functions-runtime! + fullName: address + summary: >- + The cell address where the function is being called, if requested, + otherwise undefined. + + + To request the address for the function, in the metadata JSON file, the + function options should specify: `{ "requiresAddress": true }` + + + If the metadata JSON file is being generated from JSDoc comments, include + the tag `@requiresAddress`. + remarks: >- + \[ [API set: CustomFunctionsRuntime + 1.1](/javascript/api/requirement-sets/excel/custom-functions-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + /** + + * Return the address of the cell that invoked the custom function. + + * @customfunction + + * @param {number} first First parameter. + + * @param {number} second Second parameter. + + * @param {CustomFunctions.Invocation} invocation Invocation object. + + * @requiresAddress + + */ + + function getAddress(first, second, invocation) { + const address = invocation.address; + return address; + } + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'address?: string;' + return: + type: string + - name: functionName + uid: custom-functions-runtime!CustomFunctions.Invocation#functionName:member + package: custom-functions-runtime! + fullName: functionName + summary: The name of this function. + remarks: >- + \[ [API set: CustomFunctionsRuntime + 1.1](/javascript/api/requirement-sets/excel/custom-functions-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'functionName?: string;' + return: + type: string + - name: isInValuePreview + uid: >- + custom-functions-runtime!CustomFunctions.Invocation#isInValuePreview:member + package: custom-functions-runtime! + fullName: isInValuePreview + summary: >- + Indicates whether the function is invoked as part of the formula value + preview. `isInValuePreview` is read-only and can't be set by a custom + functions add-in. This value is `true` if the function is invoked to + preview the formula value; otherwise it is `false`. + remarks: >- + \[ [API set: CustomFunctionsRuntime + 1.5](/javascript/api/requirement-sets/excel/custom-functions-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + /** + + * Get the listing price for a house on the market for the given address. + + * @customfunction + + * @param address The address of the house. + + * @param invocation Custom function handler. + + * @returns The price of the house at the address. + + */ + + function getHousePrice(address: string, invocation: + CustomFunctions.Invocation): number { + // Check if this call is for formula value preview mode. + if (invocation.isInValuePreview) { + // Avoid long-running expensive service calls. + // Return a usable but fake number. + return 450000; + } else { + // Make the actual service calls in this block. + const price = callHouseServiceAPI(address); + return price; + } + } + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'isInValuePreview?: string;' + return: + type: string + - name: parameterAddresses + uid: >- + custom-functions-runtime!CustomFunctions.Invocation#parameterAddresses:member + package: custom-functions-runtime! + fullName: parameterAddresses + summary: >- + The range addresses where the function parameters are located, if + requested, otherwise undefined. + + + To request the parameter addresses for the function, in the metadata JSON + file, the function options should specify: `{ + "requiresParameterAddresses": true }` + + + If the metadata JSON file is being generated from JSDoc comments, include + the tag `@requiresParameterAddresses`. + remarks: >- + \[ [API set: CustomFunctionsRuntime + 1.3](/javascript/api/requirement-sets/excel/custom-functions-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + /** + + * Return the addresses of three parameters. + + * @customfunction + + * @param {string} firstParameter First parameter. + + * @param {string} secondParameter Second parameter. + + * @param {string} thirdParameter Third parameter. + + * @param {CustomFunctions.Invocation} invocation Invocation object. + + * @returns {string[][]} The addresses of the parameters, as a + 2-dimensional array. + + * @requiresParameterAddresses + + */ + + function getParameterAddresses(firstParameter, secondParameter, + thirdParameter, invocation) { + const addresses = [ + [invocation.parameterAddresses[0]], + [invocation.parameterAddresses[1]], + [invocation.parameterAddresses[2]] + ]; + return addresses; + } + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'parameterAddresses?: string[];' + return: + type: string[] diff --git a/docs/docs-ref-autogen/excel_1_20/custom-functions-runtime/customfunctions.streaminginvocation.yml b/docs/docs-ref-autogen/excel_1_20/custom-functions-runtime/customfunctions.streaminginvocation.yml new file mode 100644 index 0000000000..be486bcd1e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/custom-functions-runtime/customfunctions.streaminginvocation.yml @@ -0,0 +1,75 @@ +### YamlMime:TSType +name: CustomFunctions.StreamingInvocation +uid: custom-functions-runtime!CustomFunctions.StreamingInvocation:interface +package: custom-functions-runtime! +fullName: CustomFunctions.StreamingInvocation +summary: >- + Provides information about the invocation of a streaming custom function. A + streaming custom function can provide results which can change over time. + + + Call `setResult()` one or more times to provide the result instead of + returning a result from the function. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: setResult + uid: >- + custom-functions-runtime!CustomFunctions.StreamingInvocation#setResult:member + package: custom-functions-runtime! + fullName: setResult + summary: Set the result for the custom function. May be called more than once. + remarks: >- + \[ [API set: CustomFunctionsRuntime + 1.1](/javascript/api/requirement-sets/excel/custom-functions-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/16-custom-functions/streaming-function.yaml + + + /** @CustomFunction + * @description Increments the cell with a given amount at a specified interval in milliseconds. + * @param {number} amount - The amount to add to the cell value on each increment. + * @param {number} interval - The time in milliseconds to wait before the next increment on the cell. + * @param {CustomFunctions.StreamingInvocation} invocation - Parameter to send results to Excel + * or respond to the user canceling the function. + * @returns An incrementing value. + */ + function increment(amount: number, interval: number, invocation: + CustomFunctions.StreamingInvocation): void { + let result = 0; + const timer = setInterval(() => { + result += amount; + invocation.setResult(result); + }, interval); + + invocation.onCanceled = () => { + clearInterval(timer); + } + } + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'setResult: (value: ResultType | Error) => void;' + return: + type: >- + (value: ResultType | ) => + void +extends: >- + diff --git a/docs/docs-ref-autogen/excel_1_20/excel.yml b/docs/docs-ref-autogen/excel_1_20/excel.yml new file mode 100644 index 0000000000..9f9f42dbde --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel.yml @@ -0,0 +1,1354 @@ +### YamlMime:TSPackage +uid: excel! +name: excel +type: package +summary: '' +enums: + - excel!Excel.AggregationFunction:enum + - excel!Excel.ArrowheadLength:enum + - excel!Excel.ArrowheadStyle:enum + - excel!Excel.ArrowheadWidth:enum + - excel!Excel.AutoFillType:enum + - excel!Excel.BindingType:enum + - excel!Excel.BlockedErrorCellValueSubType:enum + - excel!Excel.BorderIndex:enum + - excel!Excel.BorderLineStyle:enum + - excel!Excel.BorderWeight:enum + - excel!Excel.BuiltInStyle:enum + - excel!Excel.BusyErrorCellValueSubType:enum + - excel!Excel.CalcErrorCellValueSubType:enum + - excel!Excel.CalculationMode:enum + - excel!Excel.CalculationState:enum + - excel!Excel.CalculationType:enum + - excel!Excel.CellControlType:enum + - excel!Excel.CellValueType:enum + - excel!Excel.ChartAxisCategoryType:enum + - excel!Excel.ChartAxisDisplayUnit:enum + - excel!Excel.ChartAxisGroup:enum + - excel!Excel.ChartAxisPosition:enum + - excel!Excel.ChartAxisScaleType:enum + - excel!Excel.ChartAxisTickLabelPosition:enum + - excel!Excel.ChartAxisTickMark:enum + - excel!Excel.ChartAxisTimeUnit:enum + - excel!Excel.ChartAxisType:enum + - excel!Excel.ChartBinType:enum + - excel!Excel.ChartBoxQuartileCalculation:enum + - excel!Excel.ChartColorScheme:enum + - excel!Excel.ChartDataLabelPosition:enum + - excel!Excel.ChartDataSourceType:enum + - excel!Excel.ChartDisplayBlanksAs:enum + - excel!Excel.ChartErrorBarsInclude:enum + - excel!Excel.ChartErrorBarsType:enum + - excel!Excel.ChartGradientStyle:enum + - excel!Excel.ChartGradientStyleType:enum + - excel!Excel.ChartLegendPosition:enum + - excel!Excel.ChartLineStyle:enum + - excel!Excel.ChartMapAreaLevel:enum + - excel!Excel.ChartMapLabelStrategy:enum + - excel!Excel.ChartMapProjectionType:enum + - excel!Excel.ChartMarkerStyle:enum + - excel!Excel.ChartParentLabelStrategy:enum + - excel!Excel.ChartPlotAreaPosition:enum + - excel!Excel.ChartPlotBy:enum + - excel!Excel.ChartSeriesBy:enum + - excel!Excel.ChartSeriesDimension:enum + - excel!Excel.ChartSplitType:enum + - excel!Excel.ChartTextHorizontalAlignment:enum + - excel!Excel.ChartTextVerticalAlignment:enum + - excel!Excel.ChartTickLabelAlignment:enum + - excel!Excel.ChartTitlePosition:enum + - excel!Excel.ChartTrendlineType:enum + - excel!Excel.ChartType:enum + - excel!Excel.ChartUnderlineStyle:enum + - excel!Excel.ClearApplyTo:enum + - excel!Excel.CloseBehavior:enum + - excel!Excel.CommentChangeType:enum + - excel!Excel.ConditionalCellValueOperator:enum + - excel!Excel.ConditionalDataBarAxisFormat:enum + - excel!Excel.ConditionalDataBarDirection:enum + - excel!Excel.ConditionalFormatColorCriterionType:enum + - excel!Excel.ConditionalFormatDirection:enum + - excel!Excel.ConditionalFormatIconRuleType:enum + - excel!Excel.ConditionalFormatPresetCriterion:enum + - excel!Excel.ConditionalFormatRuleType:enum + - excel!Excel.ConditionalFormatType:enum + - excel!Excel.ConditionalIconCriterionOperator:enum + - excel!Excel.ConditionalRangeBorderIndex:enum + - excel!Excel.ConditionalRangeBorderLineStyle:enum + - excel!Excel.ConditionalRangeFontUnderlineStyle:enum + - excel!Excel.ConditionalTextOperator:enum + - excel!Excel.ConditionalTopBottomCriterionType:enum + - excel!Excel.ConnectErrorCellValueSubType:enum + - excel!Excel.ConnectorType:enum + - excel!Excel.ContentType:enum + - excel!Excel.DataChangeType:enum + - excel!Excel.DataSourceType:enum + - excel!Excel.DataValidationAlertStyle:enum + - excel!Excel.DataValidationOperator:enum + - excel!Excel.DataValidationType:enum + - excel!Excel.DateFilterCondition:enum + - excel!Excel.DeleteShiftDirection:enum + - excel!Excel.DocumentPropertyItem:enum + - excel!Excel.DocumentPropertyType:enum + - excel!Excel.DynamicFilterCriteria:enum + - excel!Excel.EntityCardLayoutType:enum + - excel!Excel.EntityCompactLayoutIcons:enum + - excel!Excel.ErrorCellValueType:enum + - excel!Excel.ErrorCodes:enum + - excel!Excel.EventSource:enum + - excel!Excel.EventTriggerSource:enum + - excel!Excel.EventType:enum + - excel!Excel.ExternalErrorCellValueSubType:enum + - excel!Excel.FieldErrorCellValueSubType:enum + - excel!Excel.FillPattern:enum + - excel!Excel.FilterDatetimeSpecificity:enum + - excel!Excel.FilterOn:enum + - excel!Excel.FilterOperator:enum + - excel!Excel.FunctionCellValueType:enum + - excel!Excel.GeometricShapeType:enum + - excel!Excel.GroupOption:enum + - excel!Excel.HeaderFooterState:enum + - excel!Excel.HorizontalAlignment:enum + - excel!Excel.IconSet:enum + - excel!Excel.ImageFittingMode:enum + - excel!Excel.InsertShiftDirection:enum + - excel!Excel.KeyboardDirection:enum + - excel!Excel.LabelFilterCondition:enum + - excel!Excel.LinkedDataTypeState:enum + - excel!Excel.LinkedEntityDataDomainRefreshMode:enum + - excel!Excel.LoadToType:enum + - excel!Excel.NamedItemScope:enum + - excel!Excel.NamedItemType:enum + - excel!Excel.NumberFormatCategory:enum + - excel!Excel.NumErrorCellValueSubType:enum + - excel!Excel.PageOrientation:enum + - excel!Excel.PaperType:enum + - excel!Excel.PictureFormat:enum + - excel!Excel.PivotAxis:enum + - excel!Excel.PivotFilterTopBottomCriterion:enum + - excel!Excel.PivotFilterType:enum + - excel!Excel.PivotLayoutType:enum + - excel!Excel.Placement:enum + - excel!Excel.PrintComments:enum + - excel!Excel.PrintErrorType:enum + - excel!Excel.PrintMarginUnit:enum + - excel!Excel.PrintOrder:enum + - excel!Excel.ProtectionSelectionMode:enum + - excel!Excel.QueryError:enum + - excel!Excel.RangeCopyType:enum + - excel!Excel.RangeUnderlineStyle:enum + - excel!Excel.RangeValueType:enum + - excel!Excel.ReadingOrder:enum + - excel!Excel.ReferenceValueType:enum + - excel!Excel.RefErrorCellValueSubType:enum + - excel!Excel.RibbonTab:enum + - excel!Excel.RowHiddenChangeType:enum + - excel!Excel.SaveBehavior:enum + - excel!Excel.SearchDirection:enum + - excel!Excel.ShapeAutoSize:enum + - excel!Excel.ShapeFillType:enum + - excel!Excel.ShapeFontUnderlineStyle:enum + - excel!Excel.ShapeLineDashStyle:enum + - excel!Excel.ShapeLineStyle:enum + - excel!Excel.ShapeScaleFrom:enum + - excel!Excel.ShapeScaleType:enum + - excel!Excel.ShapeTextHorizontalAlignment:enum + - excel!Excel.ShapeTextHorizontalOverflow:enum + - excel!Excel.ShapeTextOrientation:enum + - excel!Excel.ShapeTextReadingOrder:enum + - excel!Excel.ShapeTextVerticalAlignment:enum + - excel!Excel.ShapeTextVerticalOverflow:enum + - excel!Excel.ShapeType:enum + - excel!Excel.ShapeZOrder:enum + - excel!Excel.SheetVisibility:enum + - excel!Excel.ShowAsCalculation:enum + - excel!Excel.SlicerSortType:enum + - excel!Excel.SortBy:enum + - excel!Excel.SortDataOption:enum + - excel!Excel.SortMethod:enum + - excel!Excel.SortOn:enum + - excel!Excel.SortOrientation:enum + - excel!Excel.SpecialCellType:enum + - excel!Excel.SpecialCellValueType:enum + - excel!Excel.SpillErrorCellValueSubType:enum + - excel!Excel.SubtotalLocationType:enum + - excel!Excel.TopBottomSelectionType:enum + - excel!Excel.ValueErrorCellValueSubType:enum + - excel!Excel.ValueFilterCondition:enum + - excel!Excel.VerticalAlignment:enum + - excel!Excel.WorksheetPositionType:enum +classes: + - excel!Excel.Application:class + - excel!Excel.AutoFilter:class + - excel!Excel.Binding:class + - excel!Excel.BindingCollection:class + - excel!Excel.CellValueConditionalFormat:class + - excel!Excel.Chart:class + - excel!Excel.ChartAreaFormat:class + - excel!Excel.ChartAxes:class + - excel!Excel.ChartAxis:class + - excel!Excel.ChartAxisFormat:class + - excel!Excel.ChartAxisTitle:class + - excel!Excel.ChartAxisTitleFormat:class + - excel!Excel.ChartBinOptions:class + - excel!Excel.ChartBorder:class + - excel!Excel.ChartBoxwhiskerOptions:class + - excel!Excel.ChartCollection:class + - excel!Excel.ChartDataLabel:class + - excel!Excel.ChartDataLabelAnchor:class + - excel!Excel.ChartDataLabelFormat:class + - excel!Excel.ChartDataLabels:class + - excel!Excel.ChartDataTable:class + - excel!Excel.ChartDataTableFormat:class + - excel!Excel.ChartErrorBars:class + - excel!Excel.ChartErrorBarsFormat:class + - excel!Excel.ChartFill:class + - excel!Excel.ChartFont:class + - excel!Excel.ChartFormatString:class + - excel!Excel.ChartGridlines:class + - excel!Excel.ChartGridlinesFormat:class + - excel!Excel.ChartLeaderLines:class + - excel!Excel.ChartLeaderLinesFormat:class + - excel!Excel.ChartLegend:class + - excel!Excel.ChartLegendEntry:class + - excel!Excel.ChartLegendEntryCollection:class + - excel!Excel.ChartLegendFormat:class + - excel!Excel.ChartLineFormat:class + - excel!Excel.ChartMapOptions:class + - excel!Excel.ChartPivotOptions:class + - excel!Excel.ChartPlotArea:class + - excel!Excel.ChartPlotAreaFormat:class + - excel!Excel.ChartPoint:class + - excel!Excel.ChartPointFormat:class + - excel!Excel.ChartPointsCollection:class + - excel!Excel.ChartSeries:class + - excel!Excel.ChartSeriesCollection:class + - excel!Excel.ChartSeriesFormat:class + - excel!Excel.ChartTitle:class + - excel!Excel.ChartTitleFormat:class + - excel!Excel.ChartTrendline:class + - excel!Excel.ChartTrendlineCollection:class + - excel!Excel.ChartTrendlineFormat:class + - excel!Excel.ChartTrendlineLabel:class + - excel!Excel.ChartTrendlineLabelFormat:class + - excel!Excel.ColorScaleConditionalFormat:class + - excel!Excel.Comment:class + - excel!Excel.CommentCollection:class + - excel!Excel.CommentReply:class + - excel!Excel.CommentReplyCollection:class + - excel!Excel.ConditionalDataBarNegativeFormat:class + - excel!Excel.ConditionalDataBarPositiveFormat:class + - excel!Excel.ConditionalFormat:class + - excel!Excel.ConditionalFormatCollection:class + - excel!Excel.ConditionalFormatRule:class + - excel!Excel.ConditionalRangeBorder:class + - excel!Excel.ConditionalRangeBorderCollection:class + - excel!Excel.ConditionalRangeFill:class + - excel!Excel.ConditionalRangeFont:class + - excel!Excel.ConditionalRangeFormat:class + - excel!Excel.CultureInfo:class + - excel!Excel.CustomConditionalFormat:class + - excel!Excel.CustomFunctionManager:class + - excel!Excel.CustomProperty:class + - excel!Excel.CustomPropertyCollection:class + - excel!Excel.CustomXmlPart:class + - excel!Excel.CustomXmlPartCollection:class + - excel!Excel.CustomXmlPartScopedCollection:class + - excel!Excel.DataBarConditionalFormat:class + - excel!Excel.DataConnectionCollection:class + - excel!Excel.DataPivotHierarchy:class + - excel!Excel.DataPivotHierarchyCollection:class + - excel!Excel.DataValidation:class + - excel!Excel.DatetimeFormatInfo:class + - excel!Excel.DocumentProperties:class + - excel!Excel.Filter:class + - excel!Excel.FilterPivotHierarchy:class + - excel!Excel.FilterPivotHierarchyCollection:class + - excel!Excel.FormatProtection:class + - excel!Excel.FunctionResult:class + - excel!Excel.Functions:class + - excel!Excel.GeometricShape:class + - excel!Excel.GroupShapeCollection:class + - excel!Excel.HeaderFooter:class + - excel!Excel.HeaderFooterGroup:class + - excel!Excel.IconSetConditionalFormat:class + - excel!Excel.Image:class + - excel!Excel.IterativeCalculation:class + - excel!Excel.Line:class + - excel!Excel.LinkedEntityDataDomain:class + - excel!Excel.LinkedEntityDataDomainCollection:class + - excel!Excel.NamedItem:class + - excel!Excel.NamedItemArrayValues:class + - excel!Excel.NamedItemCollection:class + - excel!Excel.Note:class + - excel!Excel.NoteCollection:class + - excel!Excel.NumberFormatInfo:class + - excel!Excel.PageBreak:class + - excel!Excel.PageBreakCollection:class + - excel!Excel.PageLayout:class + - excel!Excel.PivotField:class + - excel!Excel.PivotFieldCollection:class + - excel!Excel.PivotHierarchy:class + - excel!Excel.PivotHierarchyCollection:class + - excel!Excel.PivotItem:class + - excel!Excel.PivotItemCollection:class + - excel!Excel.PivotLayout:class + - excel!Excel.PivotTable:class + - excel!Excel.PivotTableCollection:class + - excel!Excel.PivotTableScopedCollection:class + - excel!Excel.PivotTableStyle:class + - excel!Excel.PivotTableStyleCollection:class + - excel!Excel.PresetCriteriaConditionalFormat:class + - excel!Excel.Query:class + - excel!Excel.QueryCollection:class + - excel!Excel.Range:class + - excel!Excel.RangeAreas:class + - excel!Excel.RangeAreasCollection:class + - excel!Excel.RangeBorder:class + - excel!Excel.RangeBorderCollection:class + - excel!Excel.RangeCollection:class + - excel!Excel.RangeFill:class + - excel!Excel.RangeFont:class + - excel!Excel.RangeFormat:class + - excel!Excel.RangeSort:class + - excel!Excel.RangeView:class + - excel!Excel.RangeViewCollection:class + - excel!Excel.RemoveDuplicatesResult:class + - excel!Excel.RequestContext:class + - excel!Excel.RowColumnPivotHierarchy:class + - excel!Excel.RowColumnPivotHierarchyCollection:class + - excel!Excel.Runtime:class + - excel!Excel.Setting:class + - excel!Excel.SettingCollection:class + - excel!Excel.Shape:class + - excel!Excel.ShapeCollection:class + - excel!Excel.ShapeFill:class + - excel!Excel.ShapeFont:class + - excel!Excel.ShapeGroup:class + - excel!Excel.ShapeLineFormat:class + - excel!Excel.Slicer:class + - excel!Excel.SlicerCollection:class + - excel!Excel.SlicerItem:class + - excel!Excel.SlicerItemCollection:class + - excel!Excel.SlicerStyle:class + - excel!Excel.SlicerStyleCollection:class + - excel!Excel.Style:class + - excel!Excel.StyleCollection:class + - excel!Excel.Table:class + - excel!Excel.TableCollection:class + - excel!Excel.TableColumn:class + - excel!Excel.TableColumnCollection:class + - excel!Excel.TableRow:class + - excel!Excel.TableRowCollection:class + - excel!Excel.TableScopedCollection:class + - excel!Excel.TableSort:class + - excel!Excel.TableStyle:class + - excel!Excel.TableStyleCollection:class + - excel!Excel.TextConditionalFormat:class + - excel!Excel.TextFrame:class + - excel!Excel.TextRange:class + - excel!Excel.TimelineStyle:class + - excel!Excel.TimelineStyleCollection:class + - excel!Excel.TopBottomConditionalFormat:class + - excel!Excel.Workbook:class + - excel!Excel.WorkbookCreated:class + - excel!Excel.WorkbookProtection:class + - excel!Excel.WorkbookRangeAreas:class + - excel!Excel.Worksheet:class + - excel!Excel.WorksheetCollection:class + - excel!Excel.WorksheetCustomProperty:class + - excel!Excel.WorksheetCustomPropertyCollection:class + - excel!Excel.WorksheetFreezePanes:class + - excel!Excel.WorksheetProtection:class +interfaces: + - excel!Excel.ArrayCellValue:interface + - excel!Excel.BasicCardLayout:interface + - excel!Excel.BasicCompactLayout:interface + - excel!Excel.BasicDataValidation:interface + - excel!Excel.BasicViewLayouts:interface + - excel!Excel.BindingDataChangedEventArgs:interface + - excel!Excel.BindingSelectionChangedEventArgs:interface + - excel!Excel.BlockedErrorCellValue:interface + - excel!Excel.BooleanCellValue:interface + - excel!Excel.BusyErrorCellValue:interface + - excel!Excel.CalcErrorCellValue:interface + - excel!Excel.CardLayoutListSection:interface + - excel!Excel.CardLayoutPropertyReference:interface + - excel!Excel.CardLayoutSectionStandardProperties:interface + - excel!Excel.CardLayoutStandardProperties:interface + - excel!Excel.CardLayoutTableSection:interface + - excel!Excel.CardLayoutTwoColumnSection:interface + - excel!Excel.CellBorder:interface + - excel!Excel.CellBorderCollection:interface + - excel!Excel.CellProperties:interface + - excel!Excel.CellPropertiesBorderLoadOptions:interface + - excel!Excel.CellPropertiesFill:interface + - excel!Excel.CellPropertiesFillLoadOptions:interface + - excel!Excel.CellPropertiesFont:interface + - excel!Excel.CellPropertiesFontLoadOptions:interface + - excel!Excel.CellPropertiesFormat:interface + - excel!Excel.CellPropertiesFormatLoadOptions:interface + - excel!Excel.CellPropertiesLoadOptions:interface + - excel!Excel.CellPropertiesProtection:interface + - excel!Excel.CellValueAttributionAttributes:interface + - excel!Excel.CellValueExtraProperties:interface + - excel!Excel.CellValuePropertyMetadata:interface + - excel!Excel.CellValuePropertyMetadataExclusions:interface + - excel!Excel.CellValueProviderAttributes:interface + - excel!Excel.ChangedEventDetail:interface + - excel!Excel.ChangeDirectionState:interface + - excel!Excel.ChartActivatedEventArgs:interface + - excel!Excel.ChartAddedEventArgs:interface + - excel!Excel.ChartDeactivatedEventArgs:interface + - excel!Excel.ChartDeletedEventArgs:interface + - excel!Excel.CheckboxCellControl:interface + - excel!Excel.ColumnProperties:interface + - excel!Excel.ColumnPropertiesLoadOptions:interface + - excel!Excel.CommentAddedEventArgs:interface + - excel!Excel.CommentChangedEventArgs:interface + - excel!Excel.CommentDeletedEventArgs:interface + - excel!Excel.CommentDetail:interface + - excel!Excel.CommentMention:interface + - excel!Excel.CommentRichContent:interface + - excel!Excel.ConditionalCellValueRule:interface + - excel!Excel.ConditionalColorScaleCriteria:interface + - excel!Excel.ConditionalColorScaleCriterion:interface + - excel!Excel.ConditionalDataBarRule:interface + - excel!Excel.ConditionalIconCriterion:interface + - excel!Excel.ConditionalPresetCriteriaRule:interface + - excel!Excel.ConditionalTextComparisonRule:interface + - excel!Excel.ConditionalTopBottomRule:interface + - excel!Excel.ConnectErrorCellValue:interface + - excel!Excel.CustomDataValidation:interface + - excel!Excel.CustomFunctionVisibilityOptions:interface + - excel!Excel.DataValidationErrorAlert:interface + - excel!Excel.DataValidationPrompt:interface + - excel!Excel.DataValidationRule:interface + - excel!Excel.DateTimeDataValidation:interface + - excel!Excel.Div0ErrorCellValue:interface + - excel!Excel.DoubleCellValue:interface + - excel!Excel.EmptyCellControl:interface + - excel!Excel.EmptyCellValue:interface + - excel!Excel.EntityCardLayout:interface + - excel!Excel.EntityCellValue:interface + - excel!Excel.EntityCompactLayout:interface + - excel!Excel.EntityPropertyExtraProperties:interface + - excel!Excel.EntityViewLayouts:interface + - excel!Excel.ExternalErrorCellValue:interface + - excel!Excel.FieldErrorCellValue:interface + - excel!Excel.FilterCriteria:interface + - excel!Excel.FilterDatetime:interface + - excel!Excel.FiveArrowsGraySet:interface + - excel!Excel.FiveArrowsSet:interface + - excel!Excel.FiveBoxesSet:interface + - excel!Excel.FiveQuartersSet:interface + - excel!Excel.FiveRatingSet:interface + - excel!Excel.FormattedNumberCellValue:interface + - excel!Excel.FormulaChangedEventDetail:interface + - excel!Excel.FourArrowsGraySet:interface + - excel!Excel.FourArrowsSet:interface + - excel!Excel.FourRatingSet:interface + - excel!Excel.FourRedToBlackSet:interface + - excel!Excel.FourTrafficLightsSet:interface + - excel!Excel.GettingDataErrorCellValue:interface + - excel!Excel.Icon:interface + - excel!Excel.IconCollections:interface + - excel!Excel.InsertWorksheetOptions:interface + - excel!Excel.Interfaces.AllowEditRangeCollectionData:interface + - excel!Excel.Interfaces.AllowEditRangeCollectionUpdateData:interface + - excel!Excel.Interfaces.AllowEditRangeData:interface + - excel!Excel.Interfaces.AllowEditRangeUpdateData:interface + - excel!Excel.Interfaces.ApplicationData:interface + - excel!Excel.Interfaces.ApplicationLoadOptions:interface + - excel!Excel.Interfaces.ApplicationUpdateData:interface + - excel!Excel.Interfaces.AutoFilterData:interface + - excel!Excel.Interfaces.AutoFilterLoadOptions:interface + - excel!Excel.Interfaces.BindingCollectionData:interface + - excel!Excel.Interfaces.BindingCollectionLoadOptions:interface + - excel!Excel.Interfaces.BindingCollectionUpdateData:interface + - excel!Excel.Interfaces.BindingData:interface + - excel!Excel.Interfaces.BindingLoadOptions:interface + - excel!Excel.Interfaces.CellValueConditionalFormatData:interface + - excel!Excel.Interfaces.CellValueConditionalFormatLoadOptions:interface + - excel!Excel.Interfaces.CellValueConditionalFormatUpdateData:interface + - excel!Excel.Interfaces.ChartAreaFormatData:interface + - excel!Excel.Interfaces.ChartAreaFormatLoadOptions:interface + - excel!Excel.Interfaces.ChartAreaFormatUpdateData:interface + - excel!Excel.Interfaces.ChartAxesData:interface + - excel!Excel.Interfaces.ChartAxesLoadOptions:interface + - excel!Excel.Interfaces.ChartAxesUpdateData:interface + - excel!Excel.Interfaces.ChartAxisData:interface + - excel!Excel.Interfaces.ChartAxisFormatData:interface + - excel!Excel.Interfaces.ChartAxisFormatLoadOptions:interface + - excel!Excel.Interfaces.ChartAxisFormatUpdateData:interface + - excel!Excel.Interfaces.ChartAxisLoadOptions:interface + - excel!Excel.Interfaces.ChartAxisTitleData:interface + - excel!Excel.Interfaces.ChartAxisTitleFormatData:interface + - excel!Excel.Interfaces.ChartAxisTitleFormatLoadOptions:interface + - excel!Excel.Interfaces.ChartAxisTitleFormatUpdateData:interface + - excel!Excel.Interfaces.ChartAxisTitleLoadOptions:interface + - excel!Excel.Interfaces.ChartAxisTitleUpdateData:interface + - excel!Excel.Interfaces.ChartAxisUpdateData:interface + - excel!Excel.Interfaces.ChartBinOptionsData:interface + - excel!Excel.Interfaces.ChartBinOptionsLoadOptions:interface + - excel!Excel.Interfaces.ChartBinOptionsUpdateData:interface + - excel!Excel.Interfaces.ChartBorderData:interface + - excel!Excel.Interfaces.ChartBorderLoadOptions:interface + - excel!Excel.Interfaces.ChartBorderUpdateData:interface + - excel!Excel.Interfaces.ChartBoxwhiskerOptionsData:interface + - excel!Excel.Interfaces.ChartBoxwhiskerOptionsLoadOptions:interface + - excel!Excel.Interfaces.ChartBoxwhiskerOptionsUpdateData:interface + - excel!Excel.Interfaces.ChartCollectionData:interface + - excel!Excel.Interfaces.ChartCollectionLoadOptions:interface + - excel!Excel.Interfaces.ChartCollectionUpdateData:interface + - excel!Excel.Interfaces.ChartData:interface + - excel!Excel.Interfaces.ChartDataLabelAnchorData:interface + - excel!Excel.Interfaces.ChartDataLabelAnchorLoadOptions:interface + - excel!Excel.Interfaces.ChartDataLabelAnchorUpdateData:interface + - excel!Excel.Interfaces.ChartDataLabelData:interface + - excel!Excel.Interfaces.ChartDataLabelFormatData:interface + - excel!Excel.Interfaces.ChartDataLabelFormatLoadOptions:interface + - excel!Excel.Interfaces.ChartDataLabelFormatUpdateData:interface + - excel!Excel.Interfaces.ChartDataLabelLoadOptions:interface + - excel!Excel.Interfaces.ChartDataLabelsData:interface + - excel!Excel.Interfaces.ChartDataLabelsLoadOptions:interface + - excel!Excel.Interfaces.ChartDataLabelsUpdateData:interface + - excel!Excel.Interfaces.ChartDataLabelUpdateData:interface + - excel!Excel.Interfaces.ChartDataTableData:interface + - excel!Excel.Interfaces.ChartDataTableFormatData:interface + - excel!Excel.Interfaces.ChartDataTableFormatLoadOptions:interface + - excel!Excel.Interfaces.ChartDataTableFormatUpdateData:interface + - excel!Excel.Interfaces.ChartDataTableLoadOptions:interface + - excel!Excel.Interfaces.ChartDataTableUpdateData:interface + - excel!Excel.Interfaces.ChartErrorBarsData:interface + - excel!Excel.Interfaces.ChartErrorBarsFormatData:interface + - excel!Excel.Interfaces.ChartErrorBarsFormatLoadOptions:interface + - excel!Excel.Interfaces.ChartErrorBarsFormatUpdateData:interface + - excel!Excel.Interfaces.ChartErrorBarsLoadOptions:interface + - excel!Excel.Interfaces.ChartErrorBarsUpdateData:interface + - excel!Excel.Interfaces.ChartFontData:interface + - excel!Excel.Interfaces.ChartFontLoadOptions:interface + - excel!Excel.Interfaces.ChartFontUpdateData:interface + - excel!Excel.Interfaces.ChartFormatStringData:interface + - excel!Excel.Interfaces.ChartFormatStringLoadOptions:interface + - excel!Excel.Interfaces.ChartFormatStringUpdateData:interface + - excel!Excel.Interfaces.ChartGridlinesData:interface + - excel!Excel.Interfaces.ChartGridlinesFormatData:interface + - excel!Excel.Interfaces.ChartGridlinesFormatLoadOptions:interface + - excel!Excel.Interfaces.ChartGridlinesFormatUpdateData:interface + - excel!Excel.Interfaces.ChartGridlinesLoadOptions:interface + - excel!Excel.Interfaces.ChartGridlinesUpdateData:interface + - excel!Excel.Interfaces.ChartLeaderLinesData:interface + - excel!Excel.Interfaces.ChartLeaderLinesFormatData:interface + - excel!Excel.Interfaces.ChartLeaderLinesFormatLoadOptions:interface + - excel!Excel.Interfaces.ChartLeaderLinesFormatUpdateData:interface + - excel!Excel.Interfaces.ChartLeaderLinesLoadOptions:interface + - excel!Excel.Interfaces.ChartLeaderLinesUpdateData:interface + - excel!Excel.Interfaces.ChartLegendData:interface + - excel!Excel.Interfaces.ChartLegendEntryCollectionData:interface + - excel!Excel.Interfaces.ChartLegendEntryCollectionLoadOptions:interface + - excel!Excel.Interfaces.ChartLegendEntryCollectionUpdateData:interface + - excel!Excel.Interfaces.ChartLegendEntryData:interface + - excel!Excel.Interfaces.ChartLegendEntryLoadOptions:interface + - excel!Excel.Interfaces.ChartLegendEntryUpdateData:interface + - excel!Excel.Interfaces.ChartLegendFormatData:interface + - excel!Excel.Interfaces.ChartLegendFormatLoadOptions:interface + - excel!Excel.Interfaces.ChartLegendFormatUpdateData:interface + - excel!Excel.Interfaces.ChartLegendLoadOptions:interface + - excel!Excel.Interfaces.ChartLegendUpdateData:interface + - excel!Excel.Interfaces.ChartLineFormatData:interface + - excel!Excel.Interfaces.ChartLineFormatLoadOptions:interface + - excel!Excel.Interfaces.ChartLineFormatUpdateData:interface + - excel!Excel.Interfaces.ChartLoadOptions:interface + - excel!Excel.Interfaces.ChartMapOptionsData:interface + - excel!Excel.Interfaces.ChartMapOptionsLoadOptions:interface + - excel!Excel.Interfaces.ChartMapOptionsUpdateData:interface + - excel!Excel.Interfaces.ChartPivotOptionsData:interface + - excel!Excel.Interfaces.ChartPivotOptionsLoadOptions:interface + - excel!Excel.Interfaces.ChartPivotOptionsUpdateData:interface + - excel!Excel.Interfaces.ChartPlotAreaData:interface + - excel!Excel.Interfaces.ChartPlotAreaFormatData:interface + - excel!Excel.Interfaces.ChartPlotAreaFormatLoadOptions:interface + - excel!Excel.Interfaces.ChartPlotAreaFormatUpdateData:interface + - excel!Excel.Interfaces.ChartPlotAreaLoadOptions:interface + - excel!Excel.Interfaces.ChartPlotAreaUpdateData:interface + - excel!Excel.Interfaces.ChartPointData:interface + - excel!Excel.Interfaces.ChartPointFormatData:interface + - excel!Excel.Interfaces.ChartPointFormatLoadOptions:interface + - excel!Excel.Interfaces.ChartPointFormatUpdateData:interface + - excel!Excel.Interfaces.ChartPointLoadOptions:interface + - excel!Excel.Interfaces.ChartPointsCollectionData:interface + - excel!Excel.Interfaces.ChartPointsCollectionLoadOptions:interface + - excel!Excel.Interfaces.ChartPointsCollectionUpdateData:interface + - excel!Excel.Interfaces.ChartPointUpdateData:interface + - excel!Excel.Interfaces.ChartSeriesCollectionData:interface + - excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions:interface + - excel!Excel.Interfaces.ChartSeriesCollectionUpdateData:interface + - excel!Excel.Interfaces.ChartSeriesData:interface + - excel!Excel.Interfaces.ChartSeriesFormatData:interface + - excel!Excel.Interfaces.ChartSeriesFormatLoadOptions:interface + - excel!Excel.Interfaces.ChartSeriesFormatUpdateData:interface + - excel!Excel.Interfaces.ChartSeriesLoadOptions:interface + - excel!Excel.Interfaces.ChartSeriesUpdateData:interface + - excel!Excel.Interfaces.ChartTitleData:interface + - excel!Excel.Interfaces.ChartTitleFormatData:interface + - excel!Excel.Interfaces.ChartTitleFormatLoadOptions:interface + - excel!Excel.Interfaces.ChartTitleFormatUpdateData:interface + - excel!Excel.Interfaces.ChartTitleLoadOptions:interface + - excel!Excel.Interfaces.ChartTitleUpdateData:interface + - excel!Excel.Interfaces.ChartTrendlineCollectionData:interface + - excel!Excel.Interfaces.ChartTrendlineCollectionLoadOptions:interface + - excel!Excel.Interfaces.ChartTrendlineCollectionUpdateData:interface + - excel!Excel.Interfaces.ChartTrendlineData:interface + - excel!Excel.Interfaces.ChartTrendlineFormatData:interface + - excel!Excel.Interfaces.ChartTrendlineFormatLoadOptions:interface + - excel!Excel.Interfaces.ChartTrendlineFormatUpdateData:interface + - excel!Excel.Interfaces.ChartTrendlineLabelData:interface + - excel!Excel.Interfaces.ChartTrendlineLabelFormatData:interface + - excel!Excel.Interfaces.ChartTrendlineLabelFormatLoadOptions:interface + - excel!Excel.Interfaces.ChartTrendlineLabelFormatUpdateData:interface + - excel!Excel.Interfaces.ChartTrendlineLabelLoadOptions:interface + - excel!Excel.Interfaces.ChartTrendlineLabelUpdateData:interface + - excel!Excel.Interfaces.ChartTrendlineLoadOptions:interface + - excel!Excel.Interfaces.ChartTrendlineUpdateData:interface + - excel!Excel.Interfaces.ChartUpdateData:interface + - excel!Excel.Interfaces.CollectionLoadOptions:interface + - excel!Excel.Interfaces.ColorScaleConditionalFormatData:interface + - excel!Excel.Interfaces.ColorScaleConditionalFormatLoadOptions:interface + - excel!Excel.Interfaces.ColorScaleConditionalFormatUpdateData:interface + - excel!Excel.Interfaces.CommentCollectionData:interface + - excel!Excel.Interfaces.CommentCollectionLoadOptions:interface + - excel!Excel.Interfaces.CommentCollectionUpdateData:interface + - excel!Excel.Interfaces.CommentData:interface + - excel!Excel.Interfaces.CommentLoadOptions:interface + - excel!Excel.Interfaces.CommentReplyCollectionData:interface + - excel!Excel.Interfaces.CommentReplyCollectionLoadOptions:interface + - excel!Excel.Interfaces.CommentReplyCollectionUpdateData:interface + - excel!Excel.Interfaces.CommentReplyData:interface + - excel!Excel.Interfaces.CommentReplyLoadOptions:interface + - excel!Excel.Interfaces.CommentReplyUpdateData:interface + - excel!Excel.Interfaces.CommentUpdateData:interface + - excel!Excel.Interfaces.ConditionalDataBarNegativeFormatData:interface + - excel!Excel.Interfaces.ConditionalDataBarNegativeFormatLoadOptions:interface + - excel!Excel.Interfaces.ConditionalDataBarNegativeFormatUpdateData:interface + - excel!Excel.Interfaces.ConditionalDataBarPositiveFormatData:interface + - excel!Excel.Interfaces.ConditionalDataBarPositiveFormatLoadOptions:interface + - excel!Excel.Interfaces.ConditionalDataBarPositiveFormatUpdateData:interface + - excel!Excel.Interfaces.ConditionalFormatCollectionData:interface + - excel!Excel.Interfaces.ConditionalFormatCollectionLoadOptions:interface + - excel!Excel.Interfaces.ConditionalFormatCollectionUpdateData:interface + - excel!Excel.Interfaces.ConditionalFormatData:interface + - excel!Excel.Interfaces.ConditionalFormatLoadOptions:interface + - excel!Excel.Interfaces.ConditionalFormatRuleData:interface + - excel!Excel.Interfaces.ConditionalFormatRuleLoadOptions:interface + - excel!Excel.Interfaces.ConditionalFormatRuleUpdateData:interface + - excel!Excel.Interfaces.ConditionalFormatUpdateData:interface + - excel!Excel.Interfaces.ConditionalRangeBorderCollectionData:interface + - excel!Excel.Interfaces.ConditionalRangeBorderCollectionLoadOptions:interface + - excel!Excel.Interfaces.ConditionalRangeBorderCollectionUpdateData:interface + - excel!Excel.Interfaces.ConditionalRangeBorderData:interface + - excel!Excel.Interfaces.ConditionalRangeBorderLoadOptions:interface + - excel!Excel.Interfaces.ConditionalRangeBorderUpdateData:interface + - excel!Excel.Interfaces.ConditionalRangeFillData:interface + - excel!Excel.Interfaces.ConditionalRangeFillLoadOptions:interface + - excel!Excel.Interfaces.ConditionalRangeFillUpdateData:interface + - excel!Excel.Interfaces.ConditionalRangeFontData:interface + - excel!Excel.Interfaces.ConditionalRangeFontLoadOptions:interface + - excel!Excel.Interfaces.ConditionalRangeFontUpdateData:interface + - excel!Excel.Interfaces.ConditionalRangeFormatData:interface + - excel!Excel.Interfaces.ConditionalRangeFormatLoadOptions:interface + - excel!Excel.Interfaces.ConditionalRangeFormatUpdateData:interface + - excel!Excel.Interfaces.CultureInfoData:interface + - excel!Excel.Interfaces.CultureInfoLoadOptions:interface + - excel!Excel.Interfaces.CustomConditionalFormatData:interface + - excel!Excel.Interfaces.CustomConditionalFormatLoadOptions:interface + - excel!Excel.Interfaces.CustomConditionalFormatUpdateData:interface + - excel!Excel.Interfaces.CustomFunctionManagerData:interface + - excel!Excel.Interfaces.CustomPropertyCollectionData:interface + - excel!Excel.Interfaces.CustomPropertyCollectionLoadOptions:interface + - excel!Excel.Interfaces.CustomPropertyCollectionUpdateData:interface + - excel!Excel.Interfaces.CustomPropertyData:interface + - excel!Excel.Interfaces.CustomPropertyLoadOptions:interface + - excel!Excel.Interfaces.CustomPropertyUpdateData:interface + - excel!Excel.Interfaces.CustomXmlPartCollectionData:interface + - excel!Excel.Interfaces.CustomXmlPartCollectionLoadOptions:interface + - excel!Excel.Interfaces.CustomXmlPartCollectionUpdateData:interface + - excel!Excel.Interfaces.CustomXmlPartData:interface + - excel!Excel.Interfaces.CustomXmlPartLoadOptions:interface + - excel!Excel.Interfaces.CustomXmlPartScopedCollectionData:interface + - excel!Excel.Interfaces.CustomXmlPartScopedCollectionLoadOptions:interface + - excel!Excel.Interfaces.CustomXmlPartScopedCollectionUpdateData:interface + - excel!Excel.Interfaces.DataBarConditionalFormatData:interface + - excel!Excel.Interfaces.DataBarConditionalFormatLoadOptions:interface + - excel!Excel.Interfaces.DataBarConditionalFormatUpdateData:interface + - excel!Excel.Interfaces.DataPivotHierarchyCollectionData:interface + - excel!Excel.Interfaces.DataPivotHierarchyCollectionLoadOptions:interface + - excel!Excel.Interfaces.DataPivotHierarchyCollectionUpdateData:interface + - excel!Excel.Interfaces.DataPivotHierarchyData:interface + - excel!Excel.Interfaces.DataPivotHierarchyLoadOptions:interface + - excel!Excel.Interfaces.DataPivotHierarchyUpdateData:interface + - excel!Excel.Interfaces.DataValidationData:interface + - excel!Excel.Interfaces.DataValidationLoadOptions:interface + - excel!Excel.Interfaces.DataValidationUpdateData:interface + - excel!Excel.Interfaces.DatetimeFormatInfoData:interface + - excel!Excel.Interfaces.DatetimeFormatInfoLoadOptions:interface + - excel!Excel.Interfaces.DocumentPropertiesData:interface + - excel!Excel.Interfaces.DocumentPropertiesLoadOptions:interface + - excel!Excel.Interfaces.DocumentPropertiesUpdateData:interface + - excel!Excel.Interfaces.FilterData:interface + - excel!Excel.Interfaces.FilterLoadOptions:interface + - excel!Excel.Interfaces.FilterPivotHierarchyCollectionData:interface + - excel!Excel.Interfaces.FilterPivotHierarchyCollectionLoadOptions:interface + - excel!Excel.Interfaces.FilterPivotHierarchyCollectionUpdateData:interface + - excel!Excel.Interfaces.FilterPivotHierarchyData:interface + - excel!Excel.Interfaces.FilterPivotHierarchyLoadOptions:interface + - excel!Excel.Interfaces.FilterPivotHierarchyUpdateData:interface + - excel!Excel.Interfaces.FormatProtectionData:interface + - excel!Excel.Interfaces.FormatProtectionLoadOptions:interface + - excel!Excel.Interfaces.FormatProtectionUpdateData:interface + - excel!Excel.Interfaces.FunctionResultData:interface + - excel!Excel.Interfaces.FunctionResultLoadOptions:interface + - excel!Excel.Interfaces.GeometricShapeData:interface + - excel!Excel.Interfaces.GeometricShapeLoadOptions:interface + - excel!Excel.Interfaces.GroupShapeCollectionData:interface + - excel!Excel.Interfaces.GroupShapeCollectionLoadOptions:interface + - excel!Excel.Interfaces.GroupShapeCollectionUpdateData:interface + - excel!Excel.Interfaces.HeaderFooterData:interface + - excel!Excel.Interfaces.HeaderFooterGroupData:interface + - excel!Excel.Interfaces.HeaderFooterGroupLoadOptions:interface + - excel!Excel.Interfaces.HeaderFooterGroupUpdateData:interface + - excel!Excel.Interfaces.HeaderFooterLoadOptions:interface + - excel!Excel.Interfaces.HeaderFooterUpdateData:interface + - excel!Excel.Interfaces.IconSetConditionalFormatData:interface + - excel!Excel.Interfaces.IconSetConditionalFormatLoadOptions:interface + - excel!Excel.Interfaces.IconSetConditionalFormatUpdateData:interface + - excel!Excel.Interfaces.ImageData:interface + - excel!Excel.Interfaces.ImageLoadOptions:interface + - excel!Excel.Interfaces.IterativeCalculationData:interface + - excel!Excel.Interfaces.IterativeCalculationLoadOptions:interface + - excel!Excel.Interfaces.IterativeCalculationUpdateData:interface + - excel!Excel.Interfaces.LineData:interface + - excel!Excel.Interfaces.LineLoadOptions:interface + - excel!Excel.Interfaces.LineUpdateData:interface + - excel!Excel.Interfaces.LinkedEntityDataDomainCollectionData:interface + - excel!Excel.Interfaces.LinkedEntityDataDomainCollectionLoadOptions:interface + - excel!Excel.Interfaces.LinkedEntityDataDomainCollectionUpdateData:interface + - excel!Excel.Interfaces.LinkedEntityDataDomainData:interface + - excel!Excel.Interfaces.LinkedEntityDataDomainLoadOptions:interface + - excel!Excel.Interfaces.LinkedEntityDataDomainUpdateData:interface + - excel!Excel.Interfaces.LinkedWorkbookCollectionData:interface + - excel!Excel.Interfaces.LinkedWorkbookCollectionUpdateData:interface + - excel!Excel.Interfaces.LinkedWorkbookData:interface + - excel!Excel.Interfaces.NamedItemArrayValuesData:interface + - excel!Excel.Interfaces.NamedItemArrayValuesLoadOptions:interface + - excel!Excel.Interfaces.NamedItemCollectionData:interface + - excel!Excel.Interfaces.NamedItemCollectionLoadOptions:interface + - excel!Excel.Interfaces.NamedItemCollectionUpdateData:interface + - excel!Excel.Interfaces.NamedItemData:interface + - excel!Excel.Interfaces.NamedItemLoadOptions:interface + - excel!Excel.Interfaces.NamedItemUpdateData:interface + - excel!Excel.Interfaces.NamedSheetViewCollectionData:interface + - excel!Excel.Interfaces.NamedSheetViewCollectionUpdateData:interface + - excel!Excel.Interfaces.NamedSheetViewData:interface + - excel!Excel.Interfaces.NamedSheetViewUpdateData:interface + - excel!Excel.Interfaces.NoteCollectionData:interface + - excel!Excel.Interfaces.NoteCollectionLoadOptions:interface + - excel!Excel.Interfaces.NoteCollectionUpdateData:interface + - excel!Excel.Interfaces.NoteData:interface + - excel!Excel.Interfaces.NoteLoadOptions:interface + - excel!Excel.Interfaces.NoteUpdateData:interface + - excel!Excel.Interfaces.NumberFormatInfoData:interface + - excel!Excel.Interfaces.NumberFormatInfoLoadOptions:interface + - excel!Excel.Interfaces.PageBreakCollectionData:interface + - excel!Excel.Interfaces.PageBreakCollectionLoadOptions:interface + - excel!Excel.Interfaces.PageBreakCollectionUpdateData:interface + - excel!Excel.Interfaces.PageBreakData:interface + - excel!Excel.Interfaces.PageBreakLoadOptions:interface + - excel!Excel.Interfaces.PageLayoutData:interface + - excel!Excel.Interfaces.PageLayoutLoadOptions:interface + - excel!Excel.Interfaces.PageLayoutUpdateData:interface + - excel!Excel.Interfaces.PivotFieldCollectionData:interface + - excel!Excel.Interfaces.PivotFieldCollectionLoadOptions:interface + - excel!Excel.Interfaces.PivotFieldCollectionUpdateData:interface + - excel!Excel.Interfaces.PivotFieldData:interface + - excel!Excel.Interfaces.PivotFieldLoadOptions:interface + - excel!Excel.Interfaces.PivotFieldUpdateData:interface + - excel!Excel.Interfaces.PivotHierarchyCollectionData:interface + - excel!Excel.Interfaces.PivotHierarchyCollectionLoadOptions:interface + - excel!Excel.Interfaces.PivotHierarchyCollectionUpdateData:interface + - excel!Excel.Interfaces.PivotHierarchyData:interface + - excel!Excel.Interfaces.PivotHierarchyLoadOptions:interface + - excel!Excel.Interfaces.PivotHierarchyUpdateData:interface + - excel!Excel.Interfaces.PivotItemCollectionData:interface + - excel!Excel.Interfaces.PivotItemCollectionLoadOptions:interface + - excel!Excel.Interfaces.PivotItemCollectionUpdateData:interface + - excel!Excel.Interfaces.PivotItemData:interface + - excel!Excel.Interfaces.PivotItemLoadOptions:interface + - excel!Excel.Interfaces.PivotItemUpdateData:interface + - excel!Excel.Interfaces.PivotLayoutData:interface + - excel!Excel.Interfaces.PivotLayoutLoadOptions:interface + - excel!Excel.Interfaces.PivotLayoutUpdateData:interface + - excel!Excel.Interfaces.PivotTableCollectionData:interface + - excel!Excel.Interfaces.PivotTableCollectionLoadOptions:interface + - excel!Excel.Interfaces.PivotTableCollectionUpdateData:interface + - excel!Excel.Interfaces.PivotTableData:interface + - excel!Excel.Interfaces.PivotTableLoadOptions:interface + - excel!Excel.Interfaces.PivotTableScopedCollectionData:interface + - excel!Excel.Interfaces.PivotTableScopedCollectionLoadOptions:interface + - excel!Excel.Interfaces.PivotTableScopedCollectionUpdateData:interface + - excel!Excel.Interfaces.PivotTableStyleCollectionData:interface + - excel!Excel.Interfaces.PivotTableStyleCollectionLoadOptions:interface + - excel!Excel.Interfaces.PivotTableStyleCollectionUpdateData:interface + - excel!Excel.Interfaces.PivotTableStyleData:interface + - excel!Excel.Interfaces.PivotTableStyleLoadOptions:interface + - excel!Excel.Interfaces.PivotTableStyleUpdateData:interface + - excel!Excel.Interfaces.PivotTableUpdateData:interface + - excel!Excel.Interfaces.PresetCriteriaConditionalFormatData:interface + - excel!Excel.Interfaces.PresetCriteriaConditionalFormatLoadOptions:interface + - excel!Excel.Interfaces.PresetCriteriaConditionalFormatUpdateData:interface + - excel!Excel.Interfaces.QueryCollectionData:interface + - excel!Excel.Interfaces.QueryCollectionLoadOptions:interface + - excel!Excel.Interfaces.QueryCollectionUpdateData:interface + - excel!Excel.Interfaces.QueryData:interface + - excel!Excel.Interfaces.QueryLoadOptions:interface + - excel!Excel.Interfaces.RangeAreasCollectionData:interface + - excel!Excel.Interfaces.RangeAreasCollectionLoadOptions:interface + - excel!Excel.Interfaces.RangeAreasCollectionUpdateData:interface + - excel!Excel.Interfaces.RangeAreasData:interface + - excel!Excel.Interfaces.RangeAreasLoadOptions:interface + - excel!Excel.Interfaces.RangeAreasUpdateData:interface + - excel!Excel.Interfaces.RangeBorderCollectionData:interface + - excel!Excel.Interfaces.RangeBorderCollectionLoadOptions:interface + - excel!Excel.Interfaces.RangeBorderCollectionUpdateData:interface + - excel!Excel.Interfaces.RangeBorderData:interface + - excel!Excel.Interfaces.RangeBorderLoadOptions:interface + - excel!Excel.Interfaces.RangeBorderUpdateData:interface + - excel!Excel.Interfaces.RangeCollectionData:interface + - excel!Excel.Interfaces.RangeCollectionLoadOptions:interface + - excel!Excel.Interfaces.RangeCollectionUpdateData:interface + - excel!Excel.Interfaces.RangeData:interface + - excel!Excel.Interfaces.RangeFillData:interface + - excel!Excel.Interfaces.RangeFillLoadOptions:interface + - excel!Excel.Interfaces.RangeFillUpdateData:interface + - excel!Excel.Interfaces.RangeFontData:interface + - excel!Excel.Interfaces.RangeFontLoadOptions:interface + - excel!Excel.Interfaces.RangeFontUpdateData:interface + - excel!Excel.Interfaces.RangeFormatData:interface + - excel!Excel.Interfaces.RangeFormatLoadOptions:interface + - excel!Excel.Interfaces.RangeFormatUpdateData:interface + - excel!Excel.Interfaces.RangeLoadOptions:interface + - excel!Excel.Interfaces.RangeUpdateData:interface + - excel!Excel.Interfaces.RangeViewCollectionData:interface + - excel!Excel.Interfaces.RangeViewCollectionLoadOptions:interface + - excel!Excel.Interfaces.RangeViewCollectionUpdateData:interface + - excel!Excel.Interfaces.RangeViewData:interface + - excel!Excel.Interfaces.RangeViewLoadOptions:interface + - excel!Excel.Interfaces.RangeViewUpdateData:interface + - excel!Excel.Interfaces.RemoveDuplicatesResultData:interface + - excel!Excel.Interfaces.RemoveDuplicatesResultLoadOptions:interface + - excel!Excel.Interfaces.RowColumnPivotHierarchyCollectionData:interface + - >- + excel!Excel.Interfaces.RowColumnPivotHierarchyCollectionLoadOptions:interface + - excel!Excel.Interfaces.RowColumnPivotHierarchyCollectionUpdateData:interface + - excel!Excel.Interfaces.RowColumnPivotHierarchyData:interface + - excel!Excel.Interfaces.RowColumnPivotHierarchyLoadOptions:interface + - excel!Excel.Interfaces.RowColumnPivotHierarchyUpdateData:interface + - excel!Excel.Interfaces.RuntimeData:interface + - excel!Excel.Interfaces.RuntimeLoadOptions:interface + - excel!Excel.Interfaces.RuntimeUpdateData:interface + - excel!Excel.Interfaces.SettingCollectionData:interface + - excel!Excel.Interfaces.SettingCollectionLoadOptions:interface + - excel!Excel.Interfaces.SettingCollectionUpdateData:interface + - excel!Excel.Interfaces.SettingData:interface + - excel!Excel.Interfaces.SettingLoadOptions:interface + - excel!Excel.Interfaces.SettingUpdateData:interface + - excel!Excel.Interfaces.ShapeCollectionData:interface + - excel!Excel.Interfaces.ShapeCollectionLoadOptions:interface + - excel!Excel.Interfaces.ShapeCollectionUpdateData:interface + - excel!Excel.Interfaces.ShapeData:interface + - excel!Excel.Interfaces.ShapeFillData:interface + - excel!Excel.Interfaces.ShapeFillLoadOptions:interface + - excel!Excel.Interfaces.ShapeFillUpdateData:interface + - excel!Excel.Interfaces.ShapeFontData:interface + - excel!Excel.Interfaces.ShapeFontLoadOptions:interface + - excel!Excel.Interfaces.ShapeFontUpdateData:interface + - excel!Excel.Interfaces.ShapeGroupData:interface + - excel!Excel.Interfaces.ShapeGroupLoadOptions:interface + - excel!Excel.Interfaces.ShapeLineFormatData:interface + - excel!Excel.Interfaces.ShapeLineFormatLoadOptions:interface + - excel!Excel.Interfaces.ShapeLineFormatUpdateData:interface + - excel!Excel.Interfaces.ShapeLoadOptions:interface + - excel!Excel.Interfaces.ShapeUpdateData:interface + - excel!Excel.Interfaces.SlicerCollectionData:interface + - excel!Excel.Interfaces.SlicerCollectionLoadOptions:interface + - excel!Excel.Interfaces.SlicerCollectionUpdateData:interface + - excel!Excel.Interfaces.SlicerData:interface + - excel!Excel.Interfaces.SlicerItemCollectionData:interface + - excel!Excel.Interfaces.SlicerItemCollectionLoadOptions:interface + - excel!Excel.Interfaces.SlicerItemCollectionUpdateData:interface + - excel!Excel.Interfaces.SlicerItemData:interface + - excel!Excel.Interfaces.SlicerItemLoadOptions:interface + - excel!Excel.Interfaces.SlicerItemUpdateData:interface + - excel!Excel.Interfaces.SlicerLoadOptions:interface + - excel!Excel.Interfaces.SlicerStyleCollectionData:interface + - excel!Excel.Interfaces.SlicerStyleCollectionLoadOptions:interface + - excel!Excel.Interfaces.SlicerStyleCollectionUpdateData:interface + - excel!Excel.Interfaces.SlicerStyleData:interface + - excel!Excel.Interfaces.SlicerStyleLoadOptions:interface + - excel!Excel.Interfaces.SlicerStyleUpdateData:interface + - excel!Excel.Interfaces.SlicerUpdateData:interface + - excel!Excel.Interfaces.StyleCollectionData:interface + - excel!Excel.Interfaces.StyleCollectionLoadOptions:interface + - excel!Excel.Interfaces.StyleCollectionUpdateData:interface + - excel!Excel.Interfaces.StyleData:interface + - excel!Excel.Interfaces.StyleLoadOptions:interface + - excel!Excel.Interfaces.StyleUpdateData:interface + - excel!Excel.Interfaces.TableCollectionData:interface + - excel!Excel.Interfaces.TableCollectionLoadOptions:interface + - excel!Excel.Interfaces.TableCollectionUpdateData:interface + - excel!Excel.Interfaces.TableColumnCollectionData:interface + - excel!Excel.Interfaces.TableColumnCollectionLoadOptions:interface + - excel!Excel.Interfaces.TableColumnCollectionUpdateData:interface + - excel!Excel.Interfaces.TableColumnData:interface + - excel!Excel.Interfaces.TableColumnLoadOptions:interface + - excel!Excel.Interfaces.TableColumnUpdateData:interface + - excel!Excel.Interfaces.TableData:interface + - excel!Excel.Interfaces.TableLoadOptions:interface + - excel!Excel.Interfaces.TableRowCollectionData:interface + - excel!Excel.Interfaces.TableRowCollectionLoadOptions:interface + - excel!Excel.Interfaces.TableRowCollectionUpdateData:interface + - excel!Excel.Interfaces.TableRowData:interface + - excel!Excel.Interfaces.TableRowLoadOptions:interface + - excel!Excel.Interfaces.TableRowUpdateData:interface + - excel!Excel.Interfaces.TableScopedCollectionData:interface + - excel!Excel.Interfaces.TableScopedCollectionLoadOptions:interface + - excel!Excel.Interfaces.TableScopedCollectionUpdateData:interface + - excel!Excel.Interfaces.TableSortData:interface + - excel!Excel.Interfaces.TableSortLoadOptions:interface + - excel!Excel.Interfaces.TableStyleCollectionData:interface + - excel!Excel.Interfaces.TableStyleCollectionLoadOptions:interface + - excel!Excel.Interfaces.TableStyleCollectionUpdateData:interface + - excel!Excel.Interfaces.TableStyleData:interface + - excel!Excel.Interfaces.TableStyleLoadOptions:interface + - excel!Excel.Interfaces.TableStyleUpdateData:interface + - excel!Excel.Interfaces.TableUpdateData:interface + - excel!Excel.Interfaces.TextConditionalFormatData:interface + - excel!Excel.Interfaces.TextConditionalFormatLoadOptions:interface + - excel!Excel.Interfaces.TextConditionalFormatUpdateData:interface + - excel!Excel.Interfaces.TextFrameData:interface + - excel!Excel.Interfaces.TextFrameLoadOptions:interface + - excel!Excel.Interfaces.TextFrameUpdateData:interface + - excel!Excel.Interfaces.TextRangeData:interface + - excel!Excel.Interfaces.TextRangeLoadOptions:interface + - excel!Excel.Interfaces.TextRangeUpdateData:interface + - excel!Excel.Interfaces.TimelineStyleCollectionData:interface + - excel!Excel.Interfaces.TimelineStyleCollectionLoadOptions:interface + - excel!Excel.Interfaces.TimelineStyleCollectionUpdateData:interface + - excel!Excel.Interfaces.TimelineStyleData:interface + - excel!Excel.Interfaces.TimelineStyleLoadOptions:interface + - excel!Excel.Interfaces.TimelineStyleUpdateData:interface + - excel!Excel.Interfaces.TopBottomConditionalFormatData:interface + - excel!Excel.Interfaces.TopBottomConditionalFormatLoadOptions:interface + - excel!Excel.Interfaces.TopBottomConditionalFormatUpdateData:interface + - excel!Excel.Interfaces.WorkbookCreatedData:interface + - excel!Excel.Interfaces.WorkbookData:interface + - excel!Excel.Interfaces.WorkbookLoadOptions:interface + - excel!Excel.Interfaces.WorkbookProtectionData:interface + - excel!Excel.Interfaces.WorkbookProtectionLoadOptions:interface + - excel!Excel.Interfaces.WorkbookRangeAreasData:interface + - excel!Excel.Interfaces.WorkbookRangeAreasLoadOptions:interface + - excel!Excel.Interfaces.WorkbookUpdateData:interface + - excel!Excel.Interfaces.WorksheetCollectionData:interface + - excel!Excel.Interfaces.WorksheetCollectionLoadOptions:interface + - excel!Excel.Interfaces.WorksheetCollectionUpdateData:interface + - excel!Excel.Interfaces.WorksheetCustomPropertyCollectionData:interface + - >- + excel!Excel.Interfaces.WorksheetCustomPropertyCollectionLoadOptions:interface + - excel!Excel.Interfaces.WorksheetCustomPropertyCollectionUpdateData:interface + - excel!Excel.Interfaces.WorksheetCustomPropertyData:interface + - excel!Excel.Interfaces.WorksheetCustomPropertyLoadOptions:interface + - excel!Excel.Interfaces.WorksheetCustomPropertyUpdateData:interface + - excel!Excel.Interfaces.WorksheetData:interface + - excel!Excel.Interfaces.WorksheetLoadOptions:interface + - excel!Excel.Interfaces.WorksheetProtectionData:interface + - excel!Excel.Interfaces.WorksheetProtectionLoadOptions:interface + - excel!Excel.Interfaces.WorksheetUpdateData:interface + - excel!Excel.JavaScriptCustomFunctionReferenceCellValue:interface + - excel!Excel.LinkedEntityCellValue:interface + - excel!Excel.LinkedEntityDataDomainAddedEventArgs:interface + - excel!Excel.LinkedEntityDataDomainCreateOptions:interface + - excel!Excel.LinkedEntityDataDomainRefreshCompletedEventArgs:interface + - excel!Excel.LinkedEntityDataDomainRefreshModeChangedEventArgs:interface + - excel!Excel.LinkedEntityId:interface + - excel!Excel.LinkedEntityIdCulture:interface + - excel!Excel.LinkedEntityLoadServiceRequest:interface + - excel!Excel.LinkedEntityLoadServiceResult:interface + - excel!Excel.ListDataValidation:interface + - excel!Excel.MixedCellControl:interface + - excel!Excel.NameErrorCellValue:interface + - excel!Excel.NotAvailableErrorCellValue:interface + - excel!Excel.NullErrorCellValue:interface + - excel!Excel.NumErrorCellValue:interface + - excel!Excel.PageLayoutMarginOptions:interface + - excel!Excel.PageLayoutZoomOptions:interface + - excel!Excel.PivotDateFilter:interface + - excel!Excel.PivotFilters:interface + - excel!Excel.PivotLabelFilter:interface + - excel!Excel.PivotManualFilter:interface + - excel!Excel.PivotValueFilter:interface + - excel!Excel.PlaceholderErrorCellValue:interface + - excel!Excel.RangeHyperlink:interface + - excel!Excel.RangeReference:interface + - excel!Excel.RangeTextRun:interface + - excel!Excel.ReferenceCellValue:interface + - excel!Excel.RefErrorCellValue:interface + - excel!Excel.ReplaceCriteria:interface + - excel!Excel.RootReferenceCellValue:interface + - excel!Excel.RowProperties:interface + - excel!Excel.RowPropertiesLoadOptions:interface + - excel!Excel.RunOptions:interface + - excel!Excel.SearchCriteria:interface + - excel!Excel.SelectionChangedEventArgs:interface + - excel!Excel.Session:interface + - excel!Excel.SettableCellProperties:interface + - excel!Excel.SettableColumnProperties:interface + - excel!Excel.SettableRowProperties:interface + - excel!Excel.SettingsChangedEventArgs:interface + - excel!Excel.ShapeActivatedEventArgs:interface + - excel!Excel.ShapeDeactivatedEventArgs:interface + - excel!Excel.ShowAsRule:interface + - excel!Excel.SortField:interface + - excel!Excel.SpillErrorCellValue:interface + - excel!Excel.StringCellValue:interface + - excel!Excel.Subtotals:interface + - excel!Excel.TableAddedEventArgs:interface + - excel!Excel.TableChangedEventArgs:interface + - excel!Excel.TableDeletedEventArgs:interface + - excel!Excel.TableSelectionChangedEventArgs:interface + - excel!Excel.ThreeArrowsGraySet:interface + - excel!Excel.ThreeArrowsSet:interface + - excel!Excel.ThreeFlagsSet:interface + - excel!Excel.ThreeSignsSet:interface + - excel!Excel.ThreeStarsSet:interface + - excel!Excel.ThreeSymbols2Set:interface + - excel!Excel.ThreeSymbolsSet:interface + - excel!Excel.ThreeTrafficLights1Set:interface + - excel!Excel.ThreeTrafficLights2Set:interface + - excel!Excel.ThreeTrianglesSet:interface + - excel!Excel.UnknownCellControl:interface + - excel!Excel.ValueErrorCellValue:interface + - excel!Excel.ValueTypeNotAvailableCellValue:interface + - excel!Excel.WebImageCellValue:interface + - excel!Excel.WorkbookActivatedEventArgs:interface + - excel!Excel.WorkbookAutoSaveSettingChangedEventArgs:interface + - excel!Excel.WorksheetActivatedEventArgs:interface + - excel!Excel.WorksheetAddedEventArgs:interface + - excel!Excel.WorksheetCalculatedEventArgs:interface + - excel!Excel.WorksheetChangedEventArgs:interface + - excel!Excel.WorksheetColumnSortedEventArgs:interface + - excel!Excel.WorksheetDeactivatedEventArgs:interface + - excel!Excel.WorksheetDeletedEventArgs:interface + - excel!Excel.WorksheetFormatChangedEventArgs:interface + - excel!Excel.WorksheetFormulaChangedEventArgs:interface + - excel!Excel.WorksheetMovedEventArgs:interface + - excel!Excel.WorksheetNameChangedEventArgs:interface + - excel!Excel.WorksheetProtectionChangedEventArgs:interface + - excel!Excel.WorksheetProtectionOptions:interface + - excel!Excel.WorksheetRowHiddenChangedEventArgs:interface + - excel!Excel.WorksheetRowSortedEventArgs:interface + - excel!Excel.WorksheetSearchCriteria:interface + - excel!Excel.WorksheetSelectionChangedEventArgs:interface + - excel!Excel.WorksheetSingleClickedEventArgs:interface + - excel!Excel.WorksheetVisibilityChangedEventArgs:interface +typeAliases: + - excel!Excel.CardLayout:type + - excel!Excel.CardLayoutSection:type + - excel!Excel.CellControl:type + - excel!Excel.CellValue:type + - excel!Excel.CellValueAndPropertyMetadata:type + - excel!Excel.CompactLayout:type + - excel!Excel.EntityPropertyType:type + - excel!Excel.ErrorCellValue:type + - excel!Excel.FunctionCellValue:type + - excel!Excel.ReferencedValue:type +functions: + - name: Excel.createWorkbook(base64) + uid: excel!Excel.createWorkbook:function(1) + package: excel! + summary: >- + Creates and opens a new workbook. Optionally, the workbook can be + pre-populated with a Base64-encoded .xlsx file. The `extensionHardening` + Windows registry key affects the `base64File` param. The file extension + defined by the param must match the real file type of the file. If + `extensionHardening` is set to deny mismatches and the file extension does + not match the real file type, this API throws the following error: "This + operation is not allowed due to the extension hardening policy." Note: + Macros can be a security risk. If this API is used to create a workbook + that includes a macro, the add-in user will be prompted with a "Trust this + add-in?" dialog in the Excel UI. The user must select the "Trust add-in" + button to proceed. + + + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'export function createWorkbook(base64?: string): Promise;' + parameters: + - id: base64 + description: '' + type: string + return: + type: Promise<void> + description: >- + + + #### Examples + + + ```TypeScript + + const myFile = document.getElementById("file"); + + const reader = new FileReader(); + + + reader.onload = (event) => { + Excel.run((context) => { + // Remove the metadata before the base64-encoded string. + const startIndex = reader.result.toString().indexOf("base64,"); + const mybase64 = reader.result.toString().substr(startIndex + 7); + + Excel.createWorkbook(mybase64); + return context.sync(); + }); + }; + + + // Read in the file as a data URL so we can parse the base64-encoded + string. + + reader.readAsDataURL(myFile.files[0]); + + ``` + - name: Excel.getDataCommonPostprocess(response, callArgs) + uid: excel!Excel.getDataCommonPostprocess:function(1) + package: excel! + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + export function getDataCommonPostprocess(response: any, callArgs: any): + any; + parameters: + - id: response + description: '' + type: any + - id: callArgs + description: '' + type: any + return: + type: any + description: '' + - name: Excel.postprocessBindingDescriptor(response) + uid: excel!Excel.postprocessBindingDescriptor:function(1) + package: excel! + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'export function postprocessBindingDescriptor(response: any): any;' + parameters: + - id: response + description: '' + type: any + return: + type: any + description: '' + - name: Excel.run(batch) + uid: excel!Excel.run:function(1) + package: excel! + summary: >- + Executes a batch script that performs actions on the Excel object model, + using a new RequestContext. When the promise is resolved, any tracked + objects that were automatically allocated during execution will be + released. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + export function run(batch: (context: Excel.RequestContext) => + Promise): Promise; + parameters: + - id: batch + description: >- + A function that takes in a RequestContext and returns a promise + (typically, just the result of "context.sync()"). The context + parameter facilitates requests to the Excel application. Since the + Office add-in and the Excel application run in two different + processes, the RequestContext is required to get access to the Excel + object model from the add-in. + type: >- + (context: ) => + Promise<T> + return: + type: Promise<T> + description: '' + - name: Excel.run(object, batch) + uid: excel!Excel.run:function(2) + package: excel! + summary: >- + Executes a batch script that performs actions on the Excel object model, + using the RequestContext of a previously-created API object. When the + promise is resolved, any tracked objects that were automatically allocated + during execution will be released. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + export function run(object: OfficeExtension.ClientObject, batch: + (context: Excel.RequestContext) => Promise): Promise; + parameters: + - id: object + description: >- + A previously-created API object. The batch will use the same + RequestContext as the passed-in object, which means that any changes + applied to the object will be picked up by "context.sync()". + type: + - id: batch + description: >- + A function that takes in a RequestContext and returns a promise + (typically, just the result of "context.sync()"). The context + parameter facilitates requests to the Excel application. Since the + Office add-in and the Excel application run in two different + processes, the RequestContext is required to get access to the Excel + object model from the add-in. + type: >- + (context: ) => + Promise<T> + return: + type: Promise<T> + description: '' + - name: Excel.run(objects, batch) + uid: excel!Excel.run:function(3) + package: excel! + summary: >- + Executes a batch script that performs actions on the Excel object model, + using the RequestContext of previously-created API objects. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + export function run(objects: OfficeExtension.ClientObject[], batch: + (context: Excel.RequestContext) => Promise): Promise; + parameters: + - id: objects + description: >- + An array of previously-created API objects. The array will be + validated to make sure that all of the objects share the same + context. The batch will use this shared RequestContext, which means + that any changes applied to these objects will be picked up by + "context.sync()". + type: [] + - id: batch + description: >- + A function that takes in a RequestContext and returns a promise + (typically, just the result of "context.sync()"). The context + parameter facilitates requests to the Excel application. Since the + Office add-in and the Excel application run in two different + processes, the RequestContext is required to get access to the Excel + object model from the add-in. + type: >- + (context: ) => + Promise<T> + return: + type: Promise<T> + description: '' + - name: Excel.run(options, batch) + uid: excel!Excel.run:function(4) + package: excel! + summary: >- + Executes a batch script that performs actions on the Excel object model, + using the RequestContext of a previously-created API object. When the + promise is resolved, any tracked objects that were automatically allocated + during execution will be released. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + export function run(options: Excel.RunOptions, batch: (context: + Excel.RequestContext) => Promise): Promise; + parameters: + - id: options + description: >- + The additional options for this Excel.run which specify previous + objects, whether to delay the request for cell edit, session info, + etc. + type: + - id: batch + description: >- + A function that takes in a RequestContext and returns a promise + (typically, just the result of "context.sync()"). The context + parameter facilitates requests to the Excel application. Since the + Office add-in and the Excel application run in two different + processes, the RequestContext is required to get access to the Excel + object model from the add-in. + type: >- + (context: ) => + Promise<T> + return: + type: Promise<T> + description: '' + - name: Excel.run(context, batch) + uid: excel!Excel.run:function(5) + package: excel! + summary: >- + Executes a batch script that performs actions on the Excel object model, + using the RequestContext of a previously-created object. When the promise + is resolved, any tracked objects that were automatically allocated during + execution will be released. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + export function run(context: OfficeExtension.ClientRequestContext, + batch: (context: Excel.RequestContext) => Promise): Promise; + parameters: + - id: context + description: >- + A previously-created object. The batch will use the same + RequestContext as the passed-in object, which means that any changes + applied to the object will be picked up by "context.sync()". + type: + - id: batch + description: >- + A function that takes in a RequestContext and returns a promise + (typically, just the result of "context.sync()"). The context + parameter facilitates requests to the Excel application. Since the + Office add-in and the Excel application run in two different + processes, the RequestContext is required to get access to the Excel + object model from the add-in. + type: >- + (context: ) => + Promise<T> + return: + type: Promise<T> + description: '' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.aggregationfunction.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.aggregationfunction.yml new file mode 100644 index 0000000000..1e2c53e796 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.aggregationfunction.yml @@ -0,0 +1,176 @@ +### YamlMime:TSEnum +name: Excel.AggregationFunction +uid: excel!Excel.AggregationFunction:enum +package: excel! +fullName: Excel.AggregationFunction +summary: Aggregation function for the `DataPivotHierarchy`. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-filters-and-summaries.yaml + + + async function genericFunctionSwitch(functionType: Excel.AggregationFunction) + { + await Excel.run(async (context) => { + const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales"); + pivotTable.dataHierarchies.load("no-properties-needed"); + await context.sync(); + + pivotTable.dataHierarchies.items[0].summarizeBy = functionType; + pivotTable.dataHierarchies.items[1].summarizeBy = functionType; + await context.sync(); + }); + } + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: automatic + uid: excel!Excel.AggregationFunction.automatic:member + package: excel! + summary: >- + Excel will automatically select the aggregation based on the data items. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Automatic"' + - name: average + uid: excel!Excel.AggregationFunction.average:member + package: excel! + summary: >- + Aggregate using the average of the data, equivalent to the AVERAGE + function. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Average"' + - name: count + uid: excel!Excel.AggregationFunction.count:member + package: excel! + summary: >- + Aggregate using the count of items in the data, equivalent to the COUNTA + function. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Count"' + - name: countNumbers + uid: excel!Excel.AggregationFunction.countNumbers:member + package: excel! + summary: >- + Aggregate using the count of numbers in the data, equivalent to the COUNT + function. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"CountNumbers"' + - name: max + uid: excel!Excel.AggregationFunction.max:member + package: excel! + summary: >- + Aggregate using the maximum value of the data, equivalent to the MAX + function. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Max"' + - name: min + uid: excel!Excel.AggregationFunction.min:member + package: excel! + summary: >- + Aggregate using the minimum value of the data, equivalent to the MIN + function. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Min"' + - name: product + uid: excel!Excel.AggregationFunction.product:member + package: excel! + summary: >- + Aggregate using the product of the data, equivalent to the PRODUCT + function. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Product"' + - name: standardDeviation + uid: excel!Excel.AggregationFunction.standardDeviation:member + package: excel! + summary: >- + Aggregate using the standard deviation of the data, equivalent to the + STDEV function. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"StandardDeviation"' + - name: standardDeviationP + uid: excel!Excel.AggregationFunction.standardDeviationP:member + package: excel! + summary: >- + Aggregate using the standard deviation of the data, equivalent to the + STDEVP function. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"StandardDeviationP"' + - name: sum + uid: excel!Excel.AggregationFunction.sum:member + package: excel! + summary: >- + Aggregate using the sum of the data, equivalent to the SUM function. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Sum"' + - name: unknown + uid: excel!Excel.AggregationFunction.unknown:member + package: excel! + summary: >- + Aggregation function is unknown or unsupported. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Unknown"' + - name: variance + uid: excel!Excel.AggregationFunction.variance:member + package: excel! + summary: >- + Aggregate using the variance of the data, equivalent to the VAR function. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Variance"' + - name: varianceP + uid: excel!Excel.AggregationFunction.varianceP:member + package: excel! + summary: >- + Aggregate using the variance of the data, equivalent to the VARP function. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"VarianceP"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.application.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.application.yml new file mode 100644 index 0000000000..6ccf235596 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.application.yml @@ -0,0 +1,544 @@ +### YamlMime:TSType +name: Excel.Application +uid: excel!Excel.Application:class +package: excel! +fullName: Excel.Application +summary: Represents the Excel application that manages the workbook. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: calculationEngineVersion + uid: excel!Excel.Application#calculationEngineVersion:member + package: excel! + fullName: calculationEngineVersion + summary: >- + Returns the Excel calculation engine version used for the last full + recalculation. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly calculationEngineVersion: number;' + return: + type: number + - name: calculationMode + uid: excel!Excel.Application#calculationMode:member + package: excel! + fullName: calculationMode + summary: >- + Returns the calculation mode used in the workbook, as defined by the + constants in `Excel.CalculationMode`. Possible values are: + `Automatic`, where Excel controls recalculation; + `AutomaticExceptTables`, where Excel controls recalculation but + ignores changes in tables; `Manual`, where calculation is done + when the user requests it. + remarks: >- + \[ [API set: ExcelApi 1.1 for get, 1.8 for + set](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + calculationMode: Excel.CalculationMode | "Automatic" | + "AutomaticExceptTables" | "Manual"; + return: + type: >- + | "Automatic" | + "AutomaticExceptTables" | "Manual" + - name: calculationState + uid: excel!Excel.Application#calculationState:member + package: excel! + fullName: calculationState + summary: >- + Returns the calculation state of the application. See + `Excel.CalculationState` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly calculationState: Excel.CalculationState | "Done" | + "Calculating" | "Pending"; + return: + type: >- + | "Done" | + "Calculating" | "Pending" + - name: context + uid: excel!Excel.Application#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: cultureInfo + uid: excel!Excel.Application#cultureInfo:member + package: excel! + fullName: cultureInfo + summary: >- + Provides information based on current system culture settings. This + includes the culture names, number formatting, and other culturally + dependent settings. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly cultureInfo: Excel.CultureInfo;' + return: + type: + - name: decimalSeparator + uid: excel!Excel.Application#decimalSeparator:member + package: excel! + fullName: decimalSeparator + summary: >- + Gets the string used as the decimal separator for numeric values. This is + based on the local Excel settings. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/culture-info.yaml + + + await Excel.run(async (context) => { + context.application.load("decimalSeparator,thousandsSeparator"); + context.application.cultureInfo.numberFormat.load("numberDecimalSeparator,numberGroupSeparator"); + await context.sync(); + + // Local settings are set under the "Options > Advanced" menu. + const localDecimalSeparator = context.application.decimalSeparator; + const localThousandsSeparator = context.application.thousandsSeparator; + + const systemDecimalSeparator = context.application.cultureInfo.numberFormat.numberDecimalSeparator; + const systemThousandsSeparator = context.application.cultureInfo.numberFormat.numberGroupSeparator; + + console.log("Local character settings: "); + console.log(` Local decimal separator: ${localDecimalSeparator}`); + console.log(` Local thousands separator: ${localThousandsSeparator}`); + + console.log("System culture settings: "); + console.log(` System decimal separator: ${systemDecimalSeparator}`); + console.log(` System thousands separator: ${systemThousandsSeparator}`); + console.log(` `); + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly decimalSeparator: string;' + return: + type: string + - name: iterativeCalculation + uid: excel!Excel.Application#iterativeCalculation:member + package: excel! + fullName: iterativeCalculation + summary: >- + Returns the iterative calculation settings. In Excel on Windows and Mac, + the settings will apply to the Excel Application. In Excel on the web and + other platforms, the settings will apply to the active workbook. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly iterativeCalculation: Excel.IterativeCalculation;' + return: + type: + - name: thousandsSeparator + uid: excel!Excel.Application#thousandsSeparator:member + package: excel! + fullName: thousandsSeparator + summary: >- + Gets the string used to separate groups of digits to the left of the + decimal for numeric values. This is based on the local Excel settings. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly thousandsSeparator: string;' + return: + type: string + - name: useSystemSeparators + uid: excel!Excel.Application#useSystemSeparators:member + package: excel! + fullName: useSystemSeparators + summary: >- + Specifies if the system separators of Excel are enabled. System separators + include the decimal separator and thousands separator. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly useSystemSeparators: boolean;' + return: + type: boolean +methods: + - name: calculate(calculationType) + uid: excel!Excel.Application#calculate:member(1) + package: excel! + fullName: calculate(calculationType) + summary: Recalculate all currently opened workbooks in Excel. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/90-scenarios/performance-optimization.yaml + + + await Excel.run(async (context) => { + context.application.calculate(Excel.CalculationType.full); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'calculate(calculationType: Excel.CalculationType): void;' + parameters: + - id: calculationType + description: >- + Specifies the calculation type to use. See `Excel.CalculationType` + for details. + type: + return: + type: void + description: '' + - name: calculate(calculationType) + uid: excel!Excel.Application#calculate:member(2) + package: excel! + fullName: calculate(calculationType) + summary: Recalculate all currently opened workbooks in Excel. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + context.workbook.application.calculate('Full'); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + calculate(calculationType: "Recalculate" | "Full" | "FullRebuild"): + void; + parameters: + - id: calculationType + description: >- + Specifies the calculation type to use. See `Excel.CalculationType` + for details. + type: '"Recalculate" | "Full" | "FullRebuild"' + return: + type: void + description: '' + - name: load(options) + uid: excel!Excel.Application#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ApplicationLoadOptions): + Excel.Application; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.Application#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.Application;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: |- + + + #### Examples + + ```TypeScript + await Excel.run(async (context) => { + const application = context.workbook.application; + application.load('calculationMode'); + await context.sync(); + + console.log(application.calculationMode); + }); + ``` + - name: load(propertyNamesAndPaths) + uid: excel!Excel.Application#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.Application; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.Application#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ApplicationUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.Application#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.Application): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: suspendApiCalculationUntilNextSync() + uid: excel!Excel.Application#suspendApiCalculationUntilNextSync:member(1) + package: excel! + fullName: suspendApiCalculationUntilNextSync() + summary: >- + Suspends calculation until the next `context.sync()` is called. Once set, + it is the developer's responsibility to re-calc the workbook, to ensure + that any dependencies are propagated. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'suspendApiCalculationUntilNextSync(): void;' + return: + type: void + description: '' + - name: suspendScreenUpdatingUntilNextSync() + uid: excel!Excel.Application#suspendScreenUpdatingUntilNextSync:member(1) + package: excel! + fullName: suspendScreenUpdatingUntilNextSync() + summary: >- + Suspends screen updating until the next `context.sync()` is called. + + + *Note**: Don't call `suspendScreenUpdatingUntilNextSync` repeatedly + (such as in a loop). Repeated calls will cause the Excel window to + flicker. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/90-scenarios/performance-optimization.yaml + + + await Excel.run(async (context) => { + // Recreate the data in the worksheet with random data. + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + const startTime = Date.now(); + console.log("Starting..."); + + // If other parts of the sample have toggled screen painting off, this will stop screen updating until context.sync is called. + if (pauseScreenPainting) { + context.application.suspendScreenUpdatingUntilNextSync(); + } + + for (let i = 1; i < ROW_COUNT; i++) { + for (let j = 1; j < COLUMN_COUNT; j++) { + let cell = sheet.getCell(i, j); + cell.values = [[i * j * Math.random()]]; + + // If other parts of the sample have toggled tracking off, we will avoid tracking this range and having to manage the proxy objects. + // For more information, see https://learn.microsoft.com/office/dev/add-ins/concepts/resource-limits-and-performance-optimization#untrack-unneeded-proxy-objects + if (untrack) { + cell.untrack(); + } + } + } + + await context.sync(); + + console.log(`Ending. Adding ${ROW_COUNT * COLUMN_COUNT} cells took ${Date.now() - startTime} milliseconds`); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'suspendScreenUpdatingUntilNextSync(): void;' + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.Application#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.Application` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.ApplicationData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ApplicationData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.arraycellvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.arraycellvalue.yml new file mode 100644 index 0000000000..641e8d54b7 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.arraycellvalue.yml @@ -0,0 +1,107 @@ +### YamlMime:TSType +name: Excel.ArrayCellValue +uid: excel!Excel.ArrayCellValue:interface +package: excel! +fullName: Excel.ArrayCellValue +summary: Represents a 2D array of cell values. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: basicType + uid: excel!Excel.ArrayCellValue#basicType:member + package: excel! + fullName: basicType + summary: >- + Represents the value that would be returned by `Range.valueTypes` for a + cell with this value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicType?: RangeValueType.error | "Error";' + return: + type: | "Error" + - name: basicValue + uid: excel!Excel.ArrayCellValue#basicValue:member + package: excel! + fullName: basicValue + summary: >- + Represents the value that would be returned by `Range.values` for a cell + with this value. When accessed through a `valuesAsJson` property, this + string value aligns with the en-US locale. When accessed through a + `valuesAsJsonLocal` property, this string value aligns with the user's + display locale. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicValue?: "#VALUE!" | string;' + return: + type: '"#VALUE!" | string' + - name: elements + uid: excel!Excel.ArrayCellValue#elements:member + package: excel! + fullName: elements + summary: >- + Represents the elements of the array. May not directly contain an + `ArrayCellValue`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'elements: CellValue[][];' + return: + type: [][] + - name: referencedValues + uid: excel!Excel.ArrayCellValue#referencedValues:member + package: excel! + fullName: referencedValues + summary: >- + Represents the cell values which are referenced within + `ArrayCellValue.elements`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'referencedValues?: ReferencedValue[];' + return: + type: [] + - name: type + uid: excel!Excel.ArrayCellValue#type:member + package: excel! + fullName: type + summary: Represents the type of this cell value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: CellValueType.array | ReferenceValueType.array | "Array";' + return: + type: >- + | | "Array" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.arrowheadlength.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.arrowheadlength.yml new file mode 100644 index 0000000000..6f7dea6c40 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.arrowheadlength.yml @@ -0,0 +1,60 @@ +### YamlMime:TSEnum +name: Excel.ArrowheadLength +uid: excel!Excel.ArrowheadLength:enum +package: excel! +fullName: Excel.ArrowheadLength +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-lines.yaml + + + await Excel.run(async (context) => { + const shapes = context.workbook.worksheets.getItem("Shapes").shapes; + const line = shapes.getItem("StraightLine").line; + line.beginArrowheadLength = Excel.ArrowheadLength.long; + line.beginArrowheadWidth = Excel.ArrowheadWidth.wide; + line.beginArrowheadStyle = Excel.ArrowheadStyle.oval; + + line.endArrowheadLength = Excel.ArrowheadLength.long; + line.endArrowheadWidth = Excel.ArrowheadWidth.wide; + line.endArrowheadStyle = Excel.ArrowheadStyle.triangle; + + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: long + uid: excel!Excel.ArrowheadLength.long:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Long"' + - name: medium + uid: excel!Excel.ArrowheadLength.medium:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Medium"' + - name: short + uid: excel!Excel.ArrowheadLength.short:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Short"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.arrowheadstyle.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.arrowheadstyle.yml new file mode 100644 index 0000000000..fee115b9d4 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.arrowheadstyle.yml @@ -0,0 +1,81 @@ +### YamlMime:TSEnum +name: Excel.ArrowheadStyle +uid: excel!Excel.ArrowheadStyle:enum +package: excel! +fullName: Excel.ArrowheadStyle +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-lines.yaml + + + await Excel.run(async (context) => { + const shapes = context.workbook.worksheets.getItem("Shapes").shapes; + const line = shapes.getItem("StraightLine").line; + line.beginArrowheadLength = Excel.ArrowheadLength.long; + line.beginArrowheadWidth = Excel.ArrowheadWidth.wide; + line.beginArrowheadStyle = Excel.ArrowheadStyle.oval; + + line.endArrowheadLength = Excel.ArrowheadLength.long; + line.endArrowheadWidth = Excel.ArrowheadWidth.wide; + line.endArrowheadStyle = Excel.ArrowheadStyle.triangle; + + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: diamond + uid: excel!Excel.ArrowheadStyle.diamond:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Diamond"' + - name: none + uid: excel!Excel.ArrowheadStyle.none:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"None"' + - name: open + uid: excel!Excel.ArrowheadStyle.open:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Open"' + - name: oval + uid: excel!Excel.ArrowheadStyle.oval:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Oval"' + - name: stealth + uid: excel!Excel.ArrowheadStyle.stealth:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Stealth"' + - name: triangle + uid: excel!Excel.ArrowheadStyle.triangle:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Triangle"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.arrowheadwidth.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.arrowheadwidth.yml new file mode 100644 index 0000000000..5b99aa4454 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.arrowheadwidth.yml @@ -0,0 +1,60 @@ +### YamlMime:TSEnum +name: Excel.ArrowheadWidth +uid: excel!Excel.ArrowheadWidth:enum +package: excel! +fullName: Excel.ArrowheadWidth +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-lines.yaml + + + await Excel.run(async (context) => { + const shapes = context.workbook.worksheets.getItem("Shapes").shapes; + const line = shapes.getItem("StraightLine").line; + line.beginArrowheadLength = Excel.ArrowheadLength.long; + line.beginArrowheadWidth = Excel.ArrowheadWidth.wide; + line.beginArrowheadStyle = Excel.ArrowheadStyle.oval; + + line.endArrowheadLength = Excel.ArrowheadLength.long; + line.endArrowheadWidth = Excel.ArrowheadWidth.wide; + line.endArrowheadStyle = Excel.ArrowheadStyle.triangle; + + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: medium + uid: excel!Excel.ArrowheadWidth.medium:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Medium"' + - name: narrow + uid: excel!Excel.ArrowheadWidth.narrow:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Narrow"' + - name: wide + uid: excel!Excel.ArrowheadWidth.wide:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Wide"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.autofilltype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.autofilltype.yml new file mode 100644 index 0000000000..5d32b615bf --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.autofilltype.yml @@ -0,0 +1,161 @@ +### YamlMime:TSEnum +name: Excel.AutoFillType +uid: excel!Excel.AutoFillType:enum +package: excel! +fullName: Excel.AutoFillType +summary: The behavior types when AutoFill is used on a range in the workbook. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-auto-fill.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + const sumCell = sheet.getRange("K4"); + + // Copy only the formatting, not the values and formulas. + sumCell.autoFill("K4:K7", Excel.AutoFillType.fillFormats); + sumCell.format.autofitColumns(); + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: fillCopy + uid: excel!Excel.AutoFillType.fillCopy:member + package: excel! + summary: >- + Populates the adjacent cells with data based on the selected data. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FillCopy"' + - name: fillDays + uid: excel!Excel.AutoFillType.fillDays:member + package: excel! + summary: >- + A version of "FillSeries" for dates that bases the pattern on either the + day of the month or the day of the week, depending on the context. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FillDays"' + - name: fillDefault + uid: excel!Excel.AutoFillType.fillDefault:member + package: excel! + summary: >- + Populates the adjacent cells based on the surrounding data (the standard + AutoFill behavior). + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FillDefault"' + - name: fillFormats + uid: excel!Excel.AutoFillType.fillFormats:member + package: excel! + summary: >- + Populates the adjacent cells with the selected formats. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FillFormats"' + - name: fillMonths + uid: excel!Excel.AutoFillType.fillMonths:member + package: excel! + summary: >- + A version of "FillSeries" for dates that bases the pattern on the month. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FillMonths"' + - name: fillSeries + uid: excel!Excel.AutoFillType.fillSeries:member + package: excel! + summary: >- + Populates the adjacent cells with data that follows a pattern in the + copied cells. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FillSeries"' + - name: fillValues + uid: excel!Excel.AutoFillType.fillValues:member + package: excel! + summary: >- + Populates the adjacent cells with the selected values. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FillValues"' + - name: fillWeekdays + uid: excel!Excel.AutoFillType.fillWeekdays:member + package: excel! + summary: >- + A version of "FillSeries" for dates that bases the pattern on the day of + the week and only includes weekdays. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FillWeekdays"' + - name: fillYears + uid: excel!Excel.AutoFillType.fillYears:member + package: excel! + summary: >- + A version of "FillSeries" for dates that bases the pattern on the year. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FillYears"' + - name: flashFill + uid: excel!Excel.AutoFillType.flashFill:member + package: excel! + summary: >- + Populates the adjacent cells by using Excel's Flash Fill feature. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FlashFill"' + - name: growthTrend + uid: excel!Excel.AutoFillType.growthTrend:member + package: excel! + summary: >- + A version of "FillSeries" for numbers that fills out the values in the + adjacent cells according to a growth trend model. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"GrowthTrend"' + - name: linearTrend + uid: excel!Excel.AutoFillType.linearTrend:member + package: excel! + summary: >- + A version of "FillSeries" for numbers that fills out the values in the + adjacent cells according to a linear trend model. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LinearTrend"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.autofilter.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.autofilter.yml new file mode 100644 index 0000000000..91bf612204 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.autofilter.yml @@ -0,0 +1,422 @@ +### YamlMime:TSType +name: Excel.AutoFilter +uid: excel!Excel.AutoFilter:class +package: excel! +fullName: Excel.AutoFilter +summary: >- + Represents the `AutoFilter` object. AutoFilter turns the values in Excel + column into specific filters based on the cell contents. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.AutoFilter#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: criteria + uid: excel!Excel.AutoFilter#criteria:member + package: excel! + fullName: criteria + summary: An array that holds all the filter criteria in the autofiltered range. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly criteria: Excel.FilterCriteria[];' + return: + type: [] + - name: enabled + uid: excel!Excel.AutoFilter#enabled:member + package: excel! + fullName: enabled + summary: Specifies if the AutoFilter is enabled. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly enabled: boolean;' + return: + type: boolean + - name: isDataFiltered + uid: excel!Excel.AutoFilter#isDataFiltered:member + package: excel! + fullName: isDataFiltered + summary: Specifies if the AutoFilter has filter criteria. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly isDataFiltered: boolean;' + return: + type: boolean +methods: + - name: apply(range, columnIndex, criteria) + uid: excel!Excel.AutoFilter#apply:member(1) + package: excel! + fullName: apply(range, columnIndex, criteria) + summary: >- + Applies the AutoFilter to a range. This filters the column if column index + and filter criteria are specified. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-auto-filter.yaml + + + // This function adds a percentage AutoFilter to the active worksheet + + // and applies the filter to a column of the used range. + + await Excel.run(async (context) => { + // Retrieve the active worksheet and the used range on that worksheet. + const sheet = context.workbook.worksheets.getActiveWorksheet(); + const farmData = sheet.getUsedRange(); + + // Add a filter that will only show the rows with the top 50% of values in column 3. + sheet.autoFilter.apply(farmData, 3, { + criterion1: "50", + filterOn: Excel.FilterOn.topPercent + }); + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + apply(range: Range | string, columnIndex?: number, criteria?: + Excel.FilterCriteria): void; + parameters: + - id: range + description: The range on which the AutoFilter will apply. + type: | string + - id: columnIndex + description: The zero-based column index to which the AutoFilter is applied. + type: number + - id: criteria + description: The filter criteria. + type: + return: + type: void + description: '' + - name: clearColumnCriteria(columnIndex) + uid: excel!Excel.AutoFilter#clearColumnCriteria:member(1) + package: excel! + fullName: clearColumnCriteria(columnIndex) + summary: Clears the column filter criteria of the AutoFilter. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-auto-filter.yaml + + + // This function clears the AutoFilter setting from one column. + + await Excel.run(async (context) => { + // Retrieve the active worksheet. + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Clear the filter from only column 3. + sheet.autoFilter.clearColumnCriteria(3); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'clearColumnCriteria(columnIndex: number): void;' + parameters: + - id: columnIndex + description: >- + The zero-based column index, which represents which column filter + needs to be cleared. If the index value is not supported (for + example, if the value is a negative number, or if the value is + greater than the number of available columns in the range), then an + `InvalidArgument` error will be thrown. + type: number + return: + type: void + description: '' + - name: clearCriteria() + uid: excel!Excel.AutoFilter#clearCriteria:member(1) + package: excel! + fullName: clearCriteria() + summary: Clears the filter criteria and sort state of the AutoFilter. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'clearCriteria(): void;' + return: + type: void + description: '' + - name: getRange() + uid: excel!Excel.AutoFilter#getRange:member(1) + package: excel! + fullName: getRange() + summary: >- + Returns the `Range` object that represents the range to which the + AutoFilter applies. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getRange(): Excel.Range;' + return: + type: + description: '' + - name: getRangeOrNullObject() + uid: excel!Excel.AutoFilter#getRangeOrNullObject:member(1) + package: excel! + fullName: getRangeOrNullObject() + summary: >- + Returns the `Range` object that represents the range to which the + AutoFilter applies. If there is no `Range` object associated with the + AutoFilter, then this method returns an object with its `isNullObject` + property set to `true`. For further information, see + [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getRangeOrNullObject(): Excel.Range;' + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.AutoFilter#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.AutoFilterLoadOptions): + Excel.AutoFilter; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.AutoFilter#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.AutoFilter;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.AutoFilter#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.AutoFilter; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: reapply() + uid: excel!Excel.AutoFilter#reapply:member(1) + package: excel! + fullName: reapply() + summary: Applies the specified AutoFilter object currently on the range. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-auto-filter.yaml + + + // This function refreshes the AutoFilter to ensure that changes are + captured. + + await Excel.run(async (context) => { + // Retrieve the active worksheet. + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Reapply the filter to capture changes. + sheet.autoFilter.reapply(); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'reapply(): void;' + return: + type: void + description: '' + - name: remove() + uid: excel!Excel.AutoFilter#remove:member(1) + package: excel! + fullName: remove() + summary: Removes the AutoFilter for the range. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-auto-filter.yaml + + + // This function removes all AutoFilters from the active worksheet. + + await Excel.run(async (context) => { + // Retrieve the active worksheet. + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Remove all filters. + sheet.autoFilter.remove(); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'remove(): void;' + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.AutoFilter#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.AutoFilter` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.AutoFilterData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.AutoFilterData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.basiccardlayout.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.basiccardlayout.yml new file mode 100644 index 0000000000..869b92773a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.basiccardlayout.yml @@ -0,0 +1,33 @@ +### YamlMime:TSType +name: Excel.BasicCardLayout +uid: excel!Excel.BasicCardLayout:interface +package: excel! +fullName: Excel.BasicCardLayout +summary: Represents a card layout used for the Boolean, double, and string basic types. +remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: layout + uid: excel!Excel.BasicCardLayout#layout:member + package: excel! + fullName: layout + summary: Represents the type of this layout. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'layout?: EntityCardLayoutType.entity | "Entity";' + return: + type: >- + | + "Entity" +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.basiccompactlayout.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.basiccompactlayout.yml new file mode 100644 index 0000000000..f9676f7deb --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.basiccompactlayout.yml @@ -0,0 +1,30 @@ +### YamlMime:TSType +name: Excel.BasicCompactLayout +uid: excel!Excel.BasicCompactLayout:interface +package: excel! +fullName: Excel.BasicCompactLayout +summary: The basic compact layout properties. +remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: icon + uid: excel!Excel.BasicCompactLayout#icon:member + package: excel! + fullName: icon + summary: Specifies the name of the icon which is used to open the card. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'icon?: string | EntityCompactLayoutIcons;' + return: + type: string | diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.basicdatavalidation.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.basicdatavalidation.yml new file mode 100644 index 0000000000..aaa7ae2746 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.basicdatavalidation.yml @@ -0,0 +1,83 @@ +### YamlMime:TSType +name: Excel.BasicDataValidation +uid: excel!Excel.BasicDataValidation:interface +package: excel! +fullName: Excel.BasicDataValidation +summary: Represents the basic type data validation criteria. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: formula1 + uid: excel!Excel.BasicDataValidation#formula1:member + package: excel! + fullName: formula1 + summary: >- + Specifies the right-hand operand when the operator property is set to a + binary operator such as GreaterThan (the left-hand operand is the value + the user tries to enter in the cell). With the ternary operators Between + and NotBetween, specifies the lower bound operand. For example, setting + formula1 to 10 and operator to GreaterThan means that valid data for the + range must be greater than 10. When setting the value, it can be passed in + as a number, a range object, or a string formula (where the string is + either a stringified number, a cell reference like "=A1", or a formula + like "=MIN(A1, B1)"). When retrieving the value, it will always be + returned as a string formula, for example: "=10", "=A1", "=SUM(A1:B5)", + etc. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formula1: string | number | Range;' + return: + type: string | number | + - name: formula2 + uid: excel!Excel.BasicDataValidation#formula2:member + package: excel! + fullName: formula2 + summary: >- + With the ternary operators Between and NotBetween, specifies the upper + bound operand. Is not used with the binary operators, such as GreaterThan. + When setting the value, it can be passed in as a number, a range object, + or a string formula (where the string is either a stringified number, a + cell reference like "=A1", or a formula like "=MIN(A1, B1)"). When + retrieving the value, it will always be returned as a string formula, for + example: "=10", "=A1", "=SUM(A1:B5)", etc. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formula2?: string | number | Range;' + return: + type: string | number | + - name: operator + uid: excel!Excel.BasicDataValidation#operator:member + package: excel! + fullName: operator + summary: The operator to use for validating the data. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + operator: Excel.DataValidationOperator | "Between" | "NotBetween" | + "EqualTo" | "NotEqualTo" | "GreaterThan" | "LessThan" | + "GreaterThanOrEqualTo" | "LessThanOrEqualTo"; + return: + type: >- + | "Between" | + "NotBetween" | "EqualTo" | "NotEqualTo" | "GreaterThan" | "LessThan" | + "GreaterThanOrEqualTo" | "LessThanOrEqualTo" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.basicviewlayouts.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.basicviewlayouts.yml new file mode 100644 index 0000000000..3c70cd3627 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.basicviewlayouts.yml @@ -0,0 +1,53 @@ +### YamlMime:TSType +name: Excel.BasicViewLayouts +uid: excel!Excel.BasicViewLayouts:interface +package: excel! +fullName: Excel.BasicViewLayouts +summary: >- + Represents layout information for various views of the value and its + properties. +remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: card + uid: excel!Excel.BasicViewLayouts#card:member + package: excel! + fullName: card + summary: >- + Represents the layout of this value and its properties in card view. If + the `BasicCardLayout` object does not have a layout property, it is + assumed to be "Entity". + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'card?: BasicCardLayout;' + return: + type: + - name: compact + uid: excel!Excel.BasicViewLayouts#compact:member + package: excel! + fullName: compact + summary: >- + Represents the layout used when there is limited space to represent the + value. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'compact?: BasicCompactLayout;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.binding.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.binding.yml new file mode 100644 index 0000000000..f20401fc87 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.binding.yml @@ -0,0 +1,361 @@ +### YamlMime:TSType +name: Excel.Binding +uid: excel!Excel.Binding:class +package: excel! +fullName: Excel.Binding +summary: Represents an Office.js binding that is defined in the workbook. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.Binding#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: id + uid: excel!Excel.Binding#id:member + package: excel! + fullName: id + summary: Represents the binding identifier. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly id: string;' + return: + type: string + - name: type + uid: excel!Excel.Binding#type:member + package: excel! + fullName: type + summary: Returns the type of the binding. See `Excel.BindingType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly type: Excel.BindingType | "Range" | "Table" | "Text";' + return: + type: >- + | "Range" | "Table" | + "Text" +methods: + - name: delete() + uid: excel!Excel.Binding#delete:member(1) + package: excel! + fullName: delete() + summary: Deletes the binding. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'delete(): void;' + return: + type: void + description: '' + - name: getRange() + uid: excel!Excel.Binding#getRange:member(1) + package: excel! + fullName: getRange() + summary: >- + Returns the range represented by the binding. Will throw an error if the + binding is not of the correct type. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const binding = context.workbook.bindings.getItemAt(0); + const range = binding.getRange(); + range.load('cellCount'); + await context.sync(); + + console.log(range.cellCount); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getRange(): Excel.Range;' + return: + type: + description: '' + - name: getTable() + uid: excel!Excel.Binding#getTable:member(1) + package: excel! + fullName: getTable() + summary: >- + Returns the table represented by the binding. Will throw an error if the + binding is not of the correct type. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const binding = context.workbook.bindings.getItemAt(0); + const table = binding.getTable(); + table.load('name'); + await context.sync(); + + console.log(table.name); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getTable(): Excel.Table;' + return: + type: + description: '' + - name: getText() + uid: excel!Excel.Binding#getText:member(1) + package: excel! + fullName: getText() + summary: >- + Returns the text represented by the binding. Will throw an error if the + binding is not of the correct type. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const binding = context.workbook.bindings.getItemAt(0); + const text = binding.getText(); + binding.load('text'); + await context.sync(); + + console.log(text); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getText(): OfficeExtension.ClientResult;' + return: + type: <string> + description: '' + - name: load(options) + uid: excel!Excel.Binding#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(options?: Excel.Interfaces.BindingLoadOptions): Excel.Binding;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.Binding#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.Binding;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: |- + + + #### Examples + + ```TypeScript + await Excel.run(async (context) => { + const binding = context.workbook.bindings.getItemAt(0); + binding.load('type'); + await context.sync(); + + console.log(binding.type); + }); + ``` + - name: load(propertyNamesAndPaths) + uid: excel!Excel.Binding#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.Binding; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.Binding#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.Binding` object + is an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Excel.Interfaces.BindingData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.BindingData;' + return: + type: + description: '' +events: + - name: onDataChanged + uid: excel!Excel.Binding#onDataChanged:member + package: excel! + fullName: onDataChanged + summary: Occurs when data or formatting within the binding is changed. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/data-changed.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const salesTable = sheet.tables.getItem("SalesTable"); + const salesByQuarterBinding = context.workbook.bindings.add(salesTable.getRange(), "Table", "SalesByQuarter"); + salesByQuarterBinding.onDataChanged.add(onSalesDataChanged); + + console.log("The data changed handler is registered."); + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onDataChanged: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onSelectionChanged + uid: excel!Excel.Binding#onSelectionChanged:member + package: excel! + fullName: onSelectionChanged + summary: >- + Occurs when the selected content in the binding is changed. + + + *Note**: If multiple, discontiguous cells are selected, + `Binding.onSelectionChanged` only reports row and column information for + one selection. Use `Worksheet.onSelectionChanged` for multiple selected + ranges. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onSelectionChanged: + OfficeExtension.EventHandlers; + return: + type: >- + <> +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.bindingcollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.bindingcollection.yml new file mode 100644 index 0000000000..6cc55471a7 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.bindingcollection.yml @@ -0,0 +1,465 @@ +### YamlMime:TSType +name: Excel.BindingCollection +uid: excel!Excel.BindingCollection:class +package: excel! +fullName: Excel.BindingCollection +summary: >- + Represents the collection of all the binding objects that are part of the + workbook. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.BindingCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: count + uid: excel!Excel.BindingCollection#count:member + package: excel! + fullName: count + summary: Returns the number of bindings in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly count: number;' + return: + type: number + - name: items + uid: excel!Excel.BindingCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.Binding[];' + return: + type: [] +methods: + - name: add(range, bindingType, id) + uid: excel!Excel.BindingCollection#add:member(1) + package: excel! + fullName: add(range, bindingType, id) + summary: Add a new binding to a particular Range. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + add(range: Range | string, bindingType: Excel.BindingType, id: string): + Excel.Binding; + parameters: + - id: range + description: >- + Range to bind the binding to. May be a `Range` object or a string. + If string, must contain the full address, including the sheet name + type: | string + - id: bindingType + description: Type of binding. See `Excel.BindingType`. + type: + - id: id + description: Name of the binding. + type: string + return: + type: + description: '' + - name: add(range, bindingType, id) + uid: excel!Excel.BindingCollection#add:member(2) + package: excel! + fullName: add(range, bindingType, id) + summary: Add a new binding to a particular Range. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + add(range: Range | string, bindingType: "Range" | "Table" | "Text", id: + string): Excel.Binding; + parameters: + - id: range + description: >- + Range to bind the binding to. May be a `Range` object or a string. + If string, must contain the full address, including the sheet name + type: | string + - id: bindingType + description: Type of binding. See `Excel.BindingType`. + type: '"Range" | "Table" | "Text"' + - id: id + description: Name of the binding. + type: string + return: + type: + description: '' + - name: addFromNamedItem(name, bindingType, id) + uid: excel!Excel.BindingCollection#addFromNamedItem:member(1) + package: excel! + fullName: addFromNamedItem(name, bindingType, id) + summary: >- + Add a new binding based on a named item in the workbook. If the named item + references to multiple areas, the `InvalidReference` error will be + returned. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + addFromNamedItem(name: string, bindingType: Excel.BindingType, id: + string): Excel.Binding; + parameters: + - id: name + description: Name from which to create binding. + type: string + - id: bindingType + description: Type of binding. See `Excel.BindingType`. + type: + - id: id + description: Name of the binding. + type: string + return: + type: + description: '' + - name: addFromNamedItem(name, bindingType, id) + uid: excel!Excel.BindingCollection#addFromNamedItem:member(2) + package: excel! + fullName: addFromNamedItem(name, bindingType, id) + summary: >- + Add a new binding based on a named item in the workbook. If the named item + references to multiple areas, the `InvalidReference` error will be + returned. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + addFromNamedItem(name: string, bindingType: "Range" | "Table" | "Text", + id: string): Excel.Binding; + parameters: + - id: name + description: Name from which to create binding. + type: string + - id: bindingType + description: Type of binding. See `Excel.BindingType`. + type: '"Range" | "Table" | "Text"' + - id: id + description: Name of the binding. + type: string + return: + type: + description: '' + - name: addFromSelection(bindingType, id) + uid: excel!Excel.BindingCollection#addFromSelection:member(1) + package: excel! + fullName: addFromSelection(bindingType, id) + summary: >- + Add a new binding based on the current selection. If the selection has + multiple areas, the `InvalidReference` error will be returned. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + addFromSelection(bindingType: Excel.BindingType, id: string): + Excel.Binding; + parameters: + - id: bindingType + description: Type of binding. See `Excel.BindingType`. + type: + - id: id + description: Name of the binding. + type: string + return: + type: + description: '' + - name: addFromSelection(bindingType, id) + uid: excel!Excel.BindingCollection#addFromSelection:member(2) + package: excel! + fullName: addFromSelection(bindingType, id) + summary: >- + Add a new binding based on the current selection. If the selection has + multiple areas, the `InvalidReference` error will be returned. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + addFromSelection(bindingType: "Range" | "Table" | "Text", id: string): + Excel.Binding; + parameters: + - id: bindingType + description: Type of binding. See `Excel.BindingType`. + type: '"Range" | "Table" | "Text"' + - id: id + description: Name of the binding. + type: string + return: + type: + description: '' + - name: getCount() + uid: excel!Excel.BindingCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Gets the number of bindings in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getItem(id) + uid: excel!Excel.BindingCollection#getItem:member(1) + package: excel! + fullName: getItem(id) + summary: Gets a binding object by ID. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + async function onBindingDataChanged(eventArgs) { + await Excel.run(async (context) => { + // Highlight the table related to the binding in orange to indicate data has been changed. + context.workbook.bindings.getItem(eventArgs.binding.id).getTable().getDataBodyRange().format.fill.color = "Orange"; + await context.sync(); + + console.log("The value in this table got changed!"); + }); + } + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getItem(id: string): Excel.Binding;' + parameters: + - id: id + description: ID of the binding object to be retrieved. + type: string + return: + type: + description: '' + - name: getItemAt(index) + uid: excel!Excel.BindingCollection#getItemAt:member(1) + package: excel! + fullName: getItemAt(index) + summary: Gets a binding object based on its position in the items array. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const lastPosition = context.workbook.bindings.count - 1; + const binding = context.workbook.bindings.getItemAt(lastPosition); + binding.load('type') + await context.sync(); + + console.log(binding.type); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemAt(index: number): Excel.Binding;' + parameters: + - id: index + description: Index value of the object to be retrieved. Zero-indexed. + type: number + return: + type: + description: '' + - name: getItemOrNullObject(id) + uid: excel!Excel.BindingCollection#getItemOrNullObject:member(1) + package: excel! + fullName: getItemOrNullObject(id) + summary: >- + Gets a binding object by ID. If the binding object does not exist, then + this method returns an object with its `isNullObject` property set to + `true`. For further information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemOrNullObject(id: string): Excel.Binding;' + parameters: + - id: id + description: ID of the binding object to be retrieved. + type: string + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.BindingCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.BindingCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): Excel.BindingCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.BindingCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.BindingCollection;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: |- + + + #### Examples + + ```TypeScript + await Excel.run(async (context) => { + const bindings = context.workbook.bindings; + bindings.load('items'); + await context.sync(); + + for (let i = 0; i < bindings.items.length; i++) { + console.log(bindings.items[i].id); + } + }); + ``` + - name: load(propertyNamesAndPaths) + uid: excel!Excel.BindingCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.BindingCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.BindingCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.BindingCollection` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.BindingCollectionData`) that contains an "items" + array with shallow copies of any loaded properties from the collection's + items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.BindingCollectionData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.bindingdatachangedeventargs.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.bindingdatachangedeventargs.yml new file mode 100644 index 0000000000..091d3e8a8e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.bindingdatachangedeventargs.yml @@ -0,0 +1,32 @@ +### YamlMime:TSType +name: Excel.BindingDataChangedEventArgs +uid: excel!Excel.BindingDataChangedEventArgs:interface +package: excel! +fullName: Excel.BindingDataChangedEventArgs +summary: Provides information about the binding that raised the data changed event. +remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: binding + uid: excel!Excel.BindingDataChangedEventArgs#binding:member + package: excel! + fullName: binding + summary: >- + Gets a temporary `Binding` object that contains the ID of the `Binding` + object that raised the event. Use that ID with + `BindingCollection.getItem(id)` to get the binding. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'binding: Excel.Binding;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.bindingselectionchangedeventargs.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.bindingselectionchangedeventargs.yml new file mode 100644 index 0000000000..dc4490ec56 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.bindingselectionchangedeventargs.yml @@ -0,0 +1,99 @@ +### YamlMime:TSType +name: Excel.BindingSelectionChangedEventArgs +uid: excel!Excel.BindingSelectionChangedEventArgs:interface +package: excel! +fullName: Excel.BindingSelectionChangedEventArgs +summary: >- + Provides information about the selection that raised the selection changed + event. + + + *Note**: If multiple, discontiguous cells are selected, + `Binding.onSelectionChanged` only reports row and column information for one + selection. Use `Worksheet.onSelectionChanged` for multiple selected ranges. +remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: binding + uid: excel!Excel.BindingSelectionChangedEventArgs#binding:member + package: excel! + fullName: binding + summary: >- + Gets a temporary `Binding` object that contains the ID of the `Binding` + object that raised the event. Use that ID with + `BindingCollection.getItem(id)` to get the binding. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'binding: Excel.Binding;' + return: + type: + - name: columnCount + uid: excel!Excel.BindingSelectionChangedEventArgs#columnCount:member + package: excel! + fullName: columnCount + summary: Gets the number of columns selected. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'columnCount: number;' + return: + type: number + - name: rowCount + uid: excel!Excel.BindingSelectionChangedEventArgs#rowCount:member + package: excel! + fullName: rowCount + summary: Gets the number of rows selected. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rowCount: number;' + return: + type: number + - name: startColumn + uid: excel!Excel.BindingSelectionChangedEventArgs#startColumn:member + package: excel! + fullName: startColumn + summary: Gets the index of the first column of the selection (zero-based). + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'startColumn: number;' + return: + type: number + - name: startRow + uid: excel!Excel.BindingSelectionChangedEventArgs#startRow:member + package: excel! + fullName: startRow + summary: Gets the index of the first row of the selection (zero-based). + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'startRow: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.bindingtype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.bindingtype.yml new file mode 100644 index 0000000000..e7cfe6aee4 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.bindingtype.yml @@ -0,0 +1,60 @@ +### YamlMime:TSEnum +name: Excel.BindingType +uid: excel!Excel.BindingType:enum +package: excel! +fullName: Excel.BindingType +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-disable-events.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const sumRange = sheet.getRange("B20:P20"); + sumRange.load("columnCount"); + await context.sync(); + + // add an event handler to each cell in the sum range + for (let i = 0; i < sumRange.columnCount; i++) { + let sumBinding = context.workbook.bindings.add(sumRange.getCell(0,i), Excel.BindingType.range, "SumBinding" + i); + sumBinding.onDataChanged.add(onSumChanged); + } + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: range + uid: excel!Excel.BindingType.range:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Range"' + - name: table + uid: excel!Excel.BindingType.table:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Table"' + - name: text + uid: excel!Excel.BindingType.text:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Text"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.blockederrorcellvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.blockederrorcellvalue.yml new file mode 100644 index 0000000000..86c37b821c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.blockederrorcellvalue.yml @@ -0,0 +1,111 @@ +### YamlMime:TSType +name: Excel.BlockedErrorCellValue +uid: excel!Excel.BlockedErrorCellValue:interface +package: excel! +fullName: Excel.BlockedErrorCellValue +summary: Represents the value of a cell containing a \#BLOCKED! error. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: basicType + uid: excel!Excel.BlockedErrorCellValue#basicType:member + package: excel! + fullName: basicType + summary: >- + Represents the value that would be returned by `Range.valueTypes` for a + cell with this value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicType?: RangeValueType.error | "Error";' + return: + type: | "Error" + - name: basicValue + uid: excel!Excel.BlockedErrorCellValue#basicValue:member + package: excel! + fullName: basicValue + summary: >- + Represents the value that would be returned by `Range.values` for a cell + with this value. When accessed through a `valuesAsJson` property, this + string value aligns with the en-US locale. When accessed through a + `valuesAsJsonLocal` property, this string value aligns with the user's + display locale. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicValue?: "#BLOCKED!" | string;' + return: + type: '"#BLOCKED!" | string' + - name: errorSubType + uid: excel!Excel.BlockedErrorCellValue#errorSubType:member + package: excel! + fullName: errorSubType + summary: Represents the type of `BlockedErrorCellValue`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + errorSubType?: BlockedErrorCellValueSubType | "Unknown" | + "DataTypeRestrictedDomain" | "DataTypePrivacySetting" | + "DataTypeUnsupportedApp" | "ExternalLinksGeneric" | + "RichDataLinkDisabled" | "SignInError" | "NoLicense"; + return: + type: >- + | + "Unknown" | "DataTypeRestrictedDomain" | "DataTypePrivacySetting" | + "DataTypeUnsupportedApp" | "ExternalLinksGeneric" | + "RichDataLinkDisabled" | "SignInError" | "NoLicense" + - name: errorType + uid: excel!Excel.BlockedErrorCellValue#errorType:member + package: excel! + fullName: errorType + summary: Represents the type of `ErrorCellValue`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'errorType?: ErrorCellValueType.blocked | "Blocked";' + return: + type: >- + | + "Blocked" + - name: type + uid: excel!Excel.BlockedErrorCellValue#type:member + package: excel! + fullName: type + summary: Represents the type of this cell value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: CellValueType.error | "Error";' + return: + type: | "Error" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.blockederrorcellvaluesubtype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.blockederrorcellvaluesubtype.yml new file mode 100644 index 0000000000..3bcb517be9 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.blockederrorcellvaluesubtype.yml @@ -0,0 +1,108 @@ +### YamlMime:TSEnum +name: Excel.BlockedErrorCellValueSubType +uid: excel!Excel.BlockedErrorCellValueSubType:enum +package: excel! +fullName: Excel.BlockedErrorCellValueSubType +summary: Represents types of \#BLOCKED! errors. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: dataTypePrivacySetting + uid: excel!Excel.BlockedErrorCellValueSubType.dataTypePrivacySetting:member + package: excel! + summary: >- + An error caused by privacy settings. Displays as error type \#BLOCKED! in + Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"DataTypePrivacySetting"' + - name: dataTypeRestrictedDomain + uid: excel!Excel.BlockedErrorCellValueSubType.dataTypeRestrictedDomain:member + package: excel! + summary: >- + An error caused by a service not supporting a linked data type. Displays + as error type \#BLOCKED! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"DataTypeRestrictedDomain"' + - name: dataTypeUnsupportedApp + uid: excel!Excel.BlockedErrorCellValueSubType.dataTypeUnsupportedApp:member + package: excel! + summary: >- + An error caused by an unsupported data type. Displays as error type + \#BLOCKED! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"DataTypeUnsupportedApp"' + - name: externalLinksGeneric + uid: excel!Excel.BlockedErrorCellValueSubType.externalLinksGeneric:member + package: excel! + summary: >- + An error caused by external links. Displays as error type \#BLOCKED! in + Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ExternalLinksGeneric"' + - name: noLicense + uid: excel!Excel.BlockedErrorCellValueSubType.noLicense:member + package: excel! + summary: >- + An error caused by a license verification failure. Displays as error type + \#BLOCKED! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"NoLicense"' + - name: richDataLinkDisabled + uid: excel!Excel.BlockedErrorCellValueSubType.richDataLinkDisabled:member + package: excel! + summary: >- + An error caused by disabled rich data links. Displays as error type + \#BLOCKED! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"RichDataLinkDisabled"' + - name: signInError + uid: excel!Excel.BlockedErrorCellValueSubType.signInError:member + package: excel! + summary: >- + An error caused by sign in failure. Displays as error type \#BLOCKED! in + Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"SignInError"' + - name: unknown + uid: excel!Excel.BlockedErrorCellValueSubType.unknown:member + package: excel! + summary: >- + An unknown type of error. Displays as error type \#BLOCKED! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Unknown"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.booleancellvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.booleancellvalue.yml new file mode 100644 index 0000000000..4c5d621a90 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.booleancellvalue.yml @@ -0,0 +1,141 @@ +### YamlMime:TSType +name: Excel.BooleanCellValue +uid: excel!Excel.BooleanCellValue:interface +package: excel! +fullName: Excel.BooleanCellValue +summary: Represents the value of a cell containing a Boolean. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: basicType + uid: excel!Excel.BooleanCellValue#basicType:member + package: excel! + fullName: basicType + summary: >- + Represents the value that would be returned by `Range.valueTypes` for a + cell with this value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicType?: RangeValueType.boolean | "Boolean";' + return: + type: | "Boolean" + - name: basicValue + uid: excel!Excel.BooleanCellValue#basicValue:member + package: excel! + fullName: basicValue + summary: >- + Represents the value that would be returned by `Range.values` for a cell + with this value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicValue: boolean;' + return: + type: boolean + - name: layouts + uid: excel!Excel.BooleanCellValue#layouts:member + package: excel! + fullName: layouts + summary: Represents layout information for views of this Boolean value. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'layouts?: BasicViewLayouts;' + return: + type: + - name: properties + uid: excel!Excel.BooleanCellValue#properties:member + package: excel! + fullName: properties + summary: Represents additional properties of this Boolean value. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: |- + properties?: { + [key: string]: EntityPropertyType; + }; + return: + type: |- + { + [key: string]: ; + } + - name: provider + uid: excel!Excel.BooleanCellValue#provider:member + package: excel! + fullName: provider + summary: >- + Represents information that describes the service that provided the data + in this `BooleanCellValue`. This information can be used for + branding in card view. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'provider?: CellValueProviderAttributes;' + return: + type: + - name: referencedValues + uid: excel!Excel.BooleanCellValue#referencedValues:member + package: excel! + fullName: referencedValues + summary: >- + Represents the cell values which are referenced within + `BooleanCellValue.properties`. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'referencedValues?: ReferencedValue[];' + return: + type: [] + - name: type + uid: excel!Excel.BooleanCellValue#type:member + package: excel! + fullName: type + summary: Represents the type of this cell value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: CellValueType.boolean | "Boolean";' + return: + type: | "Boolean" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.borderindex.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.borderindex.yml new file mode 100644 index 0000000000..12667ca1c9 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.borderindex.yml @@ -0,0 +1,69 @@ +### YamlMime:TSEnum +name: Excel.BorderIndex +uid: excel!Excel.BorderIndex:enum +package: excel! +fullName: Excel.BorderIndex +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: diagonalDown + uid: excel!Excel.BorderIndex.diagonalDown:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"DiagonalDown"' + - name: diagonalUp + uid: excel!Excel.BorderIndex.diagonalUp:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"DiagonalUp"' + - name: edgeBottom + uid: excel!Excel.BorderIndex.edgeBottom:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"EdgeBottom"' + - name: edgeLeft + uid: excel!Excel.BorderIndex.edgeLeft:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"EdgeLeft"' + - name: edgeRight + uid: excel!Excel.BorderIndex.edgeRight:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"EdgeRight"' + - name: edgeTop + uid: excel!Excel.BorderIndex.edgeTop:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"EdgeTop"' + - name: insideHorizontal + uid: excel!Excel.BorderIndex.insideHorizontal:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"InsideHorizontal"' + - name: insideVertical + uid: excel!Excel.BorderIndex.insideVertical:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"InsideVertical"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.borderlinestyle.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.borderlinestyle.yml new file mode 100644 index 0000000000..31066c50c2 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.borderlinestyle.yml @@ -0,0 +1,153 @@ +### YamlMime:TSEnum +name: Excel.BorderLineStyle +uid: excel!Excel.BorderLineStyle:enum +package: excel! +fullName: Excel.BorderLineStyle +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/cell-properties.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Creating the SettableCellProperties objects to use for the range. + // In your add-in, these should be created once, outside the function. + const topHeaderProps: Excel.SettableCellProperties = { + // The style property takes a string matching the name of an Excel style. + // Built-in style names are listed in the `BuiltInStyle` enum. + // Note that a style will overwrite any formatting, + // so do not use the format property with the style property. + style: "Heading1" + }; + + const headerProps: Excel.SettableCellProperties = { + // Any subproperties of format that are not set will not be changed when these cell properties are set. + format: { + fill: { + color: "Blue" + }, + font: { + color: "White", + bold: true + } + } + }; + + const nonApplicableProps: Excel.SettableCellProperties = { + format: { + fill: { + pattern: Excel.FillPattern.gray25 + }, + font: { + color: "Gray", + italic: true + } + } + }; + + const matchupScoreProps: Excel.SettableCellProperties = { + format: { + borders: { + bottom: { + style: Excel.BorderLineStyle.continuous + }, + left: { + style: Excel.BorderLineStyle.continuous + }, + right: { + style: Excel.BorderLineStyle.continuous + }, + top: { + style: Excel.BorderLineStyle.continuous + } + } + } + }; + + const range = sheet.getRange("A1:E5"); + + // You can use empty JSON objects to avoid changing a cell's properties. + range.setCellProperties([ + [topHeaderProps, {}, {}, {}, {}], + [{}, {}, headerProps, headerProps, headerProps], + [{}, headerProps, nonApplicableProps, matchupScoreProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, nonApplicableProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, matchupScoreProps, nonApplicableProps] + ]); + + sheet.getUsedRange().format.autofitColumns(); + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: continuous + uid: excel!Excel.BorderLineStyle.continuous:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Continuous"' + - name: dash + uid: excel!Excel.BorderLineStyle.dash:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Dash"' + - name: dashDot + uid: excel!Excel.BorderLineStyle.dashDot:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"DashDot"' + - name: dashDotDot + uid: excel!Excel.BorderLineStyle.dashDotDot:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"DashDotDot"' + - name: dot + uid: excel!Excel.BorderLineStyle.dot:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Dot"' + - name: double + uid: excel!Excel.BorderLineStyle.double:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Double"' + - name: none + uid: excel!Excel.BorderLineStyle.none:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"None"' + - name: slantDashDot + uid: excel!Excel.BorderLineStyle.slantDashDot:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"SlantDashDot"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.borderweight.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.borderweight.yml new file mode 100644 index 0000000000..7eb4ca0d85 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.borderweight.yml @@ -0,0 +1,41 @@ +### YamlMime:TSEnum +name: Excel.BorderWeight +uid: excel!Excel.BorderWeight:enum +package: excel! +fullName: Excel.BorderWeight +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: hairline + uid: excel!Excel.BorderWeight.hairline:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Hairline"' + - name: medium + uid: excel!Excel.BorderWeight.medium:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Medium"' + - name: thick + uid: excel!Excel.BorderWeight.thick:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Thick"' + - name: thin + uid: excel!Excel.BorderWeight.thin:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Thin"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.builtinstyle.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.builtinstyle.yml new file mode 100644 index 0000000000..bd459b03d7 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.builtinstyle.yml @@ -0,0 +1,461 @@ +### YamlMime:TSEnum +name: Excel.BuiltInStyle +uid: excel!Excel.BuiltInStyle:enum +package: excel! +fullName: Excel.BuiltInStyle +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/cell-properties.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Creating the SettableCellProperties objects to use for the range. + // In your add-in, these should be created once, outside the function. + const topHeaderProps: Excel.SettableCellProperties = { + // The style property takes a string matching the name of an Excel style. + // Built-in style names are listed in the `BuiltInStyle` enum. + // Note that a style will overwrite any formatting, + // so do not use the format property with the style property. + style: "Heading1" + }; + + const headerProps: Excel.SettableCellProperties = { + // Any subproperties of format that are not set will not be changed when these cell properties are set. + format: { + fill: { + color: "Blue" + }, + font: { + color: "White", + bold: true + } + } + }; + + const nonApplicableProps: Excel.SettableCellProperties = { + format: { + fill: { + pattern: Excel.FillPattern.gray25 + }, + font: { + color: "Gray", + italic: true + } + } + }; + + const matchupScoreProps: Excel.SettableCellProperties = { + format: { + borders: { + bottom: { + style: Excel.BorderLineStyle.continuous + }, + left: { + style: Excel.BorderLineStyle.continuous + }, + right: { + style: Excel.BorderLineStyle.continuous + }, + top: { + style: Excel.BorderLineStyle.continuous + } + } + } + }; + + const range = sheet.getRange("A1:E5"); + + // You can use empty JSON objects to avoid changing a cell's properties. + range.setCellProperties([ + [topHeaderProps, {}, {}, {}, {}], + [{}, {}, headerProps, headerProps, headerProps], + [{}, headerProps, nonApplicableProps, matchupScoreProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, nonApplicableProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, matchupScoreProps, nonApplicableProps] + ]); + + sheet.getUsedRange().format.autofitColumns(); + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: accent1 + uid: excel!Excel.BuiltInStyle.accent1:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Accent1"' + - name: accent1_20 + uid: excel!Excel.BuiltInStyle.accent1_20:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Accent1_20"' + - name: accent1_40 + uid: excel!Excel.BuiltInStyle.accent1_40:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Accent1_40"' + - name: accent1_60 + uid: excel!Excel.BuiltInStyle.accent1_60:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Accent1_60"' + - name: accent2 + uid: excel!Excel.BuiltInStyle.accent2:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Accent2"' + - name: accent2_20 + uid: excel!Excel.BuiltInStyle.accent2_20:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Accent2_20"' + - name: accent2_40 + uid: excel!Excel.BuiltInStyle.accent2_40:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Accent2_40"' + - name: accent2_60 + uid: excel!Excel.BuiltInStyle.accent2_60:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Accent2_60"' + - name: accent3 + uid: excel!Excel.BuiltInStyle.accent3:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Accent3"' + - name: accent3_20 + uid: excel!Excel.BuiltInStyle.accent3_20:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Accent3_20"' + - name: accent3_40 + uid: excel!Excel.BuiltInStyle.accent3_40:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Accent3_40"' + - name: accent3_60 + uid: excel!Excel.BuiltInStyle.accent3_60:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Accent3_60"' + - name: accent4 + uid: excel!Excel.BuiltInStyle.accent4:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Accent4"' + - name: accent4_20 + uid: excel!Excel.BuiltInStyle.accent4_20:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Accent4_20"' + - name: accent4_40 + uid: excel!Excel.BuiltInStyle.accent4_40:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Accent4_40"' + - name: accent4_60 + uid: excel!Excel.BuiltInStyle.accent4_60:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Accent4_60"' + - name: accent5 + uid: excel!Excel.BuiltInStyle.accent5:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Accent5"' + - name: accent5_20 + uid: excel!Excel.BuiltInStyle.accent5_20:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Accent5_20"' + - name: accent5_40 + uid: excel!Excel.BuiltInStyle.accent5_40:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Accent5_40"' + - name: accent5_60 + uid: excel!Excel.BuiltInStyle.accent5_60:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Accent5_60"' + - name: accent6 + uid: excel!Excel.BuiltInStyle.accent6:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Accent6"' + - name: accent6_20 + uid: excel!Excel.BuiltInStyle.accent6_20:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Accent6_20"' + - name: accent6_40 + uid: excel!Excel.BuiltInStyle.accent6_40:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Accent6_40"' + - name: accent6_60 + uid: excel!Excel.BuiltInStyle.accent6_60:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Accent6_60"' + - name: bad + uid: excel!Excel.BuiltInStyle.bad:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Bad"' + - name: calculation + uid: excel!Excel.BuiltInStyle.calculation:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Calculation"' + - name: checkCell + uid: excel!Excel.BuiltInStyle.checkCell:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"CheckCell"' + - name: comma + uid: excel!Excel.BuiltInStyle.comma:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Comma"' + - name: currency + uid: excel!Excel.BuiltInStyle.currency:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Currency"' + - name: emphasis1 + uid: excel!Excel.BuiltInStyle.emphasis1:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Emphasis1"' + - name: emphasis2 + uid: excel!Excel.BuiltInStyle.emphasis2:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Emphasis2"' + - name: emphasis3 + uid: excel!Excel.BuiltInStyle.emphasis3:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Emphasis3"' + - name: explanatoryText + uid: excel!Excel.BuiltInStyle.explanatoryText:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ExplanatoryText"' + - name: good + uid: excel!Excel.BuiltInStyle.good:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Good"' + - name: heading1 + uid: excel!Excel.BuiltInStyle.heading1:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Heading1"' + - name: heading2 + uid: excel!Excel.BuiltInStyle.heading2:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Heading2"' + - name: heading3 + uid: excel!Excel.BuiltInStyle.heading3:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Heading3"' + - name: heading4 + uid: excel!Excel.BuiltInStyle.heading4:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Heading4"' + - name: hlink + uid: excel!Excel.BuiltInStyle.hlink:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Hlink"' + - name: hlinkTrav + uid: excel!Excel.BuiltInStyle.hlinkTrav:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"HlinkTrav"' + - name: input + uid: excel!Excel.BuiltInStyle.input:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Input"' + - name: linkedCell + uid: excel!Excel.BuiltInStyle.linkedCell:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LinkedCell"' + - name: neutral + uid: excel!Excel.BuiltInStyle.neutral:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Neutral"' + - name: normal + uid: excel!Excel.BuiltInStyle.normal:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Normal"' + - name: note + uid: excel!Excel.BuiltInStyle.note:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Note"' + - name: output + uid: excel!Excel.BuiltInStyle.output:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Output"' + - name: percent + uid: excel!Excel.BuiltInStyle.percent:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Percent"' + - name: sheetTitle + uid: excel!Excel.BuiltInStyle.sheetTitle:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"SheetTitle"' + - name: total + uid: excel!Excel.BuiltInStyle.total:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Total"' + - name: warningText + uid: excel!Excel.BuiltInStyle.warningText:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"WarningText"' + - name: wholeComma + uid: excel!Excel.BuiltInStyle.wholeComma:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"WholeComma"' + - name: wholeDollar + uid: excel!Excel.BuiltInStyle.wholeDollar:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"WholeDollar"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.busyerrorcellvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.busyerrorcellvalue.yml new file mode 100644 index 0000000000..32ae2b7c13 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.busyerrorcellvalue.yml @@ -0,0 +1,105 @@ +### YamlMime:TSType +name: Excel.BusyErrorCellValue +uid: excel!Excel.BusyErrorCellValue:interface +package: excel! +fullName: Excel.BusyErrorCellValue +summary: Represents the value of a cell containing a \#BUSY! error. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: basicType + uid: excel!Excel.BusyErrorCellValue#basicType:member + package: excel! + fullName: basicType + summary: >- + Represents the value that would be returned by `Range.valueTypes` for a + cell with this value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicType?: RangeValueType.error | "Error";' + return: + type: | "Error" + - name: basicValue + uid: excel!Excel.BusyErrorCellValue#basicValue:member + package: excel! + fullName: basicValue + summary: >- + Represents the value that would be returned by `Range.values` for a cell + with this value. When accessed through a `valuesAsJson` property, this + string value aligns with the en-US locale. When accessed through a + `valuesAsJsonLocal` property, this string value aligns with the user's + display locale. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicValue?: "#BUSY!" | string;' + return: + type: '"#BUSY!" | string' + - name: errorSubType + uid: excel!Excel.BusyErrorCellValue#errorSubType:member + package: excel! + fullName: errorSubType + summary: Represents the type of `BusyErrorCellValue`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + errorSubType?: BusyErrorCellValueSubType | "Unknown" | + "ExternalLinksGeneric" | "LoadingImage"; + return: + type: >- + | "Unknown" + | "ExternalLinksGeneric" | "LoadingImage" + - name: errorType + uid: excel!Excel.BusyErrorCellValue#errorType:member + package: excel! + fullName: errorType + summary: Represents the type of `ErrorCellValue`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'errorType?: ErrorCellValueType.busy | "Busy";' + return: + type: | "Busy" + - name: type + uid: excel!Excel.BusyErrorCellValue#type:member + package: excel! + fullName: type + summary: Represents the type of this cell value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: CellValueType.error | "Error";' + return: + type: | "Error" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.busyerrorcellvaluesubtype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.busyerrorcellvaluesubtype.yml new file mode 100644 index 0000000000..b26b6dfc01 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.busyerrorcellvaluesubtype.yml @@ -0,0 +1,48 @@ +### YamlMime:TSEnum +name: Excel.BusyErrorCellValueSubType +uid: excel!Excel.BusyErrorCellValueSubType:enum +package: excel! +fullName: Excel.BusyErrorCellValueSubType +summary: Represents types of \#BUSY! errors. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: externalLinksGeneric + uid: excel!Excel.BusyErrorCellValueSubType.externalLinksGeneric:member + package: excel! + summary: >- + An error caused by external links. Displays as error type \#BUSY! in + Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ExternalLinksGeneric"' + - name: loadingImage + uid: excel!Excel.BusyErrorCellValueSubType.loadingImage:member + package: excel! + summary: >- + An error that displays while an image is loading. Displays as error type + \#BUSY! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"LoadingImage"' + - name: unknown + uid: excel!Excel.BusyErrorCellValueSubType.unknown:member + package: excel! + summary: >- + An unknown type of error. Displays as error type \#BUSY! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Unknown"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.calcerrorcellvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.calcerrorcellvalue.yml new file mode 100644 index 0000000000..9cba6011a3 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.calcerrorcellvalue.yml @@ -0,0 +1,125 @@ +### YamlMime:TSType +name: Excel.CalcErrorCellValue +uid: excel!Excel.CalcErrorCellValue:interface +package: excel! +fullName: Excel.CalcErrorCellValue +summary: Represents the value of a cell containing a \#CALC! error. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: basicType + uid: excel!Excel.CalcErrorCellValue#basicType:member + package: excel! + fullName: basicType + summary: >- + Represents the value that would be returned by `Range.valueTypes` for a + cell with this value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicType?: RangeValueType.error | "Error";' + return: + type: | "Error" + - name: basicValue + uid: excel!Excel.CalcErrorCellValue#basicValue:member + package: excel! + fullName: basicValue + summary: >- + Represents the value that would be returned by `Range.values` for a cell + with this value. When accessed through a `valuesAsJson` property, this + string value aligns with the en-US locale. When accessed through a + `valuesAsJsonLocal` property, this string value aligns with the user's + display locale. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicValue?: "#CALC!" | string;' + return: + type: '"#CALC!" | string' + - name: errorSubType + uid: excel!Excel.CalcErrorCellValue#errorSubType:member + package: excel! + fullName: errorSubType + summary: Represents the type of `CalcErrorCellValue`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + errorSubType?: CalcErrorCellValueSubType | "Unknown" | "ArrayOfArrays" | + "ArrayOfRanges" | "EmptyArray" | "UnsupportedLifting" | + "DataTableReferencedPendingFormula" | "TooManyCells" | "LambdaInCell" | + "TooDeeplyNested" | "TextOverflow"; + return: + type: >- + | "Unknown" + | "ArrayOfArrays" | "ArrayOfRanges" | "EmptyArray" | + "UnsupportedLifting" | "DataTableReferencedPendingFormula" | + "TooManyCells" | "LambdaInCell" | "TooDeeplyNested" | "TextOverflow" + - name: errorType + uid: excel!Excel.CalcErrorCellValue#errorType:member + package: excel! + fullName: errorType + summary: Represents the type of `ErrorCellValue`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'errorType?: ErrorCellValueType.calc | "Calc";' + return: + type: | "Calc" + - name: functionName + uid: excel!Excel.CalcErrorCellValue#functionName:member + package: excel! + fullName: functionName + summary: Represents the name of the function causing the error. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'functionName?: string;' + return: + type: string + - name: type + uid: excel!Excel.CalcErrorCellValue#type:member + package: excel! + fullName: type + summary: Represents the type of this cell value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: CellValueType.error | "Error";' + return: + type: | "Error" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.calcerrorcellvaluesubtype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.calcerrorcellvaluesubtype.yml new file mode 100644 index 0000000000..7037a88d0d --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.calcerrorcellvaluesubtype.yml @@ -0,0 +1,137 @@ +### YamlMime:TSEnum +name: Excel.CalcErrorCellValueSubType +uid: excel!Excel.CalcErrorCellValueSubType:enum +package: excel! +fullName: Excel.CalcErrorCellValueSubType +summary: Represents types of \#CALC! errors. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: arrayOfArrays + uid: excel!Excel.CalcErrorCellValueSubType.arrayOfArrays:member + package: excel! + summary: >- + An error caused by including an array in an array. Displays as error type + \#CALC! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ArrayOfArrays"' + - name: arrayOfRanges + uid: excel!Excel.CalcErrorCellValueSubType.arrayOfRanges:member + package: excel! + summary: >- + An error caused by including a range in an array. Displays as error type + \#CALC! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ArrayOfRanges"' + - name: dataTableReferencedPendingFormula + uid: >- + excel!Excel.CalcErrorCellValueSubType.dataTableReferencedPendingFormula:member + package: excel! + summary: >- + An error caused by a data table referencing a pending formula. The pending + formula is likely asynchronous. Displays as error type \#CALC! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"DataTableReferencedPendingFormula"' + - name: emptyArray + uid: excel!Excel.CalcErrorCellValueSubType.emptyArray:member + package: excel! + summary: >- + An error caused by an empty array. Displays as error type \#CALC! in + Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"EmptyArray"' + - name: lambdaInCell + uid: excel!Excel.CalcErrorCellValueSubType.lambdaInCell:member + package: excel! + summary: >- + An error caused by a cell's formula evaluating to a lambda value. Displays + as error type \#CALC! in Excel. + + + Warning: `lambdaInCell` was deprecated in ExcelAPI 1.19. + + + * \[Api set: ExcelApi 1.16\] + value: '"LambdaInCell"' + - name: textOverflow + uid: excel!Excel.CalcErrorCellValueSubType.textOverflow:member + package: excel! + summary: >- + An error caused by a cell's formula returning a string that exceeds the + maximum of 32767 characters. Displays as error type \#CALC! in Excel. Some + characters, like emoji, may appear to be one character in the Excel UI but + are actually processed as surrogate characters. A surrogate character + counts as multiple characters toward the maximum character limit. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"TextOverflow"' + - name: tooDeeplyNested + uid: excel!Excel.CalcErrorCellValueSubType.tooDeeplyNested:member + package: excel! + summary: >- + An error caused by a `CellValue` object that is too deeply nested within + another `CellValue`. Displays as error type \#CALC! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"TooDeeplyNested"' + - name: tooManyCells + uid: excel!Excel.CalcErrorCellValueSubType.tooManyCells:member + package: excel! + summary: >- + An error caused by a function referencing too many cells. Displays as + error type \#CALC! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"TooManyCells"' + - name: unknown + uid: excel!Excel.CalcErrorCellValueSubType.unknown:member + package: excel! + summary: >- + An unknown type of error. Displays as error type \#CALC! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Unknown"' + - name: unsupportedLifting + uid: excel!Excel.CalcErrorCellValueSubType.unsupportedLifting:member + package: excel! + summary: >- + An error caused by attempting to lift an unsupported formula (such as a + Dynamic UDF) over an array. Displays as error type \#CALC! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"UnsupportedLifting"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.calculationmode.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.calculationmode.yml new file mode 100644 index 0000000000..8c1056714c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.calculationmode.yml @@ -0,0 +1,65 @@ +### YamlMime:TSEnum +name: Excel.CalculationMode +uid: excel!Excel.CalculationMode:enum +package: excel! +fullName: Excel.CalculationMode +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-calculation.yaml + + + await Excel.run(async (context) => { + context.application.calculationMode = Excel.CalculationMode.manual; + context.application.load("calculationMode"); + await context.sync(); + + console.log("Current calculation mode: " + context.application.calculationMode); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: automatic + uid: excel!Excel.CalculationMode.automatic:member + package: excel! + summary: >- + The default recalculation behavior where Excel calculates new formula + results every time the relevant data is changed. + + + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Automatic"' + - name: automaticExceptTables + uid: excel!Excel.CalculationMode.automaticExceptTables:member + package: excel! + summary: >- + Calculates new formula results every time the relevant data is changed, + unless the formula is in a data table. + + + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"AutomaticExceptTables"' + - name: manual + uid: excel!Excel.CalculationMode.manual:member + package: excel! + summary: >- + Calculations only occur when the user or add-in requests them. + + + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Manual"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.calculationstate.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.calculationstate.yml new file mode 100644 index 0000000000..a31bb142c1 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.calculationstate.yml @@ -0,0 +1,44 @@ +### YamlMime:TSEnum +name: Excel.CalculationState +uid: excel!Excel.CalculationState:enum +package: excel! +fullName: Excel.CalculationState +summary: Represents the state of calculation across the entire Excel application. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: calculating + uid: excel!Excel.CalculationState.calculating:member + package: excel! + summary: >- + Calculations in progress. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Calculating"' + - name: done + uid: excel!Excel.CalculationState.done:member + package: excel! + summary: >- + Calculations complete. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Done"' + - name: pending + uid: excel!Excel.CalculationState.pending:member + package: excel! + summary: >- + Changes that trigger calculation have been made, but a recalculation has + not yet been performed. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Pending"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.calculationtype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.calculationtype.yml new file mode 100644 index 0000000000..0cd78a841f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.calculationtype.yml @@ -0,0 +1,62 @@ +### YamlMime:TSEnum +name: Excel.CalculationType +uid: excel!Excel.CalculationType:enum +package: excel! +fullName: Excel.CalculationType +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-calculation.yaml + + + await Excel.run(async (context) => { + context.application.calculate(Excel.CalculationType.recalculate); + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: full + uid: excel!Excel.CalculationType.full:member + package: excel! + summary: >- + This will mark all cells as dirty and then recalculate them. + + + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Full"' + - name: fullRebuild + uid: excel!Excel.CalculationType.fullRebuild:member + package: excel! + summary: >- + This will rebuild the full dependency chain, mark all cells as dirty and + then recalculate them. + + + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FullRebuild"' + - name: recalculate + uid: excel!Excel.CalculationType.recalculate:member + package: excel! + summary: >- + Recalculates all cells that Excel has marked as dirty, that is, dependents + of volatile or changed data, and cells programmatically marked as dirty. + + + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Recalculate"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayout.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayout.yml new file mode 100644 index 0000000000..07ebbc46e3 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayout.yml @@ -0,0 +1,19 @@ +### YamlMime:TSTypeAlias +name: Excel.CardLayout +uid: excel!Excel.CardLayout:type +package: excel! +fullName: Excel.CardLayout +summary: Represents the layout of a card in card view. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout) + +isPreview: false +isDeprecated: false +syntax: export type CardLayout = EntityCardLayout; diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayoutlistsection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayoutlistsection.yml new file mode 100644 index 0000000000..9d556b4ab5 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayoutlistsection.yml @@ -0,0 +1,31 @@ +### YamlMime:TSType +name: Excel.CardLayoutListSection +uid: excel!Excel.CardLayoutListSection:interface +package: excel! +fullName: Excel.CardLayoutListSection +summary: Represents a section of a card that is arranged as a list in card view. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: layout + uid: excel!Excel.CardLayoutListSection#layout:member + package: excel! + fullName: layout + summary: Represents the type of layout for this section. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'layout: "List";' + return: + type: '"List"' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayoutpropertyreference.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayoutpropertyreference.yml new file mode 100644 index 0000000000..9c8dcfea72 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayoutpropertyreference.yml @@ -0,0 +1,30 @@ +### YamlMime:TSType +name: Excel.CardLayoutPropertyReference +uid: excel!Excel.CardLayoutPropertyReference:interface +package: excel! +fullName: Excel.CardLayoutPropertyReference +summary: Represents a reference to a property used by the card layout. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: property + uid: excel!Excel.CardLayoutPropertyReference#property:member + package: excel! + fullName: property + summary: Represents the name of the property referenced by the card layout. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'property: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayoutsection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayoutsection.yml new file mode 100644 index 0000000000..cca1b0c56e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayoutsection.yml @@ -0,0 +1,23 @@ +### YamlMime:TSTypeAlias +name: Excel.CardLayoutSection +uid: excel!Excel.CardLayoutSection:type +package: excel! +fullName: Excel.CardLayoutSection +summary: Represents the layout of a section of a card in card view. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), + [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection), + [Excel.CardLayoutTwoColumnSection](/javascript/api/excel/excel.cardlayouttwocolumnsection) + +isPreview: false +isDeprecated: false +syntax: >- + export type CardLayoutSection = CardLayoutListSection | CardLayoutTableSection + | CardLayoutTwoColumnSection; diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayoutsectionstandardproperties.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayoutsectionstandardproperties.yml new file mode 100644 index 0000000000..6f10408533 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayoutsectionstandardproperties.yml @@ -0,0 +1,81 @@ +### YamlMime:TSType +name: Excel.CardLayoutSectionStandardProperties +uid: excel!Excel.CardLayoutSectionStandardProperties:interface +package: excel! +fullName: Excel.CardLayoutSectionStandardProperties +summary: Properties of a card layout relevant to most card layouts. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: collapsed + uid: excel!Excel.CardLayoutSectionStandardProperties#collapsed:member + package: excel! + fullName: collapsed + summary: Represents whether this section of the card is initially collapsed. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'collapsed?: boolean;' + return: + type: boolean + - name: collapsible + uid: excel!Excel.CardLayoutSectionStandardProperties#collapsible:member + package: excel! + fullName: collapsible + summary: >- + Represents whether this section of the card is collapsible. If the card + section has a title, the default value is `true`. If the card + section doesn't have a title, the default value is `false`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'collapsible?: boolean;' + return: + type: boolean + - name: properties + uid: excel!Excel.CardLayoutSectionStandardProperties#properties:member + package: excel! + fullName: properties + summary: Represents the names of the properties in this section. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'properties: string[];' + return: + type: string[] + - name: title + uid: excel!Excel.CardLayoutSectionStandardProperties#title:member + package: excel! + fullName: title + summary: Represents the title of this section of the card. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'title?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayoutstandardproperties.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayoutstandardproperties.yml new file mode 100644 index 0000000000..8edc8ee5eb --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayoutstandardproperties.yml @@ -0,0 +1,84 @@ +### YamlMime:TSType +name: Excel.CardLayoutStandardProperties +uid: excel!Excel.CardLayoutStandardProperties:interface +package: excel! +fullName: Excel.CardLayoutStandardProperties +summary: Properties of a card layout relevant to most card layouts. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: mainImage + uid: excel!Excel.CardLayoutStandardProperties#mainImage:member + package: excel! + fullName: mainImage + summary: Specifies a property which will be used as the main image of the card. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'mainImage?: CardLayoutPropertyReference;' + return: + type: + - name: sections + uid: excel!Excel.CardLayoutStandardProperties#sections:member + package: excel! + fullName: sections + summary: Represents the sections of the card. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'sections?: CardLayoutSection[];' + return: + type: [] + - name: subTitle + uid: excel!Excel.CardLayoutStandardProperties#subTitle:member + package: excel! + fullName: subTitle + summary: >- + Represents a specification of which property contains the subtitle of the + card. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'subTitle?: CardLayoutPropertyReference;' + return: + type: + - name: title + uid: excel!Excel.CardLayoutStandardProperties#title:member + package: excel! + fullName: title + summary: >- + Represents the title of the card or the specification of which property + contains the title of the card. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'title?: string | CardLayoutPropertyReference;' + return: + type: >- + string | diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayouttablesection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayouttablesection.yml new file mode 100644 index 0000000000..8e98e4ae22 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayouttablesection.yml @@ -0,0 +1,31 @@ +### YamlMime:TSType +name: Excel.CardLayoutTableSection +uid: excel!Excel.CardLayoutTableSection:interface +package: excel! +fullName: Excel.CardLayoutTableSection +summary: Represents a section of a card that is arranged as a table in card view. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: layout + uid: excel!Excel.CardLayoutTableSection#layout:member + package: excel! + fullName: layout + summary: Represents the type of layout for this section. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'layout: "Table";' + return: + type: '"Table"' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayouttwocolumnsection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayouttwocolumnsection.yml new file mode 100644 index 0000000000..ed14ea2baf --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayouttwocolumnsection.yml @@ -0,0 +1,31 @@ +### YamlMime:TSType +name: Excel.CardLayoutTwoColumnSection +uid: excel!Excel.CardLayoutTwoColumnSection:interface +package: excel! +fullName: Excel.CardLayoutTwoColumnSection +summary: Represents a section of a card that is arranged as two columns in card view. +remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: layout + uid: excel!Excel.CardLayoutTwoColumnSection#layout:member + package: excel! + fullName: layout + summary: Represents the type of layout for this section. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'layout: "TwoColumn";' + return: + type: '"TwoColumn"' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.cellborder.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellborder.yml new file mode 100644 index 0000000000..bc2f00c585 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellborder.yml @@ -0,0 +1,86 @@ +### YamlMime:TSType +name: Excel.CellBorder +uid: excel!Excel.CellBorder:interface +package: excel! +fullName: Excel.CellBorder +summary: >- + Represents the properties of a single border returned by + `getCellProperties`, `getRowProperties`, and + `getColumnProperties`, or the border property input parameter of + `setCellProperties`, `setRowProperties`, and + `setColumnProperties`. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: color + uid: excel!Excel.CellBorder#color:member + package: excel! + fullName: color + summary: Represents the `color` property of a single border. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: string;' + return: + type: string + - name: style + uid: excel!Excel.CellBorder#style:member + package: excel! + fullName: style + summary: Represents the `style` property of a single border. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + style?: Excel.BorderLineStyle | "None" | "Continuous" | "Dash" | + "DashDot" | "DashDotDot" | "Dot" | "Double" | "SlantDashDot"; + return: + type: >- + | "None" | + "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot" | "Double" | + "SlantDashDot" + - name: tintAndShade + uid: excel!Excel.CellBorder#tintAndShade:member + package: excel! + fullName: tintAndShade + summary: Represents the `tintAndShade` property of a single border. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tintAndShade?: number;' + return: + type: number + - name: weight + uid: excel!Excel.CellBorder#weight:member + package: excel! + fullName: weight + summary: Represents the `weight` property of a single border. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'weight?: Excel.BorderWeight | "Hairline" | "Thin" | "Medium" | "Thick";' + return: + type: >- + | "Hairline" | "Thin" | + "Medium" | "Thick" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.cellbordercollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellbordercollection.yml new file mode 100644 index 0000000000..978a0a9ba1 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellbordercollection.yml @@ -0,0 +1,138 @@ +### YamlMime:TSType +name: Excel.CellBorderCollection +uid: excel!Excel.CellBorderCollection:interface +package: excel! +fullName: Excel.CellBorderCollection +summary: >- + Represents the `format.borders` properties of `getCellProperties`, + `getRowProperties`, and `getColumnProperties`, or the + `format.borders` input parameter of `setCellProperties`, + `setRowProperties`, and `setColumnProperties`. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: bottom + uid: excel!Excel.CellBorderCollection#bottom:member + package: excel! + fullName: bottom + summary: Represents the `format.borders.bottom` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'bottom?: Excel.CellBorder;' + return: + type: + - name: diagonalDown + uid: excel!Excel.CellBorderCollection#diagonalDown:member + package: excel! + fullName: diagonalDown + summary: Represents the `format.borders.diagonalDown` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'diagonalDown?: Excel.CellBorder;' + return: + type: + - name: diagonalUp + uid: excel!Excel.CellBorderCollection#diagonalUp:member + package: excel! + fullName: diagonalUp + summary: Represents the `format.borders.diagonalUp` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'diagonalUp?: Excel.CellBorder;' + return: + type: + - name: horizontal + uid: excel!Excel.CellBorderCollection#horizontal:member + package: excel! + fullName: horizontal + summary: Represents the `format.borders.horizontal` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'horizontal?: Excel.CellBorder;' + return: + type: + - name: left + uid: excel!Excel.CellBorderCollection#left:member + package: excel! + fullName: left + summary: Represents the `format.borders.left` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: Excel.CellBorder;' + return: + type: + - name: right + uid: excel!Excel.CellBorderCollection#right:member + package: excel! + fullName: right + summary: Represents the `format.borders.right` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'right?: Excel.CellBorder;' + return: + type: + - name: top + uid: excel!Excel.CellBorderCollection#top:member + package: excel! + fullName: top + summary: Represents the `format.borders.top` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: Excel.CellBorder;' + return: + type: + - name: vertical + uid: excel!Excel.CellBorderCollection#vertical:member + package: excel! + fullName: vertical + summary: Represents the `format.borders.vertical` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'vertical?: Excel.CellBorder;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.cellcontrol.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellcontrol.yml new file mode 100644 index 0000000000..5e5954d3df --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellcontrol.yml @@ -0,0 +1,53 @@ +### YamlMime:TSTypeAlias +name: Excel.CellControl +uid: excel!Excel.CellControl:type +package: excel! +fullName: Excel.CellControl +summary: Represents an interactable control inside of a cell. +remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + + + Learn more about the types in this type alias through the following links. + + + [Excel.UnknownCellControl](/javascript/api/excel/excel.unknowncellcontrol), + [Excel.EmptyCellControl](/javascript/api/excel/excel.emptycellcontrol), + [Excel.MixedCellControl](/javascript/api/excel/excel.mixedcellcontrol), + [Excel.CheckboxCellControl](/javascript/api/excel/excel.checkboxcellcontrol) + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml + + + // Add checkboxes to the table. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Get the second column in the table, without the header. + const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange(); + + // Change the boolean values to checkboxes. + range.control = { + type: Excel.CellControlType.checkbox + }; + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +syntax: >- + export type CellControl = UnknownCellControl | EmptyCellControl | + MixedCellControl | CheckboxCellControl; diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.cellcontroltype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellcontroltype.yml new file mode 100644 index 0000000000..96467691f0 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellcontroltype.yml @@ -0,0 +1,86 @@ +### YamlMime:TSEnum +name: Excel.CellControlType +uid: excel!Excel.CellControlType:enum +package: excel! +fullName: Excel.CellControlType +summary: Represents the type of cell control. +remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml + + + // Add checkboxes to the table. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Get the second column in the table, without the header. + const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange(); + + // Change the boolean values to checkboxes. + range.control = { + type: Excel.CellControlType.checkbox + }; + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: checkbox + uid: excel!Excel.CellControlType.checkbox:member + package: excel! + summary: >- + Type representing a checkbox control. + + + * \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Checkbox"' + - name: empty + uid: excel!Excel.CellControlType.empty:member + package: excel! + summary: >- + Type representing an empty control. + + + * \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Empty"' + - name: mixed + uid: excel!Excel.CellControlType.mixed:member + package: excel! + summary: >- + Type representing a query that results in a mix of control results. + + + * \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Mixed"' + - name: unknown + uid: excel!Excel.CellControlType.unknown:member + package: excel! + summary: >- + Type representing an unknown control. This represents a control that was + added in a future version of Excel, and the current version of Excel + doesn't know how to display this control. + + + * \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Unknown"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.cellproperties.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellproperties.yml new file mode 100644 index 0000000000..6d74ebda32 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellproperties.yml @@ -0,0 +1,72 @@ +### YamlMime:TSType +name: Excel.CellProperties +uid: excel!Excel.CellProperties:interface +package: excel! +fullName: Excel.CellProperties +summary: >- + Represents the returned properties of getCellProperties. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: address + uid: excel!Excel.CellProperties#address:member + package: excel! + fullName: address + summary: >- + Represents the `address` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'address?: string;' + return: + type: string + - name: addressLocal + uid: excel!Excel.CellProperties#addressLocal:member + package: excel! + fullName: addressLocal + summary: >- + Represents the `addressLocal` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'addressLocal?: string;' + return: + type: string + - name: hidden + uid: excel!Excel.CellProperties#hidden:member + package: excel! + fullName: hidden + summary: >- + Represents the `hidden` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'hidden?: boolean;' + return: + type: boolean +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.cellpropertiesborderloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellpropertiesborderloadoptions.yml new file mode 100644 index 0000000000..8d4c795f01 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellpropertiesborderloadoptions.yml @@ -0,0 +1,74 @@ +### YamlMime:TSType +name: Excel.CellPropertiesBorderLoadOptions +uid: excel!Excel.CellPropertiesBorderLoadOptions:interface +package: excel! +fullName: Excel.CellPropertiesBorderLoadOptions +summary: Specifies which properties to load on the `format.borders` object. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: color + uid: excel!Excel.CellPropertiesBorderLoadOptions#color:member + package: excel! + fullName: color + summary: Specifies whether to load the `color` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: boolean;' + return: + type: boolean + - name: style + uid: excel!Excel.CellPropertiesBorderLoadOptions#style:member + package: excel! + fullName: style + summary: Specifies whether to load the `style` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'style?: boolean;' + return: + type: boolean + - name: tintAndShade + uid: excel!Excel.CellPropertiesBorderLoadOptions#tintAndShade:member + package: excel! + fullName: tintAndShade + summary: Specifies whether to load the `tintAndShade` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tintAndShade?: boolean;' + return: + type: boolean + - name: weight + uid: excel!Excel.CellPropertiesBorderLoadOptions#weight:member + package: excel! + fullName: weight + summary: Specifies whether to load the `weight` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'weight?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.cellpropertiesfill.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellpropertiesfill.yml new file mode 100644 index 0000000000..b0081f14f4 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellpropertiesfill.yml @@ -0,0 +1,187 @@ +### YamlMime:TSType +name: Excel.CellPropertiesFill +uid: excel!Excel.CellPropertiesFill:interface +package: excel! +fullName: Excel.CellPropertiesFill +summary: >- + Represents the `format.fill` properties of `getCellProperties`, + `getRowProperties`, and `getColumnProperties` or the `format.fill` + input parameter of `setCellProperties`, `setRowProperties`, + and `setColumnProperties`. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: color + uid: excel!Excel.CellPropertiesFill#color:member + package: excel! + fullName: color + summary: Represents the `format.fill.color` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/cell-properties.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Creating the SettableCellProperties objects to use for the range. + // In your add-in, these should be created once, outside the function. + const topHeaderProps: Excel.SettableCellProperties = { + // The style property takes a string matching the name of an Excel style. + // Built-in style names are listed in the `BuiltInStyle` enum. + // Note that a style will overwrite any formatting, + // so do not use the format property with the style property. + style: "Heading1" + }; + + const headerProps: Excel.SettableCellProperties = { + // Any subproperties of format that are not set will not be changed when these cell properties are set. + format: { + fill: { + color: "Blue" + }, + font: { + color: "White", + bold: true + } + } + }; + + const nonApplicableProps: Excel.SettableCellProperties = { + format: { + fill: { + pattern: Excel.FillPattern.gray25 + }, + font: { + color: "Gray", + italic: true + } + } + }; + + const matchupScoreProps: Excel.SettableCellProperties = { + format: { + borders: { + bottom: { + style: Excel.BorderLineStyle.continuous + }, + left: { + style: Excel.BorderLineStyle.continuous + }, + right: { + style: Excel.BorderLineStyle.continuous + }, + top: { + style: Excel.BorderLineStyle.continuous + } + } + } + }; + + const range = sheet.getRange("A1:E5"); + + // You can use empty JSON objects to avoid changing a cell's properties. + range.setCellProperties([ + [topHeaderProps, {}, {}, {}, {}], + [{}, {}, headerProps, headerProps, headerProps], + [{}, headerProps, nonApplicableProps, matchupScoreProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, nonApplicableProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, matchupScoreProps, nonApplicableProps] + ]); + + sheet.getUsedRange().format.autofitColumns(); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: string;' + return: + type: string + - name: pattern + uid: excel!Excel.CellPropertiesFill#pattern:member + package: excel! + fullName: pattern + summary: Represents the `format.fill.pattern` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + pattern?: Excel.FillPattern | "None" | "Solid" | "Gray50" | "Gray75" | + "Gray25" | "Horizontal" | "Vertical" | "Down" | "Up" | "Checker" | + "SemiGray75" | "LightHorizontal" | "LightVertical" | "LightDown" | + "LightUp" | "Grid" | "CrissCross" | "Gray16" | "Gray8" | + "LinearGradient" | "RectangularGradient"; + return: + type: >- + | "None" | "Solid" | + "Gray50" | "Gray75" | "Gray25" | "Horizontal" | "Vertical" | "Down" | + "Up" | "Checker" | "SemiGray75" | "LightHorizontal" | "LightVertical" + | "LightDown" | "LightUp" | "Grid" | "CrissCross" | "Gray16" | "Gray8" + | "LinearGradient" | "RectangularGradient" + - name: patternColor + uid: excel!Excel.CellPropertiesFill#patternColor:member + package: excel! + fullName: patternColor + summary: Represents the `format.fill.patternColor` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'patternColor?: string;' + return: + type: string + - name: patternTintAndShade + uid: excel!Excel.CellPropertiesFill#patternTintAndShade:member + package: excel! + fullName: patternTintAndShade + summary: Represents the `format.fill.patternTintAndShade` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'patternTintAndShade?: number;' + return: + type: number + - name: tintAndShade + uid: excel!Excel.CellPropertiesFill#tintAndShade:member + package: excel! + fullName: tintAndShade + summary: Represents the `format.fill.tintAndShade` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tintAndShade?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.cellpropertiesfillloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellpropertiesfillloadoptions.yml new file mode 100644 index 0000000000..a031b4608e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellpropertiesfillloadoptions.yml @@ -0,0 +1,125 @@ +### YamlMime:TSType +name: Excel.CellPropertiesFillLoadOptions +uid: excel!Excel.CellPropertiesFillLoadOptions:interface +package: excel! +fullName: Excel.CellPropertiesFillLoadOptions +summary: Specifies which properties to load on the `format.fill` object. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: color + uid: excel!Excel.CellPropertiesFillLoadOptions#color:member + package: excel! + fullName: color + summary: Specifies whether to load the `color` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/cell-properties.yaml + + + await Excel.run(async (context) => { + const cell = context.workbook.getActiveCell(); + + // Define the cell properties to get by setting the matching LoadOptions to true. + const propertiesToGet = cell.getCellProperties({ + address: true, + format: { + fill: { + color: true + }, + font: { + color: true + } + }, + style: true + }); + + // Sync to get the data from the workbook. + await context.sync(); + const cellProperties = propertiesToGet.value[0][0]; + console.log( + `Address: ${cellProperties.address}\nStyle: ${cellProperties.style}\nFill Color: ${cellProperties.format.fill.color}\nFont Color: ${cellProperties.format.font.color}`); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: boolean;' + return: + type: boolean + - name: pattern + uid: excel!Excel.CellPropertiesFillLoadOptions#pattern:member + package: excel! + fullName: pattern + summary: Specifies whether to load the `pattern` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'pattern?: boolean;' + return: + type: boolean + - name: patternColor + uid: excel!Excel.CellPropertiesFillLoadOptions#patternColor:member + package: excel! + fullName: patternColor + summary: Specifies whether to load the `patternColor` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'patternColor?: boolean;' + return: + type: boolean + - name: patternTintAndShade + uid: excel!Excel.CellPropertiesFillLoadOptions#patternTintAndShade:member + package: excel! + fullName: patternTintAndShade + summary: Specifies whether to load the `patternTintAndShade` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'patternTintAndShade?: boolean;' + return: + type: boolean + - name: tintAndShade + uid: excel!Excel.CellPropertiesFillLoadOptions#tintAndShade:member + package: excel! + fullName: tintAndShade + summary: Specifies whether to load the `tintAndShade` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tintAndShade?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.cellpropertiesfont.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellpropertiesfont.yml new file mode 100644 index 0000000000..94da68a34e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellpropertiesfont.yml @@ -0,0 +1,256 @@ +### YamlMime:TSType +name: Excel.CellPropertiesFont +uid: excel!Excel.CellPropertiesFont:interface +package: excel! +fullName: Excel.CellPropertiesFont +summary: >- + Represents the `format.font` properties of `getCellProperties`, + `getRowProperties`, and `getColumnProperties`, or the + `format.font` input parameter of `setCellProperties`, + `setRowProperties`, and `setColumnProperties`. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: bold + uid: excel!Excel.CellPropertiesFont#bold:member + package: excel! + fullName: bold + summary: Represents the `format.font.bold` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'bold?: boolean;' + return: + type: boolean + - name: color + uid: excel!Excel.CellPropertiesFont#color:member + package: excel! + fullName: color + summary: Represents the `format.font.color` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/cell-properties.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Creating the SettableCellProperties objects to use for the range. + // In your add-in, these should be created once, outside the function. + const topHeaderProps: Excel.SettableCellProperties = { + // The style property takes a string matching the name of an Excel style. + // Built-in style names are listed in the `BuiltInStyle` enum. + // Note that a style will overwrite any formatting, + // so do not use the format property with the style property. + style: "Heading1" + }; + + const headerProps: Excel.SettableCellProperties = { + // Any subproperties of format that are not set will not be changed when these cell properties are set. + format: { + fill: { + color: "Blue" + }, + font: { + color: "White", + bold: true + } + } + }; + + const nonApplicableProps: Excel.SettableCellProperties = { + format: { + fill: { + pattern: Excel.FillPattern.gray25 + }, + font: { + color: "Gray", + italic: true + } + } + }; + + const matchupScoreProps: Excel.SettableCellProperties = { + format: { + borders: { + bottom: { + style: Excel.BorderLineStyle.continuous + }, + left: { + style: Excel.BorderLineStyle.continuous + }, + right: { + style: Excel.BorderLineStyle.continuous + }, + top: { + style: Excel.BorderLineStyle.continuous + } + } + } + }; + + const range = sheet.getRange("A1:E5"); + + // You can use empty JSON objects to avoid changing a cell's properties. + range.setCellProperties([ + [topHeaderProps, {}, {}, {}, {}], + [{}, {}, headerProps, headerProps, headerProps], + [{}, headerProps, nonApplicableProps, matchupScoreProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, nonApplicableProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, matchupScoreProps, nonApplicableProps] + ]); + + sheet.getUsedRange().format.autofitColumns(); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: string;' + return: + type: string + - name: italic + uid: excel!Excel.CellPropertiesFont#italic:member + package: excel! + fullName: italic + summary: Represents the `format.font.italic` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'italic?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.CellPropertiesFont#name:member + package: excel! + fullName: name + summary: Represents the `format.font.name` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: size + uid: excel!Excel.CellPropertiesFont#size:member + package: excel! + fullName: size + summary: Represents the `format.font.size` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'size?: number;' + return: + type: number + - name: strikethrough + uid: excel!Excel.CellPropertiesFont#strikethrough:member + package: excel! + fullName: strikethrough + summary: Represents the `format.font.strikethrough` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'strikethrough?: boolean;' + return: + type: boolean + - name: subscript + uid: excel!Excel.CellPropertiesFont#subscript:member + package: excel! + fullName: subscript + summary: Represents the `format.font.subscript` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'subscript?: boolean;' + return: + type: boolean + - name: superscript + uid: excel!Excel.CellPropertiesFont#superscript:member + package: excel! + fullName: superscript + summary: Represents the `format.font.superscript` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'superscript?: boolean;' + return: + type: boolean + - name: tintAndShade + uid: excel!Excel.CellPropertiesFont#tintAndShade:member + package: excel! + fullName: tintAndShade + summary: Represents the `format.font.tintAndShade` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tintAndShade?: number;' + return: + type: number + - name: underline + uid: excel!Excel.CellPropertiesFont#underline:member + package: excel! + fullName: underline + summary: Represents the `format.font.underline` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + underline?: Excel.RangeUnderlineStyle | "None" | "Single" | "Double" | + "SingleAccountant" | "DoubleAccountant"; + return: + type: >- + | "None" | + "Single" | "Double" | "SingleAccountant" | "DoubleAccountant" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.cellpropertiesfontloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellpropertiesfontloadoptions.yml new file mode 100644 index 0000000000..879e553f1d --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellpropertiesfontloadoptions.yml @@ -0,0 +1,200 @@ +### YamlMime:TSType +name: Excel.CellPropertiesFontLoadOptions +uid: excel!Excel.CellPropertiesFontLoadOptions:interface +package: excel! +fullName: Excel.CellPropertiesFontLoadOptions +summary: Specifies which properties to load on the `format.font` object. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: bold + uid: excel!Excel.CellPropertiesFontLoadOptions#bold:member + package: excel! + fullName: bold + summary: Specifies whether to load the `bold` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'bold?: boolean;' + return: + type: boolean + - name: color + uid: excel!Excel.CellPropertiesFontLoadOptions#color:member + package: excel! + fullName: color + summary: Specifies whether to load the `color` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/cell-properties.yaml + + + await Excel.run(async (context) => { + const cell = context.workbook.getActiveCell(); + + // Define the cell properties to get by setting the matching LoadOptions to true. + const propertiesToGet = cell.getCellProperties({ + address: true, + format: { + fill: { + color: true + }, + font: { + color: true + } + }, + style: true + }); + + // Sync to get the data from the workbook. + await context.sync(); + const cellProperties = propertiesToGet.value[0][0]; + console.log( + `Address: ${cellProperties.address}\nStyle: ${cellProperties.style}\nFill Color: ${cellProperties.format.fill.color}\nFont Color: ${cellProperties.format.font.color}`); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: boolean;' + return: + type: boolean + - name: italic + uid: excel!Excel.CellPropertiesFontLoadOptions#italic:member + package: excel! + fullName: italic + summary: Specifies whether to load the `italic` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'italic?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.CellPropertiesFontLoadOptions#name:member + package: excel! + fullName: name + summary: Specifies whether to load the `name` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: size + uid: excel!Excel.CellPropertiesFontLoadOptions#size:member + package: excel! + fullName: size + summary: Specifies whether to load the `size` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'size?: boolean;' + return: + type: boolean + - name: strikethrough + uid: excel!Excel.CellPropertiesFontLoadOptions#strikethrough:member + package: excel! + fullName: strikethrough + summary: Specifies whether to load the `strikethrough` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'strikethrough?: boolean;' + return: + type: boolean + - name: subscript + uid: excel!Excel.CellPropertiesFontLoadOptions#subscript:member + package: excel! + fullName: subscript + summary: Specifies whether to load the `subscript` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'subscript?: boolean;' + return: + type: boolean + - name: superscript + uid: excel!Excel.CellPropertiesFontLoadOptions#superscript:member + package: excel! + fullName: superscript + summary: Specifies whether to load the `superscript` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'superscript?: boolean;' + return: + type: boolean + - name: tintAndShade + uid: excel!Excel.CellPropertiesFontLoadOptions#tintAndShade:member + package: excel! + fullName: tintAndShade + summary: Specifies whether to load the `tintAndShade` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tintAndShade?: boolean;' + return: + type: boolean + - name: underline + uid: excel!Excel.CellPropertiesFontLoadOptions#underline:member + package: excel! + fullName: underline + summary: Specifies whether to load the `underline` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'underline?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.cellpropertiesformat.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellpropertiesformat.yml new file mode 100644 index 0000000000..112810501c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellpropertiesformat.yml @@ -0,0 +1,284 @@ +### YamlMime:TSType +name: Excel.CellPropertiesFormat +uid: excel!Excel.CellPropertiesFormat:interface +package: excel! +fullName: Excel.CellPropertiesFormat +summary: >- + Represents the returned format properties of getCellProperties or format input + parameter of setCellProperties. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: autoIndent + uid: excel!Excel.CellPropertiesFormat#autoIndent:member + package: excel! + fullName: autoIndent + summary: >- + Represents the `autoIndent` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'autoIndent?: boolean;' + return: + type: boolean + - name: borders + uid: excel!Excel.CellPropertiesFormat#borders:member + package: excel! + fullName: borders + summary: >- + Represents the `borders` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'borders?: Excel.CellBorderCollection;' + return: + type: + - name: fill + uid: excel!Excel.CellPropertiesFormat#fill:member + package: excel! + fullName: fill + summary: >- + Represents the `fill` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'fill?: Excel.CellPropertiesFill;' + return: + type: + - name: font + uid: excel!Excel.CellPropertiesFormat#font:member + package: excel! + fullName: font + summary: >- + Represents the `font` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.CellPropertiesFont;' + return: + type: + - name: horizontalAlignment + uid: excel!Excel.CellPropertiesFormat#horizontalAlignment:member + package: excel! + fullName: horizontalAlignment + summary: >- + Represents the `horizontalAlignment` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + horizontalAlignment?: Excel.HorizontalAlignment | "General" | "Left" | + "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | + "Distributed"; + return: + type: >- + | "General" | + "Left" | "Center" | "Right" | "Fill" | "Justify" | + "CenterAcrossSelection" | "Distributed" + - name: indentLevel + uid: excel!Excel.CellPropertiesFormat#indentLevel:member + package: excel! + fullName: indentLevel + summary: >- + Represents the `indentLevel` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'indentLevel?: number;' + return: + type: number + - name: protection + uid: excel!Excel.CellPropertiesFormat#protection:member + package: excel! + fullName: protection + summary: >- + Represents the `protection` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'protection?: Excel.CellPropertiesProtection;' + return: + type: + - name: readingOrder + uid: excel!Excel.CellPropertiesFormat#readingOrder:member + package: excel! + fullName: readingOrder + summary: >- + Represents the `readingOrder` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + readingOrder?: Excel.ReadingOrder | "Context" | "LeftToRight" | + "RightToLeft"; + return: + type: >- + | "Context" | + "LeftToRight" | "RightToLeft" + - name: shrinkToFit + uid: excel!Excel.CellPropertiesFormat#shrinkToFit:member + package: excel! + fullName: shrinkToFit + summary: >- + Represents the `shrinkToFit` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'shrinkToFit?: boolean;' + return: + type: boolean + - name: textOrientation + uid: excel!Excel.CellPropertiesFormat#textOrientation:member + package: excel! + fullName: textOrientation + summary: >- + Represents the `textOrientation` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'textOrientation?: number;' + return: + type: number + - name: useStandardHeight + uid: excel!Excel.CellPropertiesFormat#useStandardHeight:member + package: excel! + fullName: useStandardHeight + summary: >- + Represents the `useStandardHeight` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'useStandardHeight?: boolean;' + return: + type: boolean + - name: useStandardWidth + uid: excel!Excel.CellPropertiesFormat#useStandardWidth:member + package: excel! + fullName: useStandardWidth + summary: >- + Represents the `useStandardWidth` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'useStandardWidth?: boolean;' + return: + type: boolean + - name: verticalAlignment + uid: excel!Excel.CellPropertiesFormat#verticalAlignment:member + package: excel! + fullName: verticalAlignment + summary: >- + Represents the `verticalAlignment` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + verticalAlignment?: Excel.VerticalAlignment | "Top" | "Center" | + "Bottom" | "Justify" | "Distributed"; + return: + type: >- + | "Top" | "Center" | + "Bottom" | "Justify" | "Distributed" + - name: wrapText + uid: excel!Excel.CellPropertiesFormat#wrapText:member + package: excel! + fullName: wrapText + summary: >- + Represents the `wrapText` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'wrapText?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.cellpropertiesformatloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellpropertiesformatloadoptions.yml new file mode 100644 index 0000000000..711750f686 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellpropertiesformatloadoptions.yml @@ -0,0 +1,269 @@ +### YamlMime:TSType +name: Excel.CellPropertiesFormatLoadOptions +uid: excel!Excel.CellPropertiesFormatLoadOptions:interface +package: excel! +fullName: Excel.CellPropertiesFormatLoadOptions +summary: >- + Represents which properties to load on the format object. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: autoIndent + uid: excel!Excel.CellPropertiesFormatLoadOptions#autoIndent:member + package: excel! + fullName: autoIndent + summary: >- + Specifies whether to load on the `autoIndent` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'autoIndent?: boolean;' + return: + type: boolean + - name: borders + uid: excel!Excel.CellPropertiesFormatLoadOptions#borders:member + package: excel! + fullName: borders + summary: >- + Specifies whether to load on the `borders` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'borders?: Excel.CellPropertiesBorderLoadOptions;' + return: + type: + - name: fill + uid: excel!Excel.CellPropertiesFormatLoadOptions#fill:member + package: excel! + fullName: fill + summary: >- + Specifies whether to load on the `fill` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'fill?: Excel.CellPropertiesFillLoadOptions;' + return: + type: + - name: font + uid: excel!Excel.CellPropertiesFormatLoadOptions#font:member + package: excel! + fullName: font + summary: >- + Specifies whether to load on the `font` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.CellPropertiesFontLoadOptions;' + return: + type: + - name: horizontalAlignment + uid: excel!Excel.CellPropertiesFormatLoadOptions#horizontalAlignment:member + package: excel! + fullName: horizontalAlignment + summary: >- + Specifies whether to load on the `horizontalAlignment` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'horizontalAlignment?: boolean;' + return: + type: boolean + - name: indentLevel + uid: excel!Excel.CellPropertiesFormatLoadOptions#indentLevel:member + package: excel! + fullName: indentLevel + summary: >- + Specifies whether to load on the `indentLevel` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'indentLevel?: boolean;' + return: + type: boolean + - name: protection + uid: excel!Excel.CellPropertiesFormatLoadOptions#protection:member + package: excel! + fullName: protection + summary: >- + Specifies whether to load on the `protection` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'protection?: boolean;' + return: + type: boolean + - name: readingOrder + uid: excel!Excel.CellPropertiesFormatLoadOptions#readingOrder:member + package: excel! + fullName: readingOrder + summary: >- + Specifies whether to load on the `readingOrder` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readingOrder?: boolean;' + return: + type: boolean + - name: shrinkToFit + uid: excel!Excel.CellPropertiesFormatLoadOptions#shrinkToFit:member + package: excel! + fullName: shrinkToFit + summary: >- + Specifies whether to load on the `shrinkToFit` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'shrinkToFit?: boolean;' + return: + type: boolean + - name: textOrientation + uid: excel!Excel.CellPropertiesFormatLoadOptions#textOrientation:member + package: excel! + fullName: textOrientation + summary: >- + Specifies whether to load on the `textOrientation` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'textOrientation?: boolean;' + return: + type: boolean + - name: useStandardHeight + uid: excel!Excel.CellPropertiesFormatLoadOptions#useStandardHeight:member + package: excel! + fullName: useStandardHeight + summary: >- + Specifies whether to load on the `useStandardHeight` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'useStandardHeight?: boolean;' + return: + type: boolean + - name: useStandardWidth + uid: excel!Excel.CellPropertiesFormatLoadOptions#useStandardWidth:member + package: excel! + fullName: useStandardWidth + summary: >- + Specifies whether to load on the `useStandardWidth` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'useStandardWidth?: boolean;' + return: + type: boolean + - name: verticalAlignment + uid: excel!Excel.CellPropertiesFormatLoadOptions#verticalAlignment:member + package: excel! + fullName: verticalAlignment + summary: >- + Specifies whether to load on the `verticalAlignment` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'verticalAlignment?: boolean;' + return: + type: boolean + - name: wrapText + uid: excel!Excel.CellPropertiesFormatLoadOptions#wrapText:member + package: excel! + fullName: wrapText + summary: >- + Specifies whether to load on the `wrapText` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'wrapText?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.cellpropertiesloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellpropertiesloadoptions.yml new file mode 100644 index 0000000000..4f2e313968 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellpropertiesloadoptions.yml @@ -0,0 +1,179 @@ +### YamlMime:TSType +name: Excel.CellPropertiesLoadOptions +uid: excel!Excel.CellPropertiesLoadOptions:interface +package: excel! +fullName: Excel.CellPropertiesLoadOptions +summary: >- + Represents which cell properties to load, when used as part of a + "range.getCellProperties" method. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: address + uid: excel!Excel.CellPropertiesLoadOptions#address:member + package: excel! + fullName: address + summary: >- + Specifies whether to load on the `address` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'address?: boolean;' + return: + type: boolean + description: >- + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/cell-properties.yaml + + + await Excel.run(async (context) => { + const cell = context.workbook.getActiveCell(); + + // Define the cell properties to get by setting the matching LoadOptions to true. + const propertiesToGet = cell.getCellProperties({ + address: true, + format: { + fill: { + color: true + }, + font: { + color: true + } + }, + style: true + }); + + // Sync to get the data from the workbook. + await context.sync(); + const cellProperties = propertiesToGet.value[0][0]; + console.log( + `Address: ${cellProperties.address}\nStyle: ${cellProperties.style}\nFill Color: ${cellProperties.format.fill.color}\nFont Color: ${cellProperties.format.font.color}`); + }); + + ``` + - name: addressLocal + uid: excel!Excel.CellPropertiesLoadOptions#addressLocal:member + package: excel! + fullName: addressLocal + summary: >- + Specifies whether to load on the `addressLocal` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'addressLocal?: boolean;' + return: + type: boolean + - name: format + uid: excel!Excel.CellPropertiesLoadOptions#format:member + package: excel! + fullName: format + summary: >- + Specifies whether to load on the `format` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.CellPropertiesFormatLoadOptions;' + return: + type: + - name: hidden + uid: excel!Excel.CellPropertiesLoadOptions#hidden:member + package: excel! + fullName: hidden + summary: >- + Specifies whether to load on the `hidden` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'hidden?: boolean;' + return: + type: boolean + - name: hyperlink + uid: excel!Excel.CellPropertiesLoadOptions#hyperlink:member + package: excel! + fullName: hyperlink + summary: >- + Specifies whether to load on the `hyperlink` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'hyperlink?: boolean;' + return: + type: boolean + - name: style + uid: excel!Excel.CellPropertiesLoadOptions#style:member + package: excel! + fullName: style + summary: >- + Specifies whether to load on the `style` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'style?: boolean;' + return: + type: boolean + - name: textRuns + uid: excel!Excel.CellPropertiesLoadOptions#textRuns:member + package: excel! + fullName: textRuns + summary: Specifies whether to load on the `textRuns` property. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textRuns?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.cellpropertiesprotection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellpropertiesprotection.yml new file mode 100644 index 0000000000..d7bf9c2877 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellpropertiesprotection.yml @@ -0,0 +1,48 @@ +### YamlMime:TSType +name: Excel.CellPropertiesProtection +uid: excel!Excel.CellPropertiesProtection:interface +package: excel! +fullName: Excel.CellPropertiesProtection +summary: >- + Represents the `format.protection` properties of `getCellProperties`, + `getRowProperties`, and `getColumnProperties`, or the + `format.protection` input parameter of `setCellProperties`, + `setRowProperties`, and `setColumnProperties`. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: formulaHidden + uid: excel!Excel.CellPropertiesProtection#formulaHidden:member + package: excel! + fullName: formulaHidden + summary: Represents the `format.protection.formulaHidden` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulaHidden?: boolean;' + return: + type: boolean + - name: locked + uid: excel!Excel.CellPropertiesProtection#locked:member + package: excel! + fullName: locked + summary: Represents the `format.protection.locked` property. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'locked?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvalue.yml new file mode 100644 index 0000000000..4722937ebb --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvalue.yml @@ -0,0 +1,37 @@ +### YamlMime:TSTypeAlias +name: Excel.CellValue +uid: excel!Excel.CellValue:type +package: excel! +fullName: Excel.CellValue +summary: Represents the value in a cell. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), + [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), + [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), + [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), + [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), + [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), + [Excel.FormattedNumberCellValue](/javascript/api/excel/excel.formattednumbercellvalue), + [Excel.FunctionCellValue](/javascript/api/excel/excel.functioncellvalue), + [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), + [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), + [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), + [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), + [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), + [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties) + +isPreview: false +isDeprecated: false +syntax: >- + export type CellValue = (ArrayCellValue | BooleanCellValue | DoubleCellValue | + EntityCellValue | EmptyCellValue | ErrorCellValue | FormattedNumberCellValue | + FunctionCellValue | LinkedEntityCellValue | ReferenceCellValue | + StringCellValue | ValueTypeNotAvailableCellValue | WebImageCellValue) & + CellValueExtraProperties; diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvalueandpropertymetadata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvalueandpropertymetadata.yml new file mode 100644 index 0000000000..5f661bb32f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvalueandpropertymetadata.yml @@ -0,0 +1,24 @@ +### YamlMime:TSTypeAlias +name: Excel.CellValueAndPropertyMetadata +uid: excel!Excel.CellValueAndPropertyMetadata:type +package: excel! +fullName: Excel.CellValueAndPropertyMetadata +summary: >- + Represents the value and metadata of a property. The metadata applies to the + property (and not the value), but it is combined with the value in this type. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CellValue](/javascript/api/excel/excel.cellvalue), + [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties) + +isPreview: false +isDeprecated: false +syntax: >- + export type CellValueAndPropertyMetadata = (CellValue) & + EntityPropertyExtraProperties; diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvalueattributionattributes.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvalueattributionattributes.yml new file mode 100644 index 0000000000..64fe5b32bf --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvalueattributionattributes.yml @@ -0,0 +1,83 @@ +### YamlMime:TSType +name: Excel.CellValueAttributionAttributes +uid: excel!Excel.CellValueAttributionAttributes:interface +package: excel! +fullName: Excel.CellValueAttributionAttributes +summary: >- + The attribution attributes object represents the set of details that can be + used to describe where information came from, if the information comes from a + public source. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: licenseAddress + uid: excel!Excel.CellValueAttributionAttributes#licenseAddress:member + package: excel! + fullName: licenseAddress + summary: >- + Represents a URL to a license or source that describes how this property + can be used. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'licenseAddress?: string;' + return: + type: string + - name: licenseText + uid: excel!Excel.CellValueAttributionAttributes#licenseText:member + package: excel! + fullName: licenseText + summary: Represents a name for the license that governs this property. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'licenseText?: string;' + return: + type: string + - name: sourceAddress + uid: excel!Excel.CellValueAttributionAttributes#sourceAddress:member + package: excel! + fullName: sourceAddress + summary: Represents a URL to the source of the `CellValue`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'sourceAddress?: string;' + return: + type: string + - name: sourceText + uid: excel!Excel.CellValueAttributionAttributes#sourceText:member + package: excel! + fullName: sourceText + summary: Represents a name for the source of the `CellValue`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'sourceText?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvalueconditionalformat.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvalueconditionalformat.yml new file mode 100644 index 0000000000..34c4430696 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvalueconditionalformat.yml @@ -0,0 +1,269 @@ +### YamlMime:TSType +name: Excel.CellValueConditionalFormat +uid: excel!Excel.CellValueConditionalFormat:class +package: excel! +fullName: Excel.CellValueConditionalFormat +summary: Represents a cell value conditional format. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.CellValueConditionalFormat#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: format + uid: excel!Excel.CellValueConditionalFormat#format:member + package: excel! + fullName: format + summary: >- + Returns a format object, encapsulating the conditional formats font, fill, + borders, and other properties. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const range = sheet.getRange("B21:E23"); + const conditionalFormat = range.conditionalFormats + .add(Excel.ConditionalFormatType.cellValue); + conditionalFormat.cellValue.format.font.color = "red"; + conditionalFormat.cellValue.rule = { formula1: "=0", operator: "LessThan" }; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly format: Excel.ConditionalRangeFormat;' + return: + type: + - name: rule + uid: excel!Excel.CellValueConditionalFormat#rule:member + package: excel! + fullName: rule + summary: Specifies the rule object on this conditional format. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const range = sheet.getRange("B21:E23"); + const conditionalFormat = range.conditionalFormats + .add(Excel.ConditionalFormatType.cellValue); + conditionalFormat.cellValue.format.font.color = "red"; + conditionalFormat.cellValue.rule = { formula1: "=0", operator: "LessThan" }; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'rule: Excel.ConditionalCellValueRule;' + return: + type: +methods: + - name: load(options) + uid: excel!Excel.CellValueConditionalFormat#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.CellValueConditionalFormatLoadOptions): + Excel.CellValueConditionalFormat; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.CellValueConditionalFormat#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNames?: string | string[]): + Excel.CellValueConditionalFormat; + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.CellValueConditionalFormat#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.CellValueConditionalFormat; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.CellValueConditionalFormat#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.CellValueConditionalFormatUpdateData, + options?: OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.CellValueConditionalFormat#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.CellValueConditionalFormat): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.CellValueConditionalFormat#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.CellValueConditionalFormat` object is an API object, the `toJSON` + method returns a plain JavaScript object (typed as + `Excel.Interfaces.CellValueConditionalFormatData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.CellValueConditionalFormatData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvalueextraproperties.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvalueextraproperties.yml new file mode 100644 index 0000000000..4a6c2a482c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvalueextraproperties.yml @@ -0,0 +1,56 @@ +### YamlMime:TSType +name: Excel.CellValueExtraProperties +uid: excel!Excel.CellValueExtraProperties:interface +package: excel! +fullName: Excel.CellValueExtraProperties +summary: >- + These extra properties may appear on a `CellValue` and provide information + about that `CellValue`, but the extra properties are not part of the + value in the cell. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: writable + uid: excel!Excel.CellValueExtraProperties#writable:member + package: excel! + fullName: writable + summary: >- + Represents whether this `CellValue` will be used to overwrite a cell. When + false, APIs which would use this `CellValue` to overwrite a cell will + instead ignore this value without throwing an error. The default value is + true. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'writable?: boolean;' + return: + type: boolean + - name: writableNote + uid: excel!Excel.CellValueExtraProperties#writableNote:member + package: excel! + fullName: writableNote + summary: >- + Represents an explanation about why `CellValue.writable` is specified as + false. Note: This string is only available if `writable` is specified as + false. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'writableNote?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvaluepropertymetadata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvaluepropertymetadata.yml new file mode 100644 index 0000000000..052c02408a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvaluepropertymetadata.yml @@ -0,0 +1,66 @@ +### YamlMime:TSType +name: Excel.CellValuePropertyMetadata +uid: excel!Excel.CellValuePropertyMetadata:interface +package: excel! +fullName: Excel.CellValuePropertyMetadata +summary: Metadata about a property in `EntityCellValue.properties`. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: attribution + uid: excel!Excel.CellValuePropertyMetadata#attribution:member + package: excel! + fullName: attribution + summary: >- + Represents attribution information to describe the source and license + requirements for using this property. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'attribution?: CellValueAttributionAttributes[];' + return: + type: [] + - name: excludeFrom + uid: excel!Excel.CellValuePropertyMetadata#excludeFrom:member + package: excel! + fullName: excludeFrom + summary: Represents which features this property is excluded from. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'excludeFrom?: CellValuePropertyMetadataExclusions;' + return: + type: >- + + - name: sublabel + uid: excel!Excel.CellValuePropertyMetadata#sublabel:member + package: excel! + fullName: sublabel + summary: Represents the sublabel for this property shown in card view. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'sublabel?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvaluepropertymetadataexclusions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvaluepropertymetadataexclusions.yml new file mode 100644 index 0000000000..1432536b9a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvaluepropertymetadataexclusions.yml @@ -0,0 +1,92 @@ +### YamlMime:TSType +name: Excel.CellValuePropertyMetadataExclusions +uid: excel!Excel.CellValuePropertyMetadataExclusions:interface +package: excel! +fullName: Excel.CellValuePropertyMetadataExclusions +summary: >- + Represents the exclusion of a property in `EntityCellValue.properties` from + features of Excel. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: autoComplete + uid: excel!Excel.CellValuePropertyMetadataExclusions#autoComplete:member + package: excel! + fullName: autoComplete + summary: >- + True represents that the property is excluded from the properties shown by + auto complete. False and undefined represent the default behavior of + including the property. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'autoComplete?: boolean;' + return: + type: boolean + - name: calcCompare + uid: excel!Excel.CellValuePropertyMetadataExclusions#calcCompare:member + package: excel! + fullName: calcCompare + summary: >- + True represents that the property is excluded from the properties used to + compare cell values during recalc. False and undefined represent the + default behavior of including the property. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'calcCompare?: boolean;' + return: + type: boolean + - name: cardView + uid: excel!Excel.CellValuePropertyMetadataExclusions#cardView:member + package: excel! + fullName: cardView + summary: >- + True represents that the property is excluded from the properties shown by + card view. False and undefined represent the default behavior of including + the property. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'cardView?: boolean;' + return: + type: boolean + - name: dotNotation + uid: excel!Excel.CellValuePropertyMetadataExclusions#dotNotation:member + package: excel! + fullName: dotNotation + summary: >- + True represents that the property is excluded from the properties which + can be accessed via the FIELDVALUE function. False and undefined represent + the default behavior of including the property. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'dotNotation?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvalueproviderattributes.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvalueproviderattributes.yml new file mode 100644 index 0000000000..a79c10a25e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvalueproviderattributes.yml @@ -0,0 +1,72 @@ +### YamlMime:TSType +name: Excel.CellValueProviderAttributes +uid: excel!Excel.CellValueProviderAttributes:interface +package: excel! +fullName: Excel.CellValueProviderAttributes +summary: >- + The provider attributes object represents the set of details used in card view + to provide specified branding information for a `CellValue` type that supports + provider attributes. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: description + uid: excel!Excel.CellValueProviderAttributes#description:member + package: excel! + fullName: description + summary: >- + Represents the provider description property that is used in card view if + no logo is specified. If a logo is specified, this will be used as tooltip + text. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'description?: string;' + return: + type: string + - name: logoSourceAddress + uid: excel!Excel.CellValueProviderAttributes#logoSourceAddress:member + package: excel! + fullName: logoSourceAddress + summary: >- + Represents a URL used to download an image that will be used as a logo in + card view. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'logoSourceAddress?: string;' + return: + type: string + - name: logoTargetAddress + uid: excel!Excel.CellValueProviderAttributes#logoTargetAddress:member + package: excel! + fullName: logoTargetAddress + summary: >- + Represents a URL that is the navigation target if the user clicks on the + logo element in card view. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'logoTargetAddress?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvaluetype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvaluetype.yml new file mode 100644 index 0000000000..64399dd4eb --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvaluetype.yml @@ -0,0 +1,186 @@ +### YamlMime:TSEnum +name: Excel.CellValueType +uid: excel!Excel.CellValueType:enum +package: excel! +fullName: Excel.CellValueType +summary: Represents the types of the `CellValue` object. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml + + + // This function sets the value of cell A1 to a #BUSY! error using data types. + + await Excel.run(async (context) => { + // Retrieve the Sample worksheet and cell A1 on that sheet. + const sheet = context.workbook.worksheets.getItemOrNullObject("Sample"); + const range = sheet.getRange("A1"); + + // Get the error data type and set its type to `busy`. + const error: Excel.ErrorCellValue = { + type: Excel.CellValueType.error, + errorType: Excel.ErrorCellValueType.busy + }; + + // Set cell A1 as the busy error. + range.valuesAsJson = [[error]]; + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: array + uid: excel!Excel.CellValueType.array:member + package: excel! + summary: >- + Represents an `ArrayCellValue`. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Array"' + - name: boolean + uid: excel!Excel.CellValueType.boolean:member + package: excel! + summary: >- + Represents a `BooleanCellValue`. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Boolean"' + - name: double + uid: excel!Excel.CellValueType.double:member + package: excel! + summary: >- + Represents a `DoubleCellValue`. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Double"' + - name: empty + uid: excel!Excel.CellValueType.empty:member + package: excel! + summary: >- + Represents an `EmptyCellValue`. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Empty"' + - name: entity + uid: excel!Excel.CellValueType.entity:member + package: excel! + summary: >- + Represents an `EntityCellValue`. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Entity"' + - name: error + uid: excel!Excel.CellValueType.error:member + package: excel! + summary: >- + Represents an `ErrorCellValue`. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Error"' + - name: formattedNumber + uid: excel!Excel.CellValueType.formattedNumber:member + package: excel! + summary: >- + Represents a `FormattedNumberCellValue`. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"FormattedNumber"' + - name: function + uid: excel!Excel.CellValueType.function:member + package: excel! + summary: >- + Represents a `FunctionCellValue`. + + + * \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Function"' + - name: linkedEntity + uid: excel!Excel.CellValueType.linkedEntity:member + package: excel! + summary: >- + Represents a `LinkedEntityCellValue`. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"LinkedEntity"' + - name: notAvailable + uid: excel!Excel.CellValueType.notAvailable:member + package: excel! + summary: >- + Represents a `ValueTypeNotAvailableCellValue`. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"NotAvailable"' + - name: reference + uid: excel!Excel.CellValueType.reference:member + package: excel! + summary: >- + Represents a `ReferenceCellValue`. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Reference"' + - name: string + uid: excel!Excel.CellValueType.string:member + package: excel! + summary: >- + Represents a `StringCellValue`. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"String"' + - name: webImage + uid: excel!Excel.CellValueType.webImage:member + package: excel! + summary: >- + Represents a `WebImageCellValue`. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"WebImage"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.changedeventdetail.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.changedeventdetail.yml new file mode 100644 index 0000000000..b98e74f1dc --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.changedeventdetail.yml @@ -0,0 +1,128 @@ +### YamlMime:TSType +name: Excel.ChangedEventDetail +uid: excel!Excel.ChangedEventDetail:interface +package: excel! +fullName: Excel.ChangedEventDetail +summary: >- + Provides information about the details of a `WorksheetChangedEvent` or + `TableChangedEvent`. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: valueAfter + uid: excel!Excel.ChangedEventDetail#valueAfter:member + package: excel! + fullName: valueAfter + summary: >- + Represents the value after the change. The data returned could be a + string, number, or boolean. Cells that contain an error will return the + error string. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valueAfter: any;' + return: + type: any + - name: valueAsJsonAfter + uid: excel!Excel.ChangedEventDetail#valueAsJsonAfter:member + package: excel! + fullName: valueAsJsonAfter + summary: >- + Represents the type of value after the change. Unlike `valueAfter`, `valueAsJsonAfter` can represent all cell values, such as formatted + number, web image, and entity data types. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valueAsJsonAfter: CellValue;' + return: + type: + - name: valueAsJsonBefore + uid: excel!Excel.ChangedEventDetail#valueAsJsonBefore:member + package: excel! + fullName: valueAsJsonBefore + summary: >- + Represents the type of value before the change. Unlike `valueBefore`, `valueAsJsonBefore` can represent all cell values, such as formatted + number, web image, and entity data types. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valueAsJsonBefore: CellValue;' + return: + type: + - name: valueBefore + uid: excel!Excel.ChangedEventDetail#valueBefore:member + package: excel! + fullName: valueBefore + summary: >- + Represents the value before the change. The data returned could be a + string, number, or boolean. Cells that contain an error will return the + error string. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valueBefore: any;' + return: + type: any + - name: valueTypeAfter + uid: excel!Excel.ChangedEventDetail#valueTypeAfter:member + package: excel! + fullName: valueTypeAfter + summary: Represents the type of value after the change. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + valueTypeAfter: Excel.RangeValueType | "Unknown" | "Empty" | "String" | + "Integer" | "Double" | "Boolean" | "Error" | "RichValue"; + return: + type: >- + | "Unknown" | "Empty" | + "String" | "Integer" | "Double" | "Boolean" | "Error" | "RichValue" + - name: valueTypeBefore + uid: excel!Excel.ChangedEventDetail#valueTypeBefore:member + package: excel! + fullName: valueTypeBefore + summary: Represents the type of value before the change. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + valueTypeBefore: Excel.RangeValueType | "Unknown" | "Empty" | "String" | + "Integer" | "Double" | "Boolean" | "Error" | "RichValue"; + return: + type: >- + | "Unknown" | "Empty" | + "String" | "Integer" | "Double" | "Boolean" | "Error" | "RichValue" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.changedirectionstate.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.changedirectionstate.yml new file mode 100644 index 0000000000..3a6c4ecf34 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.changedirectionstate.yml @@ -0,0 +1,60 @@ +### YamlMime:TSType +name: Excel.ChangeDirectionState +uid: excel!Excel.ChangeDirectionState:interface +package: excel! +fullName: Excel.ChangeDirectionState +summary: >- + Represents the direction that existing or remaining cells in a worksheet will + shift when cells are inserted into or deleted from a worksheet. +remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: deleteShiftDirection + uid: excel!Excel.ChangeDirectionState#deleteShiftDirection:member + package: excel! + fullName: deleteShiftDirection + summary: >- + Represents the direction (such as up or to the left) that the remaining + cells will shift when a cell or cells are deleted. Note: + `insertShiftDirection` and `deleteShiftDirection` are exclusive and both + enums can't have a value at the same time. If one has a value, then the + other will return `undefined`. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'deleteShiftDirection: Excel.DeleteShiftDirection | "Up" | "Left";' + return: + type: | "Up" | "Left" + - name: insertShiftDirection + uid: excel!Excel.ChangeDirectionState#insertShiftDirection:member + package: excel! + fullName: insertShiftDirection + summary: >- + Represents the direction (such as down or to the right) that the existing + cells will shift when a new cell or cells are inserted. Note: + `insertShiftDirection` and `deleteShiftDirection` are exclusive and both + enums can't have a value at the same time. If one has a value, then the + other will return `undefined`. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'insertShiftDirection: Excel.InsertShiftDirection | "Down" | "Right";' + return: + type: >- + | "Down" | + "Right" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chart.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chart.yml new file mode 100644 index 0000000000..3a6c0d7b83 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chart.yml @@ -0,0 +1,1099 @@ +### YamlMime:TSType +name: Excel.Chart +uid: excel!Excel.Chart:class +package: excel! +fullName: Excel.Chart +summary: >- + Represents a chart object in a workbook. To learn more about the chart object + model, see [Work with charts using the Excel JavaScript + API](https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-charts). +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: axes + uid: excel!Excel.Chart#axes:member + package: excel! + fullName: axes + summary: Represents chart axes. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly axes: Excel.ChartAxes;' + return: + type: + - name: categoryLabelLevel + uid: excel!Excel.Chart#categoryLabelLevel:member + package: excel! + fullName: categoryLabelLevel + summary: >- + Specifies a chart category label level enumeration constant, referring to + the level of the source category labels. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'categoryLabelLevel: number;' + return: + type: number + - name: chartType + uid: excel!Excel.Chart#chartType:member + package: excel! + fullName: chartType + summary: Specifies the type of the chart. See `Excel.ChartType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + chartType: Excel.ChartType | "Invalid" | "ColumnClustered" | + "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | + "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" + | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | + "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | + "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | + "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | + "XYScatterSmoothNoMarkers" | "XYScatterLines" | + "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | + "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | + "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | + "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | + "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" + | "CylinderColClustered" | "CylinderColStacked" | + "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" + | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | + "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | + "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | + "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | + "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | + "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | + "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | + "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | + "Sunburst" | "Funnel"; + return: + type: >- + | "Invalid" | + "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | + "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | + "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | + "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" + | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | + "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | + "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | + "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | + "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | + "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | + "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | + "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | + "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | + "CylinderColStacked100" | "CylinderBarClustered" | + "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | + "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | + "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | + "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | + "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | + "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" + | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | + "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | + "Treemap" | "Waterfall" | "Sunburst" | "Funnel" + - name: context + uid: excel!Excel.Chart#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: dataLabels + uid: excel!Excel.Chart#dataLabels:member + package: excel! + fullName: dataLabels + summary: Represents the data labels on the chart. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly dataLabels: Excel.ChartDataLabels;' + return: + type: + - name: displayBlanksAs + uid: excel!Excel.Chart#displayBlanksAs:member + package: excel! + fullName: displayBlanksAs + summary: Specifies the way that blank cells are plotted on a chart. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + displayBlanksAs: Excel.ChartDisplayBlanksAs | "NotPlotted" | "Zero" | + "Interplotted"; + return: + type: >- + | "NotPlotted" | + "Zero" | "Interplotted" + - name: format + uid: excel!Excel.Chart#format:member + package: excel! + fullName: format + summary: Encapsulates the format properties for the chart area. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly format: Excel.ChartAreaFormat;' + return: + type: + - name: height + uid: excel!Excel.Chart#height:member + package: excel! + fullName: height + summary: Specifies the height, in points, of the chart object. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height: number;' + return: + type: number + - name: id + uid: excel!Excel.Chart#id:member + package: excel! + fullName: id + summary: The unique ID of chart. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly id: string;' + return: + type: string + - name: left + uid: excel!Excel.Chart#left:member + package: excel! + fullName: left + summary: >- + The distance, in points, from the left side of the chart to the worksheet + origin. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left: number;' + return: + type: number + - name: legend + uid: excel!Excel.Chart#legend:member + package: excel! + fullName: legend + summary: Represents the legend for the chart. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Set to show legend of Chart1 and make it on top of the chart. + + await Excel.run(async (context) => { + const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); + chart.legend.visible = true; + chart.legend.position = "Top"; + chart.legend.overlay = false; + await context.sync() + + console.log("Legend Shown "); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly legend: Excel.ChartLegend;' + return: + type: + - name: name + uid: excel!Excel.Chart#name:member + package: excel! + fullName: name + summary: Specifies the name of a chart object. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Rename the chart to new name, resize the chart to 200 points in both + height and weight. + + // Move Chart1 to 100 points to the top and left. + + await Excel.run(async (context) => { + const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); + chart.name = "New Name"; + chart.top = 100; + chart.left = 100; + chart.height = 200; + chart.width = 200; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'name: string;' + return: + type: string + - name: pivotOptions + uid: excel!Excel.Chart#pivotOptions:member + package: excel! + fullName: pivotOptions + summary: Encapsulates the options for a pivot chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly pivotOptions: Excel.ChartPivotOptions;' + return: + type: + - name: plotArea + uid: excel!Excel.Chart#plotArea:member + package: excel! + fullName: plotArea + summary: Represents the plot area for the chart. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly plotArea: Excel.ChartPlotArea;' + return: + type: + - name: plotBy + uid: excel!Excel.Chart#plotBy:member + package: excel! + fullName: plotBy + summary: Specifies the way columns or rows are used as data series on the chart. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'plotBy: Excel.ChartPlotBy | "Rows" | "Columns";' + return: + type: | "Rows" | "Columns" + - name: plotVisibleOnly + uid: excel!Excel.Chart#plotVisibleOnly:member + package: excel! + fullName: plotVisibleOnly + summary: >- + True if only visible cells are plotted. False if both visible and hidden + cells are plotted. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'plotVisibleOnly: boolean;' + return: + type: boolean + - name: series + uid: excel!Excel.Chart#series:member + package: excel! + fullName: series + summary: Represents either a single series or collection of series in the chart. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly series: Excel.ChartSeriesCollection;' + return: + type: + - name: seriesNameLevel + uid: excel!Excel.Chart#seriesNameLevel:member + package: excel! + fullName: seriesNameLevel + summary: >- + Specifies a chart series name level enumeration constant, referring to the + level of the source series names. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'seriesNameLevel: number;' + return: + type: number + - name: showAllFieldButtons + uid: excel!Excel.Chart#showAllFieldButtons:member + package: excel! + fullName: showAllFieldButtons + summary: Specifies whether to display all field buttons on a PivotChart. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showAllFieldButtons: boolean;' + return: + type: boolean + - name: showDataLabelsOverMaximum + uid: excel!Excel.Chart#showDataLabelsOverMaximum:member + package: excel! + fullName: showDataLabelsOverMaximum + summary: >- + Specifies whether to show the data labels when the value is greater than + the maximum value on the value axis. If the value axis becomes smaller + than the size of the data points, you can use this property to set whether + to show the data labels. This property applies to 2-D charts only. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showDataLabelsOverMaximum: boolean;' + return: + type: boolean + - name: style + uid: excel!Excel.Chart#style:member + package: excel! + fullName: style + summary: Specifies the chart style for the chart. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'style: number;' + return: + type: number + - name: title + uid: excel!Excel.Chart#title:member + package: excel! + fullName: title + summary: >- + Represents the title of the specified chart, including the text, + visibility, position, and formatting of the title. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly title: Excel.ChartTitle;' + return: + type: + - name: top + uid: excel!Excel.Chart#top:member + package: excel! + fullName: top + summary: >- + Specifies the distance, in points, from the top edge of the object to the + top of row 1 (on a worksheet) or the top of the chart area (on a chart). + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top: number;' + return: + type: number + - name: width + uid: excel!Excel.Chart#width:member + package: excel! + fullName: width + summary: Specifies the width, in points, of the chart object. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width: number;' + return: + type: number + - name: worksheet + uid: excel!Excel.Chart#worksheet:member + package: excel! + fullName: worksheet + summary: The worksheet containing the current chart. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly worksheet: Excel.Worksheet;' + return: + type: +methods: + - name: activate() + uid: excel!Excel.Chart#activate:member(1) + package: excel! + fullName: activate() + summary: Activates the chart in the Excel UI. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'activate(): void;' + return: + type: void + description: '' + - name: delete() + uid: excel!Excel.Chart#delete:member(1) + package: excel! + fullName: delete() + summary: Deletes the chart object. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); + chart.delete(); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'delete(): void;' + return: + type: void + description: '' + - name: getDataTable() + uid: excel!Excel.Chart#getDataTable:member(1) + package: excel! + fullName: getDataTable() + summary: >- + Gets the data table on the chart. If the chart doesn't allow a data table, + it will throw an exception. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getDataTable(): Excel.ChartDataTable;' + return: + type: + description: '' + - name: getDataTableOrNullObject() + uid: excel!Excel.Chart#getDataTableOrNullObject:member(1) + package: excel! + fullName: getDataTableOrNullObject() + summary: >- + Gets the data table on the chart. If the chart doesn't allow a data table, + then this method returns an object with its `isNullObject` property set to + `true`. For further information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-data-table.yaml + + + // This function adds a data table to a chart that already exists on the + worksheet. + + await Excel.run(async (context) => { + // Retrieve the chart named "SalesChart" from the "Sample" worksheet. + const chart = context.workbook.worksheets.getItem("Sample").charts.getItem("SalesChart"); + + // Get the data table object for the chart and set it to visible. + const chartDataTable = chart.getDataTableOrNullObject(); + chartDataTable.load("visible"); + chartDataTable.visible = true; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getDataTableOrNullObject(): Excel.ChartDataTable;' + return: + type: + description: '' + - name: getImage(width, height, fittingMode) + uid: excel!Excel.Chart#getImage:member(1) + package: excel! + fullName: getImage(width, height, fittingMode) + summary: >- + Renders the chart as a Base64-encoded image by scaling the chart to fit + the specified dimensions. The aspect ratio is preserved as part of the + resizing. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); + const image = chart.getImage(); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + getImage(width?: number, height?: number, fittingMode?: + Excel.ImageFittingMode): OfficeExtension.ClientResult; + parameters: + - id: width + description: Optional. The desired width of the resulting image. + type: number + - id: height + description: Optional. The desired height of the resulting image. + type: number + - id: fittingMode + description: >- + Optional. The method used to scale the chart to the specified + dimensions (if both height and width are set). + type: + return: + type: <string> + description: '' + - name: getImage(width, height, fittingMode) + uid: excel!Excel.Chart#getImage:member(2) + package: excel! + fullName: getImage(width, height, fittingMode) + summary: >- + Renders the chart as a Base64-encoded image by scaling the chart to fit + the specified dimensions. The aspect ratio is preserved as part of the + resizing. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + getImage(width?: number, height?: number, fittingMode?: "Fit" | + "FitAndCenter" | "Fill"): OfficeExtension.ClientResult; + parameters: + - id: width + description: Optional. The desired width of the resulting image. + type: number + - id: height + description: Optional. The desired height of the resulting image. + type: number + - id: fittingMode + description: >- + Optional. The method used to scale the chart to the specified + dimensions (if both height and width are set). + type: '"Fit" | "FitAndCenter" | "Fill"' + return: + type: <string> + description: '' + - name: load(options) + uid: excel!Excel.Chart#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(options?: Excel.Interfaces.ChartLoadOptions): Excel.Chart;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.Chart#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.Chart;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: |- + + + #### Examples + + ```TypeScript + // Get a chart named "Chart1". + await Excel.run(async (context) => { + const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); + chart.load('name'); + await context.sync(); + + console.log(chart.name); + }); + ``` + - name: load(propertyNamesAndPaths) + uid: excel!Excel.Chart#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.Chart; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.Chart#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.Chart#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.Chart): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: setData(sourceData, seriesBy) + uid: excel!Excel.Chart#setData:member(1) + package: excel! + fullName: setData(sourceData, seriesBy) + summary: Resets the source data for the chart. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Set the sourceData to be the range at "A1:B4" and seriesBy to be + "Columns". + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sheet1"); + const chart = sheet.charts.getItem("Chart1"); + const sourceData = sheet.getRange("A1:B4"); + chart.setData(sourceData, "Columns"); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'setData(sourceData: Range, seriesBy?: Excel.ChartSeriesBy): void;' + parameters: + - id: sourceData + description: The range object corresponding to the source data. + type: + - id: seriesBy + description: >- + Specifies the way columns or rows are used as data series on the + chart. Can be one of the following: Auto (default), Rows, and + Columns. See `Excel.ChartSeriesBy` for details. + type: + return: + type: void + description: '' + - name: setData(sourceData, seriesBy) + uid: excel!Excel.Chart#setData:member(2) + package: excel! + fullName: setData(sourceData, seriesBy) + summary: Resets the source data for the chart. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + setData(sourceData: Range, seriesBy?: "Auto" | "Columns" | "Rows"): + void; + parameters: + - id: sourceData + description: The range object corresponding to the source data. + type: + - id: seriesBy + description: >- + Specifies the way columns or rows are used as data series on the + chart. Can be one of the following: Auto (default), Rows, and + Columns. See `Excel.ChartSeriesBy` for details. + type: '"Auto" | "Columns" | "Rows"' + return: + type: void + description: '' + - name: setPosition(startCell, endCell) + uid: excel!Excel.Chart#setPosition:member(1) + package: excel! + fullName: setPosition(startCell, endCell) + summary: Positions the chart relative to cells on the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const sheetName = "Charts"; + const rangeSelection = "A1:B4"; + const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeSelection); + const sourceData = sheetName + "!" + "A1:B4"; + const chart = context.workbook.worksheets.getItem(sheetName).charts.add("pie", range, "auto"); + chart.width = 500; + chart.height = 300; + chart.setPosition("C2", null); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'setPosition(startCell: Range | string, endCell?: Range | string): void;' + parameters: + - id: startCell + description: >- + The start cell. This is where the chart will be moved to. The start + cell is the top-left or top-right cell, depending on the user's + right-to-left display settings. + type: | string + - id: endCell + description: >- + Optional. The end cell. If specified, the chart's width and height + will be set to fully cover up this cell/range. + type: | string + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.Chart#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.Chart` object is + an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Excel.Interfaces.ChartData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartData;' + return: + type: + description: '' +events: + - name: onActivated + uid: excel!Excel.Chart#onActivated:member + package: excel! + fullName: onActivated + summary: Occurs when the chart is activated. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-chart-activated.yaml + + + await Excel.run(async (context) => { + + const pieChart = context.workbook.worksheets.getActiveWorksheet().charts.getItem("Pie"); + + // Register the onActivated and onDeactivated event handlers. + pieChart.onActivated.add(chartActivated); + pieChart.onDeactivated.add(chartDeactivated); + + await context.sync(); + + console.log("Added handlers for Chart onActivated and onDeactivated events."); + }); + + + ... + + + async function chartActivated(event) { + await Excel.run(async (context) => { + // Retrieve the worksheet. + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Retrieve the activated chart by ID and load the name of the chart. + const activatedChart = sheet.charts.getItem(event.chartId); + activatedChart.load(["name"]); + await context.sync(); + + // Print out the activated chart's data. + console.log(`A chart was activated. ID: ${event.chartId}. Chart name: ${activatedChart.name}.`); + }); + } + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onActivated: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onDeactivated + uid: excel!Excel.Chart#onDeactivated:member + package: excel! + fullName: onDeactivated + summary: Occurs when the chart is deactivated. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-chart-activated.yaml + + + await Excel.run(async (context) => { + + const pieChart = context.workbook.worksheets.getActiveWorksheet().charts.getItem("Pie"); + + // Register the onActivated and onDeactivated event handlers. + pieChart.onActivated.add(chartActivated); + pieChart.onDeactivated.add(chartDeactivated); + + await context.sync(); + + console.log("Added handlers for Chart onActivated and onDeactivated events."); + }); + + + ... + + + async function chartDeactivated(event) { + await Excel.run(async (context) => { + // Callback function for when the chart is deactivated. + console.log("The pie chart is NOT active."); + }); + } + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onDeactivated: + OfficeExtension.EventHandlers; + return: + type: >- + <> +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartactivatedeventargs.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartactivatedeventargs.yml new file mode 100644 index 0000000000..daaa5095f8 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartactivatedeventargs.yml @@ -0,0 +1,59 @@ +### YamlMime:TSType +name: Excel.ChartActivatedEventArgs +uid: excel!Excel.ChartActivatedEventArgs:interface +package: excel! +fullName: Excel.ChartActivatedEventArgs +summary: Provides information about the chart that raised the activated event. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: chartId + uid: excel!Excel.ChartActivatedEventArgs#chartId:member + package: excel! + fullName: chartId + summary: Gets the ID of the chart that is activated. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'chartId: string;' + return: + type: string + - name: type + uid: excel!Excel.ChartActivatedEventArgs#type:member + package: excel! + fullName: type + summary: Gets the type of the event. See `Excel.EventType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: "ChartActivated";' + return: + type: '"ChartActivated"' + - name: worksheetId + uid: excel!Excel.ChartActivatedEventArgs#worksheetId:member + package: excel! + fullName: worksheetId + summary: Gets the ID of the worksheet in which the chart is activated. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheetId: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaddedeventargs.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaddedeventargs.yml new file mode 100644 index 0000000000..c6a2503e45 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaddedeventargs.yml @@ -0,0 +1,74 @@ +### YamlMime:TSType +name: Excel.ChartAddedEventArgs +uid: excel!Excel.ChartAddedEventArgs:interface +package: excel! +fullName: Excel.ChartAddedEventArgs +summary: Provides information about the chart that raised the added event. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: chartId + uid: excel!Excel.ChartAddedEventArgs#chartId:member + package: excel! + fullName: chartId + summary: Gets the ID of the chart that is added to the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'chartId: string;' + return: + type: string + - name: source + uid: excel!Excel.ChartAddedEventArgs#source:member + package: excel! + fullName: source + summary: Gets the source of the event. See `Excel.EventSource` for details. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'source: Excel.EventSource | "Local" | "Remote";' + return: + type: | "Local" | "Remote" + - name: type + uid: excel!Excel.ChartAddedEventArgs#type:member + package: excel! + fullName: type + summary: Gets the type of the event. See `Excel.EventType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: "ChartAdded";' + return: + type: '"ChartAdded"' + - name: worksheetId + uid: excel!Excel.ChartAddedEventArgs#worksheetId:member + package: excel! + fullName: worksheetId + summary: Gets the ID of the worksheet in which the chart is added. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheetId: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartareaformat.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartareaformat.yml new file mode 100644 index 0000000000..1accec1921 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartareaformat.yml @@ -0,0 +1,283 @@ +### YamlMime:TSType +name: Excel.ChartAreaFormat +uid: excel!Excel.ChartAreaFormat:class +package: excel! +fullName: Excel.ChartAreaFormat +summary: Encapsulates the format properties for the overall chart area. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: border + uid: excel!Excel.ChartAreaFormat#border:member + package: excel! + fullName: border + summary: >- + Represents the border format of chart area, which includes color, + linestyle, and weight. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly border: Excel.ChartBorder;' + return: + type: + - name: colorScheme + uid: excel!Excel.ChartAreaFormat#colorScheme:member + package: excel! + fullName: colorScheme + summary: Specifies the color scheme of the chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + colorScheme: Excel.ChartColorScheme | "ColorfulPalette1" | + "ColorfulPalette2" | "ColorfulPalette3" | "ColorfulPalette4" | + "MonochromaticPalette1" | "MonochromaticPalette2" | + "MonochromaticPalette3" | "MonochromaticPalette4" | + "MonochromaticPalette5" | "MonochromaticPalette6" | + "MonochromaticPalette7" | "MonochromaticPalette8" | + "MonochromaticPalette9" | "MonochromaticPalette10" | + "MonochromaticPalette11" | "MonochromaticPalette12" | + "MonochromaticPalette13"; + return: + type: >- + | "ColorfulPalette1" + | "ColorfulPalette2" | "ColorfulPalette3" | "ColorfulPalette4" | + "MonochromaticPalette1" | "MonochromaticPalette2" | + "MonochromaticPalette3" | "MonochromaticPalette4" | + "MonochromaticPalette5" | "MonochromaticPalette6" | + "MonochromaticPalette7" | "MonochromaticPalette8" | + "MonochromaticPalette9" | "MonochromaticPalette10" | + "MonochromaticPalette11" | "MonochromaticPalette12" | + "MonochromaticPalette13" + - name: context + uid: excel!Excel.ChartAreaFormat#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: fill + uid: excel!Excel.ChartAreaFormat#fill:member + package: excel! + fullName: fill + summary: >- + Represents the fill format of an object, which includes background + formatting information. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly fill: Excel.ChartFill;' + return: + type: + - name: font + uid: excel!Excel.ChartAreaFormat#font:member + package: excel! + fullName: font + summary: >- + Represents the font attributes (font name, font size, color, etc.) for the + current object. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly font: Excel.ChartFont;' + return: + type: + - name: roundedCorners + uid: excel!Excel.ChartAreaFormat#roundedCorners:member + package: excel! + fullName: roundedCorners + summary: Specifies if the chart area of the chart has rounded corners. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'roundedCorners: boolean;' + return: + type: boolean +methods: + - name: load(options) + uid: excel!Excel.ChartAreaFormat#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartAreaFormatLoadOptions): + Excel.ChartAreaFormat; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartAreaFormat#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartAreaFormat;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartAreaFormat#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartAreaFormat; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartAreaFormat#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartAreaFormatUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartAreaFormat#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartAreaFormat): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartAreaFormat#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.ChartAreaFormat` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.ChartAreaFormatData`) that + contains shallow copies of any loaded child properties from the original + object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartAreaFormatData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxes.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxes.yml new file mode 100644 index 0000000000..046256875c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxes.yml @@ -0,0 +1,297 @@ +### YamlMime:TSType +name: Excel.ChartAxes +uid: excel!Excel.ChartAxes:class +package: excel! +fullName: Excel.ChartAxes +summary: Represents the chart axes. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: categoryAxis + uid: excel!Excel.ChartAxes#categoryAxis:member + package: excel! + fullName: categoryAxis + summary: Represents the category axis in a chart. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly categoryAxis: Excel.ChartAxis;' + return: + type: + - name: context + uid: excel!Excel.ChartAxes#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: seriesAxis + uid: excel!Excel.ChartAxes#seriesAxis:member + package: excel! + fullName: seriesAxis + summary: Represents the series axis of a 3-D chart. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly seriesAxis: Excel.ChartAxis;' + return: + type: + - name: valueAxis + uid: excel!Excel.ChartAxes#valueAxis:member + package: excel! + fullName: valueAxis + summary: Represents the value axis in an axis. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Set the maximum, minimum, majorUnit, minorUnit of valueAxis. + + await Excel.run(async (context) => { + const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); + chart.axes.valueAxis.maximum = 5; + chart.axes.valueAxis.minimum = 0; + chart.axes.valueAxis.majorUnit = 1; + chart.axes.valueAxis.minorUnit = 0.2; + await context.sync(); + + console.log("Axis Settings Changed"); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly valueAxis: Excel.ChartAxis;' + return: + type: +methods: + - name: getItem(type, group) + uid: excel!Excel.ChartAxes#getItem:member(1) + package: excel! + fullName: getItem(type, group) + summary: Returns the specific axis identified by type and group. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + getItem(type: Excel.ChartAxisType, group?: Excel.ChartAxisGroup): + Excel.ChartAxis; + parameters: + - id: type + description: Specifies the axis type. See `Excel.ChartAxisType` for details. + type: + - id: group + description: >- + Optional. Specifies the axis group. See `Excel.ChartAxisGroup` for + details. + type: + return: + type: + description: '' + - name: getItem(type, group) + uid: excel!Excel.ChartAxes#getItem:member(2) + package: excel! + fullName: getItem(type, group) + summary: Returns the specific axis identified by type and group. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + getItem(type: "Invalid" | "Category" | "Value" | "Series", group?: + "Primary" | "Secondary"): Excel.ChartAxis; + parameters: + - id: type + description: Specifies the axis type. See `Excel.ChartAxisType` for details. + type: '"Invalid" | "Category" | "Value" | "Series"' + - id: group + description: >- + Optional. Specifies the axis group. See `Excel.ChartAxisGroup` for + details. + type: '"Primary" | "Secondary"' + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.ChartAxes#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(options?: Excel.Interfaces.ChartAxesLoadOptions): Excel.ChartAxes;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartAxes#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartAxes;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartAxes#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartAxes; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartAxes#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartAxesUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartAxes#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartAxes): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartAxes#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.ChartAxes` object + is an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Excel.Interfaces.ChartAxesData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartAxesData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxis.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxis.yml new file mode 100644 index 0000000000..c1dbea7719 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxis.yml @@ -0,0 +1,994 @@ +### YamlMime:TSType +name: Excel.ChartAxis +uid: excel!Excel.ChartAxis:class +package: excel! +fullName: Excel.ChartAxis +summary: Represents a single axis in a chart. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: alignment + uid: excel!Excel.ChartAxis#alignment:member + package: excel! + fullName: alignment + summary: >- + Specifies the alignment for the specified axis tick label. See + `Excel.ChartTextHorizontalAlignment` for detail. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'alignment: Excel.ChartTickLabelAlignment | "Center" | "Left" | "Right";' + return: + type: >- + | "Center" | + "Left" | "Right" + - name: axisGroup + uid: excel!Excel.ChartAxis#axisGroup:member + package: excel! + fullName: axisGroup + summary: >- + Specifies the group for the specified axis. See `Excel.ChartAxisGroup` for + details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly axisGroup: Excel.ChartAxisGroup | "Primary" | "Secondary";' + return: + type: >- + | "Primary" | + "Secondary" + - name: baseTimeUnit + uid: excel!Excel.ChartAxis#baseTimeUnit:member + package: excel! + fullName: baseTimeUnit + summary: Specifies the base unit for the specified category axis. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'baseTimeUnit: Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years";' + return: + type: >- + | "Days" | "Months" + | "Years" + - name: categoryType + uid: excel!Excel.ChartAxis#categoryType:member + package: excel! + fullName: categoryType + summary: Specifies the category axis type. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + categoryType: Excel.ChartAxisCategoryType | "Automatic" | "TextAxis" | + "DateAxis"; + return: + type: >- + | "Automatic" | + "TextAxis" | "DateAxis" + - name: context + uid: excel!Excel.ChartAxis#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: customDisplayUnit + uid: excel!Excel.ChartAxis#customDisplayUnit:member + package: excel! + fullName: customDisplayUnit + summary: >- + Specifies the custom axis display unit value. To set this property, please + use the `SetCustomDisplayUnit(double)` method. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly customDisplayUnit: number;' + return: + type: number + - name: displayUnit + uid: excel!Excel.ChartAxis#displayUnit:member + package: excel! + fullName: displayUnit + summary: >- + Represents the axis display unit. See `Excel.ChartAxisDisplayUnit` for + details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-axis.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + + let chart = sheet.charts.getItemAt(0); + let categoryAxis = chart.axes.categoryAxis; + let valueAxis = chart.axes.valueAxis; + + // Load to get display unit. + valueAxis.load("displayUnit"); + + await context.sync(); + + console.log("The vertical axis display unit is: " + valueAxis.displayUnit); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + displayUnit: Excel.ChartAxisDisplayUnit | "None" | "Hundreds" | + "Thousands" | "TenThousands" | "HundredThousands" | "Millions" | + "TenMillions" | "HundredMillions" | "Billions" | "Trillions" | "Custom"; + return: + type: >- + | "None" | + "Hundreds" | "Thousands" | "TenThousands" | "HundredThousands" | + "Millions" | "TenMillions" | "HundredMillions" | "Billions" | + "Trillions" | "Custom" + - name: format + uid: excel!Excel.ChartAxis#format:member + package: excel! + fullName: format + summary: >- + Represents the formatting of a chart object, which includes line and font + formatting. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly format: Excel.ChartAxisFormat;' + return: + type: + - name: height + uid: excel!Excel.ChartAxis#height:member + package: excel! + fullName: height + summary: >- + Specifies the height, in points, of the chart axis. Returns `null` if the + axis is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly height: number;' + return: + type: number + - name: isBetweenCategories + uid: excel!Excel.ChartAxis#isBetweenCategories:member + package: excel! + fullName: isBetweenCategories + summary: Specifies if the value axis crosses the category axis between categories. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'isBetweenCategories: boolean;' + return: + type: boolean + - name: left + uid: excel!Excel.ChartAxis#left:member + package: excel! + fullName: left + summary: >- + Specifies the distance, in points, from the left edge of the axis to the + left of chart area. Returns `null` if the axis is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly left: number;' + return: + type: number + - name: linkNumberFormat + uid: excel!Excel.ChartAxis#linkNumberFormat:member + package: excel! + fullName: linkNumberFormat + summary: >- + Specifies if the number format is linked to the cells. If `true`, + the number format will change in the labels when it changes in the cells. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'linkNumberFormat: boolean;' + return: + type: boolean + - name: logBase + uid: excel!Excel.ChartAxis#logBase:member + package: excel! + fullName: logBase + summary: Specifies the base of the logarithm when using logarithmic scales. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'logBase: number;' + return: + type: number + - name: majorGridlines + uid: excel!Excel.ChartAxis#majorGridlines:member + package: excel! + fullName: majorGridlines + summary: >- + Returns an object that represents the major gridlines for the specified + axis. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly majorGridlines: Excel.ChartGridlines;' + return: + type: + - name: majorTickMark + uid: excel!Excel.ChartAxis#majorTickMark:member + package: excel! + fullName: majorTickMark + summary: >- + Specifies the type of major tick mark for the specified axis. See + `Excel.ChartAxisTickMark` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + majorTickMark: Excel.ChartAxisTickMark | "None" | "Cross" | "Inside" | + "Outside"; + return: + type: >- + | "None" | "Cross" | + "Inside" | "Outside" + - name: majorTimeUnitScale + uid: excel!Excel.ChartAxis#majorTimeUnitScale:member + package: excel! + fullName: majorTimeUnitScale + summary: >- + Specifies the major unit scale value for the category axis when the + `categoryType` property is set to `dateAxis`. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + majorTimeUnitScale: Excel.ChartAxisTimeUnit | "Days" | "Months" | + "Years"; + return: + type: >- + | "Days" | "Months" + | "Years" + - name: majorUnit + uid: excel!Excel.ChartAxis#majorUnit:member + package: excel! + fullName: majorUnit + summary: >- + Represents the interval between two major tick marks. Can be set to a + numeric value or an empty string. The returned value is always a number. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'majorUnit: any;' + return: + type: any + - name: maximum + uid: excel!Excel.ChartAxis#maximum:member + package: excel! + fullName: maximum + summary: >- + Represents the maximum value on the value axis. Can be set to a numeric + value or an empty string (for automatic axis values). The returned value + is always a number. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'maximum: any;' + return: + type: any + - name: minimum + uid: excel!Excel.ChartAxis#minimum:member + package: excel! + fullName: minimum + summary: >- + Represents the minimum value on the value axis. Can be set to a numeric + value or an empty string (for automatic axis values). The returned value + is always a number. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'minimum: any;' + return: + type: any + - name: minorGridlines + uid: excel!Excel.ChartAxis#minorGridlines:member + package: excel! + fullName: minorGridlines + summary: >- + Returns an object that represents the minor gridlines for the specified + axis. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly minorGridlines: Excel.ChartGridlines;' + return: + type: + - name: minorTickMark + uid: excel!Excel.ChartAxis#minorTickMark:member + package: excel! + fullName: minorTickMark + summary: >- + Specifies the type of minor tick mark for the specified axis. See + `Excel.ChartAxisTickMark` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + minorTickMark: Excel.ChartAxisTickMark | "None" | "Cross" | "Inside" | + "Outside"; + return: + type: >- + | "None" | "Cross" | + "Inside" | "Outside" + - name: minorTimeUnitScale + uid: excel!Excel.ChartAxis#minorTimeUnitScale:member + package: excel! + fullName: minorTimeUnitScale + summary: >- + Specifies the minor unit scale value for the category axis when the + `categoryType` property is set to `dateAxis`. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + minorTimeUnitScale: Excel.ChartAxisTimeUnit | "Days" | "Months" | + "Years"; + return: + type: >- + | "Days" | "Months" + | "Years" + - name: minorUnit + uid: excel!Excel.ChartAxis#minorUnit:member + package: excel! + fullName: minorUnit + summary: >- + Represents the interval between two minor tick marks. Can be set to a + numeric value or an empty string (for automatic axis values). The returned + value is always a number. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'minorUnit: any;' + return: + type: any + - name: multiLevel + uid: excel!Excel.ChartAxis#multiLevel:member + package: excel! + fullName: multiLevel + summary: Specifies if an axis is multilevel. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'multiLevel: boolean;' + return: + type: boolean + - name: numberFormat + uid: excel!Excel.ChartAxis#numberFormat:member + package: excel! + fullName: numberFormat + summary: Specifies the format code for the axis tick label. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat: string;' + return: + type: string + - name: offset + uid: excel!Excel.ChartAxis#offset:member + package: excel! + fullName: offset + summary: >- + Specifies the distance between the levels of labels, and the distance + between the first level and the axis line. The value should be an integer + from 0 to 1000. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'offset: number;' + return: + type: number + - name: position + uid: excel!Excel.ChartAxis#position:member + package: excel! + fullName: position + summary: >- + Specifies the specified axis position where the other axis crosses. See + `Excel.ChartAxisPosition` for details. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + position: Excel.ChartAxisPosition | "Automatic" | "Maximum" | "Minimum" + | "Custom"; + return: + type: >- + | "Automatic" | + "Maximum" | "Minimum" | "Custom" + - name: positionAt + uid: excel!Excel.ChartAxis#positionAt:member + package: excel! + fullName: positionAt + summary: >- + Specifies the axis position where the other axis crosses. You should use + the `SetPositionAt(double)` method to set this property. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly positionAt: number;' + return: + type: number + - name: reversePlotOrder + uid: excel!Excel.ChartAxis#reversePlotOrder:member + package: excel! + fullName: reversePlotOrder + summary: Specifies if Excel plots data points from last to first. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'reversePlotOrder: boolean;' + return: + type: boolean + - name: scaleType + uid: excel!Excel.ChartAxis#scaleType:member + package: excel! + fullName: scaleType + summary: >- + Specifies the value axis scale type. See `Excel.ChartAxisScaleType` for + details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'scaleType: Excel.ChartAxisScaleType | "Linear" | "Logarithmic";' + return: + type: >- + | "Linear" | + "Logarithmic" + - name: showDisplayUnitLabel + uid: excel!Excel.ChartAxis#showDisplayUnitLabel:member + package: excel! + fullName: showDisplayUnitLabel + summary: Specifies if the axis display unit label is visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-axis.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + let chart = sheet.charts.getItemAt(0); + let axis = chart.axes.valueAxis; + + // Remove display unit. + axis.showDisplayUnitLabel = false; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'showDisplayUnitLabel: boolean;' + return: + type: boolean + - name: textOrientation + uid: excel!Excel.ChartAxis#textOrientation:member + package: excel! + fullName: textOrientation + summary: >- + Specifies the angle to which the text is oriented for the chart axis tick + label. The value should either be an integer from -90 to 90 or the integer + 180 for vertically-oriented text. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textOrientation: any;' + return: + type: any + - name: tickLabelPosition + uid: excel!Excel.ChartAxis#tickLabelPosition:member + package: excel! + fullName: tickLabelPosition + summary: >- + Specifies the position of tick-mark labels on the specified axis. See + `Excel.ChartAxisTickLabelPosition` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + tickLabelPosition: Excel.ChartAxisTickLabelPosition | "NextToAxis" | + "High" | "Low" | "None"; + return: + type: >- + | + "NextToAxis" | "High" | "Low" | "None" + - name: tickLabelSpacing + uid: excel!Excel.ChartAxis#tickLabelSpacing:member + package: excel! + fullName: tickLabelSpacing + summary: >- + Specifies the number of categories or series between tick-mark labels. Can + be a value from 1 through 31999 or an empty string for automatic setting. + The returned value is always a number. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tickLabelSpacing: any;' + return: + type: any + - name: tickMarkSpacing + uid: excel!Excel.ChartAxis#tickMarkSpacing:member + package: excel! + fullName: tickMarkSpacing + summary: Specifies the number of categories or series between tick marks. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tickMarkSpacing: number;' + return: + type: number + - name: title + uid: excel!Excel.ChartAxis#title:member + package: excel! + fullName: title + summary: Represents the axis title. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly title: Excel.ChartAxisTitle;' + return: + type: + - name: top + uid: excel!Excel.ChartAxis#top:member + package: excel! + fullName: top + summary: >- + Specifies the distance, in points, from the top edge of the axis to the + top of chart area. Returns `null` if the axis is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly top: number;' + return: + type: number + - name: type + uid: excel!Excel.ChartAxis#type:member + package: excel! + fullName: type + summary: Specifies the axis type. See `Excel.ChartAxisType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly type: Excel.ChartAxisType | "Invalid" | "Category" | "Value" | + "Series"; + return: + type: >- + | "Invalid" | "Category" + | "Value" | "Series" + - name: visible + uid: excel!Excel.ChartAxis#visible:member + package: excel! + fullName: visible + summary: Specifies if the axis is visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible: boolean;' + return: + type: boolean + - name: width + uid: excel!Excel.ChartAxis#width:member + package: excel! + fullName: width + summary: >- + Specifies the width, in points, of the chart axis. Returns `null` if the + axis is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly width: number;' + return: + type: number +methods: + - name: load(options) + uid: excel!Excel.ChartAxis#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(options?: Excel.Interfaces.ChartAxisLoadOptions): Excel.ChartAxis;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartAxis#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartAxis;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: |- + + + #### Examples + + ```TypeScript + // Get the maximum of Chart Axis from Chart1. + await Excel.run(async (context) => { + const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); + const axis = chart.axes.valueAxis; + axis.load('maximum'); + await context.sync(); + + console.log(axis.maximum); + }); + ``` + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartAxis#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartAxis; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartAxis#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartAxisUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartAxis#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartAxis): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: setCategoryNames(sourceData) + uid: excel!Excel.ChartAxis#setCategoryNames:member(1) + package: excel! + fullName: setCategoryNames(sourceData) + summary: Sets all the category names for the specified axis. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'setCategoryNames(sourceData: Range): void;' + parameters: + - id: sourceData + description: The `Range` object corresponding to the source data. + type: + return: + type: void + description: '' + - name: setCustomDisplayUnit(value) + uid: excel!Excel.ChartAxis#setCustomDisplayUnit:member(1) + package: excel! + fullName: setCustomDisplayUnit(value) + summary: Sets the axis display unit to a custom value. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'setCustomDisplayUnit(value: number): void;' + parameters: + - id: value + description: Custom value of the display unit. + type: number + return: + type: void + description: '' + - name: setPositionAt(value) + uid: excel!Excel.ChartAxis#setPositionAt:member(1) + package: excel! + fullName: setPositionAt(value) + summary: Sets the specified axis position where the other axis crosses. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'setPositionAt(value: number): void;' + parameters: + - id: value + description: Custom value of the crossing point. + type: number + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartAxis#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.ChartAxis` object + is an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Excel.Interfaces.ChartAxisData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartAxisData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxiscategorytype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxiscategorytype.yml new file mode 100644 index 0000000000..61f38ebc8f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxiscategorytype.yml @@ -0,0 +1,43 @@ +### YamlMime:TSEnum +name: Excel.ChartAxisCategoryType +uid: excel!Excel.ChartAxisCategoryType:enum +package: excel! +fullName: Excel.ChartAxisCategoryType +summary: Specifies the type of the category axis. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: automatic + uid: excel!Excel.ChartAxisCategoryType.automatic:member + package: excel! + summary: >- + Excel controls the axis type. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Automatic"' + - name: dateAxis + uid: excel!Excel.ChartAxisCategoryType.dateAxis:member + package: excel! + summary: >- + Axis groups data on a time scale. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"DateAxis"' + - name: textAxis + uid: excel!Excel.ChartAxisCategoryType.textAxis:member + package: excel! + summary: >- + Axis groups data by an arbitrary set of categories. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"TextAxis"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxisdisplayunit.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxisdisplayunit.yml new file mode 100644 index 0000000000..efe938deba --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxisdisplayunit.yml @@ -0,0 +1,124 @@ +### YamlMime:TSEnum +name: Excel.ChartAxisDisplayUnit +uid: excel!Excel.ChartAxisDisplayUnit:enum +package: excel! +fullName: Excel.ChartAxisDisplayUnit +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: billions + uid: excel!Excel.ChartAxisDisplayUnit.billions:member + package: excel! + summary: >- + This will set the axis in units of billions. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Billions"' + - name: custom + uid: excel!Excel.ChartAxisDisplayUnit.custom:member + package: excel! + summary: >- + This will set the axis in units of custom value. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Custom"' + - name: hundredMillions + uid: excel!Excel.ChartAxisDisplayUnit.hundredMillions:member + package: excel! + summary: >- + This will set the axis in units of hundreds of millions. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"HundredMillions"' + - name: hundreds + uid: excel!Excel.ChartAxisDisplayUnit.hundreds:member + package: excel! + summary: >- + This will set the axis in units of hundreds. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Hundreds"' + - name: hundredThousands + uid: excel!Excel.ChartAxisDisplayUnit.hundredThousands:member + package: excel! + summary: >- + This will set the axis in units of hundreds of thousands. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"HundredThousands"' + - name: millions + uid: excel!Excel.ChartAxisDisplayUnit.millions:member + package: excel! + summary: >- + This will set the axis in units of millions. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Millions"' + - name: none + uid: excel!Excel.ChartAxisDisplayUnit.none:member + package: excel! + summary: >- + Default option. This will reset display unit to the axis, and set unit + label invisible. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"None"' + - name: tenMillions + uid: excel!Excel.ChartAxisDisplayUnit.tenMillions:member + package: excel! + summary: >- + This will set the axis in units of tens of millions. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"TenMillions"' + - name: tenThousands + uid: excel!Excel.ChartAxisDisplayUnit.tenThousands:member + package: excel! + summary: >- + This will set the axis in units of tens of thousands. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"TenThousands"' + - name: thousands + uid: excel!Excel.ChartAxisDisplayUnit.thousands:member + package: excel! + summary: >- + This will set the axis in units of thousands. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Thousands"' + - name: trillions + uid: excel!Excel.ChartAxisDisplayUnit.trillions:member + package: excel! + summary: >- + This will set the axis in units of trillions. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Trillions"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxisformat.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxisformat.yml new file mode 100644 index 0000000000..8589188916 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxisformat.yml @@ -0,0 +1,231 @@ +### YamlMime:TSType +name: Excel.ChartAxisFormat +uid: excel!Excel.ChartAxisFormat:class +package: excel! +fullName: Excel.ChartAxisFormat +summary: Encapsulates the format properties for the chart axis. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.ChartAxisFormat#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: fill + uid: excel!Excel.ChartAxisFormat#fill:member + package: excel! + fullName: fill + summary: Specifies chart fill formatting. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly fill: Excel.ChartFill;' + return: + type: + - name: font + uid: excel!Excel.ChartAxisFormat#font:member + package: excel! + fullName: font + summary: >- + Specifies the font attributes (font name, font size, color, etc.) for a + chart axis element. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly font: Excel.ChartFont;' + return: + type: + - name: line + uid: excel!Excel.ChartAxisFormat#line:member + package: excel! + fullName: line + summary: Specifies chart line formatting. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly line: Excel.ChartLineFormat;' + return: + type: +methods: + - name: load(options) + uid: excel!Excel.ChartAxisFormat#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartAxisFormatLoadOptions): + Excel.ChartAxisFormat; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartAxisFormat#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartAxisFormat;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartAxisFormat#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartAxisFormat; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartAxisFormat#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartAxisFormatUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartAxisFormat#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartAxisFormat): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartAxisFormat#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.ChartAxisFormat` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.ChartAxisFormatData`) that + contains shallow copies of any loaded child properties from the original + object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartAxisFormatData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxisgroup.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxisgroup.yml new file mode 100644 index 0000000000..81ab74b242 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxisgroup.yml @@ -0,0 +1,27 @@ +### YamlMime:TSEnum +name: Excel.ChartAxisGroup +uid: excel!Excel.ChartAxisGroup:enum +package: excel! +fullName: Excel.ChartAxisGroup +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: primary + uid: excel!Excel.ChartAxisGroup.primary:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Primary"' + - name: secondary + uid: excel!Excel.ChartAxisGroup.secondary:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Secondary"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxisposition.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxisposition.yml new file mode 100644 index 0000000000..35588399a8 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxisposition.yml @@ -0,0 +1,41 @@ +### YamlMime:TSEnum +name: Excel.ChartAxisPosition +uid: excel!Excel.ChartAxisPosition:enum +package: excel! +fullName: Excel.ChartAxisPosition +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: automatic + uid: excel!Excel.ChartAxisPosition.automatic:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Automatic"' + - name: custom + uid: excel!Excel.ChartAxisPosition.custom:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Custom"' + - name: maximum + uid: excel!Excel.ChartAxisPosition.maximum:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Maximum"' + - name: minimum + uid: excel!Excel.ChartAxisPosition.minimum:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Minimum"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxisscaletype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxisscaletype.yml new file mode 100644 index 0000000000..d31ead1366 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxisscaletype.yml @@ -0,0 +1,27 @@ +### YamlMime:TSEnum +name: Excel.ChartAxisScaleType +uid: excel!Excel.ChartAxisScaleType:enum +package: excel! +fullName: Excel.ChartAxisScaleType +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: linear + uid: excel!Excel.ChartAxisScaleType.linear:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Linear"' + - name: logarithmic + uid: excel!Excel.ChartAxisScaleType.logarithmic:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Logarithmic"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxisticklabelposition.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxisticklabelposition.yml new file mode 100644 index 0000000000..052bb3a588 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxisticklabelposition.yml @@ -0,0 +1,41 @@ +### YamlMime:TSEnum +name: Excel.ChartAxisTickLabelPosition +uid: excel!Excel.ChartAxisTickLabelPosition:enum +package: excel! +fullName: Excel.ChartAxisTickLabelPosition +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: high + uid: excel!Excel.ChartAxisTickLabelPosition.high:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"High"' + - name: low + uid: excel!Excel.ChartAxisTickLabelPosition.low:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Low"' + - name: nextToAxis + uid: excel!Excel.ChartAxisTickLabelPosition.nextToAxis:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"NextToAxis"' + - name: none + uid: excel!Excel.ChartAxisTickLabelPosition.none:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"None"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxistickmark.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxistickmark.yml new file mode 100644 index 0000000000..cfbd9fcbc0 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxistickmark.yml @@ -0,0 +1,41 @@ +### YamlMime:TSEnum +name: Excel.ChartAxisTickMark +uid: excel!Excel.ChartAxisTickMark:enum +package: excel! +fullName: Excel.ChartAxisTickMark +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: cross + uid: excel!Excel.ChartAxisTickMark.cross:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Cross"' + - name: inside + uid: excel!Excel.ChartAxisTickMark.inside:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Inside"' + - name: none + uid: excel!Excel.ChartAxisTickMark.none:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"None"' + - name: outside + uid: excel!Excel.ChartAxisTickMark.outside:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Outside"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxistimeunit.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxistimeunit.yml new file mode 100644 index 0000000000..625602024c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxistimeunit.yml @@ -0,0 +1,34 @@ +### YamlMime:TSEnum +name: Excel.ChartAxisTimeUnit +uid: excel!Excel.ChartAxisTimeUnit:enum +package: excel! +fullName: Excel.ChartAxisTimeUnit +summary: Specifies the unit of time for chart axes and data series. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: days + uid: excel!Excel.ChartAxisTimeUnit.days:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Days"' + - name: months + uid: excel!Excel.ChartAxisTimeUnit.months:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Months"' + - name: years + uid: excel!Excel.ChartAxisTimeUnit.years:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Years"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxistitle.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxistitle.yml new file mode 100644 index 0000000000..254803f34f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxistitle.yml @@ -0,0 +1,308 @@ +### YamlMime:TSType +name: Excel.ChartAxisTitle +uid: excel!Excel.ChartAxisTitle:class +package: excel! +fullName: Excel.ChartAxisTitle +summary: Represents the title of a chart axis. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.ChartAxisTitle#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: format + uid: excel!Excel.ChartAxisTitle#format:member + package: excel! + fullName: format + summary: Specifies the formatting of the chart axis title. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly format: Excel.ChartAxisTitleFormat;' + return: + type: + - name: text + uid: excel!Excel.ChartAxisTitle#text:member + package: excel! + fullName: text + summary: Specifies the axis title. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'text: string;' + return: + type: string + - name: textOrientation + uid: excel!Excel.ChartAxisTitle#textOrientation:member + package: excel! + fullName: textOrientation + summary: >- + Specifies the angle to which the text is oriented for the chart axis + title. The value should either be an integer from -90 to 90 or the integer + 180 for vertically-oriented text. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + // Get a chart named "Sales Chart" from the "Sample" worksheet. + const sheet = context.workbook.worksheets.getItem("Sample"); + let chart = sheet.charts.getItem("Sales Chart"); + + // Set the value axis title to "Profits". + chart.axes.valueAxis.title.text = "Profits"; + + /* Set the value axis text orientation to 0. + For charts with a y-axis, this makes the label on the y-axis horizontal, + instead of the default look of rotated-vertically. + */ + chart.axes.valueAxis.title.textOrientation = 0; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'textOrientation: number;' + return: + type: number + - name: visible + uid: excel!Excel.ChartAxisTitle#visible:member + package: excel! + fullName: visible + summary: Specifies if the axis title is visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible: boolean;' + return: + type: boolean +methods: + - name: load(options) + uid: excel!Excel.ChartAxisTitle#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartAxisTitleLoadOptions): + Excel.ChartAxisTitle; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartAxisTitle#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartAxisTitle;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: |- + + + #### Examples + + ```TypeScript + // Add "Values" as the title for the value Axis. + await Excel.run(async (context) => { + const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); + chart.axes.valueAxis.title.text = "Values"; + await context.sync(); + + console.log("Axis Title Added "); + }); + ``` + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartAxisTitle#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartAxisTitle; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartAxisTitle#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartAxisTitleUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartAxisTitle#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartAxisTitle): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: setFormula(formula) + uid: excel!Excel.ChartAxisTitle#setFormula:member(1) + package: excel! + fullName: setFormula(formula) + summary: >- + A string value that represents the formula of chart axis title using + A1-style notation. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'setFormula(formula: string): void;' + parameters: + - id: formula + description: A string that represents the formula to set. + type: string + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartAxisTitle#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.ChartAxisTitle` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.ChartAxisTitleData`) that + contains shallow copies of any loaded child properties from the original + object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartAxisTitleData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxistitleformat.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxistitleformat.yml new file mode 100644 index 0000000000..01cf483a51 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxistitleformat.yml @@ -0,0 +1,237 @@ +### YamlMime:TSType +name: Excel.ChartAxisTitleFormat +uid: excel!Excel.ChartAxisTitleFormat:class +package: excel! +fullName: Excel.ChartAxisTitleFormat +summary: Represents the chart axis title formatting. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: border + uid: excel!Excel.ChartAxisTitleFormat#border:member + package: excel! + fullName: border + summary: >- + Specifies the chart axis title's border format, which includes color, + linestyle, and weight. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly border: Excel.ChartBorder;' + return: + type: + - name: context + uid: excel!Excel.ChartAxisTitleFormat#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: fill + uid: excel!Excel.ChartAxisTitleFormat#fill:member + package: excel! + fullName: fill + summary: Specifies the chart axis title's fill formatting. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly fill: Excel.ChartFill;' + return: + type: + - name: font + uid: excel!Excel.ChartAxisTitleFormat#font:member + package: excel! + fullName: font + summary: >- + Specifies the chart axis title's font attributes, such as font name, font + size, or color, of the chart axis title object. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly font: Excel.ChartFont;' + return: + type: +methods: + - name: load(options) + uid: excel!Excel.ChartAxisTitleFormat#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartAxisTitleFormatLoadOptions): + Excel.ChartAxisTitleFormat; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartAxisTitleFormat#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartAxisTitleFormat;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartAxisTitleFormat#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartAxisTitleFormat; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartAxisTitleFormat#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartAxisTitleFormatUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartAxisTitleFormat#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartAxisTitleFormat): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartAxisTitleFormat#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.ChartAxisTitleFormat` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.ChartAxisTitleFormatData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartAxisTitleFormatData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxistype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxistype.yml new file mode 100644 index 0000000000..cc6e718de9 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartaxistype.yml @@ -0,0 +1,50 @@ +### YamlMime:TSEnum +name: Excel.ChartAxisType +uid: excel!Excel.ChartAxisType:enum +package: excel! +fullName: Excel.ChartAxisType +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: category + uid: excel!Excel.ChartAxisType.category:member + package: excel! + summary: >- + Axis displays categories. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Category"' + - name: invalid + uid: excel!Excel.ChartAxisType.invalid:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Invalid"' + - name: series + uid: excel!Excel.ChartAxisType.series:member + package: excel! + summary: >- + Axis displays data series. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Series"' + - name: value + uid: excel!Excel.ChartAxisType.value:member + package: excel! + summary: >- + Axis displays values. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Value"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartbinoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartbinoptions.yml new file mode 100644 index 0000000000..c839d6821c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartbinoptions.yml @@ -0,0 +1,295 @@ +### YamlMime:TSType +name: Excel.ChartBinOptions +uid: excel!Excel.ChartBinOptions:class +package: excel! +fullName: Excel.ChartBinOptions +summary: Encapsulates the bin options for histogram charts and pareto charts. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: allowOverflow + uid: excel!Excel.ChartBinOptions#allowOverflow:member + package: excel! + fullName: allowOverflow + summary: Specifies if bin overflow is enabled in a histogram chart or pareto chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'allowOverflow: boolean;' + return: + type: boolean + - name: allowUnderflow + uid: excel!Excel.ChartBinOptions#allowUnderflow:member + package: excel! + fullName: allowUnderflow + summary: >- + Specifies if bin underflow is enabled in a histogram chart or pareto + chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'allowUnderflow: boolean;' + return: + type: boolean + - name: context + uid: excel!Excel.ChartBinOptions#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: count + uid: excel!Excel.ChartBinOptions#count:member + package: excel! + fullName: count + summary: Specifies the bin count of a histogram chart or pareto chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'count: number;' + return: + type: number + - name: overflowValue + uid: excel!Excel.ChartBinOptions#overflowValue:member + package: excel! + fullName: overflowValue + summary: Specifies the bin overflow value of a histogram chart or pareto chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'overflowValue: number;' + return: + type: number + - name: type + uid: excel!Excel.ChartBinOptions#type:member + package: excel! + fullName: type + summary: Specifies the bin's type for a histogram chart or pareto chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + type: Excel.ChartBinType | "Category" | "Auto" | "BinWidth" | + "BinCount"; + return: + type: >- + | "Category" | "Auto" | + "BinWidth" | "BinCount" + - name: underflowValue + uid: excel!Excel.ChartBinOptions#underflowValue:member + package: excel! + fullName: underflowValue + summary: Specifies the bin underflow value of a histogram chart or pareto chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'underflowValue: number;' + return: + type: number + - name: width + uid: excel!Excel.ChartBinOptions#width:member + package: excel! + fullName: width + summary: Specifies the bin width value of a histogram chart or pareto chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width: number;' + return: + type: number +methods: + - name: load(options) + uid: excel!Excel.ChartBinOptions#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartBinOptionsLoadOptions): + Excel.ChartBinOptions; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartBinOptions#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartBinOptions;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartBinOptions#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartBinOptions; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartBinOptions#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartBinOptionsUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartBinOptions#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartBinOptions): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartBinOptions#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.ChartBinOptions` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.ChartBinOptionsData`) that + contains shallow copies of any loaded child properties from the original + object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartBinOptionsData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartbintype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartbintype.yml new file mode 100644 index 0000000000..61b7762803 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartbintype.yml @@ -0,0 +1,41 @@ +### YamlMime:TSEnum +name: Excel.ChartBinType +uid: excel!Excel.ChartBinType:enum +package: excel! +fullName: Excel.ChartBinType +summary: Specifies the bin type of a histogram chart or pareto chart series. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: auto + uid: excel!Excel.ChartBinType.auto:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Auto"' + - name: binCount + uid: excel!Excel.ChartBinType.binCount:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"BinCount"' + - name: binWidth + uid: excel!Excel.ChartBinType.binWidth:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"BinWidth"' + - name: category + uid: excel!Excel.ChartBinType.category:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Category"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartborder.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartborder.yml new file mode 100644 index 0000000000..b5aea77cda --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartborder.yml @@ -0,0 +1,252 @@ +### YamlMime:TSType +name: Excel.ChartBorder +uid: excel!Excel.ChartBorder:class +package: excel! +fullName: Excel.ChartBorder +summary: Represents the border formatting of a chart element. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: color + uid: excel!Excel.ChartBorder#color:member + package: excel! + fullName: color + summary: HTML color code representing the color of borders in the chart. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color: string;' + return: + type: string + - name: context + uid: excel!Excel.ChartBorder#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: lineStyle + uid: excel!Excel.ChartBorder#lineStyle:member + package: excel! + fullName: lineStyle + summary: >- + Represents the line style of the border. See `Excel.ChartLineStyle` for + details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + lineStyle: Excel.ChartLineStyle | "None" | "Continuous" | "Dash" | + "DashDot" | "DashDotDot" | "Dot" | "Grey25" | "Grey50" | "Grey75" | + "Automatic" | "RoundDot"; + return: + type: >- + | "None" | "Continuous" + | "Dash" | "DashDot" | "DashDotDot" | "Dot" | "Grey25" | "Grey50" | + "Grey75" | "Automatic" | "RoundDot" + - name: weight + uid: excel!Excel.ChartBorder#weight:member + package: excel! + fullName: weight + summary: Represents weight of the border, in points. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'weight: number;' + return: + type: number +methods: + - name: clear() + uid: excel!Excel.ChartBorder#clear:member(1) + package: excel! + fullName: clear() + summary: Clear the border format of a chart element. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'clear(): void;' + return: + type: void + description: '' + - name: load(options) + uid: excel!Excel.ChartBorder#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartBorderLoadOptions): + Excel.ChartBorder; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartBorder#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartBorder;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartBorder#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartBorder; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartBorder#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartBorderUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartBorder#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartBorder): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartBorder#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.ChartBorder` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.ChartBorderData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartBorderData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartboxquartilecalculation.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartboxquartilecalculation.yml new file mode 100644 index 0000000000..9d9f7e7696 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartboxquartilecalculation.yml @@ -0,0 +1,29 @@ +### YamlMime:TSEnum +name: Excel.ChartBoxQuartileCalculation +uid: excel!Excel.ChartBoxQuartileCalculation:enum +package: excel! +fullName: Excel.ChartBoxQuartileCalculation +summary: >- + Represents the quartile calculation type of chart series layout. Only applies + to a box and whisker chart. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: exclusive + uid: excel!Excel.ChartBoxQuartileCalculation.exclusive:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Exclusive"' + - name: inclusive + uid: excel!Excel.ChartBoxQuartileCalculation.inclusive:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Inclusive"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartboxwhiskeroptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartboxwhiskeroptions.yml new file mode 100644 index 0000000000..54fcbbe764 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartboxwhiskeroptions.yml @@ -0,0 +1,267 @@ +### YamlMime:TSType +name: Excel.ChartBoxwhiskerOptions +uid: excel!Excel.ChartBoxwhiskerOptions:class +package: excel! +fullName: Excel.ChartBoxwhiskerOptions +summary: Represents the properties of a box and whisker chart. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.ChartBoxwhiskerOptions#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: quartileCalculation + uid: excel!Excel.ChartBoxwhiskerOptions#quartileCalculation:member + package: excel! + fullName: quartileCalculation + summary: Specifies if the quartile calculation type of a box and whisker chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + quartileCalculation: Excel.ChartBoxQuartileCalculation | "Inclusive" | + "Exclusive"; + return: + type: >- + | + "Inclusive" | "Exclusive" + - name: showInnerPoints + uid: excel!Excel.ChartBoxwhiskerOptions#showInnerPoints:member + package: excel! + fullName: showInnerPoints + summary: Specifies if inner points are shown in a box and whisker chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showInnerPoints: boolean;' + return: + type: boolean + - name: showMeanLine + uid: excel!Excel.ChartBoxwhiskerOptions#showMeanLine:member + package: excel! + fullName: showMeanLine + summary: Specifies if the mean line is shown in a box and whisker chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showMeanLine: boolean;' + return: + type: boolean + - name: showMeanMarker + uid: excel!Excel.ChartBoxwhiskerOptions#showMeanMarker:member + package: excel! + fullName: showMeanMarker + summary: Specifies if the mean marker is shown in a box and whisker chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showMeanMarker: boolean;' + return: + type: boolean + - name: showOutlierPoints + uid: excel!Excel.ChartBoxwhiskerOptions#showOutlierPoints:member + package: excel! + fullName: showOutlierPoints + summary: Specifies if outlier points are shown in a box and whisker chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showOutlierPoints: boolean;' + return: + type: boolean +methods: + - name: load(options) + uid: excel!Excel.ChartBoxwhiskerOptions#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartBoxwhiskerOptionsLoadOptions): + Excel.ChartBoxwhiskerOptions; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartBoxwhiskerOptions#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartBoxwhiskerOptions;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartBoxwhiskerOptions#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartBoxwhiskerOptions; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartBoxwhiskerOptions#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartBoxwhiskerOptionsUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartBoxwhiskerOptions#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartBoxwhiskerOptions): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartBoxwhiskerOptions#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.ChartBoxwhiskerOptions` object is an API object, the `toJSON` + method returns a plain JavaScript object (typed as + `Excel.Interfaces.ChartBoxwhiskerOptionsData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartBoxwhiskerOptionsData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartcollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartcollection.yml new file mode 100644 index 0000000000..81318ff319 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartcollection.yml @@ -0,0 +1,614 @@ +### YamlMime:TSType +name: Excel.ChartCollection +uid: excel!Excel.ChartCollection:class +package: excel! +fullName: Excel.ChartCollection +summary: A collection of all the chart objects on a worksheet. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.ChartCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: count + uid: excel!Excel.ChartCollection#count:member + package: excel! + fullName: count + summary: Returns the number of charts in the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly count: number;' + return: + type: number + - name: items + uid: excel!Excel.ChartCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.Chart[];' + return: + type: [] +methods: + - name: add(type, sourceData, seriesBy) + uid: excel!Excel.ChartCollection#add:member(1) + package: excel! + fullName: add(type, sourceData, seriesBy) + summary: Creates a new chart. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Add a chart of chartType "ColumnClustered" on worksheet "Charts" + + // with sourceData from range "A1:B4" and seriesBy set to "auto". + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sheet1"); + const rangeSelection = "A1:B4"; + const range = sheet.getRange(rangeSelection); + const chart = sheet.charts.add( + Excel.ChartType.columnClustered, + range, + Excel.ChartSeriesBy.auto); + await context.sync(); + + console.log("New Chart Added"); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + add(type: Excel.ChartType, sourceData: Range, seriesBy?: + Excel.ChartSeriesBy): Excel.Chart; + parameters: + - id: type + description: Represents the type of a chart. See `Excel.ChartType` for details. + type: + - id: sourceData + description: The `Range` object corresponding to the source data. + type: + - id: seriesBy + description: >- + Optional. Specifies the way columns or rows are used as data series + on the chart. See `Excel.ChartSeriesBy` for details. + type: + return: + type: + description: '' + - name: add(type, sourceData, seriesBy) + uid: excel!Excel.ChartCollection#add:member(2) + package: excel! + fullName: add(type, sourceData, seriesBy) + summary: Creates a new chart. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + add(type: "Invalid" | "ColumnClustered" | "ColumnStacked" | + "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | + "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | + "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | + "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | + "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | + "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | + "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | + "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | + "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | + "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | + "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | + "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | + "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" + | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | + "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | + "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | + "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | + "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | + "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | + "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | + "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | + "Sunburst" | "Funnel", sourceData: Range, seriesBy?: "Auto" | "Columns" + | "Rows"): Excel.Chart; + parameters: + - id: type + description: Represents the type of a chart. See `Excel.ChartType` for details. + type: >- + "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" + | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | + "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | + "3DBarStacked" | "3DBarStacked100" | "LineStacked" | + "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | + "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | + "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | + "XYScatterSmoothNoMarkers" | "XYScatterLines" | + "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | + "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | + "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | + "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | + "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | + "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | + "CylinderColStacked100" | "CylinderBarClustered" | + "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | + "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | + "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | + "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | + "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" + | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | + "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | + "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | + "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel" + - id: sourceData + description: The `Range` object corresponding to the source data. + type: + - id: seriesBy + description: >- + Optional. Specifies the way columns or rows are used as data series + on the chart. See `Excel.ChartSeriesBy` for details. + type: '"Auto" | "Columns" | "Rows"' + return: + type: + description: '' + - name: getCount() + uid: excel!Excel.ChartCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Returns the number of charts in the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getItem(name) + uid: excel!Excel.ChartCollection#getItem:member(1) + package: excel! + fullName: getItem(name) + summary: >- + Gets a chart using its name. If there are multiple charts with the same + name, the first one will be returned. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Get the number of charts. + + await Excel.run(async (context) => { + const charts = context.workbook.worksheets.getItem("Sheet1").charts; + charts.load('count'); + await context.sync(); + + console.log("charts: Count= " + charts.count); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getItem(name: string): Excel.Chart;' + parameters: + - id: name + description: Name of the chart to be retrieved. + type: string + return: + type: + description: '' + - name: getItemAt(index) + uid: excel!Excel.ChartCollection#getItemAt:member(1) + package: excel! + fullName: getItemAt(index) + summary: Gets a chart based on its position in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const lastPosition = context.workbook.worksheets.getItem("Sheet1").charts.count - 1; + const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItemAt(lastPosition); + await context.sync(); + + console.log(chart.name); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemAt(index: number): Excel.Chart;' + parameters: + - id: index + description: Index value of the object to be retrieved. Zero-indexed. + type: number + return: + type: + description: '' + - name: getItemOrNullObject(name) + uid: excel!Excel.ChartCollection#getItemOrNullObject:member(1) + package: excel! + fullName: getItemOrNullObject(name) + summary: >- + Gets a chart using its name. If there are multiple charts with the same + name, the first one will be returned. If the chart doesn't exist, then + this method returns an object with its `isNullObject` property set to + `true`. For further information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemOrNullObject(name: string): Excel.Chart;' + parameters: + - id: name + description: Name of the chart to be retrieved. + type: string + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.ChartCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): Excel.ChartCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartCollection;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: |- + + + #### Examples + + ```TypeScript + await Excel.run(async (context) => { + const charts = context.workbook.worksheets.getItem("Sheet1").charts; + charts.load('items'); + await context.sync(); + + for (let i = 0; i < charts.items.length; i++) { + console.log(charts.items[i].name); + } + }); + ``` + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.ChartCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.ChartCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.ChartCollection` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.ChartCollectionData`) that + contains an "items" array with shallow copies of any loaded properties + from the collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartCollectionData;' + return: + type: + description: '' +events: + - name: onActivated + uid: excel!Excel.ChartCollection#onActivated:member + package: excel! + fullName: onActivated + summary: Occurs when a chart is activated. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-chart-activated.yaml + + + await Excel.run(async (context) => { + + const pieChart = context.workbook.worksheets.getActiveWorksheet().charts.getItem("Pie"); + + // Register the onActivated and onDeactivated event handlers. + pieChart.onActivated.add(chartActivated); + pieChart.onDeactivated.add(chartDeactivated); + + await context.sync(); + + console.log("Added handlers for Chart onActivated and onDeactivated events."); + }); + + + ... + + + async function chartActivated(event) { + await Excel.run(async (context) => { + // Retrieve the worksheet. + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Retrieve the activated chart by ID and load the name of the chart. + const activatedChart = sheet.charts.getItem(event.chartId); + activatedChart.load(["name"]); + await context.sync(); + + // Print out the activated chart's data. + console.log(`A chart was activated. ID: ${event.chartId}. Chart name: ${activatedChart.name}.`); + }); + } + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onActivated: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onAdded + uid: excel!Excel.ChartCollection#onAdded:member + package: excel! + fullName: onAdded + summary: Occurs when a new chart is added to the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + context.workbook.worksheets.getActiveWorksheet() + .charts.onAdded.add(function (event) { + return Excel.run(async (context) => { + console.log("A chart has been added with ID: " + event.chartId); + await context.sync(); + }); + }); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onAdded: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onDeactivated + uid: excel!Excel.ChartCollection#onDeactivated:member + package: excel! + fullName: onDeactivated + summary: Occurs when a chart is deactivated. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-chart-activated.yaml + + + await Excel.run(async (context) => { + + const pieChart = context.workbook.worksheets.getActiveWorksheet().charts.getItem("Pie"); + + // Register the onActivated and onDeactivated event handlers. + pieChart.onActivated.add(chartActivated); + pieChart.onDeactivated.add(chartDeactivated); + + await context.sync(); + + console.log("Added handlers for Chart onActivated and onDeactivated events."); + }); + + + ... + + + async function chartDeactivated(event) { + await Excel.run(async (context) => { + // Callback function for when the chart is deactivated. + console.log("The pie chart is NOT active."); + }); + } + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onDeactivated: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onDeleted + uid: excel!Excel.ChartCollection#onDeleted:member + package: excel! + fullName: onDeleted + summary: Occurs when a chart is deleted. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + context.workbook.worksheets.getActiveWorksheet() + .charts.onDeleted.add(function (event) { + return Excel.run(async (context) => { + console.log("The chart with this ID was deleted: " + event.chartId); + await context.sync(); + }); + }); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onDeleted: + OfficeExtension.EventHandlers; + return: + type: >- + <> +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartcolorscheme.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartcolorscheme.yml new file mode 100644 index 0000000000..2a85d8d6e3 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartcolorscheme.yml @@ -0,0 +1,132 @@ +### YamlMime:TSEnum +name: Excel.ChartColorScheme +uid: excel!Excel.ChartColorScheme:enum +package: excel! +fullName: Excel.ChartColorScheme +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: colorfulPalette1 + uid: excel!Excel.ChartColorScheme.colorfulPalette1:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ColorfulPalette1"' + - name: colorfulPalette2 + uid: excel!Excel.ChartColorScheme.colorfulPalette2:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ColorfulPalette2"' + - name: colorfulPalette3 + uid: excel!Excel.ChartColorScheme.colorfulPalette3:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ColorfulPalette3"' + - name: colorfulPalette4 + uid: excel!Excel.ChartColorScheme.colorfulPalette4:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ColorfulPalette4"' + - name: monochromaticPalette1 + uid: excel!Excel.ChartColorScheme.monochromaticPalette1:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"MonochromaticPalette1"' + - name: monochromaticPalette10 + uid: excel!Excel.ChartColorScheme.monochromaticPalette10:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"MonochromaticPalette10"' + - name: monochromaticPalette11 + uid: excel!Excel.ChartColorScheme.monochromaticPalette11:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"MonochromaticPalette11"' + - name: monochromaticPalette12 + uid: excel!Excel.ChartColorScheme.monochromaticPalette12:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"MonochromaticPalette12"' + - name: monochromaticPalette13 + uid: excel!Excel.ChartColorScheme.monochromaticPalette13:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"MonochromaticPalette13"' + - name: monochromaticPalette2 + uid: excel!Excel.ChartColorScheme.monochromaticPalette2:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"MonochromaticPalette2"' + - name: monochromaticPalette3 + uid: excel!Excel.ChartColorScheme.monochromaticPalette3:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"MonochromaticPalette3"' + - name: monochromaticPalette4 + uid: excel!Excel.ChartColorScheme.monochromaticPalette4:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"MonochromaticPalette4"' + - name: monochromaticPalette5 + uid: excel!Excel.ChartColorScheme.monochromaticPalette5:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"MonochromaticPalette5"' + - name: monochromaticPalette6 + uid: excel!Excel.ChartColorScheme.monochromaticPalette6:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"MonochromaticPalette6"' + - name: monochromaticPalette7 + uid: excel!Excel.ChartColorScheme.monochromaticPalette7:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"MonochromaticPalette7"' + - name: monochromaticPalette8 + uid: excel!Excel.ChartColorScheme.monochromaticPalette8:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"MonochromaticPalette8"' + - name: monochromaticPalette9 + uid: excel!Excel.ChartColorScheme.monochromaticPalette9:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"MonochromaticPalette9"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartdatalabel.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartdatalabel.yml new file mode 100644 index 0000000000..4ba889edab --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartdatalabel.yml @@ -0,0 +1,826 @@ +### YamlMime:TSType +name: Excel.ChartDataLabel +uid: excel!Excel.ChartDataLabel:class +package: excel! +fullName: Excel.ChartDataLabel +summary: Represents the data label of a chart point. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-data-labels.yaml + + + // This function styles substrings within data label text using font + formatting. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem(sheetName); + const chart = sheet.charts.getItemAt(0); + await context.sync(); + + const series = chart.series.getItemAt(0); + series.load("points"); + await context.sync(); + + series.points.load("items"); + await context.sync(); + + // Style a substring in the first data label. + let searchString = "sports"; + let dataLabel = series.points.getItemAt(dataLabelInfo[0].index).dataLabel.load("text"); + await context.sync(); + let substringStart = dataLabel.text.indexOf(searchString); + let subLabel = dataLabel.getSubstring(substringStart, searchString.length); + subLabel.font.size = 13; + subLabel.font.bold = true; + + // Style a substring in the second data label. + searchString = "'Titanic'"; + dataLabel = series.points.getItemAt(dataLabelInfo[1].index).dataLabel.load("text"); + await context.sync(); + + substringStart = dataLabel.text.indexOf(searchString); + subLabel = dataLabel.getSubstring(substringStart, searchString.length); + subLabel.font.name = "Calibri"; + subLabel.font.size = 13; + subLabel.font.italic = true; + subLabel.font.color = "blue"; + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +type: class +properties: + - name: autoText + uid: excel!Excel.ChartDataLabel#autoText:member + package: excel! + fullName: autoText + summary: >- + Specifies if the data label automatically generates appropriate text based + on context. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'autoText: boolean;' + return: + type: boolean + - name: context + uid: excel!Excel.ChartDataLabel#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: format + uid: excel!Excel.ChartDataLabel#format:member + package: excel! + fullName: format + summary: Represents the format of chart data label. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly format: Excel.ChartDataLabelFormat;' + return: + type: + - name: formula + uid: excel!Excel.ChartDataLabel#formula:member + package: excel! + fullName: formula + summary: >- + String value that represents the formula of chart data label using + A1-style notation. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formula: string;' + return: + type: string + - name: geometricShapeType + uid: excel!Excel.ChartDataLabel#geometricShapeType:member + package: excel! + fullName: geometricShapeType + summary: >- + Specifies the geometric shape type of the data label. See + `Excel.GeometricShapeType` for more details. Value is `null` if the data + label is not a geometric shape. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + geometricShapeType: Excel.GeometricShapeType | "LineInverse" | + "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" + | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | + "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | + "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" + | "Star32" | "RoundRectangle" | "Round1Rectangle" | + "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" + | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | + "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" + | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | + "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | + "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | + "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | + "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | + "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | + "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | + "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | + "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | + "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | + "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" + | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | + "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | + "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | + "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | + "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | + "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" + | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | + "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | + "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | + "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" + | "FlowChartDecision" | "FlowChartInputOutput" | + "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | + "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | + "FlowChartPreparation" | "FlowChartManualInput" | + "FlowChartManualOperation" | "FlowChartConnector" | + "FlowChartPunchedCard" | "FlowChartPunchedTape" | + "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | + "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | + "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | + "FlowChartMagneticTape" | "FlowChartMagneticDisk" | + "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | + "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | + "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | + "ActionButtonInformation" | "ActionButtonForwardNext" | + "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" + | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | + "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | + "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | + "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | + "ChartStar" | "ChartPlus"; + return: + type: >- + | "LineInverse" | + "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | + "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | + "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" + | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | + "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" + | "Round2SameRectangle" | "Round2DiagonalRectangle" | + "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | + "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | + "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | + "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | + "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | + "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" + | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | + "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | + "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" + | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | + "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | + "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | + "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | + "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | + "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | + "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | + "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" + | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | + "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | + "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | + "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" + | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | + "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | + "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | + "FlowChartInputOutput" | "FlowChartPredefinedProcess" | + "FlowChartInternalStorage" | "FlowChartDocument" | + "FlowChartMultidocument" | "FlowChartTerminator" | + "FlowChartPreparation" | "FlowChartManualInput" | + "FlowChartManualOperation" | "FlowChartConnector" | + "FlowChartPunchedCard" | "FlowChartPunchedTape" | + "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | + "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | + "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | + "FlowChartMagneticTape" | "FlowChartMagneticDisk" | + "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | + "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | + "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | + "ActionButtonInformation" | "ActionButtonForwardNext" | + "ActionButtonBackPrevious" | "ActionButtonEnd" | + "ActionButtonBeginning" | "ActionButtonReturn" | + "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | + "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | + "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | + "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | + "ChartPlus" + - name: height + uid: excel!Excel.ChartDataLabel#height:member + package: excel! + fullName: height + summary: >- + Returns the height, in points, of the chart data label. Value is `null` if + the chart data label is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly height: number;' + return: + type: number + - name: horizontalAlignment + uid: excel!Excel.ChartDataLabel#horizontalAlignment:member + package: excel! + fullName: horizontalAlignment + summary: >- + Represents the horizontal alignment for chart data label. See + `Excel.ChartTextHorizontalAlignment` for details. This property is valid + only when `TextOrientation` of data label is -90, 90, or 180. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + horizontalAlignment: Excel.ChartTextHorizontalAlignment | "Center" | + "Left" | "Right" | "Justify" | "Distributed"; + return: + type: >- + | + "Center" | "Left" | "Right" | "Justify" | "Distributed" + - name: left + uid: excel!Excel.ChartDataLabel#left:member + package: excel! + fullName: left + summary: >- + Represents the distance, in points, from the left edge of chart data label + to the left edge of chart area. Value is `null` if the chart data label is + not visible. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left: number;' + return: + type: number + - name: linkNumberFormat + uid: excel!Excel.ChartDataLabel#linkNumberFormat:member + package: excel! + fullName: linkNumberFormat + summary: >- + Specifies if the number format is linked to the cells (so that the number + format changes in the labels when it changes in the cells). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'linkNumberFormat: boolean;' + return: + type: boolean + - name: numberFormat + uid: excel!Excel.ChartDataLabel#numberFormat:member + package: excel! + fullName: numberFormat + summary: Specifies the format code for data label. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat: string;' + return: + type: string + - name: position + uid: excel!Excel.ChartDataLabel#position:member + package: excel! + fullName: position + summary: >- + Value that represents the position of the data label. See + `Excel.ChartDataLabelPosition` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + position: Excel.ChartDataLabelPosition | "Invalid" | "None" | "Center" | + "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" | "Right" | "Top" | + "Bottom" | "BestFit" | "Callout"; + return: + type: >- + | "Invalid" | + "None" | "Center" | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" + | "Right" | "Top" | "Bottom" | "BestFit" | "Callout" + - name: separator + uid: excel!Excel.ChartDataLabel#separator:member + package: excel! + fullName: separator + summary: String representing the separator used for the data label on a chart. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'separator: string;' + return: + type: string + - name: showAsStickyCallout + uid: excel!Excel.ChartDataLabel#showAsStickyCallout:member + package: excel! + fullName: showAsStickyCallout + summary: >- + Specifies if the data label is shown as a callout with the tail anchor + attached to the data point. If `true`, the callout is one of the + following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", + "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or + "WedgeEllipseCallout". See + [GeometricShapeType](xref:excel!Excel.GeometricShapeType:enum) for more + details. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly showAsStickyCallout: boolean;' + return: + type: boolean + - name: showBubbleSize + uid: excel!Excel.ChartDataLabel#showBubbleSize:member + package: excel! + fullName: showBubbleSize + summary: Specifies if the data label bubble size is visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showBubbleSize: boolean;' + return: + type: boolean + - name: showCategoryName + uid: excel!Excel.ChartDataLabel#showCategoryName:member + package: excel! + fullName: showCategoryName + summary: Specifies if the data label category name is visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showCategoryName: boolean;' + return: + type: boolean + - name: showLegendKey + uid: excel!Excel.ChartDataLabel#showLegendKey:member + package: excel! + fullName: showLegendKey + summary: Specifies if the data label legend key is visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showLegendKey: boolean;' + return: + type: boolean + - name: showPercentage + uid: excel!Excel.ChartDataLabel#showPercentage:member + package: excel! + fullName: showPercentage + summary: Specifies if the data label percentage is visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showPercentage: boolean;' + return: + type: boolean + - name: showSeriesName + uid: excel!Excel.ChartDataLabel#showSeriesName:member + package: excel! + fullName: showSeriesName + summary: Specifies if the data label series name is visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showSeriesName: boolean;' + return: + type: boolean + - name: showValue + uid: excel!Excel.ChartDataLabel#showValue:member + package: excel! + fullName: showValue + summary: Specifies if the data label value is visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showValue: boolean;' + return: + type: boolean + - name: text + uid: excel!Excel.ChartDataLabel#text:member + package: excel! + fullName: text + summary: String representing the text of the data label on a chart. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'text: string;' + return: + type: string + - name: textOrientation + uid: excel!Excel.ChartDataLabel#textOrientation:member + package: excel! + fullName: textOrientation + summary: >- + Represents the angle to which the text is oriented for the chart data + label. The value should either be an integer from -90 to 90 or the integer + 180 for vertically-oriented text. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textOrientation: number;' + return: + type: number + - name: top + uid: excel!Excel.ChartDataLabel#top:member + package: excel! + fullName: top + summary: >- + Represents the distance, in points, from the top edge of chart data label + to the top of chart area. Value is `null` if the chart data label is not + visible. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top: number;' + return: + type: number + - name: verticalAlignment + uid: excel!Excel.ChartDataLabel#verticalAlignment:member + package: excel! + fullName: verticalAlignment + summary: >- + Represents the vertical alignment of chart data label. See + `Excel.ChartTextVerticalAlignment` for details. This property is valid + only when `TextOrientation` of data label is 0. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | + "Bottom" | "Top" | "Justify" | "Distributed"; + return: + type: >- + | "Center" + | "Bottom" | "Top" | "Justify" | "Distributed" + - name: width + uid: excel!Excel.ChartDataLabel#width:member + package: excel! + fullName: width + summary: >- + Returns the width, in points, of the chart data label. Value is `null` if + the chart data label is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly width: number;' + return: + type: number +methods: + - name: getSubstring(start, length) + uid: excel!Excel.ChartDataLabel#getSubstring:member(1) + package: excel! + fullName: getSubstring(start, length) + summary: >- + Returns a substring of the data label. The line break character '\\n' counts as one character. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getSubstring(start: number, length?: number): Excel.ChartFormatString;' + parameters: + - id: start + description: >- + The zero-based starting character position of a substring in the + data label. + type: number + - id: length + description: >- + Optional. The number of characters in the substring. If length is + omitted, all the characters from start to the end of the data label + are retrieved. + type: number + return: + type: + description: '' + - name: getTailAnchor() + uid: excel!Excel.ChartDataLabel#getTailAnchor:member(1) + package: excel! + fullName: getTailAnchor() + summary: >- + Returns the tail anchor of the data label which is shown as a sticky + callout. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getTailAnchor(): Excel.ChartDataLabelAnchor;' + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.ChartDataLabel#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartDataLabelLoadOptions): + Excel.ChartDataLabel; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartDataLabel#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartDataLabel;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartDataLabel#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartDataLabel; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartDataLabel#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartDataLabelUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartDataLabel#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartDataLabel): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: setHeight(height) + uid: excel!Excel.ChartDataLabel#setHeight:member(1) + package: excel! + fullName: setHeight(height) + summary: Sets the height of the data label in points. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'setHeight(height: number): void;' + parameters: + - id: height + description: The height of the data label in points. + type: number + return: + type: void + description: '' + - name: setWidth(width) + uid: excel!Excel.ChartDataLabel#setWidth:member(1) + package: excel! + fullName: setWidth(width) + summary: Sets the width of the data label in points. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'setWidth(width: number): void;' + parameters: + - id: width + description: The width of the data label in points. + type: number + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartDataLabel#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.ChartDataLabel` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.ChartDataLabelData`) that + contains shallow copies of any loaded child properties from the original + object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartDataLabelData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartdatalabelanchor.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartdatalabelanchor.yml new file mode 100644 index 0000000000..567f6f8650 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartdatalabelanchor.yml @@ -0,0 +1,226 @@ +### YamlMime:TSType +name: Excel.ChartDataLabelAnchor +uid: excel!Excel.ChartDataLabelAnchor:class +package: excel! +fullName: Excel.ChartDataLabelAnchor +summary: Represents the chart data label anchor. +remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.ChartDataLabelAnchor#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: left + uid: excel!Excel.ChartDataLabelAnchor#left:member + package: excel! + fullName: left + summary: >- + Specifies the distance, in points, from the anchor to the left edge of the + chart data label. Note that when getting the value, it may differ slightly + from the set value. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left: number;' + return: + type: number + - name: top + uid: excel!Excel.ChartDataLabelAnchor#top:member + package: excel! + fullName: top + summary: >- + Specifies the distance, in points, from the anchor to the top edge of the + chart data label. Note that when getting the value, it may differ slightly + from the set value. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top: number;' + return: + type: number +methods: + - name: load(options) + uid: excel!Excel.ChartDataLabelAnchor#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartDataLabelAnchorLoadOptions): + Excel.ChartDataLabelAnchor; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartDataLabelAnchor#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartDataLabelAnchor;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartDataLabelAnchor#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartDataLabelAnchor; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartDataLabelAnchor#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartDataLabelAnchorUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartDataLabelAnchor#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartDataLabelAnchor): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartDataLabelAnchor#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.ChartDataLabelAnchor` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.ChartDataLabelAnchorData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartDataLabelAnchorData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartdatalabelformat.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartdatalabelformat.yml new file mode 100644 index 0000000000..c0658a347f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartdatalabelformat.yml @@ -0,0 +1,235 @@ +### YamlMime:TSType +name: Excel.ChartDataLabelFormat +uid: excel!Excel.ChartDataLabelFormat:class +package: excel! +fullName: Excel.ChartDataLabelFormat +summary: Encapsulates the format properties for the chart data labels. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: border + uid: excel!Excel.ChartDataLabelFormat#border:member + package: excel! + fullName: border + summary: Represents the border format, which includes color, linestyle, and weight. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly border: Excel.ChartBorder;' + return: + type: + - name: context + uid: excel!Excel.ChartDataLabelFormat#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: fill + uid: excel!Excel.ChartDataLabelFormat#fill:member + package: excel! + fullName: fill + summary: Represents the fill format of the current chart data label. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly fill: Excel.ChartFill;' + return: + type: + - name: font + uid: excel!Excel.ChartDataLabelFormat#font:member + package: excel! + fullName: font + summary: >- + Represents the font attributes (such as font name, font size, and color) + for a chart data label. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly font: Excel.ChartFont;' + return: + type: +methods: + - name: load(options) + uid: excel!Excel.ChartDataLabelFormat#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartDataLabelFormatLoadOptions): + Excel.ChartDataLabelFormat; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartDataLabelFormat#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartDataLabelFormat;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartDataLabelFormat#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartDataLabelFormat; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartDataLabelFormat#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartDataLabelFormatUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartDataLabelFormat#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartDataLabelFormat): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartDataLabelFormat#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.ChartDataLabelFormat` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.ChartDataLabelFormatData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartDataLabelFormatData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartdatalabelposition.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartdatalabelposition.yml new file mode 100644 index 0000000000..db2db37b4b --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartdatalabelposition.yml @@ -0,0 +1,97 @@ +### YamlMime:TSEnum +name: Excel.ChartDataLabelPosition +uid: excel!Excel.ChartDataLabelPosition:enum +package: excel! +fullName: Excel.ChartDataLabelPosition +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: bestFit + uid: excel!Excel.ChartDataLabelPosition.bestFit:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"BestFit"' + - name: bottom + uid: excel!Excel.ChartDataLabelPosition.bottom:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Bottom"' + - name: callout + uid: excel!Excel.ChartDataLabelPosition.callout:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Callout"' + - name: center + uid: excel!Excel.ChartDataLabelPosition.center:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Center"' + - name: insideBase + uid: excel!Excel.ChartDataLabelPosition.insideBase:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"InsideBase"' + - name: insideEnd + uid: excel!Excel.ChartDataLabelPosition.insideEnd:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"InsideEnd"' + - name: invalid + uid: excel!Excel.ChartDataLabelPosition.invalid:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Invalid"' + - name: left + uid: excel!Excel.ChartDataLabelPosition.left:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Left"' + - name: none + uid: excel!Excel.ChartDataLabelPosition.none:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"None"' + - name: outsideEnd + uid: excel!Excel.ChartDataLabelPosition.outsideEnd:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"OutsideEnd"' + - name: right + uid: excel!Excel.ChartDataLabelPosition.right:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Right"' + - name: top + uid: excel!Excel.ChartDataLabelPosition.top:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Top"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartdatalabels.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartdatalabels.yml new file mode 100644 index 0000000000..4625bc63d2 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartdatalabels.yml @@ -0,0 +1,639 @@ +### YamlMime:TSType +name: Excel.ChartDataLabels +uid: excel!Excel.ChartDataLabels:class +package: excel! +fullName: Excel.ChartDataLabels +summary: Represents a collection of all the data labels on a chart point. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: autoText + uid: excel!Excel.ChartDataLabels#autoText:member + package: excel! + fullName: autoText + summary: >- + Specifies if data labels automatically generate appropriate text based on + context. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'autoText: boolean;' + return: + type: boolean + - name: context + uid: excel!Excel.ChartDataLabels#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: format + uid: excel!Excel.ChartDataLabels#format:member + package: excel! + fullName: format + summary: >- + Specifies the format of chart data labels, which includes fill and font + formatting. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly format: Excel.ChartDataLabelFormat;' + return: + type: + - name: geometricShapeType + uid: excel!Excel.ChartDataLabels#geometricShapeType:member + package: excel! + fullName: geometricShapeType + summary: >- + Specifies the geometric shape type of the data labels. See + `Excel.GeometricShapeType` for more details. Value is `null` if the data + labels are not geometric shapes. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + geometricShapeType: Excel.GeometricShapeType | "LineInverse" | + "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" + | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | + "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | + "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" + | "Star32" | "RoundRectangle" | "Round1Rectangle" | + "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" + | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | + "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" + | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | + "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | + "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | + "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | + "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | + "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | + "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | + "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | + "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | + "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | + "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" + | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | + "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | + "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | + "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | + "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | + "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" + | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | + "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | + "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | + "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" + | "FlowChartDecision" | "FlowChartInputOutput" | + "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | + "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | + "FlowChartPreparation" | "FlowChartManualInput" | + "FlowChartManualOperation" | "FlowChartConnector" | + "FlowChartPunchedCard" | "FlowChartPunchedTape" | + "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | + "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | + "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | + "FlowChartMagneticTape" | "FlowChartMagneticDisk" | + "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | + "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | + "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | + "ActionButtonInformation" | "ActionButtonForwardNext" | + "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" + | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | + "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | + "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | + "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | + "ChartStar" | "ChartPlus"; + return: + type: >- + | "LineInverse" | + "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | + "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | + "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" + | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | + "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" + | "Round2SameRectangle" | "Round2DiagonalRectangle" | + "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | + "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | + "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | + "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | + "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | + "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" + | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | + "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | + "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" + | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | + "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | + "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | + "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | + "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | + "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | + "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | + "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" + | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | + "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | + "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | + "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" + | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | + "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | + "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | + "FlowChartInputOutput" | "FlowChartPredefinedProcess" | + "FlowChartInternalStorage" | "FlowChartDocument" | + "FlowChartMultidocument" | "FlowChartTerminator" | + "FlowChartPreparation" | "FlowChartManualInput" | + "FlowChartManualOperation" | "FlowChartConnector" | + "FlowChartPunchedCard" | "FlowChartPunchedTape" | + "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | + "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | + "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | + "FlowChartMagneticTape" | "FlowChartMagneticDisk" | + "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | + "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | + "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | + "ActionButtonInformation" | "ActionButtonForwardNext" | + "ActionButtonBackPrevious" | "ActionButtonEnd" | + "ActionButtonBeginning" | "ActionButtonReturn" | + "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | + "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | + "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | + "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | + "ChartPlus" + - name: horizontalAlignment + uid: excel!Excel.ChartDataLabels#horizontalAlignment:member + package: excel! + fullName: horizontalAlignment + summary: >- + Specifies the horizontal alignment for chart data label. See + `Excel.ChartTextHorizontalAlignment` for details. This property is valid + only when the `TextOrientation` of data label is 0. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + horizontalAlignment: Excel.ChartTextHorizontalAlignment | "Center" | + "Left" | "Right" | "Justify" | "Distributed"; + return: + type: >- + | + "Center" | "Left" | "Right" | "Justify" | "Distributed" + - name: leaderLines + uid: excel!Excel.ChartDataLabels#leaderLines:member + package: excel! + fullName: leaderLines + summary: Gets an object that represents the leader lines of the data labels. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly leaderLines: Excel.ChartLeaderLines;' + return: + type: + - name: linkNumberFormat + uid: excel!Excel.ChartDataLabels#linkNumberFormat:member + package: excel! + fullName: linkNumberFormat + summary: >- + Specifies if the number format is linked to the cells. If `true`, + the number format will change in the labels when it changes in the cells. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'linkNumberFormat: boolean;' + return: + type: boolean + - name: numberFormat + uid: excel!Excel.ChartDataLabels#numberFormat:member + package: excel! + fullName: numberFormat + summary: Specifies the format code for data labels. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat: string;' + return: + type: string + - name: position + uid: excel!Excel.ChartDataLabels#position:member + package: excel! + fullName: position + summary: >- + Value that represents the position of the data label. See + `Excel.ChartDataLabelPosition` for details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + position: Excel.ChartDataLabelPosition | "Invalid" | "None" | "Center" | + "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" | "Right" | "Top" | + "Bottom" | "BestFit" | "Callout"; + return: + type: >- + | "Invalid" | + "None" | "Center" | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" + | "Right" | "Top" | "Bottom" | "BestFit" | "Callout" + - name: separator + uid: excel!Excel.ChartDataLabels#separator:member + package: excel! + fullName: separator + summary: String representing the separator used for the data labels on a chart. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'separator: string;' + return: + type: string + - name: showAsStickyCallout + uid: excel!Excel.ChartDataLabels#showAsStickyCallout:member + package: excel! + fullName: showAsStickyCallout + summary: >- + Specifies if the data labels are shown as a callout with the tail anchor + attached to the data point. If `true`, the callout is one of the + following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", + "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or + "WedgeEllipseCallout". See + [GeometricShapeType](xref:excel!Excel.GeometricShapeType:enum) for more + details. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly showAsStickyCallout: boolean;' + return: + type: boolean + - name: showBubbleSize + uid: excel!Excel.ChartDataLabels#showBubbleSize:member + package: excel! + fullName: showBubbleSize + summary: Specifies if the data label bubble size is visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showBubbleSize: boolean;' + return: + type: boolean + - name: showCategoryName + uid: excel!Excel.ChartDataLabels#showCategoryName:member + package: excel! + fullName: showCategoryName + summary: Specifies if the data label category name is visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showCategoryName: boolean;' + return: + type: boolean + - name: showLeaderLines + uid: excel!Excel.ChartDataLabels#showLeaderLines:member + package: excel! + fullName: showLeaderLines + summary: >- + Specifies if leader lines are displayed for the data labels. `true` if + leader lines are shown; otherwise, `false`. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showLeaderLines: boolean;' + return: + type: boolean + - name: showLegendKey + uid: excel!Excel.ChartDataLabels#showLegendKey:member + package: excel! + fullName: showLegendKey + summary: Specifies if the data label legend key is visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showLegendKey: boolean;' + return: + type: boolean + - name: showPercentage + uid: excel!Excel.ChartDataLabels#showPercentage:member + package: excel! + fullName: showPercentage + summary: Specifies if the data label percentage is visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showPercentage: boolean;' + return: + type: boolean + - name: showSeriesName + uid: excel!Excel.ChartDataLabels#showSeriesName:member + package: excel! + fullName: showSeriesName + summary: Specifies if the data label series name is visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showSeriesName: boolean;' + return: + type: boolean + - name: showValue + uid: excel!Excel.ChartDataLabels#showValue:member + package: excel! + fullName: showValue + summary: Specifies if the data label value is visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showValue: boolean;' + return: + type: boolean + - name: textOrientation + uid: excel!Excel.ChartDataLabels#textOrientation:member + package: excel! + fullName: textOrientation + summary: >- + Represents the angle to which the text is oriented for data labels. The + value should either be an integer from -90 to 90 or the integer 180 for + vertically-oriented text. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textOrientation: number;' + return: + type: number + - name: verticalAlignment + uid: excel!Excel.ChartDataLabels#verticalAlignment:member + package: excel! + fullName: verticalAlignment + summary: >- + Represents the vertical alignment of chart data label. See + `Excel.ChartTextVerticalAlignment` for details. This property is valid + only when `TextOrientation` of the data label is -90, 90, or 180. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | + "Bottom" | "Top" | "Justify" | "Distributed"; + return: + type: >- + | "Center" + | "Bottom" | "Top" | "Justify" | "Distributed" +methods: + - name: load(options) + uid: excel!Excel.ChartDataLabels#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartDataLabelsLoadOptions): + Excel.ChartDataLabels; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartDataLabels#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartDataLabels;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: >- + + + #### Examples + + + ```TypeScript + + // Show the series name in data labels and set the position of the + data labels to "top". + + await Excel.run(async (context) => { + const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); + chart.dataLabels.showValue = true; + chart.dataLabels.position = Excel.ChartDataLabelPosition.top; + chart.dataLabels.showSeriesName = true; + await context.sync(); + + console.log("Data labels shown"); + }); + + ``` + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartDataLabels#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartDataLabels; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartDataLabels#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartDataLabelsUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartDataLabels#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartDataLabels): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartDataLabels#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.ChartDataLabels` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.ChartDataLabelsData`) that + contains shallow copies of any loaded child properties from the original + object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartDataLabelsData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartdatasourcetype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartdatasourcetype.yml new file mode 100644 index 0000000000..85a703f216 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartdatasourcetype.yml @@ -0,0 +1,57 @@ +### YamlMime:TSEnum +name: Excel.ChartDataSourceType +uid: excel!Excel.ChartDataSourceType:enum +package: excel! +fullName: Excel.ChartDataSourceType +summary: Specifies the data source type of the chart series. +remarks: >- + \[ [API set: ExcelApi + 1.15](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: externalRange + uid: excel!Excel.ChartDataSourceType.externalRange:member + package: excel! + summary: >- + The data source type of the chart series is an external range. + + + * \[ [API set: ExcelApi + 1.15](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ExternalRange"' + - name: list + uid: excel!Excel.ChartDataSourceType.list:member + package: excel! + summary: >- + The data source type of the chart series is a list. + + + * \[ [API set: ExcelApi + 1.15](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"List"' + - name: localRange + uid: excel!Excel.ChartDataSourceType.localRange:member + package: excel! + summary: >- + The data source type of the chart series is a local range. + + + * \[ [API set: ExcelApi + 1.15](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"LocalRange"' + - name: unknown + uid: excel!Excel.ChartDataSourceType.unknown:member + package: excel! + summary: >- + The data source type of the chart series is unknown or unsupported. + + + * \[ [API set: ExcelApi + 1.15](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Unknown"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartdatatable.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartdatatable.yml new file mode 100644 index 0000000000..944c1806de --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartdatatable.yml @@ -0,0 +1,493 @@ +### YamlMime:TSType +name: Excel.ChartDataTable +uid: excel!Excel.ChartDataTable:class +package: excel! +fullName: Excel.ChartDataTable +summary: Represents the data table object of a chart. +remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.ChartDataTable#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: format + uid: excel!Excel.ChartDataTable#format:member + package: excel! + fullName: format + summary: >- + Represents the format of a chart data table, which includes fill, font, + and border format. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-data-table.yaml + + + // This function adjusts the display and format of a chart data table that + already exists on the worksheet. + + await Excel.run(async (context) => { + // Retrieve the chart named "SalesChart" from the "Sample" worksheet. + const chart = context.workbook.worksheets.getItem("Sample").charts.getItem("SalesChart"); + + // Get the chart data table object and load its properties. + const chartDataTable = chart.getDataTableOrNullObject(); + chartDataTable.load(); + + // Set the display properties of the chart data table. + chartDataTable.showLegendKey = true; + chartDataTable.showHorizontalBorder = false; + chartDataTable.showVerticalBorder = true; + chartDataTable.showOutlineBorder = true; + + // Retrieve the chart data table format object and set font and border properties. + const chartDataTableFormat = chartDataTable.format; + chartDataTableFormat.font.color = "#B76E79"; + chartDataTableFormat.font.name = "Comic Sans"; + chartDataTableFormat.border.color = "blue"; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly format: Excel.ChartDataTableFormat;' + return: + type: + - name: showHorizontalBorder + uid: excel!Excel.ChartDataTable#showHorizontalBorder:member + package: excel! + fullName: showHorizontalBorder + summary: Specifies whether to display the horizontal border of the data table. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-data-table.yaml + + + // This function adjusts the display and format of a chart data table that + already exists on the worksheet. + + await Excel.run(async (context) => { + // Retrieve the chart named "SalesChart" from the "Sample" worksheet. + const chart = context.workbook.worksheets.getItem("Sample").charts.getItem("SalesChart"); + + // Get the chart data table object and load its properties. + const chartDataTable = chart.getDataTableOrNullObject(); + chartDataTable.load(); + + // Set the display properties of the chart data table. + chartDataTable.showLegendKey = true; + chartDataTable.showHorizontalBorder = false; + chartDataTable.showVerticalBorder = true; + chartDataTable.showOutlineBorder = true; + + // Retrieve the chart data table format object and set font and border properties. + const chartDataTableFormat = chartDataTable.format; + chartDataTableFormat.font.color = "#B76E79"; + chartDataTableFormat.font.name = "Comic Sans"; + chartDataTableFormat.border.color = "blue"; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'showHorizontalBorder: boolean;' + return: + type: boolean + - name: showLegendKey + uid: excel!Excel.ChartDataTable#showLegendKey:member + package: excel! + fullName: showLegendKey + summary: Specifies whether to show the legend key of the data table. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-data-table.yaml + + + // This function adjusts the display and format of a chart data table that + already exists on the worksheet. + + await Excel.run(async (context) => { + // Retrieve the chart named "SalesChart" from the "Sample" worksheet. + const chart = context.workbook.worksheets.getItem("Sample").charts.getItem("SalesChart"); + + // Get the chart data table object and load its properties. + const chartDataTable = chart.getDataTableOrNullObject(); + chartDataTable.load(); + + // Set the display properties of the chart data table. + chartDataTable.showLegendKey = true; + chartDataTable.showHorizontalBorder = false; + chartDataTable.showVerticalBorder = true; + chartDataTable.showOutlineBorder = true; + + // Retrieve the chart data table format object and set font and border properties. + const chartDataTableFormat = chartDataTable.format; + chartDataTableFormat.font.color = "#B76E79"; + chartDataTableFormat.font.name = "Comic Sans"; + chartDataTableFormat.border.color = "blue"; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'showLegendKey: boolean;' + return: + type: boolean + - name: showOutlineBorder + uid: excel!Excel.ChartDataTable#showOutlineBorder:member + package: excel! + fullName: showOutlineBorder + summary: Specifies whether to display the outline border of the data table. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-data-table.yaml + + + // This function adjusts the display and format of a chart data table that + already exists on the worksheet. + + await Excel.run(async (context) => { + // Retrieve the chart named "SalesChart" from the "Sample" worksheet. + const chart = context.workbook.worksheets.getItem("Sample").charts.getItem("SalesChart"); + + // Get the chart data table object and load its properties. + const chartDataTable = chart.getDataTableOrNullObject(); + chartDataTable.load(); + + // Set the display properties of the chart data table. + chartDataTable.showLegendKey = true; + chartDataTable.showHorizontalBorder = false; + chartDataTable.showVerticalBorder = true; + chartDataTable.showOutlineBorder = true; + + // Retrieve the chart data table format object and set font and border properties. + const chartDataTableFormat = chartDataTable.format; + chartDataTableFormat.font.color = "#B76E79"; + chartDataTableFormat.font.name = "Comic Sans"; + chartDataTableFormat.border.color = "blue"; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'showOutlineBorder: boolean;' + return: + type: boolean + - name: showVerticalBorder + uid: excel!Excel.ChartDataTable#showVerticalBorder:member + package: excel! + fullName: showVerticalBorder + summary: Specifies whether to display the vertical border of the data table. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-data-table.yaml + + + // This function adjusts the display and format of a chart data table that + already exists on the worksheet. + + await Excel.run(async (context) => { + // Retrieve the chart named "SalesChart" from the "Sample" worksheet. + const chart = context.workbook.worksheets.getItem("Sample").charts.getItem("SalesChart"); + + // Get the chart data table object and load its properties. + const chartDataTable = chart.getDataTableOrNullObject(); + chartDataTable.load(); + + // Set the display properties of the chart data table. + chartDataTable.showLegendKey = true; + chartDataTable.showHorizontalBorder = false; + chartDataTable.showVerticalBorder = true; + chartDataTable.showOutlineBorder = true; + + // Retrieve the chart data table format object and set font and border properties. + const chartDataTableFormat = chartDataTable.format; + chartDataTableFormat.font.color = "#B76E79"; + chartDataTableFormat.font.name = "Comic Sans"; + chartDataTableFormat.border.color = "blue"; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'showVerticalBorder: boolean;' + return: + type: boolean + - name: visible + uid: excel!Excel.ChartDataTable#visible:member + package: excel! + fullName: visible + summary: Specifies whether to show the data table of the chart. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-data-table.yaml + + + // This function adds a data table to a chart that already exists on the + worksheet. + + await Excel.run(async (context) => { + // Retrieve the chart named "SalesChart" from the "Sample" worksheet. + const chart = context.workbook.worksheets.getItem("Sample").charts.getItem("SalesChart"); + + // Get the data table object for the chart and set it to visible. + const chartDataTable = chart.getDataTableOrNullObject(); + chartDataTable.load("visible"); + chartDataTable.visible = true; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'visible: boolean;' + return: + type: boolean +methods: + - name: load(options) + uid: excel!Excel.ChartDataTable#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartDataTableLoadOptions): + Excel.ChartDataTable; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartDataTable#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartDataTable;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartDataTable#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartDataTable; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartDataTable#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartDataTableUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartDataTable#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartDataTable): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartDataTable#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.ChartDataTable` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.ChartDataTableData`) that + contains shallow copies of any loaded child properties from the original + object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartDataTableData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartdatatableformat.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartdatatableformat.yml new file mode 100644 index 0000000000..bdf36ae414 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartdatatableformat.yml @@ -0,0 +1,316 @@ +### YamlMime:TSType +name: Excel.ChartDataTableFormat +uid: excel!Excel.ChartDataTableFormat:class +package: excel! +fullName: Excel.ChartDataTableFormat +summary: Represents the format of a chart data table. +remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: border + uid: excel!Excel.ChartDataTableFormat#border:member + package: excel! + fullName: border + summary: >- + Represents the border format of chart data table, which includes color, + line style, and weight. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-data-table.yaml + + + // This function adjusts the display and format of a chart data table that + already exists on the worksheet. + + await Excel.run(async (context) => { + // Retrieve the chart named "SalesChart" from the "Sample" worksheet. + const chart = context.workbook.worksheets.getItem("Sample").charts.getItem("SalesChart"); + + // Get the chart data table object and load its properties. + const chartDataTable = chart.getDataTableOrNullObject(); + chartDataTable.load(); + + // Set the display properties of the chart data table. + chartDataTable.showLegendKey = true; + chartDataTable.showHorizontalBorder = false; + chartDataTable.showVerticalBorder = true; + chartDataTable.showOutlineBorder = true; + + // Retrieve the chart data table format object and set font and border properties. + const chartDataTableFormat = chartDataTable.format; + chartDataTableFormat.font.color = "#B76E79"; + chartDataTableFormat.font.name = "Comic Sans"; + chartDataTableFormat.border.color = "blue"; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly border: Excel.ChartBorder;' + return: + type: + - name: context + uid: excel!Excel.ChartDataTableFormat#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: fill + uid: excel!Excel.ChartDataTableFormat#fill:member + package: excel! + fullName: fill + summary: >- + Represents the fill format of an object, which includes background + formatting information. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly fill: Excel.ChartFill;' + return: + type: + - name: font + uid: excel!Excel.ChartDataTableFormat#font:member + package: excel! + fullName: font + summary: >- + Represents the font attributes (such as font name, font size, and color) + for the current object. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-data-table.yaml + + + // This function adjusts the display and format of a chart data table that + already exists on the worksheet. + + await Excel.run(async (context) => { + // Retrieve the chart named "SalesChart" from the "Sample" worksheet. + const chart = context.workbook.worksheets.getItem("Sample").charts.getItem("SalesChart"); + + // Get the chart data table object and load its properties. + const chartDataTable = chart.getDataTableOrNullObject(); + chartDataTable.load(); + + // Set the display properties of the chart data table. + chartDataTable.showLegendKey = true; + chartDataTable.showHorizontalBorder = false; + chartDataTable.showVerticalBorder = true; + chartDataTable.showOutlineBorder = true; + + // Retrieve the chart data table format object and set font and border properties. + const chartDataTableFormat = chartDataTable.format; + chartDataTableFormat.font.color = "#B76E79"; + chartDataTableFormat.font.name = "Comic Sans"; + chartDataTableFormat.border.color = "blue"; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly font: Excel.ChartFont;' + return: + type: +methods: + - name: load(options) + uid: excel!Excel.ChartDataTableFormat#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartDataTableFormatLoadOptions): + Excel.ChartDataTableFormat; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartDataTableFormat#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartDataTableFormat;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartDataTableFormat#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartDataTableFormat; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartDataTableFormat#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartDataTableFormatUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartDataTableFormat#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartDataTableFormat): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartDataTableFormat#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.ChartDataTableFormat` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.ChartDataTableFormatData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartDataTableFormatData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartdeactivatedeventargs.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartdeactivatedeventargs.yml new file mode 100644 index 0000000000..6bae8e1ca0 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartdeactivatedeventargs.yml @@ -0,0 +1,59 @@ +### YamlMime:TSType +name: Excel.ChartDeactivatedEventArgs +uid: excel!Excel.ChartDeactivatedEventArgs:interface +package: excel! +fullName: Excel.ChartDeactivatedEventArgs +summary: Provides information about the chart that raised the deactivated event. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: chartId + uid: excel!Excel.ChartDeactivatedEventArgs#chartId:member + package: excel! + fullName: chartId + summary: Gets the ID of the chart that is deactivated. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'chartId: string;' + return: + type: string + - name: type + uid: excel!Excel.ChartDeactivatedEventArgs#type:member + package: excel! + fullName: type + summary: Gets the type of the event. See `Excel.EventType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: "ChartDeactivated";' + return: + type: '"ChartDeactivated"' + - name: worksheetId + uid: excel!Excel.ChartDeactivatedEventArgs#worksheetId:member + package: excel! + fullName: worksheetId + summary: Gets the ID of the worksheet in which the chart is deactivated. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheetId: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartdeletedeventargs.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartdeletedeventargs.yml new file mode 100644 index 0000000000..7f76ab974e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartdeletedeventargs.yml @@ -0,0 +1,74 @@ +### YamlMime:TSType +name: Excel.ChartDeletedEventArgs +uid: excel!Excel.ChartDeletedEventArgs:interface +package: excel! +fullName: Excel.ChartDeletedEventArgs +summary: Provides information about the chart that raised the deleted event. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: chartId + uid: excel!Excel.ChartDeletedEventArgs#chartId:member + package: excel! + fullName: chartId + summary: Gets the ID of the chart that is deleted from the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'chartId: string;' + return: + type: string + - name: source + uid: excel!Excel.ChartDeletedEventArgs#source:member + package: excel! + fullName: source + summary: Gets the source of the event. See `Excel.EventSource` for details. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'source: Excel.EventSource | "Local" | "Remote";' + return: + type: | "Local" | "Remote" + - name: type + uid: excel!Excel.ChartDeletedEventArgs#type:member + package: excel! + fullName: type + summary: Gets the type of the event. See `Excel.EventType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: "ChartDeleted";' + return: + type: '"ChartDeleted"' + - name: worksheetId + uid: excel!Excel.ChartDeletedEventArgs#worksheetId:member + package: excel! + fullName: worksheetId + summary: Gets the ID of the worksheet in which the chart is deleted. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheetId: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartdisplayblanksas.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartdisplayblanksas.yml new file mode 100644 index 0000000000..908e9c7601 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartdisplayblanksas.yml @@ -0,0 +1,34 @@ +### YamlMime:TSEnum +name: Excel.ChartDisplayBlanksAs +uid: excel!Excel.ChartDisplayBlanksAs:enum +package: excel! +fullName: Excel.ChartDisplayBlanksAs +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: interplotted + uid: excel!Excel.ChartDisplayBlanksAs.interplotted:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Interplotted"' + - name: notPlotted + uid: excel!Excel.ChartDisplayBlanksAs.notPlotted:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"NotPlotted"' + - name: zero + uid: excel!Excel.ChartDisplayBlanksAs.zero:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Zero"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.charterrorbars.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.charterrorbars.yml new file mode 100644 index 0000000000..88bb44a6bc --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.charterrorbars.yml @@ -0,0 +1,267 @@ +### YamlMime:TSType +name: Excel.ChartErrorBars +uid: excel!Excel.ChartErrorBars:class +package: excel! +fullName: Excel.ChartErrorBars +summary: This object represents the attributes for a chart's error bars. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.ChartErrorBars#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: endStyleCap + uid: excel!Excel.ChartErrorBars#endStyleCap:member + package: excel! + fullName: endStyleCap + summary: Specifies if error bars have an end style cap. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'endStyleCap: boolean;' + return: + type: boolean + - name: format + uid: excel!Excel.ChartErrorBars#format:member + package: excel! + fullName: format + summary: Specifies the formatting type of the error bars. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly format: Excel.ChartErrorBarsFormat;' + return: + type: + - name: include + uid: excel!Excel.ChartErrorBars#include:member + package: excel! + fullName: include + summary: Specifies which parts of the error bars to include. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + include: Excel.ChartErrorBarsInclude | "Both" | "MinusValues" | + "PlusValues"; + return: + type: >- + | "Both" | + "MinusValues" | "PlusValues" + - name: type + uid: excel!Excel.ChartErrorBars#type:member + package: excel! + fullName: type + summary: The type of range marked by the error bars. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + type: Excel.ChartErrorBarsType | "FixedValue" | "Percent" | "StDev" | + "StError" | "Custom"; + return: + type: >- + | "FixedValue" | + "Percent" | "StDev" | "StError" | "Custom" + - name: visible + uid: excel!Excel.ChartErrorBars#visible:member + package: excel! + fullName: visible + summary: Specifies whether the error bars are displayed. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible: boolean;' + return: + type: boolean +methods: + - name: load(options) + uid: excel!Excel.ChartErrorBars#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartErrorBarsLoadOptions): + Excel.ChartErrorBars; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartErrorBars#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartErrorBars;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartErrorBars#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartErrorBars; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartErrorBars#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartErrorBarsUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartErrorBars#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartErrorBars): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartErrorBars#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.ChartErrorBars` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.ChartErrorBarsData`) that + contains shallow copies of any loaded child properties from the original + object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartErrorBarsData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.charterrorbarsformat.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.charterrorbarsformat.yml new file mode 100644 index 0000000000..8ddd4aaec4 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.charterrorbarsformat.yml @@ -0,0 +1,203 @@ +### YamlMime:TSType +name: Excel.ChartErrorBarsFormat +uid: excel!Excel.ChartErrorBarsFormat:class +package: excel! +fullName: Excel.ChartErrorBarsFormat +summary: Encapsulates the format properties for chart error bars. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.ChartErrorBarsFormat#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: line + uid: excel!Excel.ChartErrorBarsFormat#line:member + package: excel! + fullName: line + summary: Represents the chart line formatting. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly line: Excel.ChartLineFormat;' + return: + type: +methods: + - name: load(options) + uid: excel!Excel.ChartErrorBarsFormat#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartErrorBarsFormatLoadOptions): + Excel.ChartErrorBarsFormat; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartErrorBarsFormat#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartErrorBarsFormat;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartErrorBarsFormat#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartErrorBarsFormat; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartErrorBarsFormat#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartErrorBarsFormatUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartErrorBarsFormat#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartErrorBarsFormat): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartErrorBarsFormat#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.ChartErrorBarsFormat` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.ChartErrorBarsFormatData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartErrorBarsFormatData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.charterrorbarsinclude.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.charterrorbarsinclude.yml new file mode 100644 index 0000000000..030c3b0c3d --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.charterrorbarsinclude.yml @@ -0,0 +1,34 @@ +### YamlMime:TSEnum +name: Excel.ChartErrorBarsInclude +uid: excel!Excel.ChartErrorBarsInclude:enum +package: excel! +fullName: Excel.ChartErrorBarsInclude +summary: Represents which parts of the error bar to include. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: both + uid: excel!Excel.ChartErrorBarsInclude.both:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Both"' + - name: minusValues + uid: excel!Excel.ChartErrorBarsInclude.minusValues:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"MinusValues"' + - name: plusValues + uid: excel!Excel.ChartErrorBarsInclude.plusValues:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"PlusValues"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.charterrorbarstype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.charterrorbarstype.yml new file mode 100644 index 0000000000..4bec25e875 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.charterrorbarstype.yml @@ -0,0 +1,48 @@ +### YamlMime:TSEnum +name: Excel.ChartErrorBarsType +uid: excel!Excel.ChartErrorBarsType:enum +package: excel! +fullName: Excel.ChartErrorBarsType +summary: Represents the range type for error bars. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: custom + uid: excel!Excel.ChartErrorBarsType.custom:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Custom"' + - name: fixedValue + uid: excel!Excel.ChartErrorBarsType.fixedValue:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FixedValue"' + - name: percent + uid: excel!Excel.ChartErrorBarsType.percent:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Percent"' + - name: stDev + uid: excel!Excel.ChartErrorBarsType.stDev:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"StDev"' + - name: stError + uid: excel!Excel.ChartErrorBarsType.stError:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"StError"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartfill.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartfill.yml new file mode 100644 index 0000000000..9f20b2baf9 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartfill.yml @@ -0,0 +1,157 @@ +### YamlMime:TSType +name: Excel.ChartFill +uid: excel!Excel.ChartFill:class +package: excel! +fullName: Excel.ChartFill +summary: Represents the fill formatting for a chart element. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.ChartFill#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: +methods: + - name: clear() + uid: excel!Excel.ChartFill#clear:member(1) + package: excel! + fullName: clear() + summary: Clears the fill color of a chart element. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Clear the line format of the major gridlines on the value axis of the + chart named "Chart1". + + await Excel.run(async (context) => { + const gridlines = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").axes.valueAxis.majorGridlines; + gridlines.format.line.clear(); + await context.sync(); + + console.log("Chart Major Gridlines Format Cleared"); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'clear(): void;' + return: + type: void + description: '' + - name: getSolidColor() + uid: excel!Excel.ChartFill#getSolidColor:member(1) + package: excel! + fullName: getSolidColor() + summary: Gets the uniform color fill formatting of a chart element. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getSolidColor(): OfficeExtension.ClientResult;' + return: + type: <string> + description: '' + - name: setSolidColor(color) + uid: excel!Excel.ChartFill#setSolidColor:member(1) + package: excel! + fullName: setSolidColor(color) + summary: Sets the fill formatting of a chart element to a uniform color. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-point.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + + let pointsCollection = sheet.charts.getItemAt(0).series.getItemAt(0).points; + let point = pointsCollection.getItemAt(2); + + // Set color for chart point. + point.format.fill.setSolidColor('red'); + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'setSolidColor(color: string): void;' + parameters: + - id: color + description: >- + HTML color code representing the color of the background, in the + form \#RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., + "orange"). + type: string + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartFill#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.ChartFill` object + is an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Excel.Interfaces.ChartFillData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + toJSON(): { + [key: string]: string; + }; + return: + type: |- + { + [key: string]: string; + } + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartfont.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartfont.yml new file mode 100644 index 0000000000..a45a88add8 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartfont.yml @@ -0,0 +1,296 @@ +### YamlMime:TSType +name: Excel.ChartFont +uid: excel!Excel.ChartFont:class +package: excel! +fullName: Excel.ChartFont +summary: >- + This object represents the font attributes (such as font name, font size, and + color) for a chart object. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Set the chart title font to Calibri, size 10, bold, and the color red. + + await Excel.run(async (context) => { + const title = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").title; + title.format.font.name = "Calibri"; + title.format.font.size = 12; + title.format.font.color = "#FF0000"; + title.format.font.italic = false; + title.format.font.bold = true; + title.format.font.underline = "None"; + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +type: class +properties: + - name: bold + uid: excel!Excel.ChartFont#bold:member + package: excel! + fullName: bold + summary: Represents the bold status of font. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'bold: boolean;' + return: + type: boolean + - name: color + uid: excel!Excel.ChartFont#color:member + package: excel! + fullName: color + summary: >- + HTML color code representation of the text color (e.g., \#FF0000 + represents Red). + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color: string;' + return: + type: string + - name: context + uid: excel!Excel.ChartFont#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: italic + uid: excel!Excel.ChartFont#italic:member + package: excel! + fullName: italic + summary: Represents the italic status of the font. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'italic: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.ChartFont#name:member + package: excel! + fullName: name + summary: Font name (e.g., "Calibri") + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name: string;' + return: + type: string + - name: size + uid: excel!Excel.ChartFont#size:member + package: excel! + fullName: size + summary: Size of the font (e.g., 11) + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'size: number;' + return: + type: number + - name: underline + uid: excel!Excel.ChartFont#underline:member + package: excel! + fullName: underline + summary: >- + Type of underline applied to the font. See `Excel.ChartUnderlineStyle` for + details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'underline: Excel.ChartUnderlineStyle | "None" | "Single";' + return: + type: >- + | "None" | + "Single" +methods: + - name: load(options) + uid: excel!Excel.ChartFont#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(options?: Excel.Interfaces.ChartFontLoadOptions): Excel.ChartFont;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartFont#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartFont;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartFont#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartFont; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartFont#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartFontUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartFont#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartFont): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartFont#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.ChartFont` object + is an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Excel.Interfaces.ChartFontData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartFontData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartformatstring.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartformatstring.yml new file mode 100644 index 0000000000..3b8a98ca88 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartformatstring.yml @@ -0,0 +1,205 @@ +### YamlMime:TSType +name: Excel.ChartFormatString +uid: excel!Excel.ChartFormatString:class +package: excel! +fullName: Excel.ChartFormatString +summary: >- + Represents the substring in chart related objects that contain text, like a + `ChartTitle` object or `ChartAxisTitle` object. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.ChartFormatString#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: font + uid: excel!Excel.ChartFormatString#font:member + package: excel! + fullName: font + summary: >- + Represents the font attributes, such as font name, font size, and color of + a chart characters object. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly font: Excel.ChartFont;' + return: + type: +methods: + - name: load(options) + uid: excel!Excel.ChartFormatString#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartFormatStringLoadOptions): + Excel.ChartFormatString; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartFormatString#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartFormatString;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartFormatString#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartFormatString; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartFormatString#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartFormatStringUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartFormatString#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartFormatString): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartFormatString#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.ChartFormatString` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.ChartFormatStringData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartFormatStringData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartgradientstyle.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartgradientstyle.yml new file mode 100644 index 0000000000..ae3bef2451 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartgradientstyle.yml @@ -0,0 +1,29 @@ +### YamlMime:TSEnum +name: Excel.ChartGradientStyle +uid: excel!Excel.ChartGradientStyle:enum +package: excel! +fullName: Excel.ChartGradientStyle +summary: >- + Represents the gradient style of a chart series. This is only applicable for + region map charts. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: threePhaseColor + uid: excel!Excel.ChartGradientStyle.threePhaseColor:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ThreePhaseColor"' + - name: twoPhaseColor + uid: excel!Excel.ChartGradientStyle.twoPhaseColor:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"TwoPhaseColor"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartgradientstyletype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartgradientstyletype.yml new file mode 100644 index 0000000000..0db5886cec --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartgradientstyletype.yml @@ -0,0 +1,36 @@ +### YamlMime:TSEnum +name: Excel.ChartGradientStyleType +uid: excel!Excel.ChartGradientStyleType:enum +package: excel! +fullName: Excel.ChartGradientStyleType +summary: >- + Represents the gradient style type of a chart series. This is only applicable + for region map charts. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: extremeValue + uid: excel!Excel.ChartGradientStyleType.extremeValue:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ExtremeValue"' + - name: number + uid: excel!Excel.ChartGradientStyleType.number:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Number"' + - name: percent + uid: excel!Excel.ChartGradientStyleType.percent:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Percent"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartgridlines.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartgridlines.yml new file mode 100644 index 0000000000..b3c72f31dd --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartgridlines.yml @@ -0,0 +1,228 @@ +### YamlMime:TSType +name: Excel.ChartGridlines +uid: excel!Excel.ChartGridlines:class +package: excel! +fullName: Excel.ChartGridlines +summary: Represents major or minor gridlines on a chart axis. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.ChartGridlines#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: format + uid: excel!Excel.ChartGridlines#format:member + package: excel! + fullName: format + summary: Represents the formatting of chart gridlines. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly format: Excel.ChartGridlinesFormat;' + return: + type: + - name: visible + uid: excel!Excel.ChartGridlines#visible:member + package: excel! + fullName: visible + summary: Specifies if the axis gridlines are visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible: boolean;' + return: + type: boolean +methods: + - name: load(options) + uid: excel!Excel.ChartGridlines#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartGridlinesLoadOptions): + Excel.ChartGridlines; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartGridlines#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartGridlines;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: |- + + + #### Examples + + ```TypeScript + // Set the value axis of Chart1 to show the major gridlines. + await Excel.run(async (context) => { + const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); + chart.axes.valueAxis.majorGridlines.visible = true; + await context.sync(); + + console.log("Axis Gridlines Added "); + }); + ``` + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartGridlines#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartGridlines; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartGridlines#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartGridlinesUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartGridlines#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartGridlines): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartGridlines#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.ChartGridlines` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.ChartGridlinesData`) that + contains shallow copies of any loaded child properties from the original + object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartGridlinesData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartgridlinesformat.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartgridlinesformat.yml new file mode 100644 index 0000000000..154166df91 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartgridlinesformat.yml @@ -0,0 +1,203 @@ +### YamlMime:TSType +name: Excel.ChartGridlinesFormat +uid: excel!Excel.ChartGridlinesFormat:class +package: excel! +fullName: Excel.ChartGridlinesFormat +summary: Encapsulates the format properties for chart gridlines. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.ChartGridlinesFormat#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: line + uid: excel!Excel.ChartGridlinesFormat#line:member + package: excel! + fullName: line + summary: Represents chart line formatting. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly line: Excel.ChartLineFormat;' + return: + type: +methods: + - name: load(options) + uid: excel!Excel.ChartGridlinesFormat#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartGridlinesFormatLoadOptions): + Excel.ChartGridlinesFormat; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartGridlinesFormat#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartGridlinesFormat;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartGridlinesFormat#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartGridlinesFormat; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartGridlinesFormat#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartGridlinesFormatUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartGridlinesFormat#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartGridlinesFormat): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartGridlinesFormat#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.ChartGridlinesFormat` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.ChartGridlinesFormatData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartGridlinesFormatData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartleaderlines.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartleaderlines.yml new file mode 100644 index 0000000000..d0aabb40d7 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartleaderlines.yml @@ -0,0 +1,231 @@ +### YamlMime:TSType +name: Excel.ChartLeaderLines +uid: excel!Excel.ChartLeaderLines:class +package: excel! +fullName: Excel.ChartLeaderLines +summary: Gets an object that represents the formatting of chart leader lines. +remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-leader-lines.yaml + + + // The following code changes the format of leader lines. It adjusts color, + weight, and line style. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem(sheetName); + const chart = sheet.charts.getItemAt(0); + const series = chart.series.getItemAt(0); + const dataLabels = series.dataLabels; + const lineFormat = dataLabels.leaderLines.format; + + // Set leader line formatting properties. + lineFormat.line.color = "blue"; + lineFormat.line.weight = 2; + lineFormat.line.lineStyle = Excel.ChartLineStyle.dot; + + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.ChartLeaderLines#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: format + uid: excel!Excel.ChartLeaderLines#format:member + package: excel! + fullName: format + summary: Represents the formatting of leader lines of data labels in a series. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly format: Excel.ChartLeaderLinesFormat;' + return: + type: +methods: + - name: load(options) + uid: excel!Excel.ChartLeaderLines#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartLeaderLinesLoadOptions): + Excel.ChartLeaderLines; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartLeaderLines#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartLeaderLines;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartLeaderLines#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartLeaderLines; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartLeaderLines#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartLeaderLinesUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartLeaderLines#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartLeaderLines): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartLeaderLines#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.ChartLeaderLines` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.ChartLeaderLinesData`) that + contains shallow copies of any loaded child properties from the original + object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartLeaderLinesData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartleaderlinesformat.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartleaderlinesformat.yml new file mode 100644 index 0000000000..3002b9abd7 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartleaderlinesformat.yml @@ -0,0 +1,234 @@ +### YamlMime:TSType +name: Excel.ChartLeaderLinesFormat +uid: excel!Excel.ChartLeaderLinesFormat:class +package: excel! +fullName: Excel.ChartLeaderLinesFormat +summary: Encapsulates the format properties for leader lines. +remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-leader-lines.yaml + + + // The following code changes the format of leader lines. It adjusts color, + weight, and line style. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem(sheetName); + const chart = sheet.charts.getItemAt(0); + const series = chart.series.getItemAt(0); + const dataLabels = series.dataLabels; + const lineFormat = dataLabels.leaderLines.format; + + // Set leader line formatting properties. + lineFormat.line.color = "blue"; + lineFormat.line.weight = 2; + lineFormat.line.lineStyle = Excel.ChartLineStyle.dot; + + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.ChartLeaderLinesFormat#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: line + uid: excel!Excel.ChartLeaderLinesFormat#line:member + package: excel! + fullName: line + summary: Gets an object that represents the line formatting of chart leader lines. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly line: Excel.ChartLineFormat;' + return: + type: +methods: + - name: load(options) + uid: excel!Excel.ChartLeaderLinesFormat#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartLeaderLinesFormatLoadOptions): + Excel.ChartLeaderLinesFormat; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartLeaderLinesFormat#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartLeaderLinesFormat;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartLeaderLinesFormat#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartLeaderLinesFormat; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartLeaderLinesFormat#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartLeaderLinesFormatUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartLeaderLinesFormat#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartLeaderLinesFormat): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartLeaderLinesFormat#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.ChartLeaderLinesFormat` object is an API object, the `toJSON` + method returns a plain JavaScript object (typed as + `Excel.Interfaces.ChartLeaderLinesFormatData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartLeaderLinesFormatData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartlegend.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartlegend.yml new file mode 100644 index 0000000000..dceea97681 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartlegend.yml @@ -0,0 +1,364 @@ +### YamlMime:TSType +name: Excel.ChartLegend +uid: excel!Excel.ChartLegend:class +package: excel! +fullName: Excel.ChartLegend +summary: Represents the legend in a chart. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.ChartLegend#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: format + uid: excel!Excel.ChartLegend#format:member + package: excel! + fullName: format + summary: >- + Represents the formatting of a chart legend, which includes fill and font + formatting. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly format: Excel.ChartLegendFormat;' + return: + type: + - name: height + uid: excel!Excel.ChartLegend#height:member + package: excel! + fullName: height + summary: >- + Specifies the height, in points, of the legend on the chart. Value is + `null` if the legend is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height: number;' + return: + type: number + - name: left + uid: excel!Excel.ChartLegend#left:member + package: excel! + fullName: left + summary: >- + Specifies the left value, in points, of the legend on the chart. Value is + `null` if the legend is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left: number;' + return: + type: number + - name: legendEntries + uid: excel!Excel.ChartLegend#legendEntries:member + package: excel! + fullName: legendEntries + summary: Represents a collection of legendEntries in the legend. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly legendEntries: Excel.ChartLegendEntryCollection;' + return: + type: + - name: overlay + uid: excel!Excel.ChartLegend#overlay:member + package: excel! + fullName: overlay + summary: >- + Specifies if the chart legend should overlap with the main body of the + chart. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'overlay: boolean;' + return: + type: boolean + - name: position + uid: excel!Excel.ChartLegend#position:member + package: excel! + fullName: position + summary: >- + Specifies the position of the legend on the chart. See + `Excel.ChartLegendPosition` for details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + position: Excel.ChartLegendPosition | "Invalid" | "Top" | "Bottom" | + "Left" | "Right" | "Corner" | "Custom"; + return: + type: >- + | "Invalid" | + "Top" | "Bottom" | "Left" | "Right" | "Corner" | "Custom" + - name: showShadow + uid: excel!Excel.ChartLegend#showShadow:member + package: excel! + fullName: showShadow + summary: Specifies if the legend has a shadow on the chart. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showShadow: boolean;' + return: + type: boolean + - name: top + uid: excel!Excel.ChartLegend#top:member + package: excel! + fullName: top + summary: Specifies the top of a chart legend. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top: number;' + return: + type: number + - name: visible + uid: excel!Excel.ChartLegend#visible:member + package: excel! + fullName: visible + summary: Specifies if the chart legend is visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible: boolean;' + return: + type: boolean + - name: width + uid: excel!Excel.ChartLegend#width:member + package: excel! + fullName: width + summary: >- + Specifies the width, in points, of the legend on the chart. Value is + `null` if the legend is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width: number;' + return: + type: number +methods: + - name: load(options) + uid: excel!Excel.ChartLegend#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartLegendLoadOptions): + Excel.ChartLegend; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartLegend#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartLegend;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: |- + + + #### Examples + + ```TypeScript + // Get the position of Chart Legend from Chart1. + await Excel.run(async (context) => { + const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); + const legend = chart.legend; + legend.load('position'); + await context.sync(); + + console.log(legend.position); + }); + ``` + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartLegend#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartLegend; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartLegend#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartLegendUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartLegend#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartLegend): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartLegend#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.ChartLegend` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.ChartLegendData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartLegendData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartlegendentry.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartlegendentry.yml new file mode 100644 index 0000000000..13450aecd1 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartlegendentry.yml @@ -0,0 +1,275 @@ +### YamlMime:TSType +name: Excel.ChartLegendEntry +uid: excel!Excel.ChartLegendEntry:class +package: excel! +fullName: Excel.ChartLegendEntry +summary: Represents the legend entry in `legendEntryCollection`. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.ChartLegendEntry#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: height + uid: excel!Excel.ChartLegendEntry#height:member + package: excel! + fullName: height + summary: Specifies the height of the legend entry on the chart legend. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly height: number;' + return: + type: number + - name: index + uid: excel!Excel.ChartLegendEntry#index:member + package: excel! + fullName: index + summary: Specifies the index of the legend entry in the chart legend. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly index: number;' + return: + type: number + - name: left + uid: excel!Excel.ChartLegendEntry#left:member + package: excel! + fullName: left + summary: Specifies the left value of a chart legend entry. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly left: number;' + return: + type: number + - name: top + uid: excel!Excel.ChartLegendEntry#top:member + package: excel! + fullName: top + summary: Specifies the top of a chart legend entry. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly top: number;' + return: + type: number + - name: visible + uid: excel!Excel.ChartLegendEntry#visible:member + package: excel! + fullName: visible + summary: Represents the visibility of a chart legend entry. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible: boolean;' + return: + type: boolean + - name: width + uid: excel!Excel.ChartLegendEntry#width:member + package: excel! + fullName: width + summary: Represents the width of the legend entry on the chart Legend. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly width: number;' + return: + type: number +methods: + - name: load(options) + uid: excel!Excel.ChartLegendEntry#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartLegendEntryLoadOptions): + Excel.ChartLegendEntry; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartLegendEntry#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartLegendEntry;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartLegendEntry#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartLegendEntry; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartLegendEntry#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartLegendEntryUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartLegendEntry#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartLegendEntry): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartLegendEntry#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.ChartLegendEntry` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.ChartLegendEntryData`) that + contains shallow copies of any loaded child properties from the original + object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartLegendEntryData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartlegendentrycollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartlegendentrycollection.yml new file mode 100644 index 0000000000..b82b37820a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartlegendentrycollection.yml @@ -0,0 +1,183 @@ +### YamlMime:TSType +name: Excel.ChartLegendEntryCollection +uid: excel!Excel.ChartLegendEntryCollection:class +package: excel! +fullName: Excel.ChartLegendEntryCollection +summary: Represents a collection of legend entries. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.ChartLegendEntryCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: excel!Excel.ChartLegendEntryCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.ChartLegendEntry[];' + return: + type: [] +methods: + - name: getCount() + uid: excel!Excel.ChartLegendEntryCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Returns the number of legend entries in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getItemAt(index) + uid: excel!Excel.ChartLegendEntryCollection#getItemAt:member(1) + package: excel! + fullName: getItemAt(index) + summary: Returns a legend entry at the given index. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemAt(index: number): Excel.ChartLegendEntry;' + parameters: + - id: index + description: Index of the legend entry to be retrieved. + type: number + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.ChartLegendEntryCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartLegendEntryCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): + Excel.ChartLegendEntryCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartLegendEntryCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNames?: string | string[]): + Excel.ChartLegendEntryCollection; + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartLegendEntryCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.ChartLegendEntryCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.ChartLegendEntryCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.ChartLegendEntryCollection` object is an API object, the `toJSON` + method returns a plain JavaScript object (typed as + `Excel.Interfaces.ChartLegendEntryCollectionData`) that contains + an "items" array with shallow copies of any loaded properties from the + collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartLegendEntryCollectionData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartlegendformat.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartlegendformat.yml new file mode 100644 index 0000000000..a4d43e78db --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartlegendformat.yml @@ -0,0 +1,265 @@ +### YamlMime:TSType +name: Excel.ChartLegendFormat +uid: excel!Excel.ChartLegendFormat:class +package: excel! +fullName: Excel.ChartLegendFormat +summary: Encapsulates the format properties of a chart legend. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: border + uid: excel!Excel.ChartLegendFormat#border:member + package: excel! + fullName: border + summary: Represents the border format, which includes color, linestyle, and weight. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly border: Excel.ChartBorder;' + return: + type: + - name: context + uid: excel!Excel.ChartLegendFormat#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: fill + uid: excel!Excel.ChartLegendFormat#fill:member + package: excel! + fullName: fill + summary: >- + Represents the fill format of an object, which includes background + formatting information. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly fill: Excel.ChartFill;' + return: + type: + - name: font + uid: excel!Excel.ChartLegendFormat#font:member + package: excel! + fullName: font + summary: >- + Represents the font attributes such as font name, font size, and color of + a chart legend. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-legend.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + + let chart = sheet.charts.getItemAt(0); + chart.legend.visible = true; + + // Format the legend font. + let font = chart.legend.format.font; + font.bold = true; + font.color = "red"; + font.italic = true; + font.size = 15; + font.name = "Calibri"; + font.underline = "Single"; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly font: Excel.ChartFont;' + return: + type: +methods: + - name: load(options) + uid: excel!Excel.ChartLegendFormat#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartLegendFormatLoadOptions): + Excel.ChartLegendFormat; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartLegendFormat#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartLegendFormat;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartLegendFormat#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartLegendFormat; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartLegendFormat#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartLegendFormatUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartLegendFormat#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartLegendFormat): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartLegendFormat#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.ChartLegendFormat` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.ChartLegendFormatData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartLegendFormatData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartlegendposition.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartlegendposition.yml new file mode 100644 index 0000000000..259407d174 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartlegendposition.yml @@ -0,0 +1,62 @@ +### YamlMime:TSEnum +name: Excel.ChartLegendPosition +uid: excel!Excel.ChartLegendPosition:enum +package: excel! +fullName: Excel.ChartLegendPosition +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: bottom + uid: excel!Excel.ChartLegendPosition.bottom:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Bottom"' + - name: corner + uid: excel!Excel.ChartLegendPosition.corner:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Corner"' + - name: custom + uid: excel!Excel.ChartLegendPosition.custom:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Custom"' + - name: invalid + uid: excel!Excel.ChartLegendPosition.invalid:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Invalid"' + - name: left + uid: excel!Excel.ChartLegendPosition.left:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Left"' + - name: right + uid: excel!Excel.ChartLegendPosition.right:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Right"' + - name: top + uid: excel!Excel.ChartLegendPosition.top:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Top"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartlineformat.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartlineformat.yml new file mode 100644 index 0000000000..84a617a318 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartlineformat.yml @@ -0,0 +1,283 @@ +### YamlMime:TSType +name: Excel.ChartLineFormat +uid: excel!Excel.ChartLineFormat:class +package: excel! +fullName: Excel.ChartLineFormat +summary: Encapsulates the formatting options for line elements. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: color + uid: excel!Excel.ChartLineFormat#color:member + package: excel! + fullName: color + summary: HTML color code representing the color of lines in the chart. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color: string;' + return: + type: string + - name: context + uid: excel!Excel.ChartLineFormat#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: lineStyle + uid: excel!Excel.ChartLineFormat#lineStyle:member + package: excel! + fullName: lineStyle + summary: Represents the line style. See `Excel.ChartLineStyle` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + lineStyle: Excel.ChartLineStyle | "None" | "Continuous" | "Dash" | + "DashDot" | "DashDotDot" | "Dot" | "Grey25" | "Grey50" | "Grey75" | + "Automatic" | "RoundDot"; + return: + type: >- + | "None" | "Continuous" + | "Dash" | "DashDot" | "DashDotDot" | "Dot" | "Grey25" | "Grey50" | + "Grey75" | "Automatic" | "RoundDot" + - name: weight + uid: excel!Excel.ChartLineFormat#weight:member + package: excel! + fullName: weight + summary: Represents weight of the line, in points. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'weight: number;' + return: + type: number +methods: + - name: clear() + uid: excel!Excel.ChartLineFormat#clear:member(1) + package: excel! + fullName: clear() + summary: Clears the line format of a chart element. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Clear the format of the major gridlines on Chart1. + + await Excel.run(async (context) => { + const gridlines = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").axes.valueAxis.majorGridlines; + gridlines.format.line.clear(); + await context.sync(); + + console.log("Chart Major Gridlines Format Cleared"); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'clear(): void;' + return: + type: void + description: '' + - name: load(options) + uid: excel!Excel.ChartLineFormat#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartLineFormatLoadOptions): + Excel.ChartLineFormat; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartLineFormat#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartLineFormat;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: |- + + + #### Examples + + ```TypeScript + // Set chart major gridlines on value axis to be red. + await Excel.run(async (context) => { + const gridlines = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").axes.valueAxis.majorGridlines; + gridlines.format.line.color = "#FF0000"; + await context.sync() + + console.log("Chart Gridlines Color Updated"); + }); + ``` + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartLineFormat#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartLineFormat; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartLineFormat#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartLineFormatUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartLineFormat#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartLineFormat): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartLineFormat#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.ChartLineFormat` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.ChartLineFormatData`) that + contains shallow copies of any loaded child properties from the original + object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartLineFormatData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartlinestyle.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartlinestyle.yml new file mode 100644 index 0000000000..6266401519 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartlinestyle.yml @@ -0,0 +1,90 @@ +### YamlMime:TSEnum +name: Excel.ChartLineStyle +uid: excel!Excel.ChartLineStyle:enum +package: excel! +fullName: Excel.ChartLineStyle +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: automatic + uid: excel!Excel.ChartLineStyle.automatic:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Automatic"' + - name: continuous + uid: excel!Excel.ChartLineStyle.continuous:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Continuous"' + - name: dash + uid: excel!Excel.ChartLineStyle.dash:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Dash"' + - name: dashDot + uid: excel!Excel.ChartLineStyle.dashDot:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"DashDot"' + - name: dashDotDot + uid: excel!Excel.ChartLineStyle.dashDotDot:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"DashDotDot"' + - name: dot + uid: excel!Excel.ChartLineStyle.dot:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Dot"' + - name: grey25 + uid: excel!Excel.ChartLineStyle.grey25:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Grey25"' + - name: grey50 + uid: excel!Excel.ChartLineStyle.grey50:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Grey50"' + - name: grey75 + uid: excel!Excel.ChartLineStyle.grey75:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Grey75"' + - name: none + uid: excel!Excel.ChartLineStyle.none:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"None"' + - name: roundDot + uid: excel!Excel.ChartLineStyle.roundDot:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"RoundDot"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartmaparealevel.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartmaparealevel.yml new file mode 100644 index 0000000000..5fc83b8893 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartmaparealevel.yml @@ -0,0 +1,71 @@ +### YamlMime:TSEnum +name: Excel.ChartMapAreaLevel +uid: excel!Excel.ChartMapAreaLevel:enum +package: excel! +fullName: Excel.ChartMapAreaLevel +summary: >- + Represents the mapping level of a chart series. This only applies to region + map charts. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: automatic + uid: excel!Excel.ChartMapAreaLevel.automatic:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Automatic"' + - name: city + uid: excel!Excel.ChartMapAreaLevel.city:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"City"' + - name: continent + uid: excel!Excel.ChartMapAreaLevel.continent:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Continent"' + - name: country + uid: excel!Excel.ChartMapAreaLevel.country:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Country"' + - name: county + uid: excel!Excel.ChartMapAreaLevel.county:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"County"' + - name: dataOnly + uid: excel!Excel.ChartMapAreaLevel.dataOnly:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"DataOnly"' + - name: state + uid: excel!Excel.ChartMapAreaLevel.state:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"State"' + - name: world + uid: excel!Excel.ChartMapAreaLevel.world:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"World"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartmaplabelstrategy.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartmaplabelstrategy.yml new file mode 100644 index 0000000000..5a2a2caf9e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartmaplabelstrategy.yml @@ -0,0 +1,36 @@ +### YamlMime:TSEnum +name: Excel.ChartMapLabelStrategy +uid: excel!Excel.ChartMapLabelStrategy:enum +package: excel! +fullName: Excel.ChartMapLabelStrategy +summary: >- + Represents the region level of a chart series layout. This only applies to + region map charts. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: bestFit + uid: excel!Excel.ChartMapLabelStrategy.bestFit:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"BestFit"' + - name: none + uid: excel!Excel.ChartMapLabelStrategy.none:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"None"' + - name: showAll + uid: excel!Excel.ChartMapLabelStrategy.showAll:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ShowAll"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartmapoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartmapoptions.yml new file mode 100644 index 0000000000..e2d2cc49aa --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartmapoptions.yml @@ -0,0 +1,242 @@ +### YamlMime:TSType +name: Excel.ChartMapOptions +uid: excel!Excel.ChartMapOptions:class +package: excel! +fullName: Excel.ChartMapOptions +summary: Encapsulates the properties for a region map chart. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.ChartMapOptions#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: labelStrategy + uid: excel!Excel.ChartMapOptions#labelStrategy:member + package: excel! + fullName: labelStrategy + summary: Specifies the series map labels strategy of a region map chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + labelStrategy: Excel.ChartMapLabelStrategy | "None" | "BestFit" | + "ShowAll"; + return: + type: >- + | "None" | + "BestFit" | "ShowAll" + - name: level + uid: excel!Excel.ChartMapOptions#level:member + package: excel! + fullName: level + summary: Specifies the series mapping level of a region map chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + level: Excel.ChartMapAreaLevel | "Automatic" | "DataOnly" | "City" | + "County" | "State" | "Country" | "Continent" | "World"; + return: + type: >- + | "Automatic" | + "DataOnly" | "City" | "County" | "State" | "Country" | "Continent" | + "World" + - name: projectionType + uid: excel!Excel.ChartMapOptions#projectionType:member + package: excel! + fullName: projectionType + summary: Specifies the series projection type of a region map chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + projectionType: Excel.ChartMapProjectionType | "Automatic" | "Mercator" + | "Miller" | "Robinson" | "Albers"; + return: + type: >- + | "Automatic" | + "Mercator" | "Miller" | "Robinson" | "Albers" +methods: + - name: load(options) + uid: excel!Excel.ChartMapOptions#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartMapOptionsLoadOptions): + Excel.ChartMapOptions; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartMapOptions#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartMapOptions;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartMapOptions#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartMapOptions; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartMapOptions#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartMapOptionsUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartMapOptions#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartMapOptions): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartMapOptions#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.ChartMapOptions` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.ChartMapOptionsData`) that + contains shallow copies of any loaded child properties from the original + object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartMapOptionsData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartmapprojectiontype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartmapprojectiontype.yml new file mode 100644 index 0000000000..a03fdbb897 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartmapprojectiontype.yml @@ -0,0 +1,50 @@ +### YamlMime:TSEnum +name: Excel.ChartMapProjectionType +uid: excel!Excel.ChartMapProjectionType:enum +package: excel! +fullName: Excel.ChartMapProjectionType +summary: >- + Represents the region projection type of a chart series layout. This only + applies to region map charts. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: albers + uid: excel!Excel.ChartMapProjectionType.albers:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Albers"' + - name: automatic + uid: excel!Excel.ChartMapProjectionType.automatic:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Automatic"' + - name: mercator + uid: excel!Excel.ChartMapProjectionType.mercator:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Mercator"' + - name: miller + uid: excel!Excel.ChartMapProjectionType.miller:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Miller"' + - name: robinson + uid: excel!Excel.ChartMapProjectionType.robinson:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Robinson"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartmarkerstyle.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartmarkerstyle.yml new file mode 100644 index 0000000000..83d9ea9470 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartmarkerstyle.yml @@ -0,0 +1,104 @@ +### YamlMime:TSEnum +name: Excel.ChartMarkerStyle +uid: excel!Excel.ChartMarkerStyle:enum +package: excel! +fullName: Excel.ChartMarkerStyle +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: automatic + uid: excel!Excel.ChartMarkerStyle.automatic:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Automatic"' + - name: circle + uid: excel!Excel.ChartMarkerStyle.circle:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Circle"' + - name: dash + uid: excel!Excel.ChartMarkerStyle.dash:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Dash"' + - name: diamond + uid: excel!Excel.ChartMarkerStyle.diamond:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Diamond"' + - name: dot + uid: excel!Excel.ChartMarkerStyle.dot:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Dot"' + - name: invalid + uid: excel!Excel.ChartMarkerStyle.invalid:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Invalid"' + - name: none + uid: excel!Excel.ChartMarkerStyle.none:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"None"' + - name: picture + uid: excel!Excel.ChartMarkerStyle.picture:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Picture"' + - name: plus + uid: excel!Excel.ChartMarkerStyle.plus:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Plus"' + - name: square + uid: excel!Excel.ChartMarkerStyle.square:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Square"' + - name: star + uid: excel!Excel.ChartMarkerStyle.star:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Star"' + - name: triangle + uid: excel!Excel.ChartMarkerStyle.triangle:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Triangle"' + - name: x + uid: excel!Excel.ChartMarkerStyle.x:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"X"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartparentlabelstrategy.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartparentlabelstrategy.yml new file mode 100644 index 0000000000..ae46f725b7 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartparentlabelstrategy.yml @@ -0,0 +1,36 @@ +### YamlMime:TSEnum +name: Excel.ChartParentLabelStrategy +uid: excel!Excel.ChartParentLabelStrategy:enum +package: excel! +fullName: Excel.ChartParentLabelStrategy +summary: >- + Represents the parent label strategy of the chart series layout. This only + applies to treemap charts +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: banner + uid: excel!Excel.ChartParentLabelStrategy.banner:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Banner"' + - name: none + uid: excel!Excel.ChartParentLabelStrategy.none:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"None"' + - name: overlapping + uid: excel!Excel.ChartParentLabelStrategy.overlapping:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Overlapping"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartpivotoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartpivotoptions.yml new file mode 100644 index 0000000000..4c53301393 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartpivotoptions.yml @@ -0,0 +1,252 @@ +### YamlMime:TSType +name: Excel.ChartPivotOptions +uid: excel!Excel.ChartPivotOptions:class +package: excel! +fullName: Excel.ChartPivotOptions +summary: Encapsulates the options for the pivot chart. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.ChartPivotOptions#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: showAxisFieldButtons + uid: excel!Excel.ChartPivotOptions#showAxisFieldButtons:member + package: excel! + fullName: showAxisFieldButtons + summary: >- + Specifies whether to display the axis field buttons on a PivotChart. The + `showAxisFieldButtons` property corresponds to the "Show Axis Field + Buttons" command on the "Field Buttons" drop-down list of the "Analyze" + tab, which is available when a PivotChart is selected. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showAxisFieldButtons: boolean;' + return: + type: boolean + - name: showLegendFieldButtons + uid: excel!Excel.ChartPivotOptions#showLegendFieldButtons:member + package: excel! + fullName: showLegendFieldButtons + summary: Specifies whether to display the legend field buttons on a PivotChart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showLegendFieldButtons: boolean;' + return: + type: boolean + - name: showReportFilterFieldButtons + uid: excel!Excel.ChartPivotOptions#showReportFilterFieldButtons:member + package: excel! + fullName: showReportFilterFieldButtons + summary: >- + Specifies whether to display the report filter field buttons on a + PivotChart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showReportFilterFieldButtons: boolean;' + return: + type: boolean + - name: showValueFieldButtons + uid: excel!Excel.ChartPivotOptions#showValueFieldButtons:member + package: excel! + fullName: showValueFieldButtons + summary: Specifies whether to display the show value field buttons on a PivotChart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showValueFieldButtons: boolean;' + return: + type: boolean +methods: + - name: load(options) + uid: excel!Excel.ChartPivotOptions#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartPivotOptionsLoadOptions): + Excel.ChartPivotOptions; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartPivotOptions#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartPivotOptions;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartPivotOptions#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartPivotOptions; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartPivotOptions#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartPivotOptionsUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartPivotOptions#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartPivotOptions): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartPivotOptions#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.ChartPivotOptions` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.ChartPivotOptionsData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartPivotOptionsData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartplotarea.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartplotarea.yml new file mode 100644 index 0000000000..e463a2a266 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartplotarea.yml @@ -0,0 +1,336 @@ +### YamlMime:TSType +name: Excel.ChartPlotArea +uid: excel!Excel.ChartPlotArea:class +package: excel! +fullName: Excel.ChartPlotArea +summary: This object represents the attributes for a chart plot area. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.ChartPlotArea#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: format + uid: excel!Excel.ChartPlotArea#format:member + package: excel! + fullName: format + summary: Specifies the formatting of a chart plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly format: Excel.ChartPlotAreaFormat;' + return: + type: + - name: height + uid: excel!Excel.ChartPlotArea#height:member + package: excel! + fullName: height + summary: Specifies the height value of a plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height: number;' + return: + type: number + - name: insideHeight + uid: excel!Excel.ChartPlotArea#insideHeight:member + package: excel! + fullName: insideHeight + summary: Specifies the inside height value of a plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'insideHeight: number;' + return: + type: number + - name: insideLeft + uid: excel!Excel.ChartPlotArea#insideLeft:member + package: excel! + fullName: insideLeft + summary: Specifies the inside left value of a plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'insideLeft: number;' + return: + type: number + - name: insideTop + uid: excel!Excel.ChartPlotArea#insideTop:member + package: excel! + fullName: insideTop + summary: Specifies the inside top value of a plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'insideTop: number;' + return: + type: number + - name: insideWidth + uid: excel!Excel.ChartPlotArea#insideWidth:member + package: excel! + fullName: insideWidth + summary: Specifies the inside width value of a plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'insideWidth: number;' + return: + type: number + - name: left + uid: excel!Excel.ChartPlotArea#left:member + package: excel! + fullName: left + summary: Specifies the left value of a plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left: number;' + return: + type: number + - name: position + uid: excel!Excel.ChartPlotArea#position:member + package: excel! + fullName: position + summary: Specifies the position of a plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'position: Excel.ChartPlotAreaPosition | "Automatic" | "Custom";' + return: + type: >- + | "Automatic" | + "Custom" + - name: top + uid: excel!Excel.ChartPlotArea#top:member + package: excel! + fullName: top + summary: Specifies the top value of a plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top: number;' + return: + type: number + - name: width + uid: excel!Excel.ChartPlotArea#width:member + package: excel! + fullName: width + summary: Specifies the width value of a plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width: number;' + return: + type: number +methods: + - name: load(options) + uid: excel!Excel.ChartPlotArea#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartPlotAreaLoadOptions): + Excel.ChartPlotArea; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartPlotArea#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartPlotArea;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartPlotArea#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartPlotArea; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartPlotArea#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartPlotAreaUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartPlotArea#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartPlotArea): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartPlotArea#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.ChartPlotArea` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.ChartPlotAreaData`) that + contains shallow copies of any loaded child properties from the original + object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartPlotAreaData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartplotareaformat.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartplotareaformat.yml new file mode 100644 index 0000000000..83f03c42d7 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartplotareaformat.yml @@ -0,0 +1,220 @@ +### YamlMime:TSType +name: Excel.ChartPlotAreaFormat +uid: excel!Excel.ChartPlotAreaFormat:class +package: excel! +fullName: Excel.ChartPlotAreaFormat +summary: Represents the format properties for a chart plot area. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: border + uid: excel!Excel.ChartPlotAreaFormat#border:member + package: excel! + fullName: border + summary: Specifies the border attributes of a chart plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly border: Excel.ChartBorder;' + return: + type: + - name: context + uid: excel!Excel.ChartPlotAreaFormat#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: fill + uid: excel!Excel.ChartPlotAreaFormat#fill:member + package: excel! + fullName: fill + summary: >- + Specifies the fill format of an object, which includes background + formatting information. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly fill: Excel.ChartFill;' + return: + type: +methods: + - name: load(options) + uid: excel!Excel.ChartPlotAreaFormat#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartPlotAreaFormatLoadOptions): + Excel.ChartPlotAreaFormat; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartPlotAreaFormat#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartPlotAreaFormat;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartPlotAreaFormat#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartPlotAreaFormat; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartPlotAreaFormat#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartPlotAreaFormatUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartPlotAreaFormat#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartPlotAreaFormat): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartPlotAreaFormat#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.ChartPlotAreaFormat` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.ChartPlotAreaFormatData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartPlotAreaFormatData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartplotareaposition.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartplotareaposition.yml new file mode 100644 index 0000000000..1b20dbd127 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartplotareaposition.yml @@ -0,0 +1,27 @@ +### YamlMime:TSEnum +name: Excel.ChartPlotAreaPosition +uid: excel!Excel.ChartPlotAreaPosition:enum +package: excel! +fullName: Excel.ChartPlotAreaPosition +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: automatic + uid: excel!Excel.ChartPlotAreaPosition.automatic:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Automatic"' + - name: custom + uid: excel!Excel.ChartPlotAreaPosition.custom:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Custom"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartplotby.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartplotby.yml new file mode 100644 index 0000000000..106460b7c6 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartplotby.yml @@ -0,0 +1,27 @@ +### YamlMime:TSEnum +name: Excel.ChartPlotBy +uid: excel!Excel.ChartPlotBy:enum +package: excel! +fullName: Excel.ChartPlotBy +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: columns + uid: excel!Excel.ChartPlotBy.columns:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Columns"' + - name: rows + uid: excel!Excel.ChartPlotBy.rows:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Rows"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartpoint.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartpoint.yml new file mode 100644 index 0000000000..d55f65de34 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartpoint.yml @@ -0,0 +1,367 @@ +### YamlMime:TSType +name: Excel.ChartPoint +uid: excel!Excel.ChartPoint:class +package: excel! +fullName: Excel.ChartPoint +summary: Represents a point of a series in a chart. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-data-labels.yaml + + + // This function adds data labels to specific chart points + + // and sets their text and position. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem(sheetName); + const chart = sheet.charts.getItemAt(0); + await context.sync(); + + const series = chart.series.getItemAt(0); + series.points.load("dataLabel"); + await context.sync(); + + // Define properties for data label positioning and shape. + const labelProperties = [ + { + top: 70, + geometricShapeType: Excel.GeometricShapeType.rectangle + }, + { + top: 200, + geometricShapeType: Excel.GeometricShapeType.rectangle + } + ]; + + // Add data labels to specific chart points and set their text and properties. + for (let i = 0; i < dataLabelInfo.length; i++) { + const point = series.points.getItemAt(dataLabelInfo[i].index); + point.hasDataLabel = true; + + const dataLabel = point.dataLabel; + dataLabel.text = dataLabelInfo[i].news; + dataLabel.set(labelProperties[i]); + } + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.ChartPoint#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: dataLabel + uid: excel!Excel.ChartPoint#dataLabel:member + package: excel! + fullName: dataLabel + summary: Returns the data label of a chart point. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly dataLabel: Excel.ChartDataLabel;' + return: + type: + - name: format + uid: excel!Excel.ChartPoint#format:member + package: excel! + fullName: format + summary: Encapsulates the format properties chart point. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly format: Excel.ChartPointFormat;' + return: + type: + - name: hasDataLabel + uid: excel!Excel.ChartPoint#hasDataLabel:member + package: excel! + fullName: hasDataLabel + summary: >- + Represents whether a data point has a data label. Not applicable for + surface charts. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'hasDataLabel: boolean;' + return: + type: boolean + - name: markerBackgroundColor + uid: excel!Excel.ChartPoint#markerBackgroundColor:member + package: excel! + fullName: markerBackgroundColor + summary: >- + HTML color code representation of the marker background color of a data + point (e.g., \#FF0000 represents Red). + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'markerBackgroundColor: string;' + return: + type: string + - name: markerForegroundColor + uid: excel!Excel.ChartPoint#markerForegroundColor:member + package: excel! + fullName: markerForegroundColor + summary: >- + HTML color code representation of the marker foreground color of a data + point (e.g., \#FF0000 represents Red). + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'markerForegroundColor: string;' + return: + type: string + - name: markerSize + uid: excel!Excel.ChartPoint#markerSize:member + package: excel! + fullName: markerSize + summary: >- + Represents marker size of a data point. The supported size range is 2 to + 72. This method returns an InvalidArgument error if it's set with a size + outside of the supported range. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'markerSize: number;' + return: + type: number + - name: markerStyle + uid: excel!Excel.ChartPoint#markerStyle:member + package: excel! + fullName: markerStyle + summary: >- + Represents marker style of a chart data point. See + `Excel.ChartMarkerStyle` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + markerStyle: Excel.ChartMarkerStyle | "Invalid" | "Automatic" | "None" | + "Square" | "Diamond" | "Triangle" | "X" | "Star" | "Dot" | "Dash" | + "Circle" | "Plus" | "Picture"; + return: + type: >- + | "Invalid" | + "Automatic" | "None" | "Square" | "Diamond" | "Triangle" | "X" | + "Star" | "Dot" | "Dash" | "Circle" | "Plus" | "Picture" + - name: value + uid: excel!Excel.ChartPoint#value:member + package: excel! + fullName: value + summary: Returns the value of a chart point. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly value: any;' + return: + type: any +methods: + - name: load(options) + uid: excel!Excel.ChartPoint#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartPointLoadOptions): + Excel.ChartPoint; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartPoint#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartPoint;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartPoint#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartPoint; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartPoint#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartPointUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartPoint#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartPoint): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartPoint#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.ChartPoint` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.ChartPointData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartPointData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartpointformat.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartpointformat.yml new file mode 100644 index 0000000000..a8cacdc4af --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartpointformat.yml @@ -0,0 +1,219 @@ +### YamlMime:TSType +name: Excel.ChartPointFormat +uid: excel!Excel.ChartPointFormat:class +package: excel! +fullName: Excel.ChartPointFormat +summary: Represents the formatting object for chart points. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: border + uid: excel!Excel.ChartPointFormat#border:member + package: excel! + fullName: border + summary: >- + Represents the border format of a chart data point, which includes color, + style, and weight information. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly border: Excel.ChartBorder;' + return: + type: + - name: context + uid: excel!Excel.ChartPointFormat#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: fill + uid: excel!Excel.ChartPointFormat#fill:member + package: excel! + fullName: fill + summary: >- + Represents the fill format of a chart, which includes background + formatting information. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly fill: Excel.ChartFill;' + return: + type: +methods: + - name: load(options) + uid: excel!Excel.ChartPointFormat#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartPointFormatLoadOptions): + Excel.ChartPointFormat; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartPointFormat#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartPointFormat;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartPointFormat#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartPointFormat; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartPointFormat#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartPointFormatUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartPointFormat#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartPointFormat): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartPointFormat#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.ChartPointFormat` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.ChartPointFormatData`) that + contains shallow copies of any loaded child properties from the original + object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartPointFormatData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartpointscollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartpointscollection.yml new file mode 100644 index 0000000000..7ea75d220c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartpointscollection.yml @@ -0,0 +1,275 @@ +### YamlMime:TSType +name: Excel.ChartPointsCollection +uid: excel!Excel.ChartPointsCollection:class +package: excel! +fullName: Excel.ChartPointsCollection +summary: A collection of all the chart points within a series inside a chart. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-data-labels.yaml + + + // This function adds data labels to specific chart points + + // and sets their text and position. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem(sheetName); + const chart = sheet.charts.getItemAt(0); + await context.sync(); + + const series = chart.series.getItemAt(0); + series.points.load("dataLabel"); + await context.sync(); + + // Define properties for data label positioning and shape. + const labelProperties = [ + { + top: 70, + geometricShapeType: Excel.GeometricShapeType.rectangle + }, + { + top: 200, + geometricShapeType: Excel.GeometricShapeType.rectangle + } + ]; + + // Add data labels to specific chart points and set their text and properties. + for (let i = 0; i < dataLabelInfo.length; i++) { + const point = series.points.getItemAt(dataLabelInfo[i].index); + point.hasDataLabel = true; + + const dataLabel = point.dataLabel; + dataLabel.text = dataLabelInfo[i].news; + dataLabel.set(labelProperties[i]); + } + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.ChartPointsCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: count + uid: excel!Excel.ChartPointsCollection#count:member + package: excel! + fullName: count + summary: Returns the number of chart points in the series. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly count: number;' + return: + type: number + - name: items + uid: excel!Excel.ChartPointsCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.ChartPoint[];' + return: + type: [] +methods: + - name: getCount() + uid: excel!Excel.ChartPointsCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Returns the number of chart points in the series. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getItemAt(index) + uid: excel!Excel.ChartPointsCollection#getItemAt:member(1) + package: excel! + fullName: getItemAt(index) + summary: Retrieve a point based on its position within the series. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Set the border color for the first points in the points collection. + + await Excel.run(async (context) => { + const points = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").series.getItemAt(0).points; + points.getItemAt(0).format.fill.setSolidColor("8FBC8F"); + await context.sync(); + + console.log("Point Border Color Changed"); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemAt(index: number): Excel.ChartPoint;' + parameters: + - id: index + description: Index value of the object to be retrieved. Zero-indexed. + type: number + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.ChartPointsCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartPointsCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): Excel.ChartPointsCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartPointsCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartPointsCollection;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: |- + + + #### Examples + + ```TypeScript + // Get the number of points. + await Excel.run(async (context) => { + const pointsCollection = + context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").series.getItemAt(0).points; + pointsCollection.load('count'); + await context.sync(); + console.log("points: Count= " + pointsCollection.count); + }); + ``` + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartPointsCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.ChartPointsCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.ChartPointsCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.ChartPointsCollection` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.ChartPointsCollectionData`) that contains an + "items" array with shallow copies of any loaded properties from the + collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartPointsCollectionData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartseries.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartseries.yml new file mode 100644 index 0000000000..71726b4b35 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartseries.yml @@ -0,0 +1,1772 @@ +### YamlMime:TSType +name: Excel.ChartSeries +uid: excel!Excel.ChartSeries:class +package: excel! +fullName: Excel.ChartSeries +summary: Represents a series in a chart. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-leader-lines.yaml + + + // The following code adds data labels to the chart and positions them to + demonstrate leader lines. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem(sheetName); + const chart = sheet.charts.getItemAt(0); + const series = chart.series.getItemAt(0); + + // Enable data labels for the series. Leader lines are enabled by default. + series.hasDataLabels = true; + series.points.load("items"); + await context.sync(); + + // Load the top position for each data label. + series.points.items.forEach((point) => point.dataLabel.load("top")); + await context.sync(); + + // Move some data labels to create distance from their chart points. + const point1 = series.points.items[1]; + const point2 = series.points.items[2]; + point1.dataLabel.top -= 50; + point2.dataLabel.top += 50; + + // Format the data labels. + series.dataLabels.geometricShapeType = Excel.GeometricShapeType.rectangle; + series.dataLabels.showCategoryName = true; + series.dataLabels.format.border.weight = 1; + + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +type: class +properties: + - name: axisGroup + uid: excel!Excel.ChartSeries#axisGroup:member + package: excel! + fullName: axisGroup + summary: Specifies the group for the specified series. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'axisGroup: Excel.ChartAxisGroup | "Primary" | "Secondary";' + return: + type: >- + | "Primary" | + "Secondary" + - name: binOptions + uid: excel!Excel.ChartSeries#binOptions:member + package: excel! + fullName: binOptions + summary: Encapsulates the bin options for histogram charts and pareto charts. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly binOptions: Excel.ChartBinOptions;' + return: + type: + - name: boxwhiskerOptions + uid: excel!Excel.ChartSeries#boxwhiskerOptions:member + package: excel! + fullName: boxwhiskerOptions + summary: Encapsulates the options for the box and whisker charts. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly boxwhiskerOptions: Excel.ChartBoxwhiskerOptions;' + return: + type: + - name: bubbleScale + uid: excel!Excel.ChartSeries#bubbleScale:member + package: excel! + fullName: bubbleScale + summary: >- + This can be an integer value from 0 (zero) to 300, representing the + percentage of the default size. This property only applies to bubble + charts. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'bubbleScale: number;' + return: + type: number + - name: chartType + uid: excel!Excel.ChartSeries#chartType:member + package: excel! + fullName: chartType + summary: Represents the chart type of a series. See `Excel.ChartType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + chartType: Excel.ChartType | "Invalid" | "ColumnClustered" | + "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | + "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" + | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | + "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | + "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | + "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | + "XYScatterSmoothNoMarkers" | "XYScatterLines" | + "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | + "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | + "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | + "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | + "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" + | "CylinderColClustered" | "CylinderColStacked" | + "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" + | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | + "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | + "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | + "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | + "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | + "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | + "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | + "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | + "Sunburst" | "Funnel"; + return: + type: >- + | "Invalid" | + "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | + "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | + "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | + "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" + | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | + "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | + "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | + "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | + "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | + "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | + "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | + "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | + "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | + "CylinderColStacked100" | "CylinderBarClustered" | + "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | + "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | + "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | + "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | + "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | + "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" + | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | + "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | + "Treemap" | "Waterfall" | "Sunburst" | "Funnel" + - name: context + uid: excel!Excel.ChartSeries#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: dataLabels + uid: excel!Excel.ChartSeries#dataLabels:member + package: excel! + fullName: dataLabels + summary: Represents a collection of all data labels in the series. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly dataLabels: Excel.ChartDataLabels;' + return: + type: + - name: doughnutHoleSize + uid: excel!Excel.ChartSeries#doughnutHoleSize:member + package: excel! + fullName: doughnutHoleSize + summary: >- + Represents the doughnut hole size of a chart series. Only valid on + doughnut and doughnut exploded charts. Throws an `InvalidArgument` error + on invalid charts. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'doughnutHoleSize: number;' + return: + type: number + - name: explosion + uid: excel!Excel.ChartSeries#explosion:member + package: excel! + fullName: explosion + summary: >- + Specifies the explosion value for a pie-chart or doughnut-chart slice. + Returns 0 (zero) if there's no explosion (the tip of the slice is in the + center of the pie). + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'explosion: number;' + return: + type: number + - name: filtered + uid: excel!Excel.ChartSeries#filtered:member + package: excel! + fullName: filtered + summary: Specifies if the series is filtered. Not applicable for surface charts. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'filtered: boolean;' + return: + type: boolean + - name: firstSliceAngle + uid: excel!Excel.ChartSeries#firstSliceAngle:member + package: excel! + fullName: firstSliceAngle + summary: >- + Specifies the angle of the first pie-chart or doughnut-chart slice, in + degrees (clockwise from vertical). Applies only to pie, 3-D pie, and + doughnut charts. Can be a value from 0 through 360. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'firstSliceAngle: number;' + return: + type: number + - name: format + uid: excel!Excel.ChartSeries#format:member + package: excel! + fullName: format + summary: >- + Represents the formatting of a chart series, which includes fill and line + formatting. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly format: Excel.ChartSeriesFormat;' + return: + type: + - name: gapWidth + uid: excel!Excel.ChartSeries#gapWidth:member + package: excel! + fullName: gapWidth + summary: >- + Represents the gap width of a chart series. Only valid on bar and column + charts, as well as specific classes of line and pie charts. Throws an + invalid argument exception on invalid charts. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gapWidth: number;' + return: + type: number + - name: gradientMaximumColor + uid: excel!Excel.ChartSeries#gradientMaximumColor:member + package: excel! + fullName: gradientMaximumColor + summary: Specifies the color for maximum value of a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientMaximumColor: string;' + return: + type: string + - name: gradientMaximumType + uid: excel!Excel.ChartSeries#gradientMaximumType:member + package: excel! + fullName: gradientMaximumType + summary: Specifies the type for maximum value of a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + gradientMaximumType: Excel.ChartGradientStyleType | "ExtremeValue" | + "Number" | "Percent"; + return: + type: >- + | + "ExtremeValue" | "Number" | "Percent" + - name: gradientMaximumValue + uid: excel!Excel.ChartSeries#gradientMaximumValue:member + package: excel! + fullName: gradientMaximumValue + summary: Specifies the maximum value of a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientMaximumValue: number;' + return: + type: number + - name: gradientMidpointColor + uid: excel!Excel.ChartSeries#gradientMidpointColor:member + package: excel! + fullName: gradientMidpointColor + summary: Specifies the color for the midpoint value of a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientMidpointColor: string;' + return: + type: string + - name: gradientMidpointType + uid: excel!Excel.ChartSeries#gradientMidpointType:member + package: excel! + fullName: gradientMidpointType + summary: Specifies the type for the midpoint value of a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + gradientMidpointType: Excel.ChartGradientStyleType | "ExtremeValue" | + "Number" | "Percent"; + return: + type: >- + | + "ExtremeValue" | "Number" | "Percent" + - name: gradientMidpointValue + uid: excel!Excel.ChartSeries#gradientMidpointValue:member + package: excel! + fullName: gradientMidpointValue + summary: Specifies the midpoint value of a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientMidpointValue: number;' + return: + type: number + - name: gradientMinimumColor + uid: excel!Excel.ChartSeries#gradientMinimumColor:member + package: excel! + fullName: gradientMinimumColor + summary: Specifies the color for the minimum value of a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientMinimumColor: string;' + return: + type: string + - name: gradientMinimumType + uid: excel!Excel.ChartSeries#gradientMinimumType:member + package: excel! + fullName: gradientMinimumType + summary: Specifies the type for the minimum value of a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + gradientMinimumType: Excel.ChartGradientStyleType | "ExtremeValue" | + "Number" | "Percent"; + return: + type: >- + | + "ExtremeValue" | "Number" | "Percent" + - name: gradientMinimumValue + uid: excel!Excel.ChartSeries#gradientMinimumValue:member + package: excel! + fullName: gradientMinimumValue + summary: Specifies the minimum value of a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientMinimumValue: number;' + return: + type: number + - name: gradientStyle + uid: excel!Excel.ChartSeries#gradientStyle:member + package: excel! + fullName: gradientStyle + summary: Specifies the series gradient style of a region map chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + gradientStyle: Excel.ChartGradientStyle | "TwoPhaseColor" | + "ThreePhaseColor"; + return: + type: >- + | "TwoPhaseColor" | + "ThreePhaseColor" + - name: hasDataLabels + uid: excel!Excel.ChartSeries#hasDataLabels:member + package: excel! + fullName: hasDataLabels + summary: Specifies if the series has data labels. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-leader-lines.yaml + + + // The following code adds data labels to the chart and positions them to + demonstrate leader lines. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem(sheetName); + const chart = sheet.charts.getItemAt(0); + const series = chart.series.getItemAt(0); + + // Enable data labels for the series. Leader lines are enabled by default. + series.hasDataLabels = true; + series.points.load("items"); + await context.sync(); + + // Load the top position for each data label. + series.points.items.forEach((point) => point.dataLabel.load("top")); + await context.sync(); + + // Move some data labels to create distance from their chart points. + const point1 = series.points.items[1]; + const point2 = series.points.items[2]; + point1.dataLabel.top -= 50; + point2.dataLabel.top += 50; + + // Format the data labels. + series.dataLabels.geometricShapeType = Excel.GeometricShapeType.rectangle; + series.dataLabels.showCategoryName = true; + series.dataLabels.format.border.weight = 1; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'hasDataLabels: boolean;' + return: + type: boolean + - name: invertColor + uid: excel!Excel.ChartSeries#invertColor:member + package: excel! + fullName: invertColor + summary: Specifies the fill color for negative data points in a series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'invertColor: string;' + return: + type: string + - name: invertIfNegative + uid: excel!Excel.ChartSeries#invertIfNegative:member + package: excel! + fullName: invertIfNegative + summary: >- + True if Excel inverts the pattern in the item when it corresponds to a + negative number. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'invertIfNegative: boolean;' + return: + type: boolean + - name: mapOptions + uid: excel!Excel.ChartSeries#mapOptions:member + package: excel! + fullName: mapOptions + summary: Encapsulates the options for a region map chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly mapOptions: Excel.ChartMapOptions;' + return: + type: + - name: markerBackgroundColor + uid: excel!Excel.ChartSeries#markerBackgroundColor:member + package: excel! + fullName: markerBackgroundColor + summary: Specifies the marker background color of a chart series. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-series-markers.yaml + + + await Excel.run(async (context) => { + let sheet = context.workbook.worksheets.getItem("Sample"); + let salesTable = sheet.tables.getItem("SalesTable"); + let dataRange = sheet.getRange("A1:E7"); + + // Create an XY scatter chart. + let chart = sheet.charts.add("XYScatterSmooth", dataRange, "Auto"); + chart.title.text = "Bicycle Parts Quarterly Sales"; + + let series = chart.series; + let series0 = series.getItemAt(0); + let series1 = series.getItemAt(1); + let series2 = series.getItemAt(2); + let series3 = series.getItemAt(3); + + // Set markers. + series0.markerStyle = "Dash"; + series0.markerForegroundColor = "black"; + series1.markerStyle = "Star"; + series1.markerForegroundColor = "black"; + series2.markerStyle = "X"; + series2.markerSize = 12; + series3.markerStyle = "Triangle"; + series3.markerBackgroundColor = "purple"; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'markerBackgroundColor: string;' + return: + type: string + - name: markerForegroundColor + uid: excel!Excel.ChartSeries#markerForegroundColor:member + package: excel! + fullName: markerForegroundColor + summary: Specifies the marker foreground color of a chart series. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-series-markers.yaml + + + await Excel.run(async (context) => { + let sheet = context.workbook.worksheets.getItem("Sample"); + let salesTable = sheet.tables.getItem("SalesTable"); + let dataRange = sheet.getRange("A1:E7"); + + // Create an XY scatter chart. + let chart = sheet.charts.add("XYScatterSmooth", dataRange, "Auto"); + chart.title.text = "Bicycle Parts Quarterly Sales"; + + let series = chart.series; + let series0 = series.getItemAt(0); + let series1 = series.getItemAt(1); + let series2 = series.getItemAt(2); + let series3 = series.getItemAt(3); + + // Set markers. + series0.markerStyle = "Dash"; + series0.markerForegroundColor = "black"; + series1.markerStyle = "Star"; + series1.markerForegroundColor = "black"; + series2.markerStyle = "X"; + series2.markerSize = 12; + series3.markerStyle = "Triangle"; + series3.markerBackgroundColor = "purple"; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'markerForegroundColor: string;' + return: + type: string + - name: markerSize + uid: excel!Excel.ChartSeries#markerSize:member + package: excel! + fullName: markerSize + summary: >- + Specifies the marker size of a chart series. The supported size range is 2 + to 72. This method returns an InvalidArgument error if it's set with a + size outside of the supported range. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-series-markers.yaml + + + await Excel.run(async (context) => { + let sheet = context.workbook.worksheets.getItem("Sample"); + let salesTable = sheet.tables.getItem("SalesTable"); + let dataRange = sheet.getRange("A1:E7"); + + // Create an XY scatter chart. + let chart = sheet.charts.add("XYScatterSmooth", dataRange, "Auto"); + chart.title.text = "Bicycle Parts Quarterly Sales"; + + let series = chart.series; + let series0 = series.getItemAt(0); + let series1 = series.getItemAt(1); + let series2 = series.getItemAt(2); + let series3 = series.getItemAt(3); + + // Set markers. + series0.markerStyle = "Dash"; + series0.markerForegroundColor = "black"; + series1.markerStyle = "Star"; + series1.markerForegroundColor = "black"; + series2.markerStyle = "X"; + series2.markerSize = 12; + series3.markerStyle = "Triangle"; + series3.markerBackgroundColor = "purple"; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'markerSize: number;' + return: + type: number + - name: markerStyle + uid: excel!Excel.ChartSeries#markerStyle:member + package: excel! + fullName: markerStyle + summary: >- + Specifies the marker style of a chart series. See `Excel.ChartMarkerStyle` + for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-series-markers.yaml + + + await Excel.run(async (context) => { + let sheet = context.workbook.worksheets.getItem("Sample"); + let salesTable = sheet.tables.getItem("SalesTable"); + let dataRange = sheet.getRange("A1:E7"); + + // Create an XY scatter chart. + let chart = sheet.charts.add("XYScatterSmooth", dataRange, "Auto"); + chart.title.text = "Bicycle Parts Quarterly Sales"; + + let series = chart.series; + let series0 = series.getItemAt(0); + let series1 = series.getItemAt(1); + let series2 = series.getItemAt(2); + let series3 = series.getItemAt(3); + + // Set markers. + series0.markerStyle = "Dash"; + series0.markerForegroundColor = "black"; + series1.markerStyle = "Star"; + series1.markerForegroundColor = "black"; + series2.markerStyle = "X"; + series2.markerSize = 12; + series3.markerStyle = "Triangle"; + series3.markerBackgroundColor = "purple"; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + markerStyle: Excel.ChartMarkerStyle | "Invalid" | "Automatic" | "None" | + "Square" | "Diamond" | "Triangle" | "X" | "Star" | "Dot" | "Dash" | + "Circle" | "Plus" | "Picture"; + return: + type: >- + | "Invalid" | + "Automatic" | "None" | "Square" | "Diamond" | "Triangle" | "X" | + "Star" | "Dot" | "Dash" | "Circle" | "Plus" | "Picture" + - name: name + uid: excel!Excel.ChartSeries#name:member + package: excel! + fullName: name + summary: >- + Specifies the name of a series in a chart. The name's length should not be + greater than 255 characters. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name: string;' + return: + type: string + - name: overlap + uid: excel!Excel.ChartSeries#overlap:member + package: excel! + fullName: overlap + summary: >- + Specifies how bars and columns are positioned. Can be a value between -100 + and 100. Applies only to 2-D bar and 2-D column charts. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'overlap: number;' + return: + type: number + - name: parentLabelStrategy + uid: excel!Excel.ChartSeries#parentLabelStrategy:member + package: excel! + fullName: parentLabelStrategy + summary: Specifies the series parent label strategy area for a treemap chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + parentLabelStrategy: Excel.ChartParentLabelStrategy | "None" | "Banner" + | "Overlapping"; + return: + type: >- + | "None" | + "Banner" | "Overlapping" + - name: plotOrder + uid: excel!Excel.ChartSeries#plotOrder:member + package: excel! + fullName: plotOrder + summary: Specifies the plot order of a chart series within the chart group. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'plotOrder: number;' + return: + type: number + - name: points + uid: excel!Excel.ChartSeries#points:member + package: excel! + fullName: points + summary: Returns a collection of all points in the series. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-leader-lines.yaml + + + // The following code adds data labels to the chart and positions them to + demonstrate leader lines. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem(sheetName); + const chart = sheet.charts.getItemAt(0); + const series = chart.series.getItemAt(0); + + // Enable data labels for the series. Leader lines are enabled by default. + series.hasDataLabels = true; + series.points.load("items"); + await context.sync(); + + // Load the top position for each data label. + series.points.items.forEach((point) => point.dataLabel.load("top")); + await context.sync(); + + // Move some data labels to create distance from their chart points. + const point1 = series.points.items[1]; + const point2 = series.points.items[2]; + point1.dataLabel.top -= 50; + point2.dataLabel.top += 50; + + // Format the data labels. + series.dataLabels.geometricShapeType = Excel.GeometricShapeType.rectangle; + series.dataLabels.showCategoryName = true; + series.dataLabels.format.border.weight = 1; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly points: Excel.ChartPointsCollection;' + return: + type: + - name: secondPlotSize + uid: excel!Excel.ChartSeries#secondPlotSize:member + package: excel! + fullName: secondPlotSize + summary: >- + Specifies the size of the secondary section of either a pie-of-pie chart + or a bar-of-pie chart, as a percentage of the size of the primary pie. Can + be a value from 5 to 200. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'secondPlotSize: number;' + return: + type: number + - name: showConnectorLines + uid: excel!Excel.ChartSeries#showConnectorLines:member + package: excel! + fullName: showConnectorLines + summary: Specifies whether connector lines are shown in waterfall charts. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showConnectorLines: boolean;' + return: + type: boolean + - name: showLeaderLines + uid: excel!Excel.ChartSeries#showLeaderLines:member + package: excel! + fullName: showLeaderLines + summary: >- + Specifies whether leader lines are displayed for each data label in the + series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-leader-lines.yaml + + + // The following code disables leader lines for chart data labels. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem(sheetName); + const chart = sheet.charts.getItemAt(0); + const series = chart.series.getItemAt(0); + const dataLabels = series.dataLabels; + + // Disable leader lines. + dataLabels.showLeaderLines = false; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'showLeaderLines: boolean;' + return: + type: boolean + - name: showShadow + uid: excel!Excel.ChartSeries#showShadow:member + package: excel! + fullName: showShadow + summary: Specifies if the series has a shadow. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showShadow: boolean;' + return: + type: boolean + - name: smooth + uid: excel!Excel.ChartSeries#smooth:member + package: excel! + fullName: smooth + summary: >- + Specifies if the series is smooth. Only applicable to line and scatter + charts. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'smooth: boolean;' + return: + type: boolean + - name: splitType + uid: excel!Excel.ChartSeries#splitType:member + package: excel! + fullName: splitType + summary: >- + Specifies the way the two sections of either a pie-of-pie chart or a + bar-of-pie chart are split. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + splitType: Excel.ChartSplitType | "SplitByPosition" | "SplitByValue" | + "SplitByPercentValue" | "SplitByCustomSplit"; + return: + type: >- + | "SplitByPosition" | + "SplitByValue" | "SplitByPercentValue" | "SplitByCustomSplit" + - name: splitValue + uid: excel!Excel.ChartSeries#splitValue:member + package: excel! + fullName: splitValue + summary: >- + Specifies the threshold value that separates two sections of either a + pie-of-pie chart or a bar-of-pie chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'splitValue: number;' + return: + type: number + - name: trendlines + uid: excel!Excel.ChartSeries#trendlines:member + package: excel! + fullName: trendlines + summary: The collection of trendlines in the series. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly trendlines: Excel.ChartTrendlineCollection;' + return: + type: + - name: varyByCategories + uid: excel!Excel.ChartSeries#varyByCategories:member + package: excel! + fullName: varyByCategories + summary: >- + True if Excel assigns a different color or pattern to each data marker. + The chart must contain only one series. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'varyByCategories: boolean;' + return: + type: boolean + - name: xErrorBars + uid: excel!Excel.ChartSeries#xErrorBars:member + package: excel! + fullName: xErrorBars + summary: Represents the error bar object of a chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly xErrorBars: Excel.ChartErrorBars;' + return: + type: + - name: yErrorBars + uid: excel!Excel.ChartSeries#yErrorBars:member + package: excel! + fullName: yErrorBars + summary: Represents the error bar object of a chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly yErrorBars: Excel.ChartErrorBars;' + return: + type: +methods: + - name: delete() + uid: excel!Excel.ChartSeries#delete:member(1) + package: excel! + fullName: delete() + summary: Deletes the chart series. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-series.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const seriesCollection = sheet.charts.getItemAt(0).series; + seriesCollection.load("count"); + await context.sync(); + + if (seriesCollection.count > 0) { + const series = seriesCollection.getItemAt(0); + + // Delete the first series. + series.delete(); + } + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'delete(): void;' + return: + type: void + description: '' + - name: getDimensionDataSourceString(dimension) + uid: excel!Excel.ChartSeries#getDimensionDataSourceString:member(1) + package: excel! + fullName: getDimensionDataSourceString(dimension) + summary: >- + Gets the string representation of the data source of the chart series. The + string representation could be information such as a cell address. + remarks: >- + \[ [API set: ExcelApi + 1.15](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-data-source.yaml + + + // This function retrieves the data source information of a chart series + in the Sample worksheet. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + + // Get the first chart series from the first chart on the worksheet. + const seriesCollection = sheet.charts.getItemAt(0).series; + const series = seriesCollection.getItemAt(0); + + // Get the series data source string and type values. + const dataSourceString = series.getDimensionDataSourceString("Values"); + const dataSourceType = series.getDimensionDataSourceType("Values"); + + series.load("name"); + await context.sync(); + + // Log the data source information to the console. + console.log(series.name + " data source string: " + dataSourceString.value); + console.log(series.name + " data source type: " + dataSourceType.value); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + getDimensionDataSourceString(dimension: Excel.ChartSeriesDimension): + OfficeExtension.ClientResult; + parameters: + - id: dimension + description: The dimension of the axis where the data is from. + type: + return: + type: <string> + description: '' + - name: getDimensionDataSourceString(dimension) + uid: excel!Excel.ChartSeries#getDimensionDataSourceString:member(2) + package: excel! + fullName: getDimensionDataSourceString(dimension) + summary: >- + Gets the string representation of the data source of the chart series. The + string representation could be information such as a cell address. + remarks: >- + \[ [API set: ExcelApi + 1.15](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + getDimensionDataSourceString(dimension: "Categories" | "Values" | + "XValues" | "YValues" | "BubbleSizes"): + OfficeExtension.ClientResult; + parameters: + - id: dimension + description: The dimension of the axis where the data is from. + type: '"Categories" | "Values" | "XValues" | "YValues" | "BubbleSizes"' + return: + type: <string> + description: '' + - name: getDimensionDataSourceType(dimension) + uid: excel!Excel.ChartSeries#getDimensionDataSourceType:member(1) + package: excel! + fullName: getDimensionDataSourceType(dimension) + summary: Gets the data source type of the chart series. + remarks: >- + \[ [API set: ExcelApi + 1.15](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-data-source.yaml + + + // This function retrieves the data source information of a chart series + in the Sample worksheet. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + + // Get the first chart series from the first chart on the worksheet. + const seriesCollection = sheet.charts.getItemAt(0).series; + const series = seriesCollection.getItemAt(0); + + // Get the series data source string and type values. + const dataSourceString = series.getDimensionDataSourceString("Values"); + const dataSourceType = series.getDimensionDataSourceType("Values"); + + series.load("name"); + await context.sync(); + + // Log the data source information to the console. + console.log(series.name + " data source string: " + dataSourceString.value); + console.log(series.name + " data source type: " + dataSourceType.value); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + getDimensionDataSourceType(dimension: Excel.ChartSeriesDimension): + OfficeExtension.ClientResult; + parameters: + - id: dimension + description: The dimension of the axis where the data is from. + type: + return: + type: >- + <> + description: '' + - name: getDimensionDataSourceType(dimension) + uid: excel!Excel.ChartSeries#getDimensionDataSourceType:member(2) + package: excel! + fullName: getDimensionDataSourceType(dimension) + summary: Gets the data source type of the chart series. + remarks: >- + \[ [API set: ExcelApi + 1.15](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + getDimensionDataSourceType(dimension: "Categories" | "Values" | + "XValues" | "YValues" | "BubbleSizes"): + OfficeExtension.ClientResult; + parameters: + - id: dimension + description: The dimension of the axis where the data is from. + type: '"Categories" | "Values" | "XValues" | "YValues" | "BubbleSizes"' + return: + type: >- + <> + description: '' + - name: getDimensionValues(dimension) + uid: excel!Excel.ChartSeries#getDimensionValues:member(1) + package: excel! + fullName: getDimensionValues(dimension) + summary: >- + Gets the values from a single dimension of the chart series. These could + be either category values or data values, depending on the dimension + specified and how the data is mapped for the chart series. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-bubble-chart.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + + // The sample chart is of type `Excel.ChartType.bubble`. + const bubbleChart = sheet.charts.getItem("Product Chart"); + + // Get the first series in the chart. + const firstSeries = bubbleChart.series.getItemAt(0); + + // Get the values for the dimensions we're interested in. + const bubbleSize = firstSeries.getDimensionValues(Excel.ChartSeriesDimension.bubbleSizes); + const xValues = firstSeries.getDimensionValues(Excel.ChartSeriesDimension.xvalues); + const yValues = firstSeries.getDimensionValues(Excel.ChartSeriesDimension.yvalues); + const category = firstSeries.getDimensionValues(Excel.ChartSeriesDimension.categories); + + await context.sync(); + + // Log the information. + console.log(`Series ${category.value} - X:${xValues.value},Y:${yValues.value},Bubble:${bubbleSize.value}`); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + getDimensionValues(dimension: Excel.ChartSeriesDimension): + OfficeExtension.ClientResult; + parameters: + - id: dimension + description: The dimension of the axis where the data is from. + type: + return: + type: >- + <string[]> + description: '' + - name: getDimensionValues(dimension) + uid: excel!Excel.ChartSeries#getDimensionValues:member(2) + package: excel! + fullName: getDimensionValues(dimension) + summary: >- + Gets the values from a single dimension of the chart series. These could + be either category values or data values, depending on the dimension + specified and how the data is mapped for the chart series. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + getDimensionValues(dimension: "Categories" | "Values" | "XValues" | + "YValues" | "BubbleSizes"): OfficeExtension.ClientResult; + parameters: + - id: dimension + description: The dimension of the axis where the data is from. + type: '"Categories" | "Values" | "XValues" | "YValues" | "BubbleSizes"' + return: + type: >- + <string[]> + description: '' + - name: load(options) + uid: excel!Excel.ChartSeries#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartSeriesLoadOptions): + Excel.ChartSeries; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartSeries#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartSeries;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: |- + + + #### Examples + + ```TypeScript + // Rename the 1st series of Chart1 to "New Series Name". + await Excel.run(async (context) => { + const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); + chart.series.getItemAt(0).name = "New Series Name"; + await context.sync(); + + console.log("Series1 Renamed"); + }); + ``` + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartSeries#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartSeries; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartSeries#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartSeriesUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartSeries#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartSeries): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: setBubbleSizes(sourceData) + uid: excel!Excel.ChartSeries#setBubbleSizes:member(1) + package: excel! + fullName: setBubbleSizes(sourceData) + summary: Sets the bubble sizes for a chart series. Only works for bubble charts. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-bubble-chart.yaml + + + await Excel.run(async (context) => { + /* + The table is expected to look like this: + Product, Inventory, Price, Current Market Share + Calamansi, 2000, $2.45, 10% + ... + + We want each bubble to represent a single row. + */ + + // Get the worksheet and table data. + const sheet = context.workbook.worksheets.getItem("Sample"); + const table = sheet.tables.getItem("Sales"); + const dataRange = table.getDataBodyRange(); + + // Get the table data without the row names. + const valueRange = dataRange.getOffsetRange(0, 1).getResizedRange(0, -1); + + // Create the chart. + const bubbleChart = sheet.charts.add(Excel.ChartType.bubble, valueRange); + bubbleChart.name = "Product Chart"; + + // Remove the default series, since we want a unique series for each row. + bubbleChart.series.getItemAt(0).delete(); + + // Load the data necessary to make a chart series. + dataRange.load(["rowCount", "values"]); + await context.sync(); + + // For each row, create a chart series (a bubble). + for (let i = 0; i < dataRange.rowCount; i++) { + const newSeries = bubbleChart.series.add(dataRange.values[i][0], i); + newSeries.setXAxisValues(dataRange.getCell(i, 1)); + newSeries.setValues(dataRange.getCell(i, 2)); + newSeries.setBubbleSizes(dataRange.getCell(i, 3)); + + // Show the product name and market share percentage. + newSeries.dataLabels.showSeriesName = true; + newSeries.dataLabels.showBubbleSize = true; + newSeries.dataLabels.showValue = false; + } + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'setBubbleSizes(sourceData: Range): void;' + parameters: + - id: sourceData + description: The `Range` object corresponding to the source data. + type: + return: + type: void + description: '' + - name: setValues(sourceData) + uid: excel!Excel.ChartSeries#setValues:member(1) + package: excel! + fullName: setValues(sourceData) + summary: >- + Sets the values for a chart series. For scatter charts, it refers to + y-axis values. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-series.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + + let seriesCollection = sheet.charts.getItemAt(0); + let rangeSelection = sheet.getRange("C2:C7"); + let xRangeSelection = sheet.getRange("A1:A7"); + + // Add a series. + let newSeries = seriesCollection.series.add("Qtr2"); + newSeries.setValues(rangeSelection); + newSeries.setXAxisValues(xRangeSelection); + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'setValues(sourceData: Range): void;' + parameters: + - id: sourceData + description: The `Range` object corresponding to the source data. + type: + return: + type: void + description: '' + - name: setXAxisValues(sourceData) + uid: excel!Excel.ChartSeries#setXAxisValues:member(1) + package: excel! + fullName: setXAxisValues(sourceData) + summary: Sets the values of the x-axis for a chart series. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'setXAxisValues(sourceData: Range): void;' + parameters: + - id: sourceData + description: The `Range` object corresponding to the source data. + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartSeries#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.ChartSeries` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.ChartSeriesData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartSeriesData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartseriesby.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartseriesby.yml new file mode 100644 index 0000000000..9bc3fbbb13 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartseriesby.yml @@ -0,0 +1,90 @@ +### YamlMime:TSEnum +name: Excel.ChartSeriesBy +uid: excel!Excel.ChartSeriesBy:enum +package: excel! +fullName: Excel.ChartSeriesBy +summary: >- + Specifies whether the series are by rows or by columns. In Excel on desktop, + the "auto" option will inspect the source data shape to automatically guess + whether the data is by rows or columns. In Excel on the web, "auto" will + simply default to "columns". +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-data-source.yaml + + + await Excel.run(async (context) => { + // Create a new worksheet called "Sample" and activate it. + context.workbook.worksheets.getItemOrNullObject("Sample").delete(); + const sheet = context.workbook.worksheets.add("Sample"); + + // Create an a table named SalesTable on the Sample worksheet. + let expensesTable = sheet.tables.add("A1:E1", true); + expensesTable.name = "SalesTable"; + + expensesTable.getHeaderRowRange().values = [["Product", "Qtr1", "Qtr2", "Qtr3", "Qtr4"]]; + expensesTable.rows.add(null, [ + ["Frames", 5000, 7000, 6544, 4377], + ["Saddles", 400, 323, 276, 651], + ["Brake levers", 12000, 8766, 8456, 9812], + ["Chains", 1550, 1088, 692, 853], + ["Mirrors", 225, 600, 923, 544], + ["Spokes", 6005, 7634, 4589, 8765] + ]); + + sheet.getUsedRange().format.autofitColumns(); + sheet.getUsedRange().format.autofitRows(); + sheet.activate(); + + // Create a line chart based on data from SalesTable. + let dataRange = sheet.getRange("A1:E7"); + let chart = sheet.charts.add("Line", dataRange, Excel.ChartSeriesBy.rows); + + // Position and style the chart. + chart.setPosition("A15", "E30"); + chart.legend.position = "Right"; + chart.legend.format.fill.setSolidColor("white"); + + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: auto + uid: excel!Excel.ChartSeriesBy.auto:member + package: excel! + summary: >- + In Excel on desktop, the "auto" option will inspect the source data shape + to automatically guess whether the data is by rows or columns. In Excel on + the web, "auto" will simply default to "columns". + + + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Auto"' + - name: columns + uid: excel!Excel.ChartSeriesBy.columns:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Columns"' + - name: rows + uid: excel!Excel.ChartSeriesBy.rows:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Rows"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartseriescollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartseriescollection.yml new file mode 100644 index 0000000000..1c2847bf65 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartseriescollection.yml @@ -0,0 +1,252 @@ +### YamlMime:TSType +name: Excel.ChartSeriesCollection +uid: excel!Excel.ChartSeriesCollection:class +package: excel! +fullName: Excel.ChartSeriesCollection +summary: Represents a collection of chart series. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.ChartSeriesCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: count + uid: excel!Excel.ChartSeriesCollection#count:member + package: excel! + fullName: count + summary: Returns the number of series in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly count: number;' + return: + type: number + - name: items + uid: excel!Excel.ChartSeriesCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.ChartSeries[];' + return: + type: [] +methods: + - name: add(name, index) + uid: excel!Excel.ChartSeriesCollection#add:member(1) + package: excel! + fullName: add(name, index) + summary: >- + Add a new series to the collection. The new added series is not visible + until values, x-axis values, or bubble sizes for it are set (depending on + chart type). + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'add(name?: string, index?: number): Excel.ChartSeries;' + parameters: + - id: name + description: Optional. Name of the series. + type: string + - id: index + description: Optional. Index value of the series to be added. Zero-indexed. + type: number + return: + type: + description: '' + - name: getCount() + uid: excel!Excel.ChartSeriesCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Returns the number of series in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getItemAt(index) + uid: excel!Excel.ChartSeriesCollection#getItemAt:member(1) + package: excel! + fullName: getItemAt(index) + summary: Retrieves a series based on its position in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Get the name of the first series in the series collection. + + await Excel.run(async (context) => { + const seriesCollection = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").series; + seriesCollection.load('items'); + await context.sync(); + + console.log(seriesCollection.items[0].name); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemAt(index: number): Excel.ChartSeries;' + parameters: + - id: index + description: Index value of the object to be retrieved. Zero-indexed. + type: number + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.ChartSeriesCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartSeriesCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): Excel.ChartSeriesCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartSeriesCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartSeriesCollection;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: |- + + + #### Examples + + ```TypeScript + // Get the number of chart series in the collection. + await Excel.run(async (context) => { + const seriesCollection = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").series; + seriesCollection.load('count'); + await context.sync(); + + console.log("series: Count= " + seriesCollection.count); + }); + ``` + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartSeriesCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.ChartSeriesCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.ChartSeriesCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.ChartSeriesCollection` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.ChartSeriesCollectionData`) that contains an + "items" array with shallow copies of any loaded properties from the + collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartSeriesCollectionData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartseriesdimension.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartseriesdimension.yml new file mode 100644 index 0000000000..2671b33018 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartseriesdimension.yml @@ -0,0 +1,101 @@ +### YamlMime:TSEnum +name: Excel.ChartSeriesDimension +uid: excel!Excel.ChartSeriesDimension:enum +package: excel! +fullName: Excel.ChartSeriesDimension +summary: Represents the dimensions when getting values from chart series. +remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-bubble-chart.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + + // The sample chart is of type `Excel.ChartType.bubble`. + const bubbleChart = sheet.charts.getItem("Product Chart"); + + // Get the first series in the chart. + const firstSeries = bubbleChart.series.getItemAt(0); + + // Get the values for the dimensions we're interested in. + const bubbleSize = firstSeries.getDimensionValues(Excel.ChartSeriesDimension.bubbleSizes); + const xValues = firstSeries.getDimensionValues(Excel.ChartSeriesDimension.xvalues); + const yValues = firstSeries.getDimensionValues(Excel.ChartSeriesDimension.yvalues); + const category = firstSeries.getDimensionValues(Excel.ChartSeriesDimension.categories); + + await context.sync(); + + // Log the information. + console.log(`Series ${category.value} - X:${xValues.value},Y:${yValues.value},Bubble:${bubbleSize.value}`); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: bubbleSizes + uid: excel!Excel.ChartSeriesDimension.bubbleSizes:member + package: excel! + summary: >- + The chart series axis for the bubble sizes in bubble charts. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"BubbleSizes"' + - name: categories + uid: excel!Excel.ChartSeriesDimension.categories:member + package: excel! + summary: >- + The chart series axis for the categories. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Categories"' + - name: values + uid: excel!Excel.ChartSeriesDimension.values:member + package: excel! + summary: >- + The chart series axis for the values. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Values"' + - name: xvalues + uid: excel!Excel.ChartSeriesDimension.xvalues:member + package: excel! + summary: >- + The chart series axis for the x-axis values in scatter and bubble charts. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"XValues"' + - name: yvalues + uid: excel!Excel.ChartSeriesDimension.yvalues:member + package: excel! + summary: >- + The chart series axis for the y-axis values in scatter and bubble charts. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"YValues"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartseriesformat.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartseriesformat.yml new file mode 100644 index 0000000000..fdaaf28b39 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartseriesformat.yml @@ -0,0 +1,218 @@ +### YamlMime:TSType +name: Excel.ChartSeriesFormat +uid: excel!Excel.ChartSeriesFormat:class +package: excel! +fullName: Excel.ChartSeriesFormat +summary: Encapsulates the format properties for the chart series +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.ChartSeriesFormat#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: fill + uid: excel!Excel.ChartSeriesFormat#fill:member + package: excel! + fullName: fill + summary: >- + Represents the fill format of a chart series, which includes background + formatting information. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly fill: Excel.ChartFill;' + return: + type: + - name: line + uid: excel!Excel.ChartSeriesFormat#line:member + package: excel! + fullName: line + summary: Represents line formatting. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly line: Excel.ChartLineFormat;' + return: + type: +methods: + - name: load(options) + uid: excel!Excel.ChartSeriesFormat#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartSeriesFormatLoadOptions): + Excel.ChartSeriesFormat; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartSeriesFormat#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartSeriesFormat;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartSeriesFormat#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartSeriesFormat; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartSeriesFormat#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartSeriesFormatUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartSeriesFormat#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartSeriesFormat): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartSeriesFormat#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.ChartSeriesFormat` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.ChartSeriesFormatData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartSeriesFormatData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartsplittype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartsplittype.yml new file mode 100644 index 0000000000..2d47569b73 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartsplittype.yml @@ -0,0 +1,41 @@ +### YamlMime:TSEnum +name: Excel.ChartSplitType +uid: excel!Excel.ChartSplitType:enum +package: excel! +fullName: Excel.ChartSplitType +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: splitByCustomSplit + uid: excel!Excel.ChartSplitType.splitByCustomSplit:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"SplitByCustomSplit"' + - name: splitByPercentValue + uid: excel!Excel.ChartSplitType.splitByPercentValue:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"SplitByPercentValue"' + - name: splitByPosition + uid: excel!Excel.ChartSplitType.splitByPosition:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"SplitByPosition"' + - name: splitByValue + uid: excel!Excel.ChartSplitType.splitByValue:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"SplitByValue"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.charttexthorizontalalignment.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.charttexthorizontalalignment.yml new file mode 100644 index 0000000000..a6a21769ad --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.charttexthorizontalalignment.yml @@ -0,0 +1,48 @@ +### YamlMime:TSEnum +name: Excel.ChartTextHorizontalAlignment +uid: excel!Excel.ChartTextHorizontalAlignment:enum +package: excel! +fullName: Excel.ChartTextHorizontalAlignment +summary: Represents the horizontal alignment for the specified object. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: center + uid: excel!Excel.ChartTextHorizontalAlignment.center:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Center"' + - name: distributed + uid: excel!Excel.ChartTextHorizontalAlignment.distributed:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Distributed"' + - name: justify + uid: excel!Excel.ChartTextHorizontalAlignment.justify:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Justify"' + - name: left + uid: excel!Excel.ChartTextHorizontalAlignment.left:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Left"' + - name: right + uid: excel!Excel.ChartTextHorizontalAlignment.right:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Right"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.charttextverticalalignment.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.charttextverticalalignment.yml new file mode 100644 index 0000000000..1c232f3a48 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.charttextverticalalignment.yml @@ -0,0 +1,48 @@ +### YamlMime:TSEnum +name: Excel.ChartTextVerticalAlignment +uid: excel!Excel.ChartTextVerticalAlignment:enum +package: excel! +fullName: Excel.ChartTextVerticalAlignment +summary: Represents the vertical alignment for the specified object. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: bottom + uid: excel!Excel.ChartTextVerticalAlignment.bottom:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Bottom"' + - name: center + uid: excel!Excel.ChartTextVerticalAlignment.center:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Center"' + - name: distributed + uid: excel!Excel.ChartTextVerticalAlignment.distributed:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Distributed"' + - name: justify + uid: excel!Excel.ChartTextVerticalAlignment.justify:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Justify"' + - name: top + uid: excel!Excel.ChartTextVerticalAlignment.top:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Top"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartticklabelalignment.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartticklabelalignment.yml new file mode 100644 index 0000000000..d473b4bd11 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartticklabelalignment.yml @@ -0,0 +1,34 @@ +### YamlMime:TSEnum +name: Excel.ChartTickLabelAlignment +uid: excel!Excel.ChartTickLabelAlignment:enum +package: excel! +fullName: Excel.ChartTickLabelAlignment +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: center + uid: excel!Excel.ChartTickLabelAlignment.center:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Center"' + - name: left + uid: excel!Excel.ChartTickLabelAlignment.left:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Left"' + - name: right + uid: excel!Excel.ChartTickLabelAlignment.right:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Right"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.charttitle.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.charttitle.yml new file mode 100644 index 0000000000..8d5c8609f3 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.charttitle.yml @@ -0,0 +1,518 @@ +### YamlMime:TSType +name: Excel.ChartTitle +uid: excel!Excel.ChartTitle:class +package: excel! +fullName: Excel.ChartTitle +summary: Represents a chart title object of a chart. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.ChartTitle#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: format + uid: excel!Excel.ChartTitle#format:member + package: excel! + fullName: format + summary: >- + Represents the formatting of a chart title, which includes fill and font + formatting. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly format: Excel.ChartTitleFormat;' + return: + type: + - name: height + uid: excel!Excel.ChartTitle#height:member + package: excel! + fullName: height + summary: >- + Returns the height, in points, of the chart title. Value is `null` if the + chart title is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly height: number;' + return: + type: number + - name: horizontalAlignment + uid: excel!Excel.ChartTitle#horizontalAlignment:member + package: excel! + fullName: horizontalAlignment + summary: Specifies the horizontal alignment for chart title. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + horizontalAlignment: Excel.ChartTextHorizontalAlignment | "Center" | + "Left" | "Right" | "Justify" | "Distributed"; + return: + type: >- + | + "Center" | "Left" | "Right" | "Justify" | "Distributed" + - name: left + uid: excel!Excel.ChartTitle#left:member + package: excel! + fullName: left + summary: >- + Specifies the distance, in points, from the left edge of chart title to + the left edge of chart area. Value is `null` if the chart title is not + visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left: number;' + return: + type: number + - name: overlay + uid: excel!Excel.ChartTitle#overlay:member + package: excel! + fullName: overlay + summary: Specifies if the chart title will overlay the chart. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'overlay: boolean;' + return: + type: boolean + - name: position + uid: excel!Excel.ChartTitle#position:member + package: excel! + fullName: position + summary: >- + Represents the position of chart title. See `Excel.ChartTitlePosition` for + details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + position: Excel.ChartTitlePosition | "Automatic" | "Top" | "Bottom" | + "Left" | "Right"; + return: + type: >- + | "Automatic" | + "Top" | "Bottom" | "Left" | "Right" + - name: showShadow + uid: excel!Excel.ChartTitle#showShadow:member + package: excel! + fullName: showShadow + summary: >- + Represents a boolean value that determines if the chart title has a + shadow. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showShadow: boolean;' + return: + type: boolean + - name: text + uid: excel!Excel.ChartTitle#text:member + package: excel! + fullName: text + summary: Specifies the chart's title text. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'text: string;' + return: + type: string + - name: textOrientation + uid: excel!Excel.ChartTitle#textOrientation:member + package: excel! + fullName: textOrientation + summary: >- + Specifies the angle to which the text is oriented for the chart title. The + value should either be an integer from -90 to 90 or the integer 180 for + vertically-oriented text. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-title-format.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const title = sheet.charts.getItemAt(0).title; + title.textOrientation = -45; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'textOrientation: number;' + return: + type: number + - name: top + uid: excel!Excel.ChartTitle#top:member + package: excel! + fullName: top + summary: >- + Specifies the distance, in points, from the top edge of chart title to the + top of chart area. Value is `null` if the chart title is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top: number;' + return: + type: number + - name: verticalAlignment + uid: excel!Excel.ChartTitle#verticalAlignment:member + package: excel! + fullName: verticalAlignment + summary: >- + Specifies the vertical alignment of chart title. See + `Excel.ChartTextVerticalAlignment` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | + "Bottom" | "Top" | "Justify" | "Distributed"; + return: + type: >- + | "Center" + | "Bottom" | "Top" | "Justify" | "Distributed" + - name: visible + uid: excel!Excel.ChartTitle#visible:member + package: excel! + fullName: visible + summary: Specifies if the chart title is visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible: boolean;' + return: + type: boolean + - name: width + uid: excel!Excel.ChartTitle#width:member + package: excel! + fullName: width + summary: >- + Specifies the width, in points, of the chart title. Value is `null` if the + chart title is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly width: number;' + return: + type: number +methods: + - name: getSubstring(start, length) + uid: excel!Excel.ChartTitle#getSubstring:member(1) + package: excel! + fullName: getSubstring(start, length) + summary: >- + Get the substring of a chart title. Line break '\\n' + counts one character. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-title-format.yaml + + + await Excel.run(async (context) => { + let sheet = context.workbook.worksheets.getItem("Sample"); + let chart = sheet.charts.getItemAt(0); + + // Get first seven characters of the title and color them green. + chart.title.getSubstring(0, 7).font.color = "Yellow"; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getSubstring(start: number, length: number): Excel.ChartFormatString;' + parameters: + - id: start + description: Start position of substring to be retrieved. Zero-indexed. + type: number + - id: length + description: Length of the substring to be retrieved. + type: number + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.ChartTitle#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartTitleLoadOptions): + Excel.ChartTitle; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartTitle#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartTitle;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: >- + + + #### Examples + + + ```TypeScript + + // Set the text of the chart title to "My Chart" and display it as an + overlay on the chart. + + await Excel.run(async (context) => { + const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); + + chart.title.text= "My Chart"; + chart.title.visible=true; + chart.title.overlay=true; + + await context.sync(); + console.log("Char Title Changed"); + }); + + ``` + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartTitle#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartTitle; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartTitle#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartTitleUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartTitle#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartTitle): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: setFormula(formula) + uid: excel!Excel.ChartTitle#setFormula:member(1) + package: excel! + fullName: setFormula(formula) + summary: >- + Sets a string value that represents the formula of chart title using + A1-style notation. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'setFormula(formula: string): void;' + parameters: + - id: formula + description: A string that represents the formula to set. + type: string + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartTitle#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.ChartTitle` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.ChartTitleData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartTitleData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.charttitleformat.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.charttitleformat.yml new file mode 100644 index 0000000000..657a7d5c23 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.charttitleformat.yml @@ -0,0 +1,236 @@ +### YamlMime:TSType +name: Excel.ChartTitleFormat +uid: excel!Excel.ChartTitleFormat:class +package: excel! +fullName: Excel.ChartTitleFormat +summary: Provides access to the formatting options for a chart title. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: border + uid: excel!Excel.ChartTitleFormat#border:member + package: excel! + fullName: border + summary: >- + Represents the border format of chart title, which includes color, + linestyle, and weight. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly border: Excel.ChartBorder;' + return: + type: + - name: context + uid: excel!Excel.ChartTitleFormat#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: fill + uid: excel!Excel.ChartTitleFormat#fill:member + package: excel! + fullName: fill + summary: >- + Represents the fill format of an object, which includes background + formatting information. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly fill: Excel.ChartFill;' + return: + type: + - name: font + uid: excel!Excel.ChartTitleFormat#font:member + package: excel! + fullName: font + summary: >- + Represents the font attributes (such as font name, font size, and color) + for an object. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly font: Excel.ChartFont;' + return: + type: +methods: + - name: load(options) + uid: excel!Excel.ChartTitleFormat#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartTitleFormatLoadOptions): + Excel.ChartTitleFormat; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartTitleFormat#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartTitleFormat;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartTitleFormat#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartTitleFormat; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartTitleFormat#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartTitleFormatUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartTitleFormat#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartTitleFormat): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartTitleFormat#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.ChartTitleFormat` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.ChartTitleFormatData`) that + contains shallow copies of any loaded child properties from the original + object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartTitleFormatData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.charttitleposition.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.charttitleposition.yml new file mode 100644 index 0000000000..21f84e8444 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.charttitleposition.yml @@ -0,0 +1,48 @@ +### YamlMime:TSEnum +name: Excel.ChartTitlePosition +uid: excel!Excel.ChartTitlePosition:enum +package: excel! +fullName: Excel.ChartTitlePosition +summary: Represents the position of the chart title. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: automatic + uid: excel!Excel.ChartTitlePosition.automatic:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Automatic"' + - name: bottom + uid: excel!Excel.ChartTitlePosition.bottom:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Bottom"' + - name: left + uid: excel!Excel.ChartTitlePosition.left:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Left"' + - name: right + uid: excel!Excel.ChartTitlePosition.right:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Right"' + - name: top + uid: excel!Excel.ChartTitlePosition.top:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Top"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.charttrendline.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.charttrendline.yml new file mode 100644 index 0000000000..dadda4c43e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.charttrendline.yml @@ -0,0 +1,406 @@ +### YamlMime:TSType +name: Excel.ChartTrendline +uid: excel!Excel.ChartTrendline:class +package: excel! +fullName: Excel.ChartTrendline +summary: This object represents the attributes for a chart trendline object. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: backwardPeriod + uid: excel!Excel.ChartTrendline#backwardPeriod:member + package: excel! + fullName: backwardPeriod + summary: Represents the number of periods that the trendline extends backward. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'backwardPeriod: number;' + return: + type: number + - name: context + uid: excel!Excel.ChartTrendline#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: format + uid: excel!Excel.ChartTrendline#format:member + package: excel! + fullName: format + summary: Represents the formatting of a chart trendline. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly format: Excel.ChartTrendlineFormat;' + return: + type: + - name: forwardPeriod + uid: excel!Excel.ChartTrendline#forwardPeriod:member + package: excel! + fullName: forwardPeriod + summary: Represents the number of periods that the trendline extends forward. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'forwardPeriod: number;' + return: + type: number + - name: intercept + uid: excel!Excel.ChartTrendline#intercept:member + package: excel! + fullName: intercept + summary: >- + Represents the intercept value of the trendline. Can be set to a numeric + value or an empty string (for automatic values). The returned value is + always a number. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'intercept: any;' + return: + type: any + - name: label + uid: excel!Excel.ChartTrendline#label:member + package: excel! + fullName: label + summary: Represents the label of a chart trendline. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly label: Excel.ChartTrendlineLabel;' + return: + type: + - name: movingAveragePeriod + uid: excel!Excel.ChartTrendline#movingAveragePeriod:member + package: excel! + fullName: movingAveragePeriod + summary: >- + Represents the period of a chart trendline. Only applicable to trendlines + with the type `MovingAverage`. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'movingAveragePeriod: number;' + return: + type: number + - name: name + uid: excel!Excel.ChartTrendline#name:member + package: excel! + fullName: name + summary: >- + Represents the name of the trendline. Can be set to a string value, a + `null` value represents automatic values. The returned value is always a + string + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name: string;' + return: + type: string + - name: polynomialOrder + uid: excel!Excel.ChartTrendline#polynomialOrder:member + package: excel! + fullName: polynomialOrder + summary: >- + Represents the order of a chart trendline. Only applicable to trendlines + with the type `Polynomial`. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'polynomialOrder: number;' + return: + type: number + - name: showEquation + uid: excel!Excel.ChartTrendline#showEquation:member + package: excel! + fullName: showEquation + summary: True if the equation for the trendline is displayed on the chart. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showEquation: boolean;' + return: + type: boolean + - name: showRSquared + uid: excel!Excel.ChartTrendline#showRSquared:member + package: excel! + fullName: showRSquared + summary: True if the r-squared value for the trendline is displayed on the chart. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showRSquared: boolean;' + return: + type: boolean + - name: type + uid: excel!Excel.ChartTrendline#type:member + package: excel! + fullName: type + summary: Represents the type of a chart trendline. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-trendlines.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + + let seriesCollection = sheet.charts.getItemAt(0).series; + + // Get the trendline for series 1 and load its type property. + let trendline = seriesCollection.getItemAt(0).trendlines.getItem(0); + trendline.load("type"); + + await context.sync(); + + console.log("The trendline type is:" + trendline.type); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + type: Excel.ChartTrendlineType | "Linear" | "Exponential" | + "Logarithmic" | "MovingAverage" | "Polynomial" | "Power"; + return: + type: >- + | "Linear" | + "Exponential" | "Logarithmic" | "MovingAverage" | "Polynomial" | + "Power" +methods: + - name: delete() + uid: excel!Excel.ChartTrendline#delete:member(1) + package: excel! + fullName: delete() + summary: Delete the trendline object. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'delete(): void;' + return: + type: void + description: '' + - name: load(options) + uid: excel!Excel.ChartTrendline#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartTrendlineLoadOptions): + Excel.ChartTrendline; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartTrendline#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartTrendline;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartTrendline#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartTrendline; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartTrendline#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartTrendlineUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartTrendline#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartTrendline): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartTrendline#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.ChartTrendline` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.ChartTrendlineData`) that + contains shallow copies of any loaded child properties from the original + object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartTrendlineData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.charttrendlinecollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.charttrendlinecollection.yml new file mode 100644 index 0000000000..bf3ef6e517 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.charttrendlinecollection.yml @@ -0,0 +1,252 @@ +### YamlMime:TSType +name: Excel.ChartTrendlineCollection +uid: excel!Excel.ChartTrendlineCollection:class +package: excel! +fullName: Excel.ChartTrendlineCollection +summary: Represents a collection of chart trendlines. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.ChartTrendlineCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: excel!Excel.ChartTrendlineCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.ChartTrendline[];' + return: + type: [] +methods: + - name: add(type) + uid: excel!Excel.ChartTrendlineCollection#add:member(1) + package: excel! + fullName: add(type) + summary: Adds a new trendline to trendline collection. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-trendlines.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + + let seriesCollection = sheet.charts.getItemAt(0).series; + + // Add a trendline. + seriesCollection.getItemAt(0).trendlines.add("Linear"); + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'add(type?: Excel.ChartTrendlineType): Excel.ChartTrendline;' + parameters: + - id: type + description: >- + Specifies the trendline type. The default value is "Linear". See + `Excel.ChartTrendline` for details. + type: + return: + type: + description: '' + - name: add(type) + uid: excel!Excel.ChartTrendlineCollection#add:member(2) + package: excel! + fullName: add(type) + summary: Adds a new trendline to trendline collection. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + add(type?: "Linear" | "Exponential" | "Logarithmic" | "MovingAverage" | + "Polynomial" | "Power"): Excel.ChartTrendline; + parameters: + - id: type + description: >- + Specifies the trendline type. The default value is "Linear". See + `Excel.ChartTrendline` for details. + type: >- + "Linear" | "Exponential" | "Logarithmic" | "MovingAverage" | + "Polynomial" | "Power" + return: + type: + description: '' + - name: getCount() + uid: excel!Excel.ChartTrendlineCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Returns the number of trendlines in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getItem(index) + uid: excel!Excel.ChartTrendlineCollection#getItem:member(1) + package: excel! + fullName: getItem(index) + summary: >- + Gets a trendline object by index, which is the insertion order in the + items array. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItem(index: number): Excel.ChartTrendline;' + parameters: + - id: index + description: Represents the insertion order in the items array. + type: number + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.ChartTrendlineCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartTrendlineCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): Excel.ChartTrendlineCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartTrendlineCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartTrendlineCollection;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartTrendlineCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.ChartTrendlineCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.ChartTrendlineCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.ChartTrendlineCollection` object is an API object, the `toJSON` + method returns a plain JavaScript object (typed as + `Excel.Interfaces.ChartTrendlineCollectionData`) that contains an + "items" array with shallow copies of any loaded properties from the + collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartTrendlineCollectionData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.charttrendlineformat.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.charttrendlineformat.yml new file mode 100644 index 0000000000..ee1b2faf77 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.charttrendlineformat.yml @@ -0,0 +1,230 @@ +### YamlMime:TSType +name: Excel.ChartTrendlineFormat +uid: excel!Excel.ChartTrendlineFormat:class +package: excel! +fullName: Excel.ChartTrendlineFormat +summary: Represents the format properties for the chart trendline. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.ChartTrendlineFormat#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: line + uid: excel!Excel.ChartTrendlineFormat#line:member + package: excel! + fullName: line + summary: Represents chart line formatting. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-trendlines.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + + let seriesCollection = sheet.charts.getItemAt(0).series; + let trendline = seriesCollection.getItemAt(0).trendlines.getItem(0); + + // Set format of the trendline to a solid, red line. + let line = trendline.format.line; + line.color = '#FF0000'; + + await context.sync(); + + console.log("The trendline color has been set to:" + line.color); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly line: Excel.ChartLineFormat;' + return: + type: +methods: + - name: load(options) + uid: excel!Excel.ChartTrendlineFormat#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartTrendlineFormatLoadOptions): + Excel.ChartTrendlineFormat; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartTrendlineFormat#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartTrendlineFormat;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartTrendlineFormat#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartTrendlineFormat; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartTrendlineFormat#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartTrendlineFormatUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartTrendlineFormat#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartTrendlineFormat): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartTrendlineFormat#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.ChartTrendlineFormat` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.ChartTrendlineFormatData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartTrendlineFormatData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.charttrendlinelabel.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.charttrendlinelabel.yml new file mode 100644 index 0000000000..756faa47b9 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.charttrendlinelabel.yml @@ -0,0 +1,416 @@ +### YamlMime:TSType +name: Excel.ChartTrendlineLabel +uid: excel!Excel.ChartTrendlineLabel:class +package: excel! +fullName: Excel.ChartTrendlineLabel +summary: This object represents the attributes for a chart trendline label object. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: autoText + uid: excel!Excel.ChartTrendlineLabel#autoText:member + package: excel! + fullName: autoText + summary: >- + Specifies if the trendline label automatically generates appropriate text + based on context. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'autoText: boolean;' + return: + type: boolean + - name: context + uid: excel!Excel.ChartTrendlineLabel#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: format + uid: excel!Excel.ChartTrendlineLabel#format:member + package: excel! + fullName: format + summary: The format of the chart trendline label. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly format: Excel.ChartTrendlineLabelFormat;' + return: + type: + - name: formula + uid: excel!Excel.ChartTrendlineLabel#formula:member + package: excel! + fullName: formula + summary: >- + String value that represents the formula of the chart trendline label + using A1-style notation. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formula: string;' + return: + type: string + - name: height + uid: excel!Excel.ChartTrendlineLabel#height:member + package: excel! + fullName: height + summary: >- + Returns the height, in points, of the chart trendline label. Value is + `null` if the chart trendline label is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly height: number;' + return: + type: number + - name: horizontalAlignment + uid: excel!Excel.ChartTrendlineLabel#horizontalAlignment:member + package: excel! + fullName: horizontalAlignment + summary: >- + Represents the horizontal alignment of the chart trendline label. See + `Excel.ChartTextHorizontalAlignment` for details. This property is valid + only when `TextOrientation` of a trendline label is -90, 90, or 180. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + horizontalAlignment: Excel.ChartTextHorizontalAlignment | "Center" | + "Left" | "Right" | "Justify" | "Distributed"; + return: + type: >- + | + "Center" | "Left" | "Right" | "Justify" | "Distributed" + - name: left + uid: excel!Excel.ChartTrendlineLabel#left:member + package: excel! + fullName: left + summary: >- + Represents the distance, in points, from the left edge of the chart + trendline label to the left edge of the chart area. Value is `null` if the + chart trendline label is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left: number;' + return: + type: number + - name: linkNumberFormat + uid: excel!Excel.ChartTrendlineLabel#linkNumberFormat:member + package: excel! + fullName: linkNumberFormat + summary: >- + Specifies if the number format is linked to the cells (so that the number + format changes in the labels when it changes in the cells). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'linkNumberFormat: boolean;' + return: + type: boolean + - name: numberFormat + uid: excel!Excel.ChartTrendlineLabel#numberFormat:member + package: excel! + fullName: numberFormat + summary: String value that represents the format code for the trendline label. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat: string;' + return: + type: string + - name: text + uid: excel!Excel.ChartTrendlineLabel#text:member + package: excel! + fullName: text + summary: String representing the text of the trendline label on a chart. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'text: string;' + return: + type: string + - name: textOrientation + uid: excel!Excel.ChartTrendlineLabel#textOrientation:member + package: excel! + fullName: textOrientation + summary: >- + Represents the angle to which the text is oriented for the chart trendline + label. The value should either be an integer from -90 to 90 or the integer + 180 for vertically-oriented text. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textOrientation: number;' + return: + type: number + - name: top + uid: excel!Excel.ChartTrendlineLabel#top:member + package: excel! + fullName: top + summary: >- + Represents the distance, in points, from the top edge of the chart + trendline label to the top of the chart area. Value is `null` if the chart + trendline label is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top: number;' + return: + type: number + - name: verticalAlignment + uid: excel!Excel.ChartTrendlineLabel#verticalAlignment:member + package: excel! + fullName: verticalAlignment + summary: >- + Represents the vertical alignment of the chart trendline label. See + `Excel.ChartTextVerticalAlignment` for details. This property is valid + only when `TextOrientation` of a trendline label is 0. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | + "Bottom" | "Top" | "Justify" | "Distributed"; + return: + type: >- + | "Center" + | "Bottom" | "Top" | "Justify" | "Distributed" + - name: width + uid: excel!Excel.ChartTrendlineLabel#width:member + package: excel! + fullName: width + summary: >- + Returns the width, in points, of the chart trendline label. Value is + `null` if the chart trendline label is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly width: number;' + return: + type: number +methods: + - name: load(options) + uid: excel!Excel.ChartTrendlineLabel#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartTrendlineLabelLoadOptions): + Excel.ChartTrendlineLabel; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartTrendlineLabel#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ChartTrendlineLabel;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartTrendlineLabel#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartTrendlineLabel; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartTrendlineLabel#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartTrendlineLabelUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartTrendlineLabel#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartTrendlineLabel): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartTrendlineLabel#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.ChartTrendlineLabel` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.ChartTrendlineLabelData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartTrendlineLabelData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.charttrendlinelabelformat.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.charttrendlinelabelformat.yml new file mode 100644 index 0000000000..8815ae7021 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.charttrendlinelabelformat.yml @@ -0,0 +1,238 @@ +### YamlMime:TSType +name: Excel.ChartTrendlineLabelFormat +uid: excel!Excel.ChartTrendlineLabelFormat:class +package: excel! +fullName: Excel.ChartTrendlineLabelFormat +summary: Encapsulates the format properties for the chart trendline label. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: border + uid: excel!Excel.ChartTrendlineLabelFormat#border:member + package: excel! + fullName: border + summary: Specifies the border format, which includes color, linestyle, and weight. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly border: Excel.ChartBorder;' + return: + type: + - name: context + uid: excel!Excel.ChartTrendlineLabelFormat#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: fill + uid: excel!Excel.ChartTrendlineLabelFormat#fill:member + package: excel! + fullName: fill + summary: Specifies the fill format of the current chart trendline label. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly fill: Excel.ChartFill;' + return: + type: + - name: font + uid: excel!Excel.ChartTrendlineLabelFormat#font:member + package: excel! + fullName: font + summary: >- + Specifies the font attributes (such as font name, font size, and color) + for a chart trendline label. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly font: Excel.ChartFont;' + return: + type: +methods: + - name: load(options) + uid: excel!Excel.ChartTrendlineLabelFormat#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ChartTrendlineLabelFormatLoadOptions): + Excel.ChartTrendlineLabelFormat; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ChartTrendlineLabelFormat#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNames?: string | string[]): + Excel.ChartTrendlineLabelFormat; + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ChartTrendlineLabelFormat#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartTrendlineLabelFormat; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ChartTrendlineLabelFormat#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ChartTrendlineLabelFormatUpdateData, + options?: OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ChartTrendlineLabelFormat#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ChartTrendlineLabelFormat): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ChartTrendlineLabelFormat#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.ChartTrendlineLabelFormat` object is an API object, the `toJSON` + method returns a plain JavaScript object (typed as + `Excel.Interfaces.ChartTrendlineLabelFormatData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ChartTrendlineLabelFormatData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.charttrendlinetype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.charttrendlinetype.yml new file mode 100644 index 0000000000..04324d1d44 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.charttrendlinetype.yml @@ -0,0 +1,55 @@ +### YamlMime:TSEnum +name: Excel.ChartTrendlineType +uid: excel!Excel.ChartTrendlineType:enum +package: excel! +fullName: Excel.ChartTrendlineType +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: exponential + uid: excel!Excel.ChartTrendlineType.exponential:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Exponential"' + - name: linear + uid: excel!Excel.ChartTrendlineType.linear:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Linear"' + - name: logarithmic + uid: excel!Excel.ChartTrendlineType.logarithmic:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Logarithmic"' + - name: movingAverage + uid: excel!Excel.ChartTrendlineType.movingAverage:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"MovingAverage"' + - name: polynomial + uid: excel!Excel.ChartTrendlineType.polynomial:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Polynomial"' + - name: power + uid: excel!Excel.ChartTrendlineType.power:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Power"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.charttype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.charttype.yml new file mode 100644 index 0000000000..2761858aed --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.charttype.yml @@ -0,0 +1,616 @@ +### YamlMime:TSEnum +name: Excel.ChartType +uid: excel!Excel.ChartType:enum +package: excel! +fullName: Excel.ChartType +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-create-several-charts.yaml + + + await Excel.run(async (context) => { + let sheet = context.workbook.worksheets.getItem("Sample"); + let salesTable = sheet.tables.getItem("SalesTable"); + + let dataRange = sheet.getRange("A1:E7"); + let chart = sheet.charts.add(Excel.ChartType.line, dataRange, "Auto"); + + chart.setPosition("A22", "F35"); + chart.legend.position = "Right"; + chart.legend.format.fill.setSolidColor("white"); + chart.dataLabels.format.font.size = 15; + chart.dataLabels.format.font.color = "black"; + chart.title.text = "Bicycle Parts Quarterly Sales"; + + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: _3DArea + uid: excel!Excel.ChartType._3DArea:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"3DArea"' + - name: _3DAreaStacked + uid: excel!Excel.ChartType._3DAreaStacked:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"3DAreaStacked"' + - name: _3DAreaStacked100 + uid: excel!Excel.ChartType._3DAreaStacked100:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"3DAreaStacked100"' + - name: _3DBarClustered + uid: excel!Excel.ChartType._3DBarClustered:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"3DBarClustered"' + - name: _3DBarStacked + uid: excel!Excel.ChartType._3DBarStacked:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"3DBarStacked"' + - name: _3DBarStacked100 + uid: excel!Excel.ChartType._3DBarStacked100:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"3DBarStacked100"' + - name: _3DColumn + uid: excel!Excel.ChartType._3DColumn:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"3DColumn"' + - name: _3DColumnClustered + uid: excel!Excel.ChartType._3DColumnClustered:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"3DColumnClustered"' + - name: _3DColumnStacked + uid: excel!Excel.ChartType._3DColumnStacked:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"3DColumnStacked"' + - name: _3DColumnStacked100 + uid: excel!Excel.ChartType._3DColumnStacked100:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"3DColumnStacked100"' + - name: _3DLine + uid: excel!Excel.ChartType._3DLine:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"3DLine"' + - name: _3DPie + uid: excel!Excel.ChartType._3DPie:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"3DPie"' + - name: _3DPieExploded + uid: excel!Excel.ChartType._3DPieExploded:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"3DPieExploded"' + - name: area + uid: excel!Excel.ChartType.area:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Area"' + - name: areaStacked + uid: excel!Excel.ChartType.areaStacked:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"AreaStacked"' + - name: areaStacked100 + uid: excel!Excel.ChartType.areaStacked100:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"AreaStacked100"' + - name: barClustered + uid: excel!Excel.ChartType.barClustered:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"BarClustered"' + - name: barOfPie + uid: excel!Excel.ChartType.barOfPie:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"BarOfPie"' + - name: barStacked + uid: excel!Excel.ChartType.barStacked:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"BarStacked"' + - name: barStacked100 + uid: excel!Excel.ChartType.barStacked100:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"BarStacked100"' + - name: boxwhisker + uid: excel!Excel.ChartType.boxwhisker:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Boxwhisker"' + - name: bubble + uid: excel!Excel.ChartType.bubble:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Bubble"' + - name: bubble3DEffect + uid: excel!Excel.ChartType.bubble3DEffect:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Bubble3DEffect"' + - name: columnClustered + uid: excel!Excel.ChartType.columnClustered:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ColumnClustered"' + - name: columnStacked + uid: excel!Excel.ChartType.columnStacked:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ColumnStacked"' + - name: columnStacked100 + uid: excel!Excel.ChartType.columnStacked100:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ColumnStacked100"' + - name: coneBarClustered + uid: excel!Excel.ChartType.coneBarClustered:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ConeBarClustered"' + - name: coneBarStacked + uid: excel!Excel.ChartType.coneBarStacked:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ConeBarStacked"' + - name: coneBarStacked100 + uid: excel!Excel.ChartType.coneBarStacked100:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ConeBarStacked100"' + - name: coneCol + uid: excel!Excel.ChartType.coneCol:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ConeCol"' + - name: coneColClustered + uid: excel!Excel.ChartType.coneColClustered:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ConeColClustered"' + - name: coneColStacked + uid: excel!Excel.ChartType.coneColStacked:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ConeColStacked"' + - name: coneColStacked100 + uid: excel!Excel.ChartType.coneColStacked100:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ConeColStacked100"' + - name: cylinderBarClustered + uid: excel!Excel.ChartType.cylinderBarClustered:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"CylinderBarClustered"' + - name: cylinderBarStacked + uid: excel!Excel.ChartType.cylinderBarStacked:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"CylinderBarStacked"' + - name: cylinderBarStacked100 + uid: excel!Excel.ChartType.cylinderBarStacked100:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"CylinderBarStacked100"' + - name: cylinderCol + uid: excel!Excel.ChartType.cylinderCol:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"CylinderCol"' + - name: cylinderColClustered + uid: excel!Excel.ChartType.cylinderColClustered:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"CylinderColClustered"' + - name: cylinderColStacked + uid: excel!Excel.ChartType.cylinderColStacked:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"CylinderColStacked"' + - name: cylinderColStacked100 + uid: excel!Excel.ChartType.cylinderColStacked100:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"CylinderColStacked100"' + - name: doughnut + uid: excel!Excel.ChartType.doughnut:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Doughnut"' + - name: doughnutExploded + uid: excel!Excel.ChartType.doughnutExploded:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"DoughnutExploded"' + - name: funnel + uid: excel!Excel.ChartType.funnel:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Funnel"' + - name: histogram + uid: excel!Excel.ChartType.histogram:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Histogram"' + - name: invalid + uid: excel!Excel.ChartType.invalid:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Invalid"' + - name: line + uid: excel!Excel.ChartType.line:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Line"' + - name: lineMarkers + uid: excel!Excel.ChartType.lineMarkers:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LineMarkers"' + - name: lineMarkersStacked + uid: excel!Excel.ChartType.lineMarkersStacked:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LineMarkersStacked"' + - name: lineMarkersStacked100 + uid: excel!Excel.ChartType.lineMarkersStacked100:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LineMarkersStacked100"' + - name: lineStacked + uid: excel!Excel.ChartType.lineStacked:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LineStacked"' + - name: lineStacked100 + uid: excel!Excel.ChartType.lineStacked100:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LineStacked100"' + - name: pareto + uid: excel!Excel.ChartType.pareto:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Pareto"' + - name: pie + uid: excel!Excel.ChartType.pie:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Pie"' + - name: pieExploded + uid: excel!Excel.ChartType.pieExploded:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"PieExploded"' + - name: pieOfPie + uid: excel!Excel.ChartType.pieOfPie:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"PieOfPie"' + - name: pyramidBarClustered + uid: excel!Excel.ChartType.pyramidBarClustered:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"PyramidBarClustered"' + - name: pyramidBarStacked + uid: excel!Excel.ChartType.pyramidBarStacked:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"PyramidBarStacked"' + - name: pyramidBarStacked100 + uid: excel!Excel.ChartType.pyramidBarStacked100:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"PyramidBarStacked100"' + - name: pyramidCol + uid: excel!Excel.ChartType.pyramidCol:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"PyramidCol"' + - name: pyramidColClustered + uid: excel!Excel.ChartType.pyramidColClustered:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"PyramidColClustered"' + - name: pyramidColStacked + uid: excel!Excel.ChartType.pyramidColStacked:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"PyramidColStacked"' + - name: pyramidColStacked100 + uid: excel!Excel.ChartType.pyramidColStacked100:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"PyramidColStacked100"' + - name: radar + uid: excel!Excel.ChartType.radar:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Radar"' + - name: radarFilled + uid: excel!Excel.ChartType.radarFilled:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"RadarFilled"' + - name: radarMarkers + uid: excel!Excel.ChartType.radarMarkers:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"RadarMarkers"' + - name: regionMap + uid: excel!Excel.ChartType.regionMap:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"RegionMap"' + - name: stockHLC + uid: excel!Excel.ChartType.stockHLC:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"StockHLC"' + - name: stockOHLC + uid: excel!Excel.ChartType.stockOHLC:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"StockOHLC"' + - name: stockVHLC + uid: excel!Excel.ChartType.stockVHLC:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"StockVHLC"' + - name: stockVOHLC + uid: excel!Excel.ChartType.stockVOHLC:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"StockVOHLC"' + - name: sunburst + uid: excel!Excel.ChartType.sunburst:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Sunburst"' + - name: surface + uid: excel!Excel.ChartType.surface:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Surface"' + - name: surfaceTopView + uid: excel!Excel.ChartType.surfaceTopView:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"SurfaceTopView"' + - name: surfaceTopViewWireframe + uid: excel!Excel.ChartType.surfaceTopViewWireframe:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"SurfaceTopViewWireframe"' + - name: surfaceWireframe + uid: excel!Excel.ChartType.surfaceWireframe:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"SurfaceWireframe"' + - name: treemap + uid: excel!Excel.ChartType.treemap:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Treemap"' + - name: waterfall + uid: excel!Excel.ChartType.waterfall:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Waterfall"' + - name: xyscatter + uid: excel!Excel.ChartType.xyscatter:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"XYScatter"' + - name: xyscatterLines + uid: excel!Excel.ChartType.xyscatterLines:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"XYScatterLines"' + - name: xyscatterLinesNoMarkers + uid: excel!Excel.ChartType.xyscatterLinesNoMarkers:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"XYScatterLinesNoMarkers"' + - name: xyscatterSmooth + uid: excel!Excel.ChartType.xyscatterSmooth:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"XYScatterSmooth"' + - name: xyscatterSmoothNoMarkers + uid: excel!Excel.ChartType.xyscatterSmoothNoMarkers:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"XYScatterSmoothNoMarkers"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.chartunderlinestyle.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartunderlinestyle.yml new file mode 100644 index 0000000000..fce7833653 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.chartunderlinestyle.yml @@ -0,0 +1,27 @@ +### YamlMime:TSEnum +name: Excel.ChartUnderlineStyle +uid: excel!Excel.ChartUnderlineStyle:enum +package: excel! +fullName: Excel.ChartUnderlineStyle +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: none + uid: excel!Excel.ChartUnderlineStyle.none:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"None"' + - name: single + uid: excel!Excel.ChartUnderlineStyle.single:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Single"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.checkboxcellcontrol.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.checkboxcellcontrol.yml new file mode 100644 index 0000000000..d4cf430b0b --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.checkboxcellcontrol.yml @@ -0,0 +1,56 @@ +### YamlMime:TSType +name: Excel.CheckboxCellControl +uid: excel!Excel.CheckboxCellControl:interface +package: excel! +fullName: Excel.CheckboxCellControl +summary: >- + Represents a checkbox. This is a cell control that allows a user to toggle the + boolean value in a cell. +remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml + + + // Add checkboxes to the table. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Get the second column in the table, without the header. + const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange(); + + // Change the boolean values to checkboxes. + range.control = { + type: Excel.CellControlType.checkbox + }; + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: type + uid: excel!Excel.CheckboxCellControl#type:member + package: excel! + fullName: type + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'type: CellControlType.checkbox;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.clearapplyto.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.clearapplyto.yml new file mode 100644 index 0000000000..0de275dab9 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.clearapplyto.yml @@ -0,0 +1,113 @@ +### YamlMime:TSEnum +name: Excel.ClearApplyTo +uid: excel!Excel.ClearApplyTo:enum +package: excel! +fullName: Excel.ClearApplyTo +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-hyperlink.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Orders"); + + const productsRange = sheet.getRange("A3:A11"); + productsRange.load("values"); + + await context.sync(); + + // Clear all hyperlinks. + for (let i = 0; i < productsRange.values.length; i++) { + let cellRange = productsRange.getCell(i, 0); + + // Clear the hyperlink. + // This removes the hyperlink but does not update text format. + cellRange.clear(Excel.ClearApplyTo.hyperlinks); + + // Update text format. + cellRange.format.font.underline = Excel.RangeUnderlineStyle.none; + cellRange.format.font.color = "#000000"; + } + + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: all + uid: excel!Excel.ClearApplyTo.all:member + package: excel! + summary: >- + Clears everything in the range. + + + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"All"' + - name: contents + uid: excel!Excel.ClearApplyTo.contents:member + package: excel! + summary: >- + Clears the contents of the range, leaving formatting intact. + + + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Contents"' + - name: formats + uid: excel!Excel.ClearApplyTo.formats:member + package: excel! + summary: >- + Clears all formatting for the range, leaving values intact. + + + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Formats"' + - name: hyperlinks + uid: excel!Excel.ClearApplyTo.hyperlinks:member + package: excel! + summary: >- + Clears all hyperlinks, but leaves all content and formatting intact. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Hyperlinks"' + - name: removeHyperlinks + uid: excel!Excel.ClearApplyTo.removeHyperlinks:member + package: excel! + summary: >- + Removes hyperlinks and formatting for the cell but leaves content, + conditional formats, and data validation intact. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"RemoveHyperlinks"' + - name: resetContents + uid: excel!Excel.ClearApplyTo.resetContents:member + package: excel! + summary: >- + Sets all cells in the range to their default state. Cells with cell + controls are set to the default value defined by each control. Cells + without cell controls are set to blank. + + + * \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ResetContents"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.closebehavior.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.closebehavior.yml new file mode 100644 index 0000000000..8b92dc6313 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.closebehavior.yml @@ -0,0 +1,49 @@ +### YamlMime:TSEnum +name: Excel.CloseBehavior +uid: excel!Excel.CloseBehavior:enum +package: excel! +fullName: Excel.CloseBehavior +summary: Specifies the close behavior for `Workbook.close`. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-save-and-close.yaml + + + await Excel.run(async (context) => { + context.workbook.close(Excel.CloseBehavior.skipSave); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: save + uid: excel!Excel.CloseBehavior.save:member + package: excel! + summary: >- + Save the possible changes before closing the workbook. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Save"' + - name: skipSave + uid: excel!Excel.CloseBehavior.skipSave:member + package: excel! + summary: >- + Discard the possible changes when closing the workbook. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"SkipSave"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.colorscaleconditionalformat.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.colorscaleconditionalformat.yml new file mode 100644 index 0000000000..37de2c9ccb --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.colorscaleconditionalformat.yml @@ -0,0 +1,252 @@ +### YamlMime:TSType +name: Excel.ColorScaleConditionalFormat +uid: excel!Excel.ColorScaleConditionalFormat:class +package: excel! +fullName: Excel.ColorScaleConditionalFormat +summary: Represents the color scale criteria for conditional formatting. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.ColorScaleConditionalFormat#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: criteria + uid: excel!Excel.ColorScaleConditionalFormat#criteria:member + package: excel! + fullName: criteria + summary: >- + The criteria of the color scale. Midpoint is optional when using a two + point color scale. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const range = sheet.getRange("B2:M5"); + const conditionalFormat = range.conditionalFormats + .add(Excel.ConditionalFormatType.colorScale); + const criteria = { + minimum: { formula: null, type: Excel.ConditionalFormatColorCriterionType.lowestValue, color: "blue" }, + midpoint: { formula: "50", type: Excel.ConditionalFormatColorCriterionType.percent, color: "yellow" }, + maximum: { formula: null, type: Excel.ConditionalFormatColorCriterionType.highestValue, color: "red" } + }; + conditionalFormat.colorScale.criteria = criteria; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'criteria: Excel.ConditionalColorScaleCriteria;' + return: + type: + - name: threeColorScale + uid: excel!Excel.ColorScaleConditionalFormat#threeColorScale:member + package: excel! + fullName: threeColorScale + summary: >- + If `true`, the color scale will have three points (minimum, + midpoint, maximum), otherwise it will have two (minimum, maximum). + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly threeColorScale: boolean;' + return: + type: boolean +methods: + - name: load(options) + uid: excel!Excel.ColorScaleConditionalFormat#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ColorScaleConditionalFormatLoadOptions): + Excel.ColorScaleConditionalFormat; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ColorScaleConditionalFormat#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNames?: string | string[]): + Excel.ColorScaleConditionalFormat; + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ColorScaleConditionalFormat#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ColorScaleConditionalFormat; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ColorScaleConditionalFormat#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ColorScaleConditionalFormatUpdateData, + options?: OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ColorScaleConditionalFormat#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ColorScaleConditionalFormat): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ColorScaleConditionalFormat#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.ColorScaleConditionalFormat` object is an API object, the `toJSON` + method returns a plain JavaScript object (typed as + `Excel.Interfaces.ColorScaleConditionalFormatData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ColorScaleConditionalFormatData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.columnproperties.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.columnproperties.yml new file mode 100644 index 0000000000..62fff4916a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.columnproperties.yml @@ -0,0 +1,72 @@ +### YamlMime:TSType +name: Excel.ColumnProperties +uid: excel!Excel.ColumnProperties:interface +package: excel! +fullName: Excel.ColumnProperties +summary: >- + Represents the returned properties of getColumnProperties. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: address + uid: excel!Excel.ColumnProperties#address:member + package: excel! + fullName: address + summary: >- + Represents the `address` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'address?: string;' + return: + type: string + - name: addressLocal + uid: excel!Excel.ColumnProperties#addressLocal:member + package: excel! + fullName: addressLocal + summary: >- + Represents the `addressLocal` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'addressLocal?: string;' + return: + type: string + - name: columnIndex + uid: excel!Excel.ColumnProperties#columnIndex:member + package: excel! + fullName: columnIndex + summary: >- + Represents the `columnIndex` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'columnIndex?: number;' + return: + type: number +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.columnpropertiesloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.columnpropertiesloadoptions.yml new file mode 100644 index 0000000000..b9ca07e7a5 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.columnpropertiesloadoptions.yml @@ -0,0 +1,80 @@ +### YamlMime:TSType +name: Excel.ColumnPropertiesLoadOptions +uid: excel!Excel.ColumnPropertiesLoadOptions:interface +package: excel! +fullName: Excel.ColumnPropertiesLoadOptions +summary: >- + Represents which column properties to load, when used as part of a + "range.getColumnProperties" method. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: columnHidden + uid: excel!Excel.ColumnPropertiesLoadOptions#columnHidden:member + package: excel! + fullName: columnHidden + summary: >- + Specifies whether to load on the `columnHidden` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'columnHidden?: boolean;' + return: + type: boolean + - name: columnIndex + uid: excel!Excel.ColumnPropertiesLoadOptions#columnIndex:member + package: excel! + fullName: columnIndex + summary: >- + Specifies whether to load on the `columnIndex` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'columnIndex?: boolean;' + return: + type: boolean + - name: format + uid: excel!Excel.ColumnPropertiesLoadOptions#format:member + package: excel! + fullName: format + summary: >- + Specifies whether to load on the `format` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + format?: Excel.CellPropertiesFormatLoadOptions & { + columnWidth?: boolean; + }; + return: + type: >- + & + { + columnWidth?: boolean; + } +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.comment.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.comment.yml new file mode 100644 index 0000000000..f014cd834d --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.comment.yml @@ -0,0 +1,479 @@ +### YamlMime:TSType +name: Excel.Comment +uid: excel!Excel.Comment:class +package: excel! +fullName: Excel.Comment +summary: Represents a comment in the workbook. +remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: authorEmail + uid: excel!Excel.Comment#authorEmail:member + package: excel! + fullName: authorEmail + summary: Gets the email of the comment's author. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly authorEmail: string;' + return: + type: string + - name: authorName + uid: excel!Excel.Comment#authorName:member + package: excel! + fullName: authorName + summary: Gets the name of the comment's author. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly authorName: string;' + return: + type: string + - name: content + uid: excel!Excel.Comment#content:member + package: excel! + fullName: content + summary: The comment's content. The string is plain text. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/comment-basics.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Comments"); + const comment = sheet.comments.getItemAt(0); + comment.content = "PLEASE add headers here."; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'content: string;' + return: + type: string + - name: contentType + uid: excel!Excel.Comment#contentType:member + package: excel! + fullName: contentType + summary: Gets the content type of the comment. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly contentType: Excel.ContentType | "Plain" | "Mention";' + return: + type: | "Plain" | "Mention" + - name: context + uid: excel!Excel.Comment#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: creationDate + uid: excel!Excel.Comment#creationDate:member + package: excel! + fullName: creationDate + summary: >- + Gets the creation time of the comment. Returns `null` if the comment was + converted from a note, since the comment does not have a creation date. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly creationDate: Date;' + return: + type: Date + - name: id + uid: excel!Excel.Comment#id:member + package: excel! + fullName: id + summary: Specifies the comment identifier. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly id: string;' + return: + type: string + - name: mentions + uid: excel!Excel.Comment#mentions:member + package: excel! + fullName: mentions + summary: Gets the entities (e.g., people) that are mentioned in comments. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly mentions: Excel.CommentMention[];' + return: + type: [] + - name: replies + uid: excel!Excel.Comment#replies:member + package: excel! + fullName: replies + summary: Represents a collection of reply objects associated with the comment. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly replies: Excel.CommentReplyCollection;' + return: + type: + - name: resolved + uid: excel!Excel.Comment#resolved:member + package: excel! + fullName: resolved + summary: >- + The comment thread status. A value of `true` means that the comment thread + is resolved. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/comment-resolution.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Comments"); + sheet.comments.getItemAt(0).resolved = true; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'resolved: boolean;' + return: + type: boolean + - name: richContent + uid: excel!Excel.Comment#richContent:member + package: excel! + fullName: richContent + summary: >- + Gets the rich comment content (e.g., mentions in comments). This string is + not meant to be displayed to end-users. Your add-in should only use this + to parse rich comment content. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly richContent: string;' + return: + type: string +methods: + - name: delete() + uid: excel!Excel.Comment#delete:member(1) + package: excel! + fullName: delete() + summary: Deletes the comment and all the connected replies. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/comment-basics.yaml + + + await Excel.run(async (context) => { + context.workbook.comments.getItemByCell("Comments!A2").delete(); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'delete(): void;' + return: + type: void + description: '' + - name: getLocation() + uid: excel!Excel.Comment#getLocation:member(1) + package: excel! + fullName: getLocation() + summary: Gets the cell where this comment is located. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getLocation(): Excel.Range;' + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.Comment#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(options?: Excel.Interfaces.CommentLoadOptions): Excel.Comment;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.Comment#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.Comment;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: >- + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/comment-basics.yaml + + + await Excel.run(async (context) => { + const comment = context.workbook.comments.getItemByCell("Comments!A2"); + comment.load(["authorEmail", "authorName", "creationDate"]); + await context.sync(); + + console.log(`${comment.creationDate.toDateString()}: ${comment.authorName} (${comment.authorEmail})`); + await context.sync(); + }); + + ``` + - name: load(propertyNamesAndPaths) + uid: excel!Excel.Comment#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.Comment; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.Comment#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.CommentUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.Comment#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.Comment): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.Comment#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.Comment` object + is an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Excel.Interfaces.CommentData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.CommentData;' + return: + type: + description: '' + - name: updateMentions(contentWithMentions) + uid: excel!Excel.Comment#updateMentions:member(1) + package: excel! + fullName: updateMentions(contentWithMentions) + summary: >- + Updates the comment content with a specially formatted string and a list + of mentions. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'updateMentions(contentWithMentions: Excel.CommentRichContent): void;' + parameters: + - id: contentWithMentions + description: >- + The content for the comment. This contains a specially formatted + string and a list of mentions that will be parsed into the string + when displayed by Excel. + type: + return: + type: void + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.commentaddedeventargs.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.commentaddedeventargs.yml new file mode 100644 index 0000000000..bfadf2e87e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.commentaddedeventargs.yml @@ -0,0 +1,80 @@ +### YamlMime:TSType +name: Excel.CommentAddedEventArgs +uid: excel!Excel.CommentAddedEventArgs:interface +package: excel! +fullName: Excel.CommentAddedEventArgs +summary: Provides information about the comments that raised the comment added event. +remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: commentDetails + uid: excel!Excel.CommentAddedEventArgs#commentDetails:member + package: excel! + fullName: commentDetails + summary: >- + Gets the `CommentDetail` array that contains the comment ID and IDs of its + related replies. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'commentDetails: Excel.CommentDetail[];' + return: + type: [] + - name: source + uid: excel!Excel.CommentAddedEventArgs#source:member + package: excel! + fullName: source + summary: Specifies the source of the event. See `Excel.EventSource` for details. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'source: Excel.EventSource | "Local" | "Remote";' + return: + type: | "Local" | "Remote" + - name: type + uid: excel!Excel.CommentAddedEventArgs#type:member + package: excel! + fullName: type + summary: Gets the type of the event. See `Excel.EventType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: "CommentAdded";' + return: + type: '"CommentAdded"' + - name: worksheetId + uid: excel!Excel.CommentAddedEventArgs#worksheetId:member + package: excel! + fullName: worksheetId + summary: Gets the ID of the worksheet in which the event happened. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheetId: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.commentchangedeventargs.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.commentchangedeventargs.yml new file mode 100644 index 0000000000..43613c75d0 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.commentchangedeventargs.yml @@ -0,0 +1,102 @@ +### YamlMime:TSType +name: Excel.CommentChangedEventArgs +uid: excel!Excel.CommentChangedEventArgs:interface +package: excel! +fullName: Excel.CommentChangedEventArgs +summary: Occurs when existing comments are changed. +remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: changeType + uid: excel!Excel.CommentChangedEventArgs#changeType:member + package: excel! + fullName: changeType + summary: Gets the change type that represents how the changed event is triggered. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + changeType: Excel.CommentChangeType | "CommentEdited" | + "CommentResolved" | "CommentReopened" | "ReplyAdded" | "ReplyDeleted" | + "ReplyEdited"; + return: + type: >- + | "CommentEdited" | + "CommentResolved" | "CommentReopened" | "ReplyAdded" | "ReplyDeleted" + | "ReplyEdited" + - name: commentDetails + uid: excel!Excel.CommentChangedEventArgs#commentDetails:member + package: excel! + fullName: commentDetails + summary: >- + Get the `CommentDetail` array which contains the comment ID and IDs of its + related replies. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'commentDetails: Excel.CommentDetail[];' + return: + type: [] + - name: source + uid: excel!Excel.CommentChangedEventArgs#source:member + package: excel! + fullName: source + summary: Specifies the source of the event. See `Excel.EventSource` for details. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'source: Excel.EventSource | "Local" | "Remote";' + return: + type: | "Local" | "Remote" + - name: type + uid: excel!Excel.CommentChangedEventArgs#type:member + package: excel! + fullName: type + summary: Gets the type of the event. See `Excel.EventType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: "CommentChanged";' + return: + type: '"CommentChanged"' + - name: worksheetId + uid: excel!Excel.CommentChangedEventArgs#worksheetId:member + package: excel! + fullName: worksheetId + summary: Gets the ID of the worksheet in which the event happened. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheetId: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.commentchangetype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.commentchangetype.yml new file mode 100644 index 0000000000..bd57b6ab41 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.commentchangetype.yml @@ -0,0 +1,79 @@ +### YamlMime:TSEnum +name: Excel.CommentChangeType +uid: excel!Excel.CommentChangeType:enum +package: excel! +fullName: Excel.CommentChangeType +summary: Represents how the comments in the event were changed. +remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: commentEdited + uid: excel!Excel.CommentChangeType.commentEdited:member + package: excel! + summary: >- + Comments were edited. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CommentEdited"' + - name: commentReopened + uid: excel!Excel.CommentChangeType.commentReopened:member + package: excel! + summary: >- + Comments were reopened. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CommentReopened"' + - name: commentResolved + uid: excel!Excel.CommentChangeType.commentResolved:member + package: excel! + summary: >- + Comments were resolved. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CommentResolved"' + - name: replyAdded + uid: excel!Excel.CommentChangeType.replyAdded:member + package: excel! + summary: >- + Replies were added. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ReplyAdded"' + - name: replyDeleted + uid: excel!Excel.CommentChangeType.replyDeleted:member + package: excel! + summary: >- + Replies were deleted. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ReplyDeleted"' + - name: replyEdited + uid: excel!Excel.CommentChangeType.replyEdited:member + package: excel! + summary: >- + Replies were edited. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ReplyEdited"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.commentcollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.commentcollection.yml new file mode 100644 index 0000000000..a31ebebaaa --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.commentcollection.yml @@ -0,0 +1,584 @@ +### YamlMime:TSType +name: Excel.CommentCollection +uid: excel!Excel.CommentCollection:class +package: excel! +fullName: Excel.CommentCollection +summary: Represents a collection of comment objects that are part of the workbook. +remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.CommentCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: excel!Excel.CommentCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.Comment[];' + return: + type: [] +methods: + - name: add(cellAddress, content, contentType) + uid: excel!Excel.CommentCollection#add:member(1) + package: excel! + fullName: add(cellAddress, content, contentType) + summary: >- + Creates a new comment with the given content on the given cell. An + `InvalidArgument` error is thrown if the provided range is larger than one + cell. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/comment-basics.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Comments"); + + // Note that an InvalidArgument error will be thrown if multiple cells passed to `comment.add`. + sheet.comments.add("A2", "TODO: add data."); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + add(cellAddress: Range | string, content: CommentRichContent | string, + contentType?: Excel.ContentType): Excel.Comment; + parameters: + - id: cellAddress + description: >- + The cell to which the comment is added. This can be a `Range` object + or a string. If it's a string, it must contain the full address, + including the sheet name. An `InvalidArgument` error is thrown if + the provided range is larger than one cell. + type: | string + - id: content + description: >- + The comment's content. This can be either a string or + `CommentRichContent` object. Strings are used for plain text. + `CommentRichContent` objects allow for other comment features, such + as mentions. \[Api set: ExcelApi 1.10 for string, 1.11 for + CommentRichContent object\] + type: | string + - id: contentType + description: >- + Optional. The type of content contained within the comment. The + default value is enum `ContentType.Plain`. \[Api set: + ExcelApi 1.10 for Enum ContentType.Plain, 1.11 for Enum + ContentType.Mention\] + type: + return: + type: + description: '' + - name: add(cellAddress, content, contentType) + uid: excel!Excel.CommentCollection#add:member(2) + package: excel! + fullName: add(cellAddress, content, contentType) + summary: >- + Creates a new comment with the given content on the given cell. An + `InvalidArgument` error is thrown if the provided range is larger than one + cell. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + add(cellAddress: Range | string, content: CommentRichContent | string, + contentType?: "Plain" | "Mention"): Excel.Comment; + parameters: + - id: cellAddress + description: >- + The cell to which the comment is added. This can be a `Range` object + or a string. If it's a string, it must contain the full address, + including the sheet name. An `InvalidArgument` error is thrown if + the provided range is larger than one cell. + type: | string + - id: content + description: >- + The comment's content. This can be either a string or + `CommentRichContent` object. Strings are used for plain text. + `CommentRichContent` objects allow for other comment features, such + as mentions. \[Api set: ExcelApi 1.10 for string, 1.11 for + CommentRichContent object\] + type: | string + - id: contentType + description: >- + Optional. The type of content contained within the comment. The + default value is enum `ContentType.Plain`. \[Api set: + ExcelApi 1.10 for Enum ContentType.Plain, 1.11 for Enum + ContentType.Mention\] + type: '"Plain" | "Mention"' + return: + type: + description: '' + - name: getCount() + uid: excel!Excel.CommentCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Gets the number of comments in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getItem(commentId) + uid: excel!Excel.CommentCollection#getItem:member(1) + package: excel! + fullName: getItem(commentId) + summary: Gets a comment from the collection based on its ID. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItem(commentId: string): Excel.Comment;' + parameters: + - id: commentId + description: The identifier for the comment. + type: string + return: + type: + description: '' + - name: getItemAt(index) + uid: excel!Excel.CommentCollection#getItemAt:member(1) + package: excel! + fullName: getItemAt(index) + summary: Gets a comment from the collection based on its position. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemAt(index: number): Excel.Comment;' + parameters: + - id: index + description: Index value of the object to be retrieved. Zero-indexed. + type: number + return: + type: + description: '' + - name: getItemByCell(cellAddress) + uid: excel!Excel.CommentCollection#getItemByCell:member(1) + package: excel! + fullName: getItemByCell(cellAddress) + summary: >- + Gets the comment from the specified cell. If there is no comment in the + cell, an error is thrown. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemByCell(cellAddress: Range | string): Excel.Comment;' + parameters: + - id: cellAddress + description: >- + The cell which the comment is on. This can be a `Range` object or a + string. If it's a string, it must contain the full address, + including the sheet name. An `InvalidArgument` error is thrown if + the provided range is larger than one cell. + type: | string + return: + type: + description: '' + - name: getItemByReplyId(replyId) + uid: excel!Excel.CommentCollection#getItemByReplyId:member(1) + package: excel! + fullName: getItemByReplyId(replyId) + summary: Gets the comment to which the given reply is connected. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemByReplyId(replyId: string): Excel.Comment;' + parameters: + - id: replyId + description: The identifier of comment reply. + type: string + return: + type: + description: '' + - name: getItemOrNullObject(commentId) + uid: excel!Excel.CommentCollection#getItemOrNullObject:member(1) + package: excel! + fullName: getItemOrNullObject(commentId) + summary: >- + Gets a comment from the collection based on its ID. If the comment object + does not exist, then this method returns an object with its `isNullObject` + property set to `true`. For further information, see + [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemOrNullObject(commentId: string): Excel.Comment;' + parameters: + - id: commentId + description: The identifier for the comment. + type: string + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.CommentCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.CommentCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): Excel.CommentCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.CommentCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.CommentCollection;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.CommentCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.CommentCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.CommentCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.CommentCollection` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.CommentCollectionData`) that contains an "items" + array with shallow copies of any loaded properties from the collection's + items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.CommentCollectionData;' + return: + type: + description: '' +events: + - name: onAdded + uid: excel!Excel.CommentCollection#onAdded:member + package: excel! + fullName: onAdded + summary: Occurs when the comments are added. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-comment-event-handler.yaml + + + await Excel.run(async (context) => { + const comments = context.workbook.worksheets.getActiveWorksheet().comments; + + // Register the onAdded, onChanged, and onDeleted comment event handlers. + comments.onAdded.add(commentAdded); + comments.onChanged.add(commentChanged); + comments.onDeleted.add(commentDeleted); + + await context.sync(); + + console.log("Added event handlers for when comments are added, changed, or deleted."); + }); + + + ... + + + async function commentAdded(event: Excel.CommentAddedEventArgs) { + // Retrieve the added comment using the comment ID. + // Note: This function assumes only a single comment is added at a time. + await Excel.run(async (context) => { + const addedComment = context.workbook.comments.getItem(event.commentDetails[0].commentId); + + // Load the added comment's data. + addedComment.load(["content", "authorName", "creationDate"]); + + await context.sync(); + + // Print out the added comment's data. + console.log(`A comment was added:`); + console.log(` ID: ${event.commentDetails[0].commentId}`); + console.log(` Comment content:${addedComment.content}`); + console.log(` Comment author:${addedComment.authorName}`); + console.log(` Creation date:${addedComment.creationDate}`); + }); + } + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onAdded: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onChanged + uid: excel!Excel.CommentCollection#onChanged:member + package: excel! + fullName: onChanged + summary: >- + Occurs when comments or replies in a comment collection are changed, + including when replies are deleted. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-comment-event-handler.yaml + + + await Excel.run(async (context) => { + const comments = context.workbook.worksheets.getActiveWorksheet().comments; + + // Register the onAdded, onChanged, and onDeleted comment event handlers. + comments.onAdded.add(commentAdded); + comments.onChanged.add(commentChanged); + comments.onDeleted.add(commentDeleted); + + await context.sync(); + + console.log("Added event handlers for when comments are added, changed, or deleted."); + }); + + + ... + + + async function commentChanged(event: Excel.CommentChangedEventArgs) { + // Retrieve the changed comment using the comment ID. + // Note: This function assumes only a single comment is changed at a time. + await Excel.run(async (context) => { + const changedComment = context.workbook.comments.getItem(event.commentDetails[0].commentId); + + // Load the changed comment's data. + changedComment.load(["content", "authorName", "creationDate"]); + + await context.sync(); + + // Print out the changed comment's data. + console.log(`A comment was changed:`); + console.log(` ID: ${event.commentDetails[0].commentId}`); + console.log(` Updated comment content: ${changedComment.content}`); + console.log(` Comment author: ${changedComment.authorName}`); + console.log(` Creation date: ${changedComment.creationDate}`); + }); + } + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onChanged: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onDeleted + uid: excel!Excel.CommentCollection#onDeleted:member + package: excel! + fullName: onDeleted + summary: Occurs when comments are deleted in the comment collection. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-comment-event-handler.yaml + + + await Excel.run(async (context) => { + const comments = context.workbook.worksheets.getActiveWorksheet().comments; + + // Register the onAdded, onChanged, and onDeleted comment event handlers. + comments.onAdded.add(commentAdded); + comments.onChanged.add(commentChanged); + comments.onDeleted.add(commentDeleted); + + await context.sync(); + + console.log("Added event handlers for when comments are added, changed, or deleted."); + }); + + + ... + + + async function commentDeleted(event: Excel.CommentDeletedEventArgs) { + // Print out the deleted comment's ID. + // Note: This function assumes only a single comment is deleted at a time. + await Excel.run(async (context) => { + console.log(`A comment was deleted:`); + console.log(` ID: ${event.commentDetails[0].commentId}`); + }); + } + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onDeleted: + OfficeExtension.EventHandlers; + return: + type: >- + <> +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.commentdeletedeventargs.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.commentdeletedeventargs.yml new file mode 100644 index 0000000000..3593cdd328 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.commentdeletedeventargs.yml @@ -0,0 +1,80 @@ +### YamlMime:TSType +name: Excel.CommentDeletedEventArgs +uid: excel!Excel.CommentDeletedEventArgs:interface +package: excel! +fullName: Excel.CommentDeletedEventArgs +summary: Provides information about the comments that raised the comment deleted event. +remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: commentDetails + uid: excel!Excel.CommentDeletedEventArgs#commentDetails:member + package: excel! + fullName: commentDetails + summary: >- + Gets the `CommentDetail` array that contains the comment ID and IDs of its + related replies. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'commentDetails: Excel.CommentDetail[];' + return: + type: [] + - name: source + uid: excel!Excel.CommentDeletedEventArgs#source:member + package: excel! + fullName: source + summary: Specifies the source of the event. See `Excel.EventSource` for details. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'source: Excel.EventSource | "Local" | "Remote";' + return: + type: | "Local" | "Remote" + - name: type + uid: excel!Excel.CommentDeletedEventArgs#type:member + package: excel! + fullName: type + summary: Gets the type of the event. See `Excel.EventType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: "CommentDeleted";' + return: + type: '"CommentDeleted"' + - name: worksheetId + uid: excel!Excel.CommentDeletedEventArgs#worksheetId:member + package: excel! + fullName: worksheetId + summary: Gets the ID of the worksheet in which the event happened. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheetId: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.commentdetail.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.commentdetail.yml new file mode 100644 index 0000000000..43659fa9b7 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.commentdetail.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: Excel.CommentDetail +uid: excel!Excel.CommentDetail:interface +package: excel! +fullName: Excel.CommentDetail +summary: A structure for the comment ID and IDs of its related replies. +remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: commentId + uid: excel!Excel.CommentDetail#commentId:member + package: excel! + fullName: commentId + summary: Represents the ID of the comment. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'commentId: string;' + return: + type: string + - name: replyIds + uid: excel!Excel.CommentDetail#replyIds:member + package: excel! + fullName: replyIds + summary: Represents the IDs of the related replies that belong to the comment. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'replyIds: string[];' + return: + type: string[] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.commentmention.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.commentmention.yml new file mode 100644 index 0000000000..ce48154011 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.commentmention.yml @@ -0,0 +1,64 @@ +### YamlMime:TSType +name: Excel.CommentMention +uid: excel!Excel.CommentMention:interface +package: excel! +fullName: Excel.CommentMention +summary: Represents the entity that is mentioned in comments. +remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: email + uid: excel!Excel.CommentMention#email:member + package: excel! + fullName: email + summary: The email address of the entity that is mentioned in a comment. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'email: string;' + return: + type: string + - name: id + uid: excel!Excel.CommentMention#id:member + package: excel! + fullName: id + summary: >- + The ID of the entity. The ID matches one of the IDs in + `CommentRichContent.richContent`. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id: number;' + return: + type: number + - name: name + uid: excel!Excel.CommentMention#name:member + package: excel! + fullName: name + summary: The name of the entity that is mentioned in a comment. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.commentreply.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.commentreply.yml new file mode 100644 index 0000000000..a92a3b82b3 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.commentreply.yml @@ -0,0 +1,455 @@ +### YamlMime:TSType +name: Excel.CommentReply +uid: excel!Excel.CommentReply:class +package: excel! +fullName: Excel.CommentReply +summary: Represents a comment reply in the workbook. +remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: authorEmail + uid: excel!Excel.CommentReply#authorEmail:member + package: excel! + fullName: authorEmail + summary: Gets the email of the comment reply's author. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly authorEmail: string;' + return: + type: string + - name: authorName + uid: excel!Excel.CommentReply#authorName:member + package: excel! + fullName: authorName + summary: Gets the name of the comment reply's author. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly authorName: string;' + return: + type: string + - name: content + uid: excel!Excel.CommentReply#content:member + package: excel! + fullName: content + summary: The comment reply's content. The string is plain text. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/comment-replies.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Comments"); + const comment = sheet.comments.getItemAt(0); + const reply = comment.replies.getItemAt(0); + reply.load("content"); + // Sync to load the content of the comment reply. + await context.sync(); + + // Append "Please!" to the end of the comment reply. + reply.content += " Please!"; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'content: string;' + return: + type: string + - name: contentType + uid: excel!Excel.CommentReply#contentType:member + package: excel! + fullName: contentType + summary: The content type of the reply. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly contentType: Excel.ContentType | "Plain" | "Mention";' + return: + type: | "Plain" | "Mention" + - name: context + uid: excel!Excel.CommentReply#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: creationDate + uid: excel!Excel.CommentReply#creationDate:member + package: excel! + fullName: creationDate + summary: Gets the creation time of the comment reply. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly creationDate: Date;' + return: + type: Date + - name: id + uid: excel!Excel.CommentReply#id:member + package: excel! + fullName: id + summary: Specifies the comment reply identifier. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly id: string;' + return: + type: string + - name: mentions + uid: excel!Excel.CommentReply#mentions:member + package: excel! + fullName: mentions + summary: The entities (e.g., people) that are mentioned in comments. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly mentions: Excel.CommentMention[];' + return: + type: [] + - name: resolved + uid: excel!Excel.CommentReply#resolved:member + package: excel! + fullName: resolved + summary: >- + The comment reply status. A value of `true` means the reply is in the + resolved state. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly resolved: boolean;' + return: + type: boolean + - name: richContent + uid: excel!Excel.CommentReply#richContent:member + package: excel! + fullName: richContent + summary: >- + The rich comment content (e.g., mentions in comments). This string is not + meant to be displayed to end-users. Your add-in should only use this to + parse rich comment content. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly richContent: string;' + return: + type: string +methods: + - name: delete() + uid: excel!Excel.CommentReply#delete:member(1) + package: excel! + fullName: delete() + summary: Deletes the comment reply. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/comment-replies.yaml + + + await Excel.run(async (context) => { + // Remove the first comment reply from this worksheet's first comment. + const sheet = context.workbook.worksheets.getItem("Comments"); + const comment = sheet.comments.getItemAt(0); + comment.replies.getItemAt(0).delete(); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'delete(): void;' + return: + type: void + description: '' + - name: getLocation() + uid: excel!Excel.CommentReply#getLocation:member(1) + package: excel! + fullName: getLocation() + summary: Gets the cell where this comment reply is located. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getLocation(): Excel.Range;' + return: + type: + description: '' + - name: getParentComment() + uid: excel!Excel.CommentReply#getParentComment:member(1) + package: excel! + fullName: getParentComment() + summary: Gets the parent comment of this reply. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getParentComment(): Excel.Comment;' + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.CommentReply#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.CommentReplyLoadOptions): + Excel.CommentReply; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.CommentReply#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.CommentReply;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.CommentReply#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.CommentReply; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.CommentReply#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.CommentReplyUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.CommentReply#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.CommentReply): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.CommentReply#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.CommentReply` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.CommentReplyData`) that + contains shallow copies of any loaded child properties from the original + object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.CommentReplyData;' + return: + type: + description: '' + - name: updateMentions(contentWithMentions) + uid: excel!Excel.CommentReply#updateMentions:member(1) + package: excel! + fullName: updateMentions(contentWithMentions) + summary: >- + Updates the comment content with a specially formatted string and a list + of mentions. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'updateMentions(contentWithMentions: Excel.CommentRichContent): void;' + parameters: + - id: contentWithMentions + description: >- + The content for the comment. This contains a specially formatted + string and a list of mentions that will be parsed into the string + when displayed by Excel. + type: + return: + type: void + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.commentreplycollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.commentreplycollection.yml new file mode 100644 index 0000000000..6362b4b694 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.commentreplycollection.yml @@ -0,0 +1,319 @@ +### YamlMime:TSType +name: Excel.CommentReplyCollection +uid: excel!Excel.CommentReplyCollection:class +package: excel! +fullName: Excel.CommentReplyCollection +summary: Represents a collection of comment reply objects that are part of the comment. +remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.CommentReplyCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: excel!Excel.CommentReplyCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.CommentReply[];' + return: + type: [] +methods: + - name: add(content, contentType) + uid: excel!Excel.CommentReplyCollection#add:member(1) + package: excel! + fullName: add(content, contentType) + summary: Creates a comment reply for a comment. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/comment-replies.yaml + + + await Excel.run(async (context) => { + // Adds a reply to the first comment in this worksheet. + const sheet = context.workbook.worksheets.getItem("Comments"); + const comment = sheet.comments.getItemAt(0); + comment.replies.add("Add content to this worksheet."); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + add(content: CommentRichContent | string, contentType?: + Excel.ContentType): Excel.CommentReply; + parameters: + - id: content + description: >- + The comment's content. This can be either a string or a + `CommentRichContent` object (e.g., for comments with mentions). + \[Api set: ExcelApi 1.10 for string, 1.11 for CommentRichContent + object\] + type: | string + - id: contentType + description: >- + Optional. The type of content contained within the comment. The + default value is enum `ContentType.Plain`. \[Api set: + ExcelApi 1.10 for Enum ContentType.Plain, 1.11 for Enum + ContentType.Mention\] + type: + return: + type: + description: '' + - name: add(content, contentType) + uid: excel!Excel.CommentReplyCollection#add:member(2) + package: excel! + fullName: add(content, contentType) + summary: Creates a comment reply for a comment. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + add(content: CommentRichContent | string, contentType?: "Plain" | + "Mention"): Excel.CommentReply; + parameters: + - id: content + description: >- + The comment's content. This can be either a string or a + `CommentRichContent` object (e.g., for comments with mentions). + \[Api set: ExcelApi 1.10 for string, 1.11 for CommentRichContent + object\] + type: | string + - id: contentType + description: >- + Optional. The type of content contained within the comment. The + default value is enum `ContentType.Plain`. \[Api set: + ExcelApi 1.10 for Enum ContentType.Plain, 1.11 for Enum + ContentType.Mention\] + type: '"Plain" | "Mention"' + return: + type: + description: '' + - name: getCount() + uid: excel!Excel.CommentReplyCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Gets the number of comment replies in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getItem(commentReplyId) + uid: excel!Excel.CommentReplyCollection#getItem:member(1) + package: excel! + fullName: getItem(commentReplyId) + summary: Returns a comment reply identified by its ID. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItem(commentReplyId: string): Excel.CommentReply;' + parameters: + - id: commentReplyId + description: The identifier for the comment reply. + type: string + return: + type: + description: '' + - name: getItemAt(index) + uid: excel!Excel.CommentReplyCollection#getItemAt:member(1) + package: excel! + fullName: getItemAt(index) + summary: Gets a comment reply based on its position in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemAt(index: number): Excel.CommentReply;' + parameters: + - id: index + description: >- + The index value of the comment reply to be retrieved. The collection + uses zero-based indexing. + type: number + return: + type: + description: '' + - name: getItemOrNullObject(commentReplyId) + uid: excel!Excel.CommentReplyCollection#getItemOrNullObject:member(1) + package: excel! + fullName: getItemOrNullObject(commentReplyId) + summary: >- + Returns a comment reply identified by its ID. If the comment reply object + does not exist, then this method returns an object with its `isNullObject` + property set to `true`. For further information, see + [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemOrNullObject(commentReplyId: string): Excel.CommentReply;' + parameters: + - id: commentReplyId + description: The identifier for the comment reply. + type: string + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.CommentReplyCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.CommentReplyCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): Excel.CommentReplyCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.CommentReplyCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.CommentReplyCollection;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.CommentReplyCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.CommentReplyCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.CommentReplyCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.CommentReplyCollection` object is an API object, the `toJSON` + method returns a plain JavaScript object (typed as + `Excel.Interfaces.CommentReplyCollectionData`) that contains an + "items" array with shallow copies of any loaded properties from the + collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.CommentReplyCollectionData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.commentrichcontent.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.commentrichcontent.yml new file mode 100644 index 0000000000..08d4da814a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.commentrichcontent.yml @@ -0,0 +1,86 @@ +### YamlMime:TSType +name: Excel.CommentRichContent +uid: excel!Excel.CommentRichContent:interface +package: excel! +fullName: Excel.CommentRichContent +summary: >- + Represents the content contained within a comment or comment reply. Rich + content incudes the text string and any other objects contained within the + comment body, such as mentions. +remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: mentions + uid: excel!Excel.CommentRichContent#mentions:member + package: excel! + fullName: mentions + summary: >- + An array containing all the entities (e.g., people) mentioned within the + comment. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/comment-mentions.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Comments"); + const mention = { + email: "kakri@contoso.com", + id: 0, + name: "Kate Kristensen" + }; + + // This will tag the mention's name using the '@' syntax. + // They will be notified via email. + const commentBody = { + mentions: [mention], + richContent: '' + mention.name + " - Can you take a look?" + }; + + // Note that an InvalidArgument error will be thrown if multiple cells passed to `comment.add`. + sheet.comments.add("A1", commentBody, Excel.ContentType.mention); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'mentions?: Excel.CommentMention[];' + return: + type: [] + - name: richContent + uid: excel!Excel.CommentRichContent#richContent:member + package: excel! + fullName: richContent + summary: >- + Specifies the rich content of the comment (e.g., comment content with + mentions, the first mentioned entity has an ID attribute of 0, and the + second mentioned entity has an ID attribute of 1). + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'richContent: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.compactlayout.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.compactlayout.yml new file mode 100644 index 0000000000..5bb689c662 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.compactlayout.yml @@ -0,0 +1,21 @@ +### YamlMime:TSTypeAlias +name: Excel.CompactLayout +uid: excel!Excel.CompactLayout:type +package: excel! +fullName: Excel.CompactLayout +summary: >- + Represents the layout used when there is limited space to represent the + entity. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout) + +isPreview: false +isDeprecated: false +syntax: export type CompactLayout = EntityCompactLayout; diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalcellvalueoperator.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalcellvalueoperator.yml new file mode 100644 index 0000000000..141162bd4f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalcellvalueoperator.yml @@ -0,0 +1,76 @@ +### YamlMime:TSEnum +name: Excel.ConditionalCellValueOperator +uid: excel!Excel.ConditionalCellValueOperator:enum +package: excel! +fullName: Excel.ConditionalCellValueOperator +summary: Represents the operator of the text conditional format type. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: between + uid: excel!Excel.ConditionalCellValueOperator.between:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Between"' + - name: equalTo + uid: excel!Excel.ConditionalCellValueOperator.equalTo:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"EqualTo"' + - name: greaterThan + uid: excel!Excel.ConditionalCellValueOperator.greaterThan:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"GreaterThan"' + - name: greaterThanOrEqual + uid: excel!Excel.ConditionalCellValueOperator.greaterThanOrEqual:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"GreaterThanOrEqual"' + - name: invalid + uid: excel!Excel.ConditionalCellValueOperator.invalid:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Invalid"' + - name: lessThan + uid: excel!Excel.ConditionalCellValueOperator.lessThan:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LessThan"' + - name: lessThanOrEqual + uid: excel!Excel.ConditionalCellValueOperator.lessThanOrEqual:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LessThanOrEqual"' + - name: notBetween + uid: excel!Excel.ConditionalCellValueOperator.notBetween:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"NotBetween"' + - name: notEqualTo + uid: excel!Excel.ConditionalCellValueOperator.notEqualTo:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"NotEqualTo"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalcellvaluerule.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalcellvaluerule.yml new file mode 100644 index 0000000000..ec8ac08f0d --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalcellvaluerule.yml @@ -0,0 +1,115 @@ +### YamlMime:TSType +name: Excel.ConditionalCellValueRule +uid: excel!Excel.ConditionalCellValueRule:interface +package: excel! +fullName: Excel.ConditionalCellValueRule +summary: Represents a cell value conditional format rule. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: formula1 + uid: excel!Excel.ConditionalCellValueRule#formula1:member + package: excel! + fullName: formula1 + summary: >- + The formula, if required, on which to evaluate the conditional format + rule. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const range = sheet.getRange("B21:E23"); + const conditionalFormat = range.conditionalFormats + .add(Excel.ConditionalFormatType.cellValue); + conditionalFormat.cellValue.format.font.color = "red"; + conditionalFormat.cellValue.rule = { formula1: "=0", operator: "LessThan" }; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'formula1: string;' + return: + type: string + - name: formula2 + uid: excel!Excel.ConditionalCellValueRule#formula2:member + package: excel! + fullName: formula2 + summary: >- + The formula, if required, on which to evaluate the conditional format + rule. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formula2?: string;' + return: + type: string + - name: operator + uid: excel!Excel.ConditionalCellValueRule#operator:member + package: excel! + fullName: operator + summary: The operator of the cell value conditional format. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const range = sheet.getRange("B21:E23"); + const conditionalFormat = range.conditionalFormats + .add(Excel.ConditionalFormatType.cellValue); + conditionalFormat.cellValue.format.font.color = "red"; + conditionalFormat.cellValue.rule = { formula1: "=0", operator: "LessThan" }; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + operator: Excel.ConditionalCellValueOperator | "Invalid" | "Between" | + "NotBetween" | "EqualTo" | "NotEqualTo" | "GreaterThan" | "LessThan" | + "GreaterThanOrEqual" | "LessThanOrEqual"; + return: + type: >- + | + "Invalid" | "Between" | "NotBetween" | "EqualTo" | "NotEqualTo" | + "GreaterThan" | "LessThan" | "GreaterThanOrEqual" | "LessThanOrEqual" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalcolorscalecriteria.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalcolorscalecriteria.yml new file mode 100644 index 0000000000..2f584202fc --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalcolorscalecriteria.yml @@ -0,0 +1,61 @@ +### YamlMime:TSType +name: Excel.ConditionalColorScaleCriteria +uid: excel!Excel.ConditionalColorScaleCriteria:interface +package: excel! +fullName: Excel.ConditionalColorScaleCriteria +summary: Represents the criteria of the color scale. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: maximum + uid: excel!Excel.ConditionalColorScaleCriteria#maximum:member + package: excel! + fullName: maximum + summary: The maximum point of the color scale criterion. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'maximum: Excel.ConditionalColorScaleCriterion;' + return: + type: + - name: midpoint + uid: excel!Excel.ConditionalColorScaleCriteria#midpoint:member + package: excel! + fullName: midpoint + summary: >- + The midpoint of the color scale criterion, if the color scale is a 3-color + scale. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'midpoint?: Excel.ConditionalColorScaleCriterion;' + return: + type: + - name: minimum + uid: excel!Excel.ConditionalColorScaleCriteria#minimum:member + package: excel! + fullName: minimum + summary: The minimum point of the color scale criterion. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'minimum: Excel.ConditionalColorScaleCriterion;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalcolorscalecriterion.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalcolorscalecriterion.yml new file mode 100644 index 0000000000..0176017d7f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalcolorscalecriterion.yml @@ -0,0 +1,67 @@ +### YamlMime:TSType +name: Excel.ConditionalColorScaleCriterion +uid: excel!Excel.ConditionalColorScaleCriterion:interface +package: excel! +fullName: Excel.ConditionalColorScaleCriterion +summary: Represents a color scale criterion which contains a type, value, and a color. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: color + uid: excel!Excel.ConditionalColorScaleCriterion#color:member + package: excel! + fullName: color + summary: >- + HTML color code representation of the color scale color (e.g., \#FF0000 + represents Red). + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: string;' + return: + type: string + - name: formula + uid: excel!Excel.ConditionalColorScaleCriterion#formula:member + package: excel! + fullName: formula + summary: A number, a formula, or `null` (if `type` is `lowestValue`). + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formula?: string;' + return: + type: string + - name: type + uid: excel!Excel.ConditionalColorScaleCriterion#type:member + package: excel! + fullName: type + summary: What the criterion conditional formula should be based on. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + type: Excel.ConditionalFormatColorCriterionType | "Invalid" | + "LowestValue" | "HighestValue" | "Number" | "Percent" | "Formula" | + "Percentile"; + return: + type: >- + | + "Invalid" | "LowestValue" | "HighestValue" | "Number" | "Percent" | + "Formula" | "Percentile" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionaldatabaraxisformat.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionaldatabaraxisformat.yml new file mode 100644 index 0000000000..9940a1a018 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionaldatabaraxisformat.yml @@ -0,0 +1,34 @@ +### YamlMime:TSEnum +name: Excel.ConditionalDataBarAxisFormat +uid: excel!Excel.ConditionalDataBarAxisFormat:enum +package: excel! +fullName: Excel.ConditionalDataBarAxisFormat +summary: Represents the format options for a data bar axis. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: automatic + uid: excel!Excel.ConditionalDataBarAxisFormat.automatic:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Automatic"' + - name: cellMidPoint + uid: excel!Excel.ConditionalDataBarAxisFormat.cellMidPoint:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"CellMidPoint"' + - name: none + uid: excel!Excel.ConditionalDataBarAxisFormat.none:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"None"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionaldatabardirection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionaldatabardirection.yml new file mode 100644 index 0000000000..f97fb96ec7 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionaldatabardirection.yml @@ -0,0 +1,56 @@ +### YamlMime:TSEnum +name: Excel.ConditionalDataBarDirection +uid: excel!Excel.ConditionalDataBarDirection:enum +package: excel! +fullName: Excel.ConditionalDataBarDirection +summary: Represents the data bar direction within a cell. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const range = sheet.getRange("B8:E13"); + const conditionalFormat = range.conditionalFormats + .add(Excel.ConditionalFormatType.dataBar); + conditionalFormat.dataBar.barDirection = Excel.ConditionalDataBarDirection.leftToRight; + + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: context + uid: excel!Excel.ConditionalDataBarDirection.context:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Context"' + - name: leftToRight + uid: excel!Excel.ConditionalDataBarDirection.leftToRight:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LeftToRight"' + - name: rightToLeft + uid: excel!Excel.ConditionalDataBarDirection.rightToLeft:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"RightToLeft"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionaldatabarnegativeformat.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionaldatabarnegativeformat.yml new file mode 100644 index 0000000000..48321e7046 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionaldatabarnegativeformat.yml @@ -0,0 +1,263 @@ +### YamlMime:TSType +name: Excel.ConditionalDataBarNegativeFormat +uid: excel!Excel.ConditionalDataBarNegativeFormat:class +package: excel! +fullName: Excel.ConditionalDataBarNegativeFormat +summary: Represents a conditional format for the negative side of the data bar. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: borderColor + uid: excel!Excel.ConditionalDataBarNegativeFormat#borderColor:member + package: excel! + fullName: borderColor + summary: >- + HTML color code representing the color of the border line, in the form + \#RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). Value + is "" (an empty string) if no border is present or set. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'borderColor: string;' + return: + type: string + - name: context + uid: excel!Excel.ConditionalDataBarNegativeFormat#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: fillColor + uid: excel!Excel.ConditionalDataBarNegativeFormat#fillColor:member + package: excel! + fullName: fillColor + summary: >- + HTML color code representing the fill color, in the form \#RRGGBB (e.g., + "FFA500") or as a named HTML color (e.g., "orange"). + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'fillColor: string;' + return: + type: string + - name: matchPositiveBorderColor + uid: >- + excel!Excel.ConditionalDataBarNegativeFormat#matchPositiveBorderColor:member + package: excel! + fullName: matchPositiveBorderColor + summary: >- + Specifies if the negative data bar has the same border color as the + positive data bar. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'matchPositiveBorderColor: boolean;' + return: + type: boolean + - name: matchPositiveFillColor + uid: excel!Excel.ConditionalDataBarNegativeFormat#matchPositiveFillColor:member + package: excel! + fullName: matchPositiveFillColor + summary: >- + Specifies if the negative data bar has the same fill color as the positive + data bar. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'matchPositiveFillColor: boolean;' + return: + type: boolean +methods: + - name: load(options) + uid: excel!Excel.ConditionalDataBarNegativeFormat#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: + Excel.Interfaces.ConditionalDataBarNegativeFormatLoadOptions): + Excel.ConditionalDataBarNegativeFormat; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ConditionalDataBarNegativeFormat#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNames?: string | string[]): + Excel.ConditionalDataBarNegativeFormat; + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ConditionalDataBarNegativeFormat#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ConditionalDataBarNegativeFormat; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ConditionalDataBarNegativeFormat#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ConditionalDataBarNegativeFormatUpdateData, + options?: OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ConditionalDataBarNegativeFormat#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ConditionalDataBarNegativeFormat): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ConditionalDataBarNegativeFormat#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.ConditionalDataBarNegativeFormat` object is an API object, the + `toJSON` method returns a plain JavaScript object (typed as + `Excel.Interfaces.ConditionalDataBarNegativeFormatData`) that + contains shallow copies of any loaded child properties from the original + object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ConditionalDataBarNegativeFormatData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionaldatabarpositiveformat.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionaldatabarpositiveformat.yml new file mode 100644 index 0000000000..eb6e1f1c63 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionaldatabarpositiveformat.yml @@ -0,0 +1,243 @@ +### YamlMime:TSType +name: Excel.ConditionalDataBarPositiveFormat +uid: excel!Excel.ConditionalDataBarPositiveFormat:class +package: excel! +fullName: Excel.ConditionalDataBarPositiveFormat +summary: Represents a conditional format for the positive side of the data bar. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: borderColor + uid: excel!Excel.ConditionalDataBarPositiveFormat#borderColor:member + package: excel! + fullName: borderColor + summary: >- + HTML color code representing the color of the border line, in the form + \#RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). Value + is "" (an empty string) if no border is present or set. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'borderColor: string;' + return: + type: string + - name: context + uid: excel!Excel.ConditionalDataBarPositiveFormat#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: fillColor + uid: excel!Excel.ConditionalDataBarPositiveFormat#fillColor:member + package: excel! + fullName: fillColor + summary: >- + HTML color code representing the fill color, in the form \#RRGGBB (e.g., + "FFA500") or as a named HTML color (e.g., "orange"). + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'fillColor: string;' + return: + type: string + - name: gradientFill + uid: excel!Excel.ConditionalDataBarPositiveFormat#gradientFill:member + package: excel! + fullName: gradientFill + summary: Specifies if the data bar has a gradient. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientFill: boolean;' + return: + type: boolean +methods: + - name: load(options) + uid: excel!Excel.ConditionalDataBarPositiveFormat#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: + Excel.Interfaces.ConditionalDataBarPositiveFormatLoadOptions): + Excel.ConditionalDataBarPositiveFormat; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ConditionalDataBarPositiveFormat#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNames?: string | string[]): + Excel.ConditionalDataBarPositiveFormat; + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ConditionalDataBarPositiveFormat#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ConditionalDataBarPositiveFormat; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ConditionalDataBarPositiveFormat#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ConditionalDataBarPositiveFormatUpdateData, + options?: OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ConditionalDataBarPositiveFormat#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ConditionalDataBarPositiveFormat): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ConditionalDataBarPositiveFormat#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.ConditionalDataBarPositiveFormat` object is an API object, the + `toJSON` method returns a plain JavaScript object (typed as + `Excel.Interfaces.ConditionalDataBarPositiveFormatData`) that + contains shallow copies of any loaded child properties from the original + object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ConditionalDataBarPositiveFormatData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionaldatabarrule.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionaldatabarrule.yml new file mode 100644 index 0000000000..6b9633ed56 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionaldatabarrule.yml @@ -0,0 +1,50 @@ +### YamlMime:TSType +name: Excel.ConditionalDataBarRule +uid: excel!Excel.ConditionalDataBarRule:interface +package: excel! +fullName: Excel.ConditionalDataBarRule +summary: Represents a rule-type for a data bar. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: formula + uid: excel!Excel.ConditionalDataBarRule#formula:member + package: excel! + fullName: formula + summary: The formula, if required, on which to evaluate the data bar rule. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formula?: string;' + return: + type: string + - name: type + uid: excel!Excel.ConditionalDataBarRule#type:member + package: excel! + fullName: type + summary: The type of rule for the data bar. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + type: Excel.ConditionalFormatRuleType | "Invalid" | "Automatic" | + "LowestValue" | "HighestValue" | "Number" | "Percent" | "Formula" | + "Percentile"; + return: + type: >- + | "Invalid" + | "Automatic" | "LowestValue" | "HighestValue" | "Number" | "Percent" + | "Formula" | "Percentile" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalformat.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalformat.yml new file mode 100644 index 0000000000..a19ea6f4b6 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalformat.yml @@ -0,0 +1,1074 @@ +### YamlMime:TSType +name: Excel.ConditionalFormat +uid: excel!Excel.ConditionalFormat:class +package: excel! +fullName: Excel.ConditionalFormat +summary: >- + An object encapsulating a conditional format's range, format, rule, and other + properties. To learn more about the conditional formatting object model, read + [Apply conditional formatting to Excel + ranges](https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-conditional-formatting). +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: cellValue + uid: excel!Excel.ConditionalFormat#cellValue:member + package: excel! + fullName: cellValue + summary: >- + Returns the cell value conditional format properties if the current + conditional format is a `CellValue` type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const range = sheet.getRange("B21:E23"); + const conditionalFormat = range.conditionalFormats + .add(Excel.ConditionalFormatType.cellValue); + conditionalFormat.cellValue.format.font.color = "red"; + conditionalFormat.cellValue.rule = { formula1: "=0", operator: "LessThan" }; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly cellValue: Excel.CellValueConditionalFormat;' + return: + type: + - name: cellValueOrNullObject + uid: excel!Excel.ConditionalFormat#cellValueOrNullObject:member + package: excel! + fullName: cellValueOrNullObject + summary: >- + Returns the cell value conditional format properties if the current + conditional format is a `CellValue` type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly cellValueOrNullObject: Excel.CellValueConditionalFormat;' + return: + type: + - name: colorScale + uid: excel!Excel.ConditionalFormat#colorScale:member + package: excel! + fullName: colorScale + summary: >- + Returns the color scale conditional format properties if the current + conditional format is a `ColorScale` type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const range = sheet.getRange("B2:M5"); + const conditionalFormat = range.conditionalFormats + .add(Excel.ConditionalFormatType.colorScale); + const criteria = { + minimum: { formula: null, type: Excel.ConditionalFormatColorCriterionType.lowestValue, color: "blue" }, + midpoint: { formula: "50", type: Excel.ConditionalFormatColorCriterionType.percent, color: "yellow" }, + maximum: { formula: null, type: Excel.ConditionalFormatColorCriterionType.highestValue, color: "red" } + }; + conditionalFormat.colorScale.criteria = criteria; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly colorScale: Excel.ColorScaleConditionalFormat;' + return: + type: + - name: colorScaleOrNullObject + uid: excel!Excel.ConditionalFormat#colorScaleOrNullObject:member + package: excel! + fullName: colorScaleOrNullObject + summary: >- + Returns the color scale conditional format properties if the current + conditional format is a `ColorScale` type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly colorScaleOrNullObject: Excel.ColorScaleConditionalFormat;' + return: + type: + - name: context + uid: excel!Excel.ConditionalFormat#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: custom + uid: excel!Excel.ConditionalFormat#custom:member + package: excel! + fullName: custom + summary: >- + Returns the custom conditional format properties if the current + conditional format is a custom type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const range = sheet.getRange("B8:E13"); + const conditionalFormat = range.conditionalFormats.add(Excel.ConditionalFormatType.custom); + conditionalFormat.custom.rule.formula = '=IF(B8>INDIRECT("RC[-1]",0),TRUE)'; + conditionalFormat.custom.format.font.color = "green"; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly custom: Excel.CustomConditionalFormat;' + return: + type: + - name: customOrNullObject + uid: excel!Excel.ConditionalFormat#customOrNullObject:member + package: excel! + fullName: customOrNullObject + summary: >- + Returns the custom conditional format properties if the current + conditional format is a custom type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly customOrNullObject: Excel.CustomConditionalFormat;' + return: + type: + - name: dataBar + uid: excel!Excel.ConditionalFormat#dataBar:member + package: excel! + fullName: dataBar + summary: >- + Returns the data bar properties if the current conditional format is a + data bar. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const range = sheet.getRange("B8:E13"); + const conditionalFormat = range.conditionalFormats + .add(Excel.ConditionalFormatType.dataBar); + conditionalFormat.dataBar.barDirection = Excel.ConditionalDataBarDirection.leftToRight; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly dataBar: Excel.DataBarConditionalFormat;' + return: + type: + - name: dataBarOrNullObject + uid: excel!Excel.ConditionalFormat#dataBarOrNullObject:member + package: excel! + fullName: dataBarOrNullObject + summary: >- + Returns the data bar properties if the current conditional format is a + data bar. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly dataBarOrNullObject: Excel.DataBarConditionalFormat;' + return: + type: + - name: iconSet + uid: excel!Excel.ConditionalFormat#iconSet:member + package: excel! + fullName: iconSet + summary: >- + Returns the icon set conditional format properties if the current + conditional format is an `IconSet` type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const range = sheet.getRange("B8:E13"); + const conditionalFormat = range.conditionalFormats + .add(Excel.ConditionalFormatType.iconSet); + const iconSetCF = conditionalFormat.iconSet; + iconSetCF.style = Excel.IconSet.threeTriangles; + + /* + The iconSetCF.criteria array is automatically prepopulated with + criterion elements whose properties have been given default settings. + You can't write to each property of a criterion directly. Instead, + replace the whole criteria object. + + With a "three*" icon set style, such as "threeTriangles", the third + element in the criteria array (criteria[2]) defines the "top" icon; + e.g., a green triangle. The second (criteria[1]) defines the "middle" + icon. The first (criteria[0]) defines the "low" icon, but it + can often be left empty as the following object shows, because every + cell that does not match the other two criteria always gets the low + icon. + */ + iconSetCF.criteria = [ + {} as any, + { + type: Excel.ConditionalFormatIconRuleType.number, + operator: Excel.ConditionalIconCriterionOperator.greaterThanOrEqual, + formula: "=700" + }, + { + type: Excel.ConditionalFormatIconRuleType.number, + operator: Excel.ConditionalIconCriterionOperator.greaterThanOrEqual, + formula: "=1000", + } + ]; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly iconSet: Excel.IconSetConditionalFormat;' + return: + type: + - name: iconSetOrNullObject + uid: excel!Excel.ConditionalFormat#iconSetOrNullObject:member + package: excel! + fullName: iconSetOrNullObject + summary: >- + Returns the icon set conditional format properties if the current + conditional format is an `IconSet` type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly iconSetOrNullObject: Excel.IconSetConditionalFormat;' + return: + type: + - name: id + uid: excel!Excel.ConditionalFormat#id:member + package: excel! + fullName: id + summary: >- + The priority of the conditional format in the current + `ConditionalFormatCollection`. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly id: string;' + return: + type: string + - name: preset + uid: excel!Excel.ConditionalFormat#preset:member + package: excel! + fullName: preset + summary: >- + Returns the preset criteria conditional format. See + `Excel.PresetCriteriaConditionalFormat` for more details. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const range = sheet.getRange("B2:M5"); + const conditionalFormat = range.conditionalFormats + .add(Excel.ConditionalFormatType.presetCriteria); + conditionalFormat.preset.format.font.color = "white"; + conditionalFormat.preset.rule = { criterion: Excel.ConditionalFormatPresetCriterion.oneStdDevAboveAverage }; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly preset: Excel.PresetCriteriaConditionalFormat;' + return: + type: + - name: presetOrNullObject + uid: excel!Excel.ConditionalFormat#presetOrNullObject:member + package: excel! + fullName: presetOrNullObject + summary: >- + Returns the preset criteria conditional format. See + `Excel.PresetCriteriaConditionalFormat` for more details. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly presetOrNullObject: Excel.PresetCriteriaConditionalFormat;' + return: + type: + - name: priority + uid: excel!Excel.ConditionalFormat#priority:member + package: excel! + fullName: priority + summary: >- + The priority (or index) within the conditional format collection that this + conditional format currently exists in. Changing this also changes other + conditional formats' priorities, to allow for a contiguous priority order. + Use a negative priority to begin from the back. Priorities greater than + the bounds will get and set to the maximum (or minimum if negative) + priority. Also note that if you change the priority, you have to re-fetch + a new copy of the object at that new priority location if you want to make + further changes to it. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'priority: number;' + return: + type: number + - name: stopIfTrue + uid: excel!Excel.ConditionalFormat#stopIfTrue:member + package: excel! + fullName: stopIfTrue + summary: >- + If the conditions of this conditional format are met, no lower-priority + formats shall take effect on that cell. Value is `null` on data bars, icon + sets, and color scales as there's no concept of `StopIfTrue` for these. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'stopIfTrue: boolean;' + return: + type: boolean + - name: textComparison + uid: excel!Excel.ConditionalFormat#textComparison:member + package: excel! + fullName: textComparison + summary: >- + Returns the specific text conditional format properties if the current + conditional format is a text type. For example, to format cells matching + the word "Text". + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const range = sheet.getRange("B16:D18"); + const conditionalFormat = range.conditionalFormats + .add(Excel.ConditionalFormatType.containsText); + conditionalFormat.textComparison.format.font.color = "red"; + conditionalFormat.textComparison.rule = { operator: Excel.ConditionalTextOperator.contains, text: "Delayed" }; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly textComparison: Excel.TextConditionalFormat;' + return: + type: + - name: textComparisonOrNullObject + uid: excel!Excel.ConditionalFormat#textComparisonOrNullObject:member + package: excel! + fullName: textComparisonOrNullObject + summary: >- + Returns the specific text conditional format properties if the current + conditional format is a text type. For example, to format cells matching + the word "Text". + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly textComparisonOrNullObject: Excel.TextConditionalFormat;' + return: + type: + - name: topBottom + uid: excel!Excel.ConditionalFormat#topBottom:member + package: excel! + fullName: topBottom + summary: >- + Returns the top/bottom conditional format properties if the current + conditional format is a `TopBottom` type. For example, to format the top + 10% or bottom 10 items. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly topBottom: Excel.TopBottomConditionalFormat;' + return: + type: + - name: topBottomOrNullObject + uid: excel!Excel.ConditionalFormat#topBottomOrNullObject:member + package: excel! + fullName: topBottomOrNullObject + summary: >- + Returns the top/bottom conditional format properties if the current + conditional format is a `TopBottom` type. For example, to format the top + 10% or bottom 10 items. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly topBottomOrNullObject: Excel.TopBottomConditionalFormat;' + return: + type: + - name: type + uid: excel!Excel.ConditionalFormat#type:member + package: excel! + fullName: type + summary: A type of conditional format. Only one can be set at a time. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const worksheetRange = sheet.getRange(); + worksheetRange.conditionalFormats.load("type"); + + await context.sync(); + + let cfRangePairs: { cf: Excel.ConditionalFormat, range: Excel.Range }[] = []; + worksheetRange.conditionalFormats.items.forEach(item => { + cfRangePairs.push({ + cf: item, + range: item.getRange().load("address") + }); + }); + + await context.sync(); + + if (cfRangePairs.length > 0) { + cfRangePairs.forEach(item => { + console.log(item.cf.type); + }); + } else { + console.log("No conditional formats applied."); + } + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly type: Excel.ConditionalFormatType | "Custom" | "DataBar" | + "ColorScale" | "IconSet" | "TopBottom" | "PresetCriteria" | + "ContainsText" | "CellValue"; + return: + type: >- + | "Custom" | + "DataBar" | "ColorScale" | "IconSet" | "TopBottom" | "PresetCriteria" + | "ContainsText" | "CellValue" +methods: + - name: changeRuleToCellValue(properties) + uid: excel!Excel.ConditionalFormat#changeRuleToCellValue:member(1) + package: excel! + fullName: changeRuleToCellValue(properties) + summary: Change the conditional format rule type to cell value. + 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;' + parameters: + - id: properties + description: The properties to set for the cell value conditional format rule. + type: + return: + type: void + description: '' + - name: changeRuleToColorScale() + uid: excel!Excel.ConditionalFormat#changeRuleToColorScale:member(1) + package: excel! + fullName: changeRuleToColorScale() + summary: Change the conditional format rule type to color scale. + remarks: >- + \[ [API set: ExcelApi + 1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'changeRuleToColorScale(): void;' + return: + type: void + description: '' + - name: changeRuleToContainsText(properties) + uid: excel!Excel.ConditionalFormat#changeRuleToContainsText:member(1) + package: excel! + fullName: changeRuleToContainsText(properties) + summary: Change the conditional format rule type to text comparison. + 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; + parameters: + - id: properties + description: >- + The properties to set for the text comparison conditional format + rule. + type: + return: + type: void + description: '' + - name: changeRuleToCustom(formula) + uid: excel!Excel.ConditionalFormat#changeRuleToCustom:member(1) + package: excel! + fullName: changeRuleToCustom(formula) + summary: Change the conditional format rule type to custom. + 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;' + parameters: + - id: formula + description: The formula to set for the custom conditional format rule. + type: string + return: + type: void + description: '' + - name: changeRuleToDataBar() + uid: excel!Excel.ConditionalFormat#changeRuleToDataBar:member(1) + package: excel! + fullName: changeRuleToDataBar() + summary: Change the conditional format rule type to data bar. + remarks: >- + \[ [API set: ExcelApi + 1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'changeRuleToDataBar(): void;' + return: + type: void + description: '' + - name: changeRuleToIconSet() + uid: excel!Excel.ConditionalFormat#changeRuleToIconSet:member(1) + package: excel! + fullName: changeRuleToIconSet() + summary: Change the conditional format rule type to icon set. + remarks: >- + \[ [API set: ExcelApi + 1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'changeRuleToIconSet(): void;' + return: + type: void + description: '' + - name: changeRuleToPresetCriteria(properties) + uid: excel!Excel.ConditionalFormat#changeRuleToPresetCriteria:member(1) + package: excel! + fullName: changeRuleToPresetCriteria(properties) + summary: Change the conditional format rule type to preset criteria. + 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; + parameters: + - id: properties + description: >- + The properties to set for the preset criteria conditional format + rule. + type: + return: + type: void + description: '' + - name: changeRuleToTopBottom(properties) + uid: excel!Excel.ConditionalFormat#changeRuleToTopBottom:member(1) + package: excel! + fullName: changeRuleToTopBottom(properties) + summary: Change the conditional format rule type to top/bottom. + 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;' + parameters: + - id: properties + description: The properties to set for the top/bottom conditional format rule. + type: + return: + type: void + description: '' + - name: delete() + uid: excel!Excel.ConditionalFormat#delete:member(1) + package: excel! + fullName: delete() + summary: Deletes this conditional format. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'delete(): void;' + return: + type: void + description: '' + - name: getRange() + uid: excel!Excel.ConditionalFormat#getRange:member(1) + package: excel! + fullName: getRange() + summary: >- + Returns the range the conditional format is applied to. Throws an error if + the conditional format is applied to multiple ranges. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const worksheetRange = sheet.getRange(); + worksheetRange.conditionalFormats.load("type"); + + await context.sync(); + + let cfRangePairs: { cf: Excel.ConditionalFormat, range: Excel.Range }[] = []; + worksheetRange.conditionalFormats.items.forEach(item => { + cfRangePairs.push({ + cf: item, + range: item.getRange().load("address") + }); + }); + + await context.sync(); + + if (cfRangePairs.length > 0) { + cfRangePairs.forEach(item => { + console.log(item.cf.type); + }); + } else { + console.log("No conditional formats applied."); + } + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getRange(): Excel.Range;' + return: + type: + description: '' + - name: getRangeOrNullObject() + uid: excel!Excel.ConditionalFormat#getRangeOrNullObject:member(1) + package: excel! + fullName: getRangeOrNullObject() + summary: >- + Returns the range to which the conditional format is applied. If the + conditional format is applied to multiple ranges, then this method returns + an object with its `isNullObject` property set to `true`. For + further information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getRangeOrNullObject(): Excel.Range;' + return: + type: + description: '' + - name: getRanges() + uid: excel!Excel.ConditionalFormat#getRanges:member(1) + package: excel! + fullName: getRanges() + summary: >- + Returns the `RangeAreas`, comprising one or more rectangular + ranges, to which the conditional format is applied. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getRanges(): Excel.RangeAreas;' + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.ConditionalFormat#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ConditionalFormatLoadOptions): + Excel.ConditionalFormat; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ConditionalFormat#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ConditionalFormat;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ConditionalFormat#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ConditionalFormat; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ConditionalFormat#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ConditionalFormatUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ConditionalFormat#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ConditionalFormat): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: setRanges(ranges) + uid: excel!Excel.ConditionalFormat#setRanges:member(1) + package: excel! + fullName: setRanges(ranges) + summary: Set the ranges that the conditional format rule is applied to. + 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;' + parameters: + - id: ranges + description: Collection of one or more ranges for this rule to be applied to. + type: >- + | | string + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ConditionalFormat#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.ConditionalFormat` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.ConditionalFormatData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ConditionalFormatData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalformatcollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalformatcollection.yml new file mode 100644 index 0000000000..50beaa30dd --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalformatcollection.yml @@ -0,0 +1,425 @@ +### YamlMime:TSType +name: Excel.ConditionalFormatCollection +uid: excel!Excel.ConditionalFormatCollection:class +package: excel! +fullName: Excel.ConditionalFormatCollection +summary: >- + Represents a collection of all the conditional formats that are overlap the + range. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.ConditionalFormatCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: excel!Excel.ConditionalFormatCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.ConditionalFormat[];' + return: + type: [] +methods: + - name: add(type) + uid: excel!Excel.ConditionalFormatCollection#add:member(1) + package: excel! + fullName: add(type) + summary: Adds a new conditional format to the collection at the first/top priority. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const range = sheet.getRange("B2:M5"); + const conditionalFormat = range.conditionalFormats + .add(Excel.ConditionalFormatType.colorScale); + const criteria = { + minimum: { formula: null, type: Excel.ConditionalFormatColorCriterionType.lowestValue, color: "blue" }, + midpoint: { formula: "50", type: Excel.ConditionalFormatColorCriterionType.percent, color: "yellow" }, + maximum: { formula: null, type: Excel.ConditionalFormatColorCriterionType.highestValue, color: "red" } + }; + conditionalFormat.colorScale.criteria = criteria; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'add(type: Excel.ConditionalFormatType): Excel.ConditionalFormat;' + parameters: + - id: type + description: >- + The type of conditional format being added. See + `Excel.ConditionalFormatType` for details. + type: + return: + type: + description: '' + - name: add(type) + uid: excel!Excel.ConditionalFormatCollection#add:member(2) + package: excel! + fullName: add(type) + summary: Adds a new conditional format to the collection at the first/top priority. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + add(type: "Custom" | "DataBar" | "ColorScale" | "IconSet" | "TopBottom" + | "PresetCriteria" | "ContainsText" | "CellValue"): + Excel.ConditionalFormat; + parameters: + - id: type + description: >- + The type of conditional format being added. See + `Excel.ConditionalFormatType` for details. + type: >- + "Custom" | "DataBar" | "ColorScale" | "IconSet" | "TopBottom" | + "PresetCriteria" | "ContainsText" | "CellValue" + return: + type: + description: '' + - name: clearAll() + uid: excel!Excel.ConditionalFormatCollection#clearAll:member(1) + package: excel! + fullName: clearAll() + summary: Clears all conditional formats active on the current specified range. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const range = sheet.getRange(); + range.conditionalFormats.clearAll(); + + await context.sync(); + + document.querySelectorAll(".conditional-formats").forEach(element => { + element.style.display = "none"; + }); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'clearAll(): void;' + return: + type: void + description: '' + - name: getCount() + uid: excel!Excel.ConditionalFormatCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Returns the number of conditional formats in the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const sheetName = "Sheet1"; + const rangeAddress = "A1:C3"; + const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); + const conditionalFormat = range.conditionalFormats.add(Excel.ConditionalFormatType.iconSet); + conditionalFormat.iconSetOrNullObject.style = Excel.IconSet.fourTrafficLights; + const cfCount = range.conditionalFormats.getCount(); + + await context.sync() + console.log("Count: " + cfCount.value); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getItem(id) + uid: excel!Excel.ConditionalFormatCollection#getItem:member(1) + package: excel! + fullName: getItem(id) + summary: Returns a conditional format for the given ID. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const sheetName = "Sheet1"; + const rangeAddress = "A1:C3"; + const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); + const conditionalFormats = range.conditionalFormats; + const conditionalFormat = conditionalFormats.getItemAt(3); + await context.sync() + + console.log("Conditional Format at Item 3 Loaded"); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getItem(id: string): Excel.ConditionalFormat;' + parameters: + - id: id + description: The ID of the conditional format. + type: string + return: + type: + description: Conditional format object. + - name: getItemAt(index) + uid: excel!Excel.ConditionalFormatCollection#getItemAt:member(1) + package: excel! + fullName: getItemAt(index) + summary: Returns a conditional format at the given index. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const worksheetRange = sheet.getRange(); + worksheetRange.conditionalFormats.load("type"); + + await context.sync(); + + let cfRangePairs: { cf: Excel.ConditionalFormat, range: Excel.Range }[] = []; + worksheetRange.conditionalFormats.items.forEach(item => { + cfRangePairs.push({ + cf: item, + range: item.getRange().load("address") + }); + }); + + await context.sync(); + + if (cfRangePairs.length > 0) { + cfRangePairs.forEach(item => { + console.log(item.cf.type); + }); + } else { + console.log("No conditional formats applied."); + } + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemAt(index: number): Excel.ConditionalFormat;' + parameters: + - id: index + description: Index of the conditional formats to be retrieved. + type: number + return: + type: + description: '' + - name: getItemOrNullObject(id) + uid: excel!Excel.ConditionalFormatCollection#getItemOrNullObject:member(1) + package: excel! + fullName: getItemOrNullObject(id) + summary: >- + Returns a conditional format identified by its ID. If the conditional + format object does not exist, then this method returns an object with its + `isNullObject` property set to `true`. For further information, + see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemOrNullObject(id: string): Excel.ConditionalFormat;' + parameters: + - id: id + description: The ID of the conditional format. + type: string + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.ConditionalFormatCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ConditionalFormatCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): + Excel.ConditionalFormatCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ConditionalFormatCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNames?: string | string[]): + Excel.ConditionalFormatCollection; + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ConditionalFormatCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.ConditionalFormatCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.ConditionalFormatCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.ConditionalFormatCollection` object is an API object, the `toJSON` + method returns a plain JavaScript object (typed as + `Excel.Interfaces.ConditionalFormatCollectionData`) that contains + an "items" array with shallow copies of any loaded properties from the + collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ConditionalFormatCollectionData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalformatcolorcriteriontype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalformatcolorcriteriontype.yml new file mode 100644 index 0000000000..7a9c0068cf --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalformatcolorcriteriontype.yml @@ -0,0 +1,89 @@ +### YamlMime:TSEnum +name: Excel.ConditionalFormatColorCriterionType +uid: excel!Excel.ConditionalFormatColorCriterionType:enum +package: excel! +fullName: Excel.ConditionalFormatColorCriterionType +summary: Represents the types of color criterion for conditional formatting. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const range = sheet.getRange("B2:M5"); + const conditionalFormat = range.conditionalFormats + .add(Excel.ConditionalFormatType.colorScale); + const criteria = { + minimum: { formula: null, type: Excel.ConditionalFormatColorCriterionType.lowestValue, color: "blue" }, + midpoint: { formula: "50", type: Excel.ConditionalFormatColorCriterionType.percent, color: "yellow" }, + maximum: { formula: null, type: Excel.ConditionalFormatColorCriterionType.highestValue, color: "red" } + }; + conditionalFormat.colorScale.criteria = criteria; + + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: formula + uid: excel!Excel.ConditionalFormatColorCriterionType.formula:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Formula"' + - name: highestValue + uid: excel!Excel.ConditionalFormatColorCriterionType.highestValue:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"HighestValue"' + - name: invalid + uid: excel!Excel.ConditionalFormatColorCriterionType.invalid:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Invalid"' + - name: lowestValue + uid: excel!Excel.ConditionalFormatColorCriterionType.lowestValue:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LowestValue"' + - name: number + uid: excel!Excel.ConditionalFormatColorCriterionType.number:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Number"' + - name: percent + uid: excel!Excel.ConditionalFormatColorCriterionType.percent:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Percent"' + - name: percentile + uid: excel!Excel.ConditionalFormatColorCriterionType.percentile:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Percentile"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalformatdirection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalformatdirection.yml new file mode 100644 index 0000000000..ad40a03aee --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalformatdirection.yml @@ -0,0 +1,27 @@ +### YamlMime:TSEnum +name: Excel.ConditionalFormatDirection +uid: excel!Excel.ConditionalFormatDirection:enum +package: excel! +fullName: Excel.ConditionalFormatDirection +summary: Represents the direction for a selection. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: bottom + uid: excel!Excel.ConditionalFormatDirection.bottom:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Bottom"' + - name: top + uid: excel!Excel.ConditionalFormatDirection.top:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Top"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalformaticonruletype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalformaticonruletype.yml new file mode 100644 index 0000000000..6de78d8f46 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalformaticonruletype.yml @@ -0,0 +1,99 @@ +### YamlMime:TSEnum +name: Excel.ConditionalFormatIconRuleType +uid: excel!Excel.ConditionalFormatIconRuleType:enum +package: excel! +fullName: Excel.ConditionalFormatIconRuleType +summary: Represents the types of icon conditional format. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const range = sheet.getRange("B8:E13"); + const conditionalFormat = range.conditionalFormats + .add(Excel.ConditionalFormatType.iconSet); + const iconSetCF = conditionalFormat.iconSet; + iconSetCF.style = Excel.IconSet.threeTriangles; + + /* + The iconSetCF.criteria array is automatically prepopulated with + criterion elements whose properties have been given default settings. + You can't write to each property of a criterion directly. Instead, + replace the whole criteria object. + + With a "three*" icon set style, such as "threeTriangles", the third + element in the criteria array (criteria[2]) defines the "top" icon; + e.g., a green triangle. The second (criteria[1]) defines the "middle" + icon. The first (criteria[0]) defines the "low" icon, but it + can often be left empty as the following object shows, because every + cell that does not match the other two criteria always gets the low + icon. + */ + iconSetCF.criteria = [ + {} as any, + { + type: Excel.ConditionalFormatIconRuleType.number, + operator: Excel.ConditionalIconCriterionOperator.greaterThanOrEqual, + formula: "=700" + }, + { + type: Excel.ConditionalFormatIconRuleType.number, + operator: Excel.ConditionalIconCriterionOperator.greaterThanOrEqual, + formula: "=1000", + } + ]; + + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: formula + uid: excel!Excel.ConditionalFormatIconRuleType.formula:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Formula"' + - name: invalid + uid: excel!Excel.ConditionalFormatIconRuleType.invalid:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Invalid"' + - name: number + uid: excel!Excel.ConditionalFormatIconRuleType.number:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Number"' + - name: percent + uid: excel!Excel.ConditionalFormatIconRuleType.percent:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Percent"' + - name: percentile + uid: excel!Excel.ConditionalFormatIconRuleType.percentile:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Percentile"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalformatpresetcriterion.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalformatpresetcriterion.yml new file mode 100644 index 0000000000..98904d4b85 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalformatpresetcriterion.yml @@ -0,0 +1,250 @@ +### YamlMime:TSEnum +name: Excel.ConditionalFormatPresetCriterion +uid: excel!Excel.ConditionalFormatPresetCriterion:enum +package: excel! +fullName: Excel.ConditionalFormatPresetCriterion +summary: Represents the criteria of the preset criteria conditional format type. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-advanced.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + queueCommandsToClearAllConditionalFormats(sheet); + + const temperatureDataRange = sheet.tables.getItem("TemperatureTable").getDataBodyRange(); + + /* When the priority property of ConditionalFormat objects + is not explicitly set, they are prioritized in the order + that they are added, with zero-based numbering: 0, 1, ... + Contradictions are resolved in favor of the format with + the lower priority number. In the example below, negative + numbers will get a green background, but NOT a blue font, + because priority goes to the format that gives them a red font. + */ + + // Set low numbers to bold, dark red font. This format will + // get priority 0. + const presetFormat = temperatureDataRange.conditionalFormats + .add(Excel.ConditionalFormatType.presetCriteria); + presetFormat.preset.format.font.color = "red"; + presetFormat.preset.format.font.bold = true; + presetFormat.preset.rule = { criterion: Excel.ConditionalFormatPresetCriterion.oneStdDevBelowAverage }; + + // Set negative numbers to blue font with green background. + // This format will get priority 1. + const cellValueFormat = temperatureDataRange.conditionalFormats + .add(Excel.ConditionalFormatType.cellValue); + cellValueFormat.cellValue.format.font.color = "blue"; + cellValueFormat.cellValue.format.fill.color = "lightgreen"; + cellValueFormat.cellValue.rule = { formula1: "=0", operator: "LessThan" }; + + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: aboveAverage + uid: excel!Excel.ConditionalFormatPresetCriterion.aboveAverage:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"AboveAverage"' + - name: belowAverage + uid: excel!Excel.ConditionalFormatPresetCriterion.belowAverage:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"BelowAverage"' + - name: blanks + uid: excel!Excel.ConditionalFormatPresetCriterion.blanks:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Blanks"' + - name: duplicateValues + uid: excel!Excel.ConditionalFormatPresetCriterion.duplicateValues:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"DuplicateValues"' + - name: equalOrAboveAverage + uid: excel!Excel.ConditionalFormatPresetCriterion.equalOrAboveAverage:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"EqualOrAboveAverage"' + - name: equalOrBelowAverage + uid: excel!Excel.ConditionalFormatPresetCriterion.equalOrBelowAverage:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"EqualOrBelowAverage"' + - name: errors + uid: excel!Excel.ConditionalFormatPresetCriterion.errors:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Errors"' + - name: invalid + uid: excel!Excel.ConditionalFormatPresetCriterion.invalid:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Invalid"' + - name: lastMonth + uid: excel!Excel.ConditionalFormatPresetCriterion.lastMonth:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LastMonth"' + - name: lastSevenDays + uid: excel!Excel.ConditionalFormatPresetCriterion.lastSevenDays:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LastSevenDays"' + - name: lastWeek + uid: excel!Excel.ConditionalFormatPresetCriterion.lastWeek:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LastWeek"' + - name: nextMonth + uid: excel!Excel.ConditionalFormatPresetCriterion.nextMonth:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"NextMonth"' + - name: nextWeek + uid: excel!Excel.ConditionalFormatPresetCriterion.nextWeek:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"NextWeek"' + - name: nonBlanks + uid: excel!Excel.ConditionalFormatPresetCriterion.nonBlanks:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"NonBlanks"' + - name: nonErrors + uid: excel!Excel.ConditionalFormatPresetCriterion.nonErrors:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"NonErrors"' + - name: oneStdDevAboveAverage + uid: excel!Excel.ConditionalFormatPresetCriterion.oneStdDevAboveAverage:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"OneStdDevAboveAverage"' + - name: oneStdDevBelowAverage + uid: excel!Excel.ConditionalFormatPresetCriterion.oneStdDevBelowAverage:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"OneStdDevBelowAverage"' + - name: thisMonth + uid: excel!Excel.ConditionalFormatPresetCriterion.thisMonth:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ThisMonth"' + - name: thisWeek + uid: excel!Excel.ConditionalFormatPresetCriterion.thisWeek:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ThisWeek"' + - name: threeStdDevAboveAverage + uid: >- + excel!Excel.ConditionalFormatPresetCriterion.threeStdDevAboveAverage:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ThreeStdDevAboveAverage"' + - name: threeStdDevBelowAverage + uid: >- + excel!Excel.ConditionalFormatPresetCriterion.threeStdDevBelowAverage:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ThreeStdDevBelowAverage"' + - name: today + uid: excel!Excel.ConditionalFormatPresetCriterion.today:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Today"' + - name: tomorrow + uid: excel!Excel.ConditionalFormatPresetCriterion.tomorrow:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Tomorrow"' + - name: twoStdDevAboveAverage + uid: excel!Excel.ConditionalFormatPresetCriterion.twoStdDevAboveAverage:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"TwoStdDevAboveAverage"' + - name: twoStdDevBelowAverage + uid: excel!Excel.ConditionalFormatPresetCriterion.twoStdDevBelowAverage:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"TwoStdDevBelowAverage"' + - name: uniqueValues + uid: excel!Excel.ConditionalFormatPresetCriterion.uniqueValues:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"UniqueValues"' + - name: yesterday + uid: excel!Excel.ConditionalFormatPresetCriterion.yesterday:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Yesterday"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalformatrule.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalformatrule.yml new file mode 100644 index 0000000000..7d21259885 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalformatrule.yml @@ -0,0 +1,261 @@ +### YamlMime:TSType +name: Excel.ConditionalFormatRule +uid: excel!Excel.ConditionalFormatRule:class +package: excel! +fullName: Excel.ConditionalFormatRule +summary: Represents a rule, for all traditional rule/format pairings. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.ConditionalFormatRule#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: formula + uid: excel!Excel.ConditionalFormatRule#formula:member + package: excel! + fullName: formula + summary: >- + The formula, if required, on which to evaluate the conditional format + rule. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const range = sheet.getRange("B8:E13"); + const conditionalFormat = range.conditionalFormats.add(Excel.ConditionalFormatType.custom); + conditionalFormat.custom.rule.formula = '=IF(B8>INDIRECT("RC[-1]",0),TRUE)'; + conditionalFormat.custom.format.font.color = "green"; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'formula: string;' + return: + type: string + - name: formulaLocal + uid: excel!Excel.ConditionalFormatRule#formulaLocal:member + package: excel! + fullName: formulaLocal + summary: >- + The formula, if required, on which to evaluate the conditional format rule + in the user's language. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulaLocal: string;' + return: + type: string + - name: formulaR1C1 + uid: excel!Excel.ConditionalFormatRule#formulaR1C1:member + package: excel! + fullName: formulaR1C1 + summary: >- + The formula, if required, on which to evaluate the conditional format rule + in R1C1-style notation. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulaR1C1: string;' + return: + type: string +methods: + - name: load(options) + uid: excel!Excel.ConditionalFormatRule#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ConditionalFormatRuleLoadOptions): + Excel.ConditionalFormatRule; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ConditionalFormatRule#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ConditionalFormatRule;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ConditionalFormatRule#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ConditionalFormatRule; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ConditionalFormatRule#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ConditionalFormatRuleUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ConditionalFormatRule#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ConditionalFormatRule): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ConditionalFormatRule#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.ConditionalFormatRule` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.ConditionalFormatRuleData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ConditionalFormatRuleData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalformatruletype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalformatruletype.yml new file mode 100644 index 0000000000..1f8c5ed48f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalformatruletype.yml @@ -0,0 +1,69 @@ +### YamlMime:TSEnum +name: Excel.ConditionalFormatRuleType +uid: excel!Excel.ConditionalFormatRuleType:enum +package: excel! +fullName: Excel.ConditionalFormatRuleType +summary: Represents the types of conditional format values. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: automatic + uid: excel!Excel.ConditionalFormatRuleType.automatic:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Automatic"' + - name: formula + uid: excel!Excel.ConditionalFormatRuleType.formula:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Formula"' + - name: highestValue + uid: excel!Excel.ConditionalFormatRuleType.highestValue:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"HighestValue"' + - name: invalid + uid: excel!Excel.ConditionalFormatRuleType.invalid:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Invalid"' + - name: lowestValue + uid: excel!Excel.ConditionalFormatRuleType.lowestValue:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LowestValue"' + - name: number + uid: excel!Excel.ConditionalFormatRuleType.number:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Number"' + - name: percent + uid: excel!Excel.ConditionalFormatRuleType.percent:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Percent"' + - name: percentile + uid: excel!Excel.ConditionalFormatRuleType.percentile:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Percentile"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalformattype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalformattype.yml new file mode 100644 index 0000000000..8d69ccca27 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalformattype.yml @@ -0,0 +1,115 @@ +### YamlMime:TSEnum +name: Excel.ConditionalFormatType +uid: excel!Excel.ConditionalFormatType:enum +package: excel! +fullName: Excel.ConditionalFormatType +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-advanced.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + queueCommandsToClearAllConditionalFormats(sheet); + + const temperatureDataRange = sheet.tables.getItem("TemperatureTable").getDataBodyRange(); + + /* When the priority property of ConditionalFormat objects + is not explicitly set, they are prioritized in the order + that they are added, with zero-based numbering: 0, 1, ... + Contradictions are resolved in favor of the format with + the lower priority number. In the example below, negative + numbers will get a green background, but NOT a blue font, + because priority goes to the format that gives them a red font. + */ + + // Set low numbers to bold, dark red font. This format will + // get priority 0. + const presetFormat = temperatureDataRange.conditionalFormats + .add(Excel.ConditionalFormatType.presetCriteria); + presetFormat.preset.format.font.color = "red"; + presetFormat.preset.format.font.bold = true; + presetFormat.preset.rule = { criterion: Excel.ConditionalFormatPresetCriterion.oneStdDevBelowAverage }; + + // Set negative numbers to blue font with green background. + // This format will get priority 1. + const cellValueFormat = temperatureDataRange.conditionalFormats + .add(Excel.ConditionalFormatType.cellValue); + cellValueFormat.cellValue.format.font.color = "blue"; + cellValueFormat.cellValue.format.fill.color = "lightgreen"; + cellValueFormat.cellValue.rule = { formula1: "=0", operator: "LessThan" }; + + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: cellValue + uid: excel!Excel.ConditionalFormatType.cellValue:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"CellValue"' + - name: colorScale + uid: excel!Excel.ConditionalFormatType.colorScale:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ColorScale"' + - name: containsText + uid: excel!Excel.ConditionalFormatType.containsText:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ContainsText"' + - name: custom + uid: excel!Excel.ConditionalFormatType.custom:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Custom"' + - name: dataBar + uid: excel!Excel.ConditionalFormatType.dataBar:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"DataBar"' + - name: iconSet + uid: excel!Excel.ConditionalFormatType.iconSet:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"IconSet"' + - name: presetCriteria + uid: excel!Excel.ConditionalFormatType.presetCriteria:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"PresetCriteria"' + - name: topBottom + uid: excel!Excel.ConditionalFormatType.topBottom:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"TopBottom"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionaliconcriterion.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionaliconcriterion.yml new file mode 100644 index 0000000000..7aaa77f926 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionaliconcriterion.yml @@ -0,0 +1,241 @@ +### YamlMime:TSType +name: Excel.ConditionalIconCriterion +uid: excel!Excel.ConditionalIconCriterion:interface +package: excel! +fullName: Excel.ConditionalIconCriterion +summary: >- + Represents an icon criterion which contains a type, value, an operator, and an + optional custom icon, if not using an icon set. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: customIcon + uid: excel!Excel.ConditionalIconCriterion#customIcon:member + package: excel! + fullName: customIcon + summary: >- + The custom icon for the current criterion, if different from the default + icon set, else `null` will be returned. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'customIcon?: Excel.Icon;' + return: + type: + - name: formula + uid: excel!Excel.ConditionalIconCriterion#formula:member + package: excel! + fullName: formula + summary: A number or a formula depending on the type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const range = sheet.getRange("B8:E13"); + const conditionalFormat = range.conditionalFormats + .add(Excel.ConditionalFormatType.iconSet); + const iconSetCF = conditionalFormat.iconSet; + iconSetCF.style = Excel.IconSet.threeTriangles; + + /* + The iconSetCF.criteria array is automatically prepopulated with + criterion elements whose properties have been given default settings. + You can't write to each property of a criterion directly. Instead, + replace the whole criteria object. + + With a "three*" icon set style, such as "threeTriangles", the third + element in the criteria array (criteria[2]) defines the "top" icon; + e.g., a green triangle. The second (criteria[1]) defines the "middle" + icon. The first (criteria[0]) defines the "low" icon, but it + can often be left empty as the following object shows, because every + cell that does not match the other two criteria always gets the low + icon. + */ + iconSetCF.criteria = [ + {} as any, + { + type: Excel.ConditionalFormatIconRuleType.number, + operator: Excel.ConditionalIconCriterionOperator.greaterThanOrEqual, + formula: "=700" + }, + { + type: Excel.ConditionalFormatIconRuleType.number, + operator: Excel.ConditionalIconCriterionOperator.greaterThanOrEqual, + formula: "=1000", + } + ]; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'formula: string;' + return: + type: string + - name: operator + uid: excel!Excel.ConditionalIconCriterion#operator:member + package: excel! + fullName: operator + summary: >- + `greaterThan` or `greaterThanOrEqual` for each of the rule types for the + icon conditional format. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const range = sheet.getRange("B8:E13"); + const conditionalFormat = range.conditionalFormats + .add(Excel.ConditionalFormatType.iconSet); + const iconSetCF = conditionalFormat.iconSet; + iconSetCF.style = Excel.IconSet.threeTriangles; + + /* + The iconSetCF.criteria array is automatically prepopulated with + criterion elements whose properties have been given default settings. + You can't write to each property of a criterion directly. Instead, + replace the whole criteria object. + + With a "three*" icon set style, such as "threeTriangles", the third + element in the criteria array (criteria[2]) defines the "top" icon; + e.g., a green triangle. The second (criteria[1]) defines the "middle" + icon. The first (criteria[0]) defines the "low" icon, but it + can often be left empty as the following object shows, because every + cell that does not match the other two criteria always gets the low + icon. + */ + iconSetCF.criteria = [ + {} as any, + { + type: Excel.ConditionalFormatIconRuleType.number, + operator: Excel.ConditionalIconCriterionOperator.greaterThanOrEqual, + formula: "=700" + }, + { + type: Excel.ConditionalFormatIconRuleType.number, + operator: Excel.ConditionalIconCriterionOperator.greaterThanOrEqual, + formula: "=1000", + } + ]; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + operator: Excel.ConditionalIconCriterionOperator | "Invalid" | + "GreaterThan" | "GreaterThanOrEqual"; + return: + type: >- + | + "Invalid" | "GreaterThan" | "GreaterThanOrEqual" + - name: type + uid: excel!Excel.ConditionalIconCriterion#type:member + package: excel! + fullName: type + summary: What the icon conditional formula should be based on. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const range = sheet.getRange("B8:E13"); + const conditionalFormat = range.conditionalFormats + .add(Excel.ConditionalFormatType.iconSet); + const iconSetCF = conditionalFormat.iconSet; + iconSetCF.style = Excel.IconSet.threeTriangles; + + /* + The iconSetCF.criteria array is automatically prepopulated with + criterion elements whose properties have been given default settings. + You can't write to each property of a criterion directly. Instead, + replace the whole criteria object. + + With a "three*" icon set style, such as "threeTriangles", the third + element in the criteria array (criteria[2]) defines the "top" icon; + e.g., a green triangle. The second (criteria[1]) defines the "middle" + icon. The first (criteria[0]) defines the "low" icon, but it + can often be left empty as the following object shows, because every + cell that does not match the other two criteria always gets the low + icon. + */ + iconSetCF.criteria = [ + {} as any, + { + type: Excel.ConditionalFormatIconRuleType.number, + operator: Excel.ConditionalIconCriterionOperator.greaterThanOrEqual, + formula: "=700" + }, + { + type: Excel.ConditionalFormatIconRuleType.number, + operator: Excel.ConditionalIconCriterionOperator.greaterThanOrEqual, + formula: "=1000", + } + ]; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + type: Excel.ConditionalFormatIconRuleType | "Invalid" | "Number" | + "Percent" | "Formula" | "Percentile"; + return: + type: >- + | + "Invalid" | "Number" | "Percent" | "Formula" | "Percentile" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionaliconcriterionoperator.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionaliconcriterionoperator.yml new file mode 100644 index 0000000000..7b1130cd1b --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionaliconcriterionoperator.yml @@ -0,0 +1,85 @@ +### YamlMime:TSEnum +name: Excel.ConditionalIconCriterionOperator +uid: excel!Excel.ConditionalIconCriterionOperator:enum +package: excel! +fullName: Excel.ConditionalIconCriterionOperator +summary: Represents the operator for each icon criteria. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const range = sheet.getRange("B8:E13"); + const conditionalFormat = range.conditionalFormats + .add(Excel.ConditionalFormatType.iconSet); + const iconSetCF = conditionalFormat.iconSet; + iconSetCF.style = Excel.IconSet.threeTriangles; + + /* + The iconSetCF.criteria array is automatically prepopulated with + criterion elements whose properties have been given default settings. + You can't write to each property of a criterion directly. Instead, + replace the whole criteria object. + + With a "three*" icon set style, such as "threeTriangles", the third + element in the criteria array (criteria[2]) defines the "top" icon; + e.g., a green triangle. The second (criteria[1]) defines the "middle" + icon. The first (criteria[0]) defines the "low" icon, but it + can often be left empty as the following object shows, because every + cell that does not match the other two criteria always gets the low + icon. + */ + iconSetCF.criteria = [ + {} as any, + { + type: Excel.ConditionalFormatIconRuleType.number, + operator: Excel.ConditionalIconCriterionOperator.greaterThanOrEqual, + formula: "=700" + }, + { + type: Excel.ConditionalFormatIconRuleType.number, + operator: Excel.ConditionalIconCriterionOperator.greaterThanOrEqual, + formula: "=1000", + } + ]; + + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: greaterThan + uid: excel!Excel.ConditionalIconCriterionOperator.greaterThan:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"GreaterThan"' + - name: greaterThanOrEqual + uid: excel!Excel.ConditionalIconCriterionOperator.greaterThanOrEqual:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"GreaterThanOrEqual"' + - name: invalid + uid: excel!Excel.ConditionalIconCriterionOperator.invalid:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Invalid"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalpresetcriteriarule.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalpresetcriteriarule.yml new file mode 100644 index 0000000000..f04f54a9e0 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalpresetcriteriarule.yml @@ -0,0 +1,70 @@ +### YamlMime:TSType +name: Excel.ConditionalPresetCriteriaRule +uid: excel!Excel.ConditionalPresetCriteriaRule:interface +package: excel! +fullName: Excel.ConditionalPresetCriteriaRule +summary: Represents the preset criteria conditional format rule. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: criterion + uid: excel!Excel.ConditionalPresetCriteriaRule#criterion:member + package: excel! + fullName: criterion + summary: The criterion of the conditional format. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const range = sheet.getRange("B2:M5"); + const conditionalFormat = range.conditionalFormats + .add(Excel.ConditionalFormatType.presetCriteria); + conditionalFormat.preset.format.font.color = "white"; + conditionalFormat.preset.rule = { criterion: Excel.ConditionalFormatPresetCriterion.oneStdDevAboveAverage }; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + criterion: Excel.ConditionalFormatPresetCriterion | "Invalid" | "Blanks" + | "NonBlanks" | "Errors" | "NonErrors" | "Yesterday" | "Today" | + "Tomorrow" | "LastSevenDays" | "LastWeek" | "ThisWeek" | "NextWeek" | + "LastMonth" | "ThisMonth" | "NextMonth" | "AboveAverage" | + "BelowAverage" | "EqualOrAboveAverage" | "EqualOrBelowAverage" | + "OneStdDevAboveAverage" | "OneStdDevBelowAverage" | + "TwoStdDevAboveAverage" | "TwoStdDevBelowAverage" | + "ThreeStdDevAboveAverage" | "ThreeStdDevBelowAverage" | "UniqueValues" | + "DuplicateValues"; + return: + type: >- + | + "Invalid" | "Blanks" | "NonBlanks" | "Errors" | "NonErrors" | + "Yesterday" | "Today" | "Tomorrow" | "LastSevenDays" | "LastWeek" | + "ThisWeek" | "NextWeek" | "LastMonth" | "ThisMonth" | "NextMonth" | + "AboveAverage" | "BelowAverage" | "EqualOrAboveAverage" | + "EqualOrBelowAverage" | "OneStdDevAboveAverage" | + "OneStdDevBelowAverage" | "TwoStdDevAboveAverage" | + "TwoStdDevBelowAverage" | "ThreeStdDevAboveAverage" | + "ThreeStdDevBelowAverage" | "UniqueValues" | "DuplicateValues" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalrangeborder.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalrangeborder.yml new file mode 100644 index 0000000000..8c0030acfb --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalrangeborder.yml @@ -0,0 +1,247 @@ +### YamlMime:TSType +name: Excel.ConditionalRangeBorder +uid: excel!Excel.ConditionalRangeBorder:class +package: excel! +fullName: Excel.ConditionalRangeBorder +summary: Represents the border of an object. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: color + uid: excel!Excel.ConditionalRangeBorder#color:member + package: excel! + fullName: color + summary: >- + HTML color code representing the color of the border line, in the form + \#RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color: string;' + return: + type: string + - name: context + uid: excel!Excel.ConditionalRangeBorder#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: sideIndex + uid: excel!Excel.ConditionalRangeBorder#sideIndex:member + package: excel! + fullName: sideIndex + summary: >- + Constant value that indicates the specific side of the border. See + `Excel.ConditionalRangeBorderIndex` for details. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly sideIndex: Excel.ConditionalRangeBorderIndex | "EdgeTop" | + "EdgeBottom" | "EdgeLeft" | "EdgeRight"; + return: + type: >- + | + "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight" + - name: style + uid: excel!Excel.ConditionalRangeBorder#style:member + package: excel! + fullName: style + summary: >- + One of the constants of line style specifying the line style for the + border. See `Excel.BorderLineStyle` for details. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + style: Excel.ConditionalRangeBorderLineStyle | "None" | "Continuous" | + "Dash" | "DashDot" | "DashDotDot" | "Dot"; + return: + type: >- + | + "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot" +methods: + - name: load(options) + uid: excel!Excel.ConditionalRangeBorder#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ConditionalRangeBorderLoadOptions): + Excel.ConditionalRangeBorder; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ConditionalRangeBorder#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ConditionalRangeBorder;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ConditionalRangeBorder#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ConditionalRangeBorder; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ConditionalRangeBorder#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ConditionalRangeBorderUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ConditionalRangeBorder#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ConditionalRangeBorder): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ConditionalRangeBorder#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.ConditionalRangeBorder` object is an API object, the `toJSON` + method returns a plain JavaScript object (typed as + `Excel.Interfaces.ConditionalRangeBorderData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ConditionalRangeBorderData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalrangebordercollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalrangebordercollection.yml new file mode 100644 index 0000000000..be4b30331c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalrangebordercollection.yml @@ -0,0 +1,291 @@ +### YamlMime:TSType +name: Excel.ConditionalRangeBorderCollection +uid: excel!Excel.ConditionalRangeBorderCollection:class +package: excel! +fullName: Excel.ConditionalRangeBorderCollection +summary: Represents the border objects that make up range border. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: bottom + uid: excel!Excel.ConditionalRangeBorderCollection#bottom:member + package: excel! + fullName: bottom + summary: Gets the bottom border. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly bottom: Excel.ConditionalRangeBorder;' + return: + type: + - name: context + uid: excel!Excel.ConditionalRangeBorderCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: count + uid: excel!Excel.ConditionalRangeBorderCollection#count:member + package: excel! + fullName: count + summary: Number of border objects in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly count: number;' + return: + type: number + - name: items + uid: excel!Excel.ConditionalRangeBorderCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.ConditionalRangeBorder[];' + return: + type: [] + - name: left + uid: excel!Excel.ConditionalRangeBorderCollection#left:member + package: excel! + fullName: left + summary: Gets the left border. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly left: Excel.ConditionalRangeBorder;' + return: + type: + - name: right + uid: excel!Excel.ConditionalRangeBorderCollection#right:member + package: excel! + fullName: right + summary: Gets the right border. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly right: Excel.ConditionalRangeBorder;' + return: + type: + - name: top + uid: excel!Excel.ConditionalRangeBorderCollection#top:member + package: excel! + fullName: top + summary: Gets the top border. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly top: Excel.ConditionalRangeBorder;' + return: + type: +methods: + - name: getItem(index) + uid: excel!Excel.ConditionalRangeBorderCollection#getItem:member(1) + package: excel! + fullName: getItem(index) + summary: Gets a border object using its name. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + getItem(index: Excel.ConditionalRangeBorderIndex): + Excel.ConditionalRangeBorder; + parameters: + - id: index + description: >- + Index value of the border object to be retrieved. See + `Excel.ConditionalRangeBorderIndex` for details. + type: + return: + type: + description: '' + - name: getItem(index) + uid: excel!Excel.ConditionalRangeBorderCollection#getItem:member(2) + package: excel! + fullName: getItem(index) + summary: Gets a border object using its name. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + getItem(index: "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight"): + Excel.ConditionalRangeBorder; + parameters: + - id: index + description: >- + Index value of the border object to be retrieved. See + `Excel.ConditionalRangeBorderIndex` for details. + type: '"EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight"' + return: + type: + description: '' + - name: getItemAt(index) + uid: excel!Excel.ConditionalRangeBorderCollection#getItemAt:member(1) + package: excel! + fullName: getItemAt(index) + summary: Gets a border object using its index. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemAt(index: number): Excel.ConditionalRangeBorder;' + parameters: + - id: index + description: Index value of the object to be retrieved. Zero-indexed. + type: number + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.ConditionalRangeBorderCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: + Excel.Interfaces.ConditionalRangeBorderCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): + Excel.ConditionalRangeBorderCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ConditionalRangeBorderCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNames?: string | string[]): + Excel.ConditionalRangeBorderCollection; + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ConditionalRangeBorderCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.ConditionalRangeBorderCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.ConditionalRangeBorderCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.ConditionalRangeBorderCollection` object is an API object, the + `toJSON` method returns a plain JavaScript object (typed as + `Excel.Interfaces.ConditionalRangeBorderCollectionData`) that + contains an "items" array with shallow copies of any loaded properties + from the collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ConditionalRangeBorderCollectionData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalrangeborderindex.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalrangeborderindex.yml new file mode 100644 index 0000000000..2ff9bf799e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalrangeborderindex.yml @@ -0,0 +1,41 @@ +### YamlMime:TSEnum +name: Excel.ConditionalRangeBorderIndex +uid: excel!Excel.ConditionalRangeBorderIndex:enum +package: excel! +fullName: Excel.ConditionalRangeBorderIndex +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: edgeBottom + uid: excel!Excel.ConditionalRangeBorderIndex.edgeBottom:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"EdgeBottom"' + - name: edgeLeft + uid: excel!Excel.ConditionalRangeBorderIndex.edgeLeft:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"EdgeLeft"' + - name: edgeRight + uid: excel!Excel.ConditionalRangeBorderIndex.edgeRight:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"EdgeRight"' + - name: edgeTop + uid: excel!Excel.ConditionalRangeBorderIndex.edgeTop:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"EdgeTop"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalrangeborderlinestyle.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalrangeborderlinestyle.yml new file mode 100644 index 0000000000..3e09a52c9a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalrangeborderlinestyle.yml @@ -0,0 +1,55 @@ +### YamlMime:TSEnum +name: Excel.ConditionalRangeBorderLineStyle +uid: excel!Excel.ConditionalRangeBorderLineStyle:enum +package: excel! +fullName: Excel.ConditionalRangeBorderLineStyle +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: continuous + uid: excel!Excel.ConditionalRangeBorderLineStyle.continuous:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Continuous"' + - name: dash + uid: excel!Excel.ConditionalRangeBorderLineStyle.dash:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Dash"' + - name: dashDot + uid: excel!Excel.ConditionalRangeBorderLineStyle.dashDot:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"DashDot"' + - name: dashDotDot + uid: excel!Excel.ConditionalRangeBorderLineStyle.dashDotDot:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"DashDotDot"' + - name: dot + uid: excel!Excel.ConditionalRangeBorderLineStyle.dot:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Dot"' + - name: none + uid: excel!Excel.ConditionalRangeBorderLineStyle.none:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"None"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalrangefill.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalrangefill.yml new file mode 100644 index 0000000000..c357e6d584 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalrangefill.yml @@ -0,0 +1,221 @@ +### YamlMime:TSType +name: Excel.ConditionalRangeFill +uid: excel!Excel.ConditionalRangeFill:class +package: excel! +fullName: Excel.ConditionalRangeFill +summary: Represents the background of a conditional range object. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: color + uid: excel!Excel.ConditionalRangeFill#color:member + package: excel! + fullName: color + summary: >- + HTML color code representing the color of the fill, in the form \#RRGGBB + (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color: string;' + return: + type: string + - name: context + uid: excel!Excel.ConditionalRangeFill#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: +methods: + - name: clear() + uid: excel!Excel.ConditionalRangeFill#clear:member(1) + package: excel! + fullName: clear() + summary: Resets the fill. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'clear(): void;' + return: + type: void + description: '' + - name: load(options) + uid: excel!Excel.ConditionalRangeFill#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ConditionalRangeFillLoadOptions): + Excel.ConditionalRangeFill; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ConditionalRangeFill#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ConditionalRangeFill;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ConditionalRangeFill#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ConditionalRangeFill; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ConditionalRangeFill#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ConditionalRangeFillUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ConditionalRangeFill#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ConditionalRangeFill): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ConditionalRangeFill#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.ConditionalRangeFill` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.ConditionalRangeFillData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ConditionalRangeFillData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalrangefont.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalrangefont.yml new file mode 100644 index 0000000000..bb3719d611 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalrangefont.yml @@ -0,0 +1,289 @@ +### YamlMime:TSType +name: Excel.ConditionalRangeFont +uid: excel!Excel.ConditionalRangeFont:class +package: excel! +fullName: Excel.ConditionalRangeFont +summary: >- + This object represents the font attributes (font style, color, etc.) for an + object. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: bold + uid: excel!Excel.ConditionalRangeFont#bold:member + package: excel! + fullName: bold + summary: Specifies if the font is bold. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'bold: boolean;' + return: + type: boolean + - name: color + uid: excel!Excel.ConditionalRangeFont#color:member + package: excel! + fullName: color + summary: >- + HTML color code representation of the text color (e.g., \#FF0000 + represents Red). + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color: string;' + return: + type: string + - name: context + uid: excel!Excel.ConditionalRangeFont#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: italic + uid: excel!Excel.ConditionalRangeFont#italic:member + package: excel! + fullName: italic + summary: Specifies if the font is italic. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'italic: boolean;' + return: + type: boolean + - name: strikethrough + uid: excel!Excel.ConditionalRangeFont#strikethrough:member + package: excel! + fullName: strikethrough + summary: Specifies the strikethrough status of the font. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'strikethrough: boolean;' + return: + type: boolean + - name: underline + uid: excel!Excel.ConditionalRangeFont#underline:member + package: excel! + fullName: underline + summary: >- + The type of underline applied to the font. See + `Excel.ConditionalRangeFontUnderlineStyle` for details. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + underline: Excel.ConditionalRangeFontUnderlineStyle | "None" | "Single" + | "Double"; + return: + type: >- + | + "None" | "Single" | "Double" +methods: + - name: clear() + uid: excel!Excel.ConditionalRangeFont#clear:member(1) + package: excel! + fullName: clear() + summary: Resets the font formats. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'clear(): void;' + return: + type: void + description: '' + - name: load(options) + uid: excel!Excel.ConditionalRangeFont#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ConditionalRangeFontLoadOptions): + Excel.ConditionalRangeFont; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ConditionalRangeFont#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ConditionalRangeFont;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ConditionalRangeFont#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ConditionalRangeFont; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ConditionalRangeFont#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ConditionalRangeFontUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ConditionalRangeFont#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ConditionalRangeFont): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ConditionalRangeFont#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.ConditionalRangeFont` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.ConditionalRangeFontData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ConditionalRangeFontData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalrangefontunderlinestyle.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalrangefontunderlinestyle.yml new file mode 100644 index 0000000000..9b43a9d3f0 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalrangefontunderlinestyle.yml @@ -0,0 +1,34 @@ +### YamlMime:TSEnum +name: Excel.ConditionalRangeFontUnderlineStyle +uid: excel!Excel.ConditionalRangeFontUnderlineStyle:enum +package: excel! +fullName: Excel.ConditionalRangeFontUnderlineStyle +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: double + uid: excel!Excel.ConditionalRangeFontUnderlineStyle.double:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Double"' + - name: none + uid: excel!Excel.ConditionalRangeFontUnderlineStyle.none:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"None"' + - name: single + uid: excel!Excel.ConditionalRangeFontUnderlineStyle.single:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Single"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalrangeformat.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalrangeformat.yml new file mode 100644 index 0000000000..f4182060c9 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionalrangeformat.yml @@ -0,0 +1,275 @@ +### YamlMime:TSType +name: Excel.ConditionalRangeFormat +uid: excel!Excel.ConditionalRangeFormat:class +package: excel! +fullName: Excel.ConditionalRangeFormat +summary: >- + A format object encapsulating the conditional formats range's font, fill, + borders, and other properties. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: borders + uid: excel!Excel.ConditionalRangeFormat#borders:member + package: excel! + fullName: borders + summary: >- + Collection of border objects that apply to the overall conditional format + range. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly borders: Excel.ConditionalRangeBorderCollection;' + return: + type: + - name: context + uid: excel!Excel.ConditionalRangeFormat#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: fill + uid: excel!Excel.ConditionalRangeFormat#fill:member + package: excel! + fullName: fill + summary: Returns the fill object defined on the overall conditional format range. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly fill: Excel.ConditionalRangeFill;' + return: + type: + - name: font + uid: excel!Excel.ConditionalRangeFormat#font:member + package: excel! + fullName: font + summary: Returns the font object defined on the overall conditional format range. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly font: Excel.ConditionalRangeFont;' + return: + type: + - name: numberFormat + uid: excel!Excel.ConditionalRangeFormat#numberFormat:member + package: excel! + fullName: numberFormat + summary: >- + Represents Excel's number format code for the given range. For more + information about Excel number formatting, see [Number format + codes](https://support.microsoft.com/office/5026bbd6-04bc-48cd-bf33-80f18b4eae68). Cleared if `null` is passed in. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat: any;' + return: + type: any +methods: + - name: clearFormat() + uid: excel!Excel.ConditionalRangeFormat#clearFormat:member(1) + 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 + 1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'clearFormat(): void;' + return: + type: void + description: '' + - name: load(options) + uid: excel!Excel.ConditionalRangeFormat#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ConditionalRangeFormatLoadOptions): + Excel.ConditionalRangeFormat; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ConditionalRangeFormat#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ConditionalRangeFormat;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ConditionalRangeFormat#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ConditionalRangeFormat; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ConditionalRangeFormat#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ConditionalRangeFormatUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ConditionalRangeFormat#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ConditionalRangeFormat): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ConditionalRangeFormat#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.ConditionalRangeFormat` object is an API object, the `toJSON` + method returns a plain JavaScript object (typed as + `Excel.Interfaces.ConditionalRangeFormatData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ConditionalRangeFormatData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionaltextcomparisonrule.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionaltextcomparisonrule.yml new file mode 100644 index 0000000000..6491b8333a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionaltextcomparisonrule.yml @@ -0,0 +1,71 @@ +### YamlMime:TSType +name: Excel.ConditionalTextComparisonRule +uid: excel!Excel.ConditionalTextComparisonRule:interface +package: excel! +fullName: Excel.ConditionalTextComparisonRule +summary: Represents a cell value conditional format rule. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: operator + uid: excel!Excel.ConditionalTextComparisonRule#operator:member + package: excel! + fullName: operator + summary: The operator of the text conditional format. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + operator: Excel.ConditionalTextOperator | "Invalid" | "Contains" | + "NotContains" | "BeginsWith" | "EndsWith"; + return: + type: >- + | "Invalid" | + "Contains" | "NotContains" | "BeginsWith" | "EndsWith" + - name: text + uid: excel!Excel.ConditionalTextComparisonRule#text:member + package: excel! + fullName: text + summary: The text value of the conditional format. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const range = sheet.getRange("B16:D18"); + const conditionalFormat = range.conditionalFormats + .add(Excel.ConditionalFormatType.containsText); + conditionalFormat.textComparison.format.font.color = "red"; + conditionalFormat.textComparison.rule = { operator: Excel.ConditionalTextOperator.contains, text: "Delayed" }; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'text: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionaltextoperator.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionaltextoperator.yml new file mode 100644 index 0000000000..111152fa28 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionaltextoperator.yml @@ -0,0 +1,71 @@ +### YamlMime:TSEnum +name: Excel.ConditionalTextOperator +uid: excel!Excel.ConditionalTextOperator:enum +package: excel! +fullName: Excel.ConditionalTextOperator +summary: Represents the operator of the text conditional format type. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const range = sheet.getRange("B16:D18"); + const conditionalFormat = range.conditionalFormats + .add(Excel.ConditionalFormatType.containsText); + conditionalFormat.textComparison.format.font.color = "red"; + conditionalFormat.textComparison.rule = { operator: Excel.ConditionalTextOperator.contains, text: "Delayed" }; + + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: beginsWith + uid: excel!Excel.ConditionalTextOperator.beginsWith:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"BeginsWith"' + - name: contains + uid: excel!Excel.ConditionalTextOperator.contains:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Contains"' + - name: endsWith + uid: excel!Excel.ConditionalTextOperator.endsWith:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"EndsWith"' + - name: invalid + uid: excel!Excel.ConditionalTextOperator.invalid:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Invalid"' + - name: notContains + uid: excel!Excel.ConditionalTextOperator.notContains:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"NotContains"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionaltopbottomcriteriontype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionaltopbottomcriteriontype.yml new file mode 100644 index 0000000000..407eca344d --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionaltopbottomcriteriontype.yml @@ -0,0 +1,48 @@ +### YamlMime:TSEnum +name: Excel.ConditionalTopBottomCriterionType +uid: excel!Excel.ConditionalTopBottomCriterionType:enum +package: excel! +fullName: Excel.ConditionalTopBottomCriterionType +summary: Represents the criteria for the above/below average conditional format type. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: bottomItems + uid: excel!Excel.ConditionalTopBottomCriterionType.bottomItems:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"BottomItems"' + - name: bottomPercent + uid: excel!Excel.ConditionalTopBottomCriterionType.bottomPercent:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"BottomPercent"' + - name: invalid + uid: excel!Excel.ConditionalTopBottomCriterionType.invalid:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Invalid"' + - name: topItems + uid: excel!Excel.ConditionalTopBottomCriterionType.topItems:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"TopItems"' + - name: topPercent + uid: excel!Excel.ConditionalTopBottomCriterionType.topPercent:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"TopPercent"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionaltopbottomrule.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionaltopbottomrule.yml new file mode 100644 index 0000000000..a5c67100b9 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.conditionaltopbottomrule.yml @@ -0,0 +1,51 @@ +### YamlMime:TSType +name: Excel.ConditionalTopBottomRule +uid: excel!Excel.ConditionalTopBottomRule:interface +package: excel! +fullName: Excel.ConditionalTopBottomRule +summary: Represents the rule of the top/bottom conditional format. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: rank + uid: excel!Excel.ConditionalTopBottomRule#rank:member + package: excel! + fullName: rank + summary: >- + The rank between 1 and 1000 for numeric ranks or 1 and 100 for percent + ranks. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rank: number;' + return: + type: number + - name: type + uid: excel!Excel.ConditionalTopBottomRule#type:member + package: excel! + fullName: type + summary: Format values based on the top or bottom rank. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + type: Excel.ConditionalTopBottomCriterionType | "Invalid" | "TopItems" | + "TopPercent" | "BottomItems" | "BottomPercent"; + return: + type: >- + | + "Invalid" | "TopItems" | "TopPercent" | "BottomItems" | + "BottomPercent" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.connecterrorcellvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.connecterrorcellvalue.yml new file mode 100644 index 0000000000..5e90afad3e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.connecterrorcellvalue.yml @@ -0,0 +1,120 @@ +### YamlMime:TSType +name: Excel.ConnectErrorCellValue +uid: excel!Excel.ConnectErrorCellValue:interface +package: excel! +fullName: Excel.ConnectErrorCellValue +summary: Represents the value of a cell containing a \#CONNECT! error. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: basicType + uid: excel!Excel.ConnectErrorCellValue#basicType:member + package: excel! + fullName: basicType + summary: >- + Represents the value that would be returned by `Range.valueTypes` for a + cell with this value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicType?: RangeValueType.error | "Error";' + return: + type: | "Error" + - name: basicValue + uid: excel!Excel.ConnectErrorCellValue#basicValue:member + package: excel! + fullName: basicValue + summary: >- + Represents the value that would be returned by `Range.values` for a cell + with this value. When accessed through a `valuesAsJson` property, this + string value aligns with the en-US locale. When accessed through a + `valuesAsJsonLocal` property, this string value aligns with the user's + display locale. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicValue?: "#CONNECT!" | string;' + return: + type: '"#CONNECT!" | string' + - name: errorSubType + uid: excel!Excel.ConnectErrorCellValue#errorSubType:member + package: excel! + fullName: errorSubType + summary: Represents the type of `ConnectErrorCellValue`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + errorSubType?: ConnectErrorCellValueSubType | "Unknown" | "ServiceError" + | "ExternalLinks" | "ExternalLinksNonCloudLocation" | + "DataTypeNoConnection" | "DataTypeServiceError" | "MissingContent" | + "RequestThrottle" | "ExternalLinksFailedToRefresh" | + "ExternalLinksAccessFailed" | "ExternalLinksServerError" | + "ExternalLinksInvalidRequest" | "ExternalLinksUnAuthenticated" | + "ExternalLinksThrottledByHost" | "ExternalLinksFileTooLarge" | + "OutdatedLinkedEntity" | "GenericServerError"; + return: + type: >- + | + "Unknown" | "ServiceError" | "ExternalLinks" | + "ExternalLinksNonCloudLocation" | "DataTypeNoConnection" | + "DataTypeServiceError" | "MissingContent" | "RequestThrottle" | + "ExternalLinksFailedToRefresh" | "ExternalLinksAccessFailed" | + "ExternalLinksServerError" | "ExternalLinksInvalidRequest" | + "ExternalLinksUnAuthenticated" | "ExternalLinksThrottledByHost" | + "ExternalLinksFileTooLarge" | "OutdatedLinkedEntity" | + "GenericServerError" + - name: errorType + uid: excel!Excel.ConnectErrorCellValue#errorType:member + package: excel! + fullName: errorType + summary: Represents the type of `ErrorCellValue`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'errorType?: ErrorCellValueType.connect | "Connect";' + return: + type: >- + | + "Connect" + - name: type + uid: excel!Excel.ConnectErrorCellValue#type:member + package: excel! + fullName: type + summary: Represents the type of this cell value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: CellValueType.error | "Error";' + return: + type: | "Error" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.connecterrorcellvaluesubtype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.connecterrorcellvaluesubtype.yml new file mode 100644 index 0000000000..5bfab0db3f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.connecterrorcellvaluesubtype.yml @@ -0,0 +1,222 @@ +### YamlMime:TSEnum +name: Excel.ConnectErrorCellValueSubType +uid: excel!Excel.ConnectErrorCellValueSubType:enum +package: excel! +fullName: Excel.ConnectErrorCellValueSubType +summary: Represents types of \#CONNECT! errors. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: dataTypeNoConnection + uid: excel!Excel.ConnectErrorCellValueSubType.dataTypeNoConnection:member + package: excel! + summary: >- + An error caused by no service connection for linked data types. Displays + as error type \#CONNECT! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"DataTypeNoConnection"' + - name: dataTypeServiceError + uid: excel!Excel.ConnectErrorCellValueSubType.dataTypeServiceError:member + package: excel! + summary: >- + An error caused by an issue in the service for linked data types. Displays + as error type \#CONNECT! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"DataTypeServiceError"' + - name: externalLinks + uid: excel!Excel.ConnectErrorCellValueSubType.externalLinks:member + package: excel! + summary: >- + An error caused by an issue with the external links. Displays as error + type \#CONNECT! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ExternalLinks"' + - name: externalLinksAccessFailed + uid: excel!Excel.ConnectErrorCellValueSubType.externalLinksAccessFailed:member + package: excel! + summary: >- + An error caused by a failure to access external links. Displays as error + type \#CONNECT! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ExternalLinksAccessFailed"' + - name: externalLinksFailedToRefresh + uid: >- + excel!Excel.ConnectErrorCellValueSubType.externalLinksFailedToRefresh:member + package: excel! + summary: >- + An error caused by external links failing to refresh. Displays as error + type \#CONNECT! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ExternalLinksFailedToRefresh"' + - name: externalLinksFileTooLarge + uid: excel!Excel.ConnectErrorCellValueSubType.externalLinksFileTooLarge:member + package: excel! + summary: >- + An error caused by an external link to a file which exceeds file size + capacity. Displays as error type \#CONNECT! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ExternalLinksFileTooLarge"' + - name: externalLinksInvalidRequest + uid: >- + excel!Excel.ConnectErrorCellValueSubType.externalLinksInvalidRequest:member + package: excel! + summary: >- + An error caused by an invalid request while resolving an external link. + Displays as error type \#CONNECT! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ExternalLinksInvalidRequest"' + - name: externalLinksNonCloudLocation + uid: >- + excel!Excel.ConnectErrorCellValueSubType.externalLinksNonCloudLocation:member + package: excel! + summary: >- + An error caused by an external link to a non-cloud location, such as a + link to an Excel file that is saved to a local computer instead of to a + cloud location. Displays as error type \#CONNECT! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ExternalLinksNonCloudLocation"' + - name: externalLinksServerError + uid: excel!Excel.ConnectErrorCellValueSubType.externalLinksServerError:member + package: excel! + summary: >- + An error caused by a server error while resolving an external link. + Displays as error type \#CONNECT! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ExternalLinksServerError"' + - name: externalLinksThrottledByHost + uid: >- + excel!Excel.ConnectErrorCellValueSubType.externalLinksThrottledByHost:member + package: excel! + summary: >- + An error caused by throttling from an external link host. Displays as + error type \#CONNECT! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ExternalLinksThrottledByHost"' + - name: externalLinksUnAuthenticated + uid: >- + excel!Excel.ConnectErrorCellValueSubType.externalLinksUnAuthenticated:member + package: excel! + summary: >- + An error caused by a lack of authentication for external links. Displays + as error type \#CONNECT! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ExternalLinksUnAuthenticated"' + - name: genericServerError + uid: excel!Excel.ConnectErrorCellValueSubType.genericServerError:member + package: excel! + summary: >- + An error caused by an error returned from the server. Displays as error + type \#CONNECT! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"GenericServerError"' + - name: missingContent + uid: excel!Excel.ConnectErrorCellValueSubType.missingContent:member + package: excel! + summary: >- + An error caused by missing content. Displays as error type \#CONNECT! in + Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"MissingContent"' + - name: outdatedLinkedEntity + uid: excel!Excel.ConnectErrorCellValueSubType.outdatedLinkedEntity:member + package: excel! + summary: >- + An error caused by an outdated linked entity. Displays as error type + \#CONNECT! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"OutdatedLinkedEntity"' + - name: requestThrottle + uid: excel!Excel.ConnectErrorCellValueSubType.requestThrottle:member + package: excel! + summary: >- + An error caused by request throttling. Displays as error type \#CONNECT! + in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"RequestThrottle"' + - name: serviceError + uid: excel!Excel.ConnectErrorCellValueSubType.serviceError:member + package: excel! + summary: >- + An error caused by a problem with the service. Displays as error type + \#CONNECT! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ServiceError"' + - name: unknown + uid: excel!Excel.ConnectErrorCellValueSubType.unknown:member + package: excel! + summary: >- + An unknown type of error. Displays as error type \#CONNECT! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Unknown"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.connectortype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.connectortype.yml new file mode 100644 index 0000000000..12b7ed2f8f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.connectortype.yml @@ -0,0 +1,53 @@ +### YamlMime:TSEnum +name: Excel.ConnectorType +uid: excel!Excel.ConnectorType:enum +package: excel! +fullName: Excel.ConnectorType +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-lines.yaml + + + await Excel.run(async (context) => { + const shapes = context.workbook.worksheets.getItem("Shapes").shapes; + const line = shapes.addLine(200, 50, 300, 150, Excel.ConnectorType.straight); + line.name = "StraightLine"; + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: curve + uid: excel!Excel.ConnectorType.curve:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Curve"' + - name: elbow + uid: excel!Excel.ConnectorType.elbow:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Elbow"' + - name: straight + uid: excel!Excel.ConnectorType.straight:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Straight"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.contenttype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.contenttype.yml new file mode 100644 index 0000000000..e6474311b3 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.contenttype.yml @@ -0,0 +1,67 @@ +### YamlMime:TSEnum +name: Excel.ContentType +uid: excel!Excel.ContentType:enum +package: excel! +fullName: Excel.ContentType +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/comment-mentions.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Comments"); + const mention = { + email: "kakri@contoso.com", + id: 0, + name: "Kate Kristensen" + }; + + // This will tag the mention's name using the '@' syntax. + // They will be notified via email. + const commentBody = { + mentions: [mention], + richContent: '' + mention.name + " - Can you take a look?" + }; + + // Note that an InvalidArgument error will be thrown if multiple cells passed to `comment.add`. + sheet.comments.add("A1", commentBody, Excel.ContentType.mention); + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: mention + uid: excel!Excel.ContentType.mention:member + package: excel! + summary: >- + Comment content containing mentions. + + + * \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Mention"' + - name: plain + uid: excel!Excel.ContentType.plain:member + package: excel! + summary: >- + Indicates a plain format type for the comment content. + + + * \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Plain"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.cultureinfo.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cultureinfo.yml new file mode 100644 index 0000000000..8edf5a1fde --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cultureinfo.yml @@ -0,0 +1,234 @@ +### YamlMime:TSType +name: Excel.CultureInfo +uid: excel!Excel.CultureInfo:class +package: excel! +fullName: Excel.CultureInfo +summary: >- + Provides information based on current system culture settings. This includes + the culture names, number formatting, and other culturally dependent settings. +remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.CultureInfo#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: datetimeFormat + uid: excel!Excel.CultureInfo#datetimeFormat:member + package: excel! + fullName: datetimeFormat + summary: >- + Defines the culturally appropriate format of displaying date and time. + This is based on current system culture settings. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/culture-info-date-time.yaml + + + await Excel.run(async (context) => { + context.application.cultureInfo.datetimeFormat.load([ + "longDatePattern", + "shortDatePattern", + "dateSeparator", + "longTimePattern", + "timeSeparator" + ]); + await context.sync(); + + // Use the cultural settings API to retrieve the user's system date and time settings. + const systemLongDatePattern = context.application.cultureInfo.datetimeFormat.longDatePattern; + const systemShortDatePattern = context.application.cultureInfo.datetimeFormat.shortDatePattern; + const systemDateSeparator = context.application.cultureInfo.datetimeFormat.dateSeparator; + const systemLongTimePattern = context.application.cultureInfo.datetimeFormat.longTimePattern; + const systemTimeSeparator = context.application.cultureInfo.datetimeFormat.timeSeparator; + + // Write the date and time settings in your table. + const sheet = context.workbook.worksheets.getActiveWorksheet(); + const dateTimeData = sheet.getRange("A2:B6"); + dateTimeData.values = [ + ["Long date", systemLongDatePattern], + ["Short date", systemShortDatePattern], + ["Date separator", systemDateSeparator], + ["Long time format", systemLongTimePattern], + ["Time separator", systemTimeSeparator] + ]; + + sheet.tables + .getItemAt(0) + .getRange() + .format.autofitColumns(); + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly datetimeFormat: Excel.DatetimeFormatInfo;' + return: + type: + - name: name + uid: excel!Excel.CultureInfo#name:member + package: excel! + fullName: name + summary: >- + Gets the culture name in the format languagecode2-country/regioncode2 + (e.g., "zh-cn" or "en-us"). This is based on current system settings. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly name: string;' + return: + type: string + - name: numberFormat + uid: excel!Excel.CultureInfo#numberFormat:member + package: excel! + fullName: numberFormat + summary: >- + Defines the culturally appropriate format of displaying numbers. This is + based on current system culture settings. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly numberFormat: Excel.NumberFormatInfo;' + return: + type: +methods: + - name: load(options) + uid: excel!Excel.CultureInfo#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.CultureInfoLoadOptions): + Excel.CultureInfo; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.CultureInfo#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.CultureInfo;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.CultureInfo#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.CultureInfo; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.CultureInfo#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.CultureInfo` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.CultureInfoData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.CultureInfoData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.customconditionalformat.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.customconditionalformat.yml new file mode 100644 index 0000000000..f5c6def465 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.customconditionalformat.yml @@ -0,0 +1,263 @@ +### YamlMime:TSType +name: Excel.CustomConditionalFormat +uid: excel!Excel.CustomConditionalFormat:class +package: excel! +fullName: Excel.CustomConditionalFormat +summary: Represents a custom conditional format type. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.CustomConditionalFormat#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: format + uid: excel!Excel.CustomConditionalFormat#format:member + package: excel! + fullName: format + summary: >- + Returns a format object, encapsulating the conditional formats font, fill, + borders, and other properties. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const range = sheet.getRange("B8:E13"); + const conditionalFormat = range.conditionalFormats.add(Excel.ConditionalFormatType.custom); + conditionalFormat.custom.rule.formula = '=IF(B8>INDIRECT("RC[-1]",0),TRUE)'; + conditionalFormat.custom.format.font.color = "green"; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly format: Excel.ConditionalRangeFormat;' + return: + type: + - name: rule + uid: excel!Excel.CustomConditionalFormat#rule:member + package: excel! + fullName: rule + summary: Specifies the `Rule` object on this conditional format. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + const range = sheet.getRange("A1:A5"); + range.values = [[1], [20], [""], [5], ["test"]]; + const cf = range.conditionalFormats.add(Excel.ConditionalFormatType.custom); + const cfCustom = cf.customOrNullObject; + cfCustom.rule.formula = "=ISBLANK(A1)"; + cfCustom.format.fill.color = "#00FF00"; + await context.sync() + + console.log("Added new custom conditional format highlighting all blank cells."); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly rule: Excel.ConditionalFormatRule;' + return: + type: +methods: + - name: load(options) + uid: excel!Excel.CustomConditionalFormat#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.CustomConditionalFormatLoadOptions): + Excel.CustomConditionalFormat; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.CustomConditionalFormat#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.CustomConditionalFormat;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.CustomConditionalFormat#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.CustomConditionalFormat; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.CustomConditionalFormat#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.CustomConditionalFormatUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.CustomConditionalFormat#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.CustomConditionalFormat): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.CustomConditionalFormat#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.CustomConditionalFormat` object is an API object, the `toJSON` + method returns a plain JavaScript object (typed as + `Excel.Interfaces.CustomConditionalFormatData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.CustomConditionalFormatData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.customdatavalidation.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.customdatavalidation.yml new file mode 100644 index 0000000000..8de6986eac --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.customdatavalidation.yml @@ -0,0 +1,31 @@ +### YamlMime:TSType +name: Excel.CustomDataValidation +uid: excel!Excel.CustomDataValidation:interface +package: excel! +fullName: Excel.CustomDataValidation +summary: Represents the custom data validation criteria. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: formula + uid: excel!Excel.CustomDataValidation#formula:member + package: excel! + fullName: formula + summary: >- + A custom data validation formula. This creates special input rules, such + as preventing duplicates, or limiting the total in a range of cells. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formula: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.customfunctionmanager.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.customfunctionmanager.yml new file mode 100644 index 0000000000..085d0f6fbc --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.customfunctionmanager.yml @@ -0,0 +1,158 @@ +### YamlMime:TSType +name: Excel.CustomFunctionManager +uid: excel!Excel.CustomFunctionManager:class +package: excel! +fullName: Excel.CustomFunctionManager +summary: Manages settings on custom functions. +remarks: >- + \[ [API set: ExcelApi + 1.20](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.CustomFunctionManager#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: +methods: + - name: load(propertyNames) + uid: excel!Excel.CustomFunctionManager#load:member(1) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.CustomFunctionManager;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.CustomFunctionManager#load:member(2) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: >- + \[ [API set: ExcelApi + 1.20](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.CustomFunctionManager; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: newObject(context) + uid: excel!Excel.CustomFunctionManager.newObject:member(1) + package: excel! + fullName: newObject(context) + summary: Create a new instance of the `Excel.CustomFunctionManager` object. + remarks: >- + \[ [API set: ExcelApi + 1.20](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + static newObject(context: OfficeExtension.ClientRequestContext): + Excel.CustomFunctionManager; + parameters: + - id: context + description: '' + type: + return: + type: + description: '' + - name: setVisibility(customFunctionVisibilityOptions) + uid: excel!Excel.CustomFunctionManager.setVisibility:member(1) + package: excel! + fullName: setVisibility(customFunctionVisibilityOptions) + summary: Show or hide custom functions in Excel AutoComplete. + remarks: >- + \[ [API set: ExcelApi + 1.20](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + static setVisibility(customFunctionVisibilityOptions: + Excel.CustomFunctionVisibilityOptions): void; + parameters: + - id: customFunctionVisibilityOptions + description: Specifies which custom functions to show or hide. + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.CustomFunctionManager#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.CustomFunctionManager` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.CustomFunctionManagerData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.CustomFunctionManagerData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.customfunctionvisibilityoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.customfunctionvisibilityoptions.yml new file mode 100644 index 0000000000..69a2c25bc7 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.customfunctionvisibilityoptions.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: Excel.CustomFunctionVisibilityOptions +uid: excel!Excel.CustomFunctionVisibilityOptions:interface +package: excel! +fullName: Excel.CustomFunctionVisibilityOptions +summary: Represents which custom functions to show or hide in Excel AutoComplete. +remarks: >- + \[ [API set: ExcelApi + 1.20](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: hide + uid: excel!Excel.CustomFunctionVisibilityOptions#hide:member + package: excel! + fullName: hide + summary: A list of custom functions to hide from Excel AutoComplete. + remarks: >- + \[ [API set: ExcelApi + 1.20](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'hide?: string[];' + return: + type: string[] + - name: show + uid: excel!Excel.CustomFunctionVisibilityOptions#show:member + package: excel! + fullName: show + summary: A list of custom functions to show in Excel AutoComplete. + remarks: >- + \[ [API set: ExcelApi + 1.20](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'show?: string[];' + return: + type: string[] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.customproperty.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.customproperty.yml new file mode 100644 index 0000000000..93f0208f9c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.customproperty.yml @@ -0,0 +1,255 @@ +### YamlMime:TSType +name: Excel.CustomProperty +uid: excel!Excel.CustomProperty:class +package: excel! +fullName: Excel.CustomProperty +summary: Represents a custom property. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.CustomProperty#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: key + uid: excel!Excel.CustomProperty#key:member + package: excel! + fullName: key + summary: >- + The key of the custom property. The key is limited to 255 characters + outside of Excel on the web (larger keys are automatically trimmed to 255 + characters on other platforms). + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly key: string;' + return: + type: string + - name: type + uid: excel!Excel.CustomProperty#type:member + package: excel! + fullName: type + summary: The type of the value used for the custom property. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly type: Excel.DocumentPropertyType | "Number" | "Boolean" | + "Date" | "String" | "Float"; + return: + type: >- + | "Number" | + "Boolean" | "Date" | "String" | "Float" + - name: value + uid: excel!Excel.CustomProperty#value:member + package: excel! + fullName: value + summary: >- + The value of the custom property. The value is limited to 255 characters + outside of Excel on the web (larger values are automatically trimmed to + 255 characters on other platforms). + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'value: any;' + return: + type: any +methods: + - name: delete() + uid: excel!Excel.CustomProperty#delete:member(1) + package: excel! + fullName: delete() + summary: Deletes the custom property. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'delete(): void;' + return: + type: void + description: '' + - name: load(options) + uid: excel!Excel.CustomProperty#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.CustomPropertyLoadOptions): + Excel.CustomProperty; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.CustomProperty#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.CustomProperty;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.CustomProperty#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.CustomProperty; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.CustomProperty#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.CustomPropertyUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.CustomProperty#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.CustomProperty): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.CustomProperty#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.CustomProperty` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.CustomPropertyData`) that + contains shallow copies of any loaded child properties from the original + object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.CustomPropertyData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.custompropertycollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.custompropertycollection.yml new file mode 100644 index 0000000000..d7d76bc102 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.custompropertycollection.yml @@ -0,0 +1,279 @@ +### YamlMime:TSType +name: Excel.CustomPropertyCollection +uid: excel!Excel.CustomPropertyCollection:class +package: excel! +fullName: Excel.CustomPropertyCollection +summary: Contains the collection of custom properties. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.CustomPropertyCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: excel!Excel.CustomPropertyCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.CustomProperty[];' + return: + type: [] +methods: + - name: add(key, value) + uid: excel!Excel.CustomPropertyCollection#add:member(1) + package: excel! + fullName: add(key, value) + summary: Creates a new or sets an existing custom property. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/26-document/custom-properties.yaml + + + await Excel.run(async (context) => { + // Get the key/value pair from the task pane. + const userKey = document.getElementById("key").textContent; + const userValue = document.getElementById("value").textContent; + + // Add the custom property. + const customDocProperties = context.workbook.properties.custom; + customDocProperties.add(userKey, userValue); + + await context.sync(); + + console.log(`Successfully set custom document property ${userKey}:${userValue}.`); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'add(key: string, value: any): Excel.CustomProperty;' + parameters: + - id: key + description: >- + Required. The custom property's key, which is case-insensitive. The + key is limited to 255 characters outside of Excel on the web (larger + keys are automatically trimmed to 255 characters on other + platforms). + type: string + - id: value + description: >- + Required. The custom property's value. The value is limited to 255 + characters outside of Excel on the web (larger values are + automatically trimmed to 255 characters on other platforms). + type: any + return: + type: + description: '' + - name: deleteAll() + uid: excel!Excel.CustomPropertyCollection#deleteAll:member(1) + package: excel! + fullName: deleteAll() + summary: Deletes all custom properties in this collection. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'deleteAll(): void;' + return: + type: void + description: '' + - name: getCount() + uid: excel!Excel.CustomPropertyCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Gets the count of custom properties. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getItem(key) + uid: excel!Excel.CustomPropertyCollection#getItem:member(1) + package: excel! + fullName: getItem(key) + summary: >- + Gets a custom property object by its key, which is case-insensitive. + Throws an error if the custom property does not exist. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItem(key: string): Excel.CustomProperty;' + parameters: + - id: key + description: The key that identifies the custom property object. + type: string + return: + type: + description: '' + - name: getItemOrNullObject(key) + uid: excel!Excel.CustomPropertyCollection#getItemOrNullObject:member(1) + package: excel! + fullName: getItemOrNullObject(key) + summary: >- + Gets a custom property object by its key, which is case-insensitive. If + the custom property doesn't exist, then this method returns an object with + its `isNullObject` property set to `true`. For further + information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemOrNullObject(key: string): Excel.CustomProperty;' + parameters: + - id: key + description: Required. The key that identifies the custom property object. + type: string + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.CustomPropertyCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.CustomPropertyCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): Excel.CustomPropertyCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.CustomPropertyCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.CustomPropertyCollection;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.CustomPropertyCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.CustomPropertyCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.CustomPropertyCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.CustomPropertyCollection` object is an API object, the `toJSON` + method returns a plain JavaScript object (typed as + `Excel.Interfaces.CustomPropertyCollectionData`) that contains an + "items" array with shallow copies of any loaded properties from the + collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.CustomPropertyCollectionData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.customxmlpart.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.customxmlpart.yml new file mode 100644 index 0000000000..85264f9f8f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.customxmlpart.yml @@ -0,0 +1,349 @@ +### YamlMime:TSType +name: Excel.CustomXmlPart +uid: excel!Excel.CustomXmlPart:class +package: excel! +fullName: Excel.CustomXmlPart +summary: Represents a custom XML part object in a workbook. +remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.CustomXmlPart#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: id + uid: excel!Excel.CustomXmlPart#id:member + package: excel! + fullName: id + summary: The custom XML part's ID. + remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/18-custom-xml-parts/create-set-get-and-delete-custom-xml-parts.yaml + + + await Excel.run(async (context) => { + // You must have the xmlns attribute to populate the + // CustomXml.namespaceUri property. + const originalXml = "JuanHongSally"; + const customXmlPart = context.workbook.customXmlParts.add(originalXml); + customXmlPart.load("id"); + const xmlBlob = customXmlPart.getXml(); + + await context.sync(); + + const readableXml = addLineBreaksToXML(xmlBlob.value); + document.getElementById("display-xml").textContent = readableXml; + + // Store the XML part's ID in a setting. + const settings = context.workbook.settings; + settings.add("ContosoReviewXmlPartId", customXmlPart.id); + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly id: string;' + return: + type: string + - name: namespaceUri + uid: excel!Excel.CustomXmlPart#namespaceUri:member + package: excel! + fullName: namespaceUri + summary: The custom XML part's namespace URI. + remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly namespaceUri: string;' + return: + type: string +methods: + - name: delete() + uid: excel!Excel.CustomXmlPart#delete:member(1) + package: excel! + fullName: delete() + summary: Deletes the custom XML part. + remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/18-custom-xml-parts/create-set-get-and-delete-custom-xml-parts.yaml + + + await Excel.run(async (context) => { + const settings = context.workbook.settings; + const xmlPartIDSetting = settings.getItemOrNullObject("ContosoReviewXmlPartId").load("value"); + await context.sync(); + + if (xmlPartIDSetting.value) { + let customXmlPart = context.workbook.customXmlParts.getItem(xmlPartIDSetting.value); + const xmlBlob = customXmlPart.getXml(); + customXmlPart.delete(); + customXmlPart = context.workbook.customXmlParts.getItemOrNullObject(xmlPartIDSetting.value); + + await context.sync(); + + if (customXmlPart.isNullObject) { + document.getElementById("display-xml").textContent = `The XML part with the id ${xmlPartIDSetting.value} has been deleted.`; + + // Delete the unneeded setting too. + xmlPartIDSetting.delete(); + } else { + const readableXml = addLineBreaksToXML(xmlBlob.value); + const strangeMessage = `This is strange. The XML part with the id ${xmlPartIDSetting.value} has not been deleted:\n${readableXml}` + document.getElementById("display-xml").textContent = strangeMessage; + } + + await context.sync(); + } + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'delete(): void;' + return: + type: void + description: '' + - name: getXml() + uid: excel!Excel.CustomXmlPart#getXml:member(1) + package: excel! + fullName: getXml() + summary: Gets the custom XML part's full XML content. + remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/18-custom-xml-parts/create-set-get-and-delete-custom-xml-parts.yaml + + + await Excel.run(async (context) => { + // You must have the xmlns attribute to populate the + // CustomXml.namespaceUri property. + const originalXml = "JuanHongSally"; + const customXmlPart = context.workbook.customXmlParts.add(originalXml); + customXmlPart.load("id"); + const xmlBlob = customXmlPart.getXml(); + + await context.sync(); + + const readableXml = addLineBreaksToXML(xmlBlob.value); + document.getElementById("display-xml").textContent = readableXml; + + // Store the XML part's ID in a setting. + const settings = context.workbook.settings; + settings.add("ContosoReviewXmlPartId", customXmlPart.id); + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getXml(): OfficeExtension.ClientResult;' + return: + type: <string> + description: '' + - name: load(options) + uid: excel!Excel.CustomXmlPart#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.CustomXmlPartLoadOptions): + Excel.CustomXmlPart; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.CustomXmlPart#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.CustomXmlPart;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.CustomXmlPart#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.CustomXmlPart; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: setXml(xml) + uid: excel!Excel.CustomXmlPart#setXml:member(1) + package: excel! + fullName: setXml(xml) + summary: Sets the custom XML part's full XML content. + remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/18-custom-xml-parts/create-set-get-and-delete-custom-xml-parts.yaml + + + await Excel.run(async (context) => { + const settings = context.workbook.settings; + const xmlPartIDSetting = settings.getItemOrNullObject("ContosoReviewXmlPartId").load("value"); + await context.sync(); + + if (xmlPartIDSetting.value) { + const customXmlPart = context.workbook.customXmlParts.getItem(xmlPartIDSetting.value); + + // The setXml method does a whole-for-whole replacement + // of the entire XML. + customXmlPart.setXml("JohnHitomi"); + const xmlBlob = customXmlPart.getXml(); + await context.sync(); + + const readableXml = addLineBreaksToXML(xmlBlob.value); + document.getElementById("display-xml").textContent = readableXml; + await context.sync(); + } + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'setXml(xml: string): void;' + parameters: + - id: xml + description: XML content for the part. + type: string + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.CustomXmlPart#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.CustomXmlPart` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.CustomXmlPartData`) that + contains shallow copies of any loaded child properties from the original + object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.CustomXmlPartData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.customxmlpartcollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.customxmlpartcollection.yml new file mode 100644 index 0000000000..2eb4280e4b --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.customxmlpartcollection.yml @@ -0,0 +1,355 @@ +### YamlMime:TSType +name: Excel.CustomXmlPartCollection +uid: excel!Excel.CustomXmlPartCollection:class +package: excel! +fullName: Excel.CustomXmlPartCollection +summary: A collection of custom XML parts. +remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.CustomXmlPartCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: excel!Excel.CustomXmlPartCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.CustomXmlPart[];' + return: + type: [] +methods: + - name: add(xml) + uid: excel!Excel.CustomXmlPartCollection#add:member(1) + package: excel! + fullName: add(xml) + summary: Adds a new custom XML part to the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/18-custom-xml-parts/create-set-get-and-delete-custom-xml-parts.yaml + + + await Excel.run(async (context) => { + // You must have the xmlns attribute to populate the + // CustomXml.namespaceUri property. + const originalXml = "JuanHongSally"; + const customXmlPart = context.workbook.customXmlParts.add(originalXml); + customXmlPart.load("id"); + const xmlBlob = customXmlPart.getXml(); + + await context.sync(); + + const readableXml = addLineBreaksToXML(xmlBlob.value); + document.getElementById("display-xml").textContent = readableXml; + + // Store the XML part's ID in a setting. + const settings = context.workbook.settings; + settings.add("ContosoReviewXmlPartId", customXmlPart.id); + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'add(xml: string): Excel.CustomXmlPart;' + parameters: + - id: xml + description: XML content. Must be a valid XML fragment. + type: string + return: + type: + description: '' + - name: getByNamespace(namespaceUri) + uid: excel!Excel.CustomXmlPartCollection#getByNamespace:member(1) + package: excel! + fullName: getByNamespace(namespaceUri) + summary: >- + Gets a new scoped collection of custom XML parts whose namespaces match + the given namespace. + remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/18-custom-xml-parts/test-xml-for-unique-namespace.yaml + + + await Excel.run(async (context) => { + document.getElementById("display-xml").textContent = ""; + const contosoNamespace = "http://schemas.contoso.com/review/1.0"; + const customXmlParts = context.workbook.customXmlParts; + const filteredXmlParts = customXmlParts.getByNamespace(contosoNamespace); + const numberOfPartsInNamespace = filteredXmlParts.getCount(); + + await context.sync(); + + if (numberOfPartsInNamespace.value == 1) { + const onlyXmlPartInNamespace = filteredXmlParts.getOnlyItem(); + const xmlBlob = onlyXmlPartInNamespace.getXml(); + + await context.sync(); + + // Make it a bit more readable. + const readableXml = xmlBlob.value.replace(/>\n<"); + + document.getElementById("display-xml").textContent = `The only XML part in the namespace ${contosoNamespace} is: + ${readableXml}`; + + } else { + console.log(`There are ${numberOfPartsInNamespace.value} XML parts with namespace ${contosoNamespace}. There should be exactly 1.`); + } + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + getByNamespace(namespaceUri: string): + Excel.CustomXmlPartScopedCollection; + parameters: + - id: namespaceUri + description: >- + This must be a fully qualified schema URI; for example, + "http://schemas.contoso.com/review/1.0". + type: string + return: + type: + description: '' + - name: getCount() + uid: excel!Excel.CustomXmlPartCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Gets the number of custom XML parts in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getItem(id) + uid: excel!Excel.CustomXmlPartCollection#getItem:member(1) + package: excel! + fullName: getItem(id) + summary: Gets a custom XML part based on its ID. + remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/18-custom-xml-parts/create-set-get-and-delete-custom-xml-parts.yaml + + + await Excel.run(async (context) => { + const settings = context.workbook.settings; + const xmlPartIDSetting = settings.getItemOrNullObject("ContosoReviewXmlPartId").load("value"); + await context.sync(); + + if (xmlPartIDSetting.value) { + const customXmlPart = context.workbook.customXmlParts.getItem(xmlPartIDSetting.value); + + // The setXml method does a whole-for-whole replacement + // of the entire XML. + customXmlPart.setXml("JohnHitomi"); + const xmlBlob = customXmlPart.getXml(); + await context.sync(); + + const readableXml = addLineBreaksToXML(xmlBlob.value); + document.getElementById("display-xml").textContent = readableXml; + await context.sync(); + } + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getItem(id: string): Excel.CustomXmlPart;' + parameters: + - id: id + description: ID of the object to be retrieved. + type: string + return: + type: + description: '' + - name: getItemOrNullObject(id) + uid: excel!Excel.CustomXmlPartCollection#getItemOrNullObject:member(1) + package: excel! + fullName: getItemOrNullObject(id) + summary: >- + Gets a custom XML part based on its ID. If the `CustomXmlPart` does not + exist, then this method returns an object with its `isNullObject` property + set to `true`. For further information, see [*OrNullObject + methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemOrNullObject(id: string): Excel.CustomXmlPart;' + parameters: + - id: id + description: ID of the object to be retrieved. + type: string + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.CustomXmlPartCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.CustomXmlPartCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): Excel.CustomXmlPartCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.CustomXmlPartCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.CustomXmlPartCollection;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.CustomXmlPartCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.CustomXmlPartCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.CustomXmlPartCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.CustomXmlPartCollection` object is an API object, the `toJSON` + method returns a plain JavaScript object (typed as + `Excel.Interfaces.CustomXmlPartCollectionData`) that contains an + "items" array with shallow copies of any loaded properties from the + collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.CustomXmlPartCollectionData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.customxmlpartscopedcollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.customxmlpartscopedcollection.yml new file mode 100644 index 0000000000..a70f13bedb --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.customxmlpartscopedcollection.yml @@ -0,0 +1,369 @@ +### YamlMime:TSType +name: Excel.CustomXmlPartScopedCollection +uid: excel!Excel.CustomXmlPartScopedCollection:class +package: excel! +fullName: Excel.CustomXmlPartScopedCollection +summary: >- + A scoped collection of custom XML parts. A scoped collection is the result of + some operation (e.g., filtering by namespace). A scoped collection cannot be + scoped any further. +remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.CustomXmlPartScopedCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: excel!Excel.CustomXmlPartScopedCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.CustomXmlPart[];' + return: + type: [] +methods: + - name: getCount() + uid: excel!Excel.CustomXmlPartScopedCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Gets the number of CustomXML parts in this collection. + remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/18-custom-xml-parts/test-xml-for-unique-namespace.yaml + + + await Excel.run(async (context) => { + document.getElementById("display-xml").textContent = ""; + const contosoNamespace = "http://schemas.contoso.com/review/1.0"; + const customXmlParts = context.workbook.customXmlParts; + const filteredXmlParts = customXmlParts.getByNamespace(contosoNamespace); + const numberOfPartsInNamespace = filteredXmlParts.getCount(); + + await context.sync(); + + if (numberOfPartsInNamespace.value == 1) { + const onlyXmlPartInNamespace = filteredXmlParts.getOnlyItem(); + const xmlBlob = onlyXmlPartInNamespace.getXml(); + + await context.sync(); + + // Make it a bit more readable. + const readableXml = xmlBlob.value.replace(/>\n<"); + + document.getElementById("display-xml").textContent = `The only XML part in the namespace ${contosoNamespace} is: + ${readableXml}`; + + } else { + console.log(`There are ${numberOfPartsInNamespace.value} XML parts with namespace ${contosoNamespace}. There should be exactly 1.`); + } + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getItem(id) + uid: excel!Excel.CustomXmlPartScopedCollection#getItem:member(1) + package: excel! + fullName: getItem(id) + summary: Gets a custom XML part based on its ID. + remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItem(id: string): Excel.CustomXmlPart;' + parameters: + - id: id + description: ID of the object to be retrieved. + type: string + return: + type: + description: '' + - name: getItemOrNullObject(id) + uid: excel!Excel.CustomXmlPartScopedCollection#getItemOrNullObject:member(1) + package: excel! + fullName: getItemOrNullObject(id) + summary: >- + Gets a custom XML part based on its ID. If the `CustomXmlPart` does not + exist, then this method returns an object with its `isNullObject` property + set to `true`. For further information, see [*OrNullObject + methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/18-custom-xml-parts/create-set-get-and-delete-custom-xml-parts.yaml + + + await Excel.run(async (context) => { + const settings = context.workbook.settings; + const xmlPartIDSetting = settings.getItemOrNullObject("ContosoReviewXmlPartId").load("value"); + await context.sync(); + + if (xmlPartIDSetting.value) { + let customXmlPart = context.workbook.customXmlParts.getItem(xmlPartIDSetting.value); + const xmlBlob = customXmlPart.getXml(); + customXmlPart.delete(); + customXmlPart = context.workbook.customXmlParts.getItemOrNullObject(xmlPartIDSetting.value); + + await context.sync(); + + if (customXmlPart.isNullObject) { + document.getElementById("display-xml").textContent = `The XML part with the id ${xmlPartIDSetting.value} has been deleted.`; + + // Delete the unneeded setting too. + xmlPartIDSetting.delete(); + } else { + const readableXml = addLineBreaksToXML(xmlBlob.value); + const strangeMessage = `This is strange. The XML part with the id ${xmlPartIDSetting.value} has not been deleted:\n${readableXml}` + document.getElementById("display-xml").textContent = strangeMessage; + } + + await context.sync(); + } + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemOrNullObject(id: string): Excel.CustomXmlPart;' + parameters: + - id: id + description: ID of the object to be retrieved. + type: string + return: + type: + description: '' + - name: getOnlyItem() + uid: excel!Excel.CustomXmlPartScopedCollection#getOnlyItem:member(1) + package: excel! + fullName: getOnlyItem() + summary: >- + If the collection contains exactly one item, this method returns it. + Otherwise, this method produces an error. + remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/18-custom-xml-parts/test-xml-for-unique-namespace.yaml + + + await Excel.run(async (context) => { + document.getElementById("display-xml").textContent = ""; + const contosoNamespace = "http://schemas.contoso.com/review/1.0"; + const customXmlParts = context.workbook.customXmlParts; + const filteredXmlParts = customXmlParts.getByNamespace(contosoNamespace); + const numberOfPartsInNamespace = filteredXmlParts.getCount(); + + await context.sync(); + + if (numberOfPartsInNamespace.value == 1) { + const onlyXmlPartInNamespace = filteredXmlParts.getOnlyItem(); + const xmlBlob = onlyXmlPartInNamespace.getXml(); + + await context.sync(); + + // Make it a bit more readable. + const readableXml = xmlBlob.value.replace(/>\n<"); + + document.getElementById("display-xml").textContent = `The only XML part in the namespace ${contosoNamespace} is: + ${readableXml}`; + + } else { + console.log(`There are ${numberOfPartsInNamespace.value} XML parts with namespace ${contosoNamespace}. There should be exactly 1.`); + } + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getOnlyItem(): Excel.CustomXmlPart;' + return: + type: + description: '' + - name: getOnlyItemOrNullObject() + uid: >- + excel!Excel.CustomXmlPartScopedCollection#getOnlyItemOrNullObject:member(1) + package: excel! + fullName: getOnlyItemOrNullObject() + summary: >- + If the collection contains exactly one item, this method returns it. + Otherwise, this method returns `null`. + remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getOnlyItemOrNullObject(): Excel.CustomXmlPart;' + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.CustomXmlPartScopedCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.CustomXmlPartScopedCollectionLoadOptions + & Excel.Interfaces.CollectionLoadOptions): + Excel.CustomXmlPartScopedCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.CustomXmlPartScopedCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNames?: string | string[]): + Excel.CustomXmlPartScopedCollection; + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.CustomXmlPartScopedCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.CustomXmlPartScopedCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.CustomXmlPartScopedCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.CustomXmlPartScopedCollection` object is an API object, the + `toJSON` method returns a plain JavaScript object (typed as + `Excel.Interfaces.CustomXmlPartScopedCollectionData`) that + contains an "items" array with shallow copies of any loaded properties + from the collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.CustomXmlPartScopedCollectionData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.databarconditionalformat.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.databarconditionalformat.yml new file mode 100644 index 0000000000..f52d41ce07 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.databarconditionalformat.yml @@ -0,0 +1,353 @@ +### YamlMime:TSType +name: Excel.DataBarConditionalFormat +uid: excel!Excel.DataBarConditionalFormat:class +package: excel! +fullName: Excel.DataBarConditionalFormat +summary: Represents an Excel conditional data bar type. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: axisColor + uid: excel!Excel.DataBarConditionalFormat#axisColor:member + package: excel! + fullName: axisColor + summary: >- + HTML color code representing the color of the Axis line, in the form + \#RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). Value + is "" (an empty string) if no axis is present or set. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'axisColor: string;' + return: + type: string + - name: axisFormat + uid: excel!Excel.DataBarConditionalFormat#axisFormat:member + package: excel! + fullName: axisFormat + summary: Representation of how the axis is determined for an Excel data bar. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + axisFormat: Excel.ConditionalDataBarAxisFormat | "Automatic" | "None" | + "CellMidPoint"; + return: + type: >- + | + "Automatic" | "None" | "CellMidPoint" + - name: barDirection + uid: excel!Excel.DataBarConditionalFormat#barDirection:member + package: excel! + fullName: barDirection + summary: Specifies the direction that the data bar graphic should be based on. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const range = sheet.getRange("B8:E13"); + const conditionalFormat = range.conditionalFormats + .add(Excel.ConditionalFormatType.dataBar); + conditionalFormat.dataBar.barDirection = Excel.ConditionalDataBarDirection.leftToRight; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + barDirection: Excel.ConditionalDataBarDirection | "Context" | + "LeftToRight" | "RightToLeft"; + return: + type: >- + | + "Context" | "LeftToRight" | "RightToLeft" + - name: context + uid: excel!Excel.DataBarConditionalFormat#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: lowerBoundRule + uid: excel!Excel.DataBarConditionalFormat#lowerBoundRule:member + package: excel! + fullName: lowerBoundRule + summary: >- + The rule for what constitutes the lower bound (and how to calculate it, if + applicable) for a data bar. The `ConditionalDataBarRule` object must be + set as a JSON object (use `x.lowerBoundRule = {...}` instead of + `x.lowerBoundRule.formula = ...`). + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'lowerBoundRule: Excel.ConditionalDataBarRule;' + return: + type: + - name: negativeFormat + uid: excel!Excel.DataBarConditionalFormat#negativeFormat:member + package: excel! + fullName: negativeFormat + summary: Representation of all values to the left of the axis in an Excel data bar. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly negativeFormat: Excel.ConditionalDataBarNegativeFormat;' + return: + type: + - name: positiveFormat + uid: excel!Excel.DataBarConditionalFormat#positiveFormat:member + package: excel! + fullName: positiveFormat + summary: >- + Representation of all values to the right of the axis in an Excel data + bar. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly positiveFormat: Excel.ConditionalDataBarPositiveFormat;' + return: + type: + - name: showDataBarOnly + uid: excel!Excel.DataBarConditionalFormat#showDataBarOnly:member + package: excel! + fullName: showDataBarOnly + summary: >- + If `true`, hides the values from the cells where the data bar is + applied. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showDataBarOnly: boolean;' + return: + type: boolean + - name: upperBoundRule + uid: excel!Excel.DataBarConditionalFormat#upperBoundRule:member + package: excel! + fullName: upperBoundRule + summary: >- + The rule for what constitutes the upper bound (and how to calculate it, if + applicable) for a data bar. The `ConditionalDataBarRule` object must be + set as a JSON object (use `x.upperBoundRule = {...}` instead of + `x.upperBoundRule.formula = ...`). + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'upperBoundRule: Excel.ConditionalDataBarRule;' + return: + type: +methods: + - name: load(options) + uid: excel!Excel.DataBarConditionalFormat#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.DataBarConditionalFormatLoadOptions): + Excel.DataBarConditionalFormat; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.DataBarConditionalFormat#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.DataBarConditionalFormat;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.DataBarConditionalFormat#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.DataBarConditionalFormat; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.DataBarConditionalFormat#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.DataBarConditionalFormatUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.DataBarConditionalFormat#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.DataBarConditionalFormat): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.DataBarConditionalFormat#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.DataBarConditionalFormat` object is an API object, the `toJSON` + method returns a plain JavaScript object (typed as + `Excel.Interfaces.DataBarConditionalFormatData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.DataBarConditionalFormatData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.datachangetype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.datachangetype.yml new file mode 100644 index 0000000000..befc66104e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.datachangetype.yml @@ -0,0 +1,102 @@ +### YamlMime:TSEnum +name: Excel.DataChangeType +uid: excel!Excel.DataChangeType:enum +package: excel! +fullName: Excel.DataChangeType +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: cellDeleted + uid: excel!Excel.DataChangeType.cellDeleted:member + package: excel! + summary: >- + `CellDeleted` indicates that the data change event is triggered by + deleting cells. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"CellDeleted"' + - name: cellInserted + uid: excel!Excel.DataChangeType.cellInserted:member + package: excel! + summary: >- + `CellInserted` indicates that the data change event is triggered by + inserting new cells. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"CellInserted"' + - name: columnDeleted + uid: excel!Excel.DataChangeType.columnDeleted:member + package: excel! + summary: >- + `ColumnDeleted` indicates that the data change event is triggered by + deleting columns. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ColumnDeleted"' + - name: columnInserted + uid: excel!Excel.DataChangeType.columnInserted:member + package: excel! + summary: >- + `ColumnInserted` indicates that the data change event is triggered by + inserting new columns. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ColumnInserted"' + - name: rangeEdited + uid: excel!Excel.DataChangeType.rangeEdited:member + package: excel! + summary: >- + `RangeEdited` indicates that the data change event is triggered by a range + being edited. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"RangeEdited"' + - name: rowDeleted + uid: excel!Excel.DataChangeType.rowDeleted:member + package: excel! + summary: >- + `RowDeleted` indicates that the data change event is triggered by deleting + rows. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"RowDeleted"' + - name: rowInserted + uid: excel!Excel.DataChangeType.rowInserted:member + package: excel! + summary: >- + `RowInserted` indicates that the data change event is triggered by + inserting new rows. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"RowInserted"' + - name: unknown + uid: excel!Excel.DataChangeType.unknown:member + package: excel! + summary: >- + `Unknown` indicates that the type of data change is not one of the listed + types. + + + * \[ [API set: ExcelApi 1.8. The name of this value was 'Others' in + ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Unknown"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.dataconnectioncollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.dataconnectioncollection.yml new file mode 100644 index 0000000000..d0d43ef922 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.dataconnectioncollection.yml @@ -0,0 +1,82 @@ +### YamlMime:TSType +name: Excel.DataConnectionCollection +uid: excel!Excel.DataConnectionCollection:class +package: excel! +fullName: Excel.DataConnectionCollection +summary: >- + Represents a collection of all the data connections that are part of the + workbook. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.DataConnectionCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: +methods: + - name: refreshAll() + uid: excel!Excel.DataConnectionCollection#refreshAll:member(1) + package: excel! + fullName: refreshAll() + summary: >- + Refreshes data connections in the collection, such as from a PivotTable to + a Power BI dataset, or a Data Model to a table or range in the same + workbook. Data connections unsupported by this method are: Power Query + connections, data connections outside the original workbook (except Power + BI connections), and connections to data protected by a firewall. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'refreshAll(): void;' + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.DataConnectionCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.DataConnectionCollection` object is an API object, the `toJSON` + method returns a plain JavaScript object (typed as + `Excel.Interfaces.DataConnectionCollectionData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + toJSON(): { + [key: string]: string; + }; + return: + type: |- + { + [key: string]: string; + } + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.datapivothierarchy.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.datapivothierarchy.yml new file mode 100644 index 0000000000..8e330d2f2d --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.datapivothierarchy.yml @@ -0,0 +1,370 @@ +### YamlMime:TSType +name: Excel.DataPivotHierarchy +uid: excel!Excel.DataPivotHierarchy:class +package: excel! +fullName: Excel.DataPivotHierarchy +summary: Represents the Excel DataPivotHierarchy. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.DataPivotHierarchy#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: field + uid: excel!Excel.DataPivotHierarchy#field:member + package: excel! + fullName: field + summary: Returns the PivotFields associated with the DataPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly field: Excel.PivotField;' + return: + type: + - name: id + uid: excel!Excel.DataPivotHierarchy#id:member + package: excel! + fullName: id + summary: ID of the DataPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly id: string;' + return: + type: string + - name: name + uid: excel!Excel.DataPivotHierarchy#name:member + package: excel! + fullName: name + summary: Name of the DataPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-create-and-modify.yaml + + + await Excel.run(async (context) => { + const dataHierarchies = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales").dataHierarchies + dataHierarchies.load("no-properties-needed"); + await context.sync(); + + dataHierarchies.items[0].name = "Farm Sales"; + dataHierarchies.items[1].name = "Wholesale"; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'name: string;' + return: + type: string + - name: numberFormat + uid: excel!Excel.DataPivotHierarchy#numberFormat:member + package: excel! + fullName: numberFormat + summary: Number format of the DataPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat: string;' + return: + type: string + - name: position + uid: excel!Excel.DataPivotHierarchy#position:member + package: excel! + fullName: position + summary: Position of the DataPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'position: number;' + return: + type: number + - name: showAs + uid: excel!Excel.DataPivotHierarchy#showAs:member + package: excel! + fullName: showAs + summary: Specifies if the data should be shown as a specific summary calculation. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-calculations.yaml + + + await Excel.run(async (context) => { + const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales"); + const farmDataHierarchy: Excel.DataPivotHierarchy = pivotTable.dataHierarchies.getItem("Sum of Crates Sold at Farm"); + const wholesaleDataHierarchy: Excel.DataPivotHierarchy = pivotTable.dataHierarchies.getItem("Sum of Crates Sold Wholesale"); + + farmDataHierarchy.load("showAs"); + wholesaleDataHierarchy.load("showAs"); + await context.sync(); + + // Show the crates of each fruit type sold at the farm as a percentage of the column's total. + let farmShowAs = farmDataHierarchy.showAs; + farmShowAs.calculation = Excel.ShowAsCalculation.percentOfColumnTotal; + farmShowAs.baseField = pivotTable.rowHierarchies.getItem("Type").fields.getItem("Type"); + farmDataHierarchy.showAs = farmShowAs; + + let wholesaleShowAs = wholesaleDataHierarchy.showAs; + wholesaleShowAs.calculation = Excel.ShowAsCalculation.percentOfColumnTotal; + wholesaleShowAs.baseField = pivotTable.rowHierarchies.getItem("Type").fields.getItem("Type"); + wholesaleDataHierarchy.showAs = wholesaleShowAs; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'showAs: Excel.ShowAsRule;' + return: + type: + - name: summarizeBy + uid: excel!Excel.DataPivotHierarchy#summarizeBy:member + package: excel! + fullName: summarizeBy + summary: Specifies if all items of the DataPivotHierarchy are shown. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + summarizeBy: Excel.AggregationFunction | "Unknown" | "Automatic" | "Sum" + | "Count" | "Average" | "Max" | "Min" | "Product" | "CountNumbers" | + "StandardDeviation" | "StandardDeviationP" | "Variance" | "VarianceP"; + return: + type: >- + | "Unknown" | + "Automatic" | "Sum" | "Count" | "Average" | "Max" | "Min" | "Product" + | "CountNumbers" | "StandardDeviation" | "StandardDeviationP" | + "Variance" | "VarianceP" +methods: + - name: load(options) + uid: excel!Excel.DataPivotHierarchy#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.DataPivotHierarchyLoadOptions): + Excel.DataPivotHierarchy; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.DataPivotHierarchy#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.DataPivotHierarchy;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.DataPivotHierarchy#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.DataPivotHierarchy; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.DataPivotHierarchy#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.DataPivotHierarchyUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.DataPivotHierarchy#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.DataPivotHierarchy): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: setToDefault() + uid: excel!Excel.DataPivotHierarchy#setToDefault:member(1) + package: excel! + fullName: setToDefault() + summary: Reset the DataPivotHierarchy back to its default values. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'setToDefault(): void;' + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.DataPivotHierarchy#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.DataPivotHierarchy` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.DataPivotHierarchyData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.DataPivotHierarchyData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.datapivothierarchycollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.datapivothierarchycollection.yml new file mode 100644 index 0000000000..9a0dc23a27 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.datapivothierarchycollection.yml @@ -0,0 +1,251 @@ +### YamlMime:TSType +name: Excel.DataPivotHierarchyCollection +uid: excel!Excel.DataPivotHierarchyCollection:class +package: excel! +fullName: Excel.DataPivotHierarchyCollection +summary: >- + Represents a collection of DataPivotHierarchy items associated with the + PivotTable. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.DataPivotHierarchyCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: excel!Excel.DataPivotHierarchyCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.DataPivotHierarchy[];' + return: + type: [] +methods: + - name: add(pivotHierarchy) + uid: excel!Excel.DataPivotHierarchyCollection#add:member(1) + package: excel! + fullName: add(pivotHierarchy) + summary: Adds the PivotHierarchy to the current axis. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'add(pivotHierarchy: Excel.PivotHierarchy): Excel.DataPivotHierarchy;' + parameters: + - id: pivotHierarchy + description: '' + type: + return: + type: + description: '' + - name: getCount() + uid: excel!Excel.DataPivotHierarchyCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Gets the number of pivot hierarchies in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getItem(name) + uid: excel!Excel.DataPivotHierarchyCollection#getItem:member(1) + package: excel! + fullName: getItem(name) + summary: Gets a DataPivotHierarchy by its name or ID. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItem(name: string): Excel.DataPivotHierarchy;' + parameters: + - id: name + description: Name of the DataPivotHierarchy to be retrieved. + type: string + return: + type: + description: '' + - name: getItemOrNullObject(name) + uid: excel!Excel.DataPivotHierarchyCollection#getItemOrNullObject:member(1) + package: excel! + fullName: getItemOrNullObject(name) + summary: >- + Gets a DataPivotHierarchy by name. If the DataPivotHierarchy does not + exist, then this method returns an object with its `isNullObject` property + set to `true`. For further information, see [*OrNullObject + methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemOrNullObject(name: string): Excel.DataPivotHierarchy;' + parameters: + - id: name + description: Name of the DataPivotHierarchy to be retrieved. + type: string + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.DataPivotHierarchyCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.DataPivotHierarchyCollectionLoadOptions + & Excel.Interfaces.CollectionLoadOptions): + Excel.DataPivotHierarchyCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.DataPivotHierarchyCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNames?: string | string[]): + Excel.DataPivotHierarchyCollection; + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.DataPivotHierarchyCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.DataPivotHierarchyCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: remove(DataPivotHierarchy) + uid: excel!Excel.DataPivotHierarchyCollection#remove:member(1) + package: excel! + fullName: remove(DataPivotHierarchy) + summary: Removes the PivotHierarchy from the current axis. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'remove(DataPivotHierarchy: Excel.DataPivotHierarchy): void;' + parameters: + - id: DataPivotHierarchy + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.DataPivotHierarchyCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.DataPivotHierarchyCollection` object is an API object, the `toJSON` + method returns a plain JavaScript object (typed as + `Excel.Interfaces.DataPivotHierarchyCollectionData`) that contains + an "items" array with shallow copies of any loaded properties from the + collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.DataPivotHierarchyCollectionData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.datasourcetype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.datasourcetype.yml new file mode 100644 index 0000000000..fae1b5af44 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.datasourcetype.yml @@ -0,0 +1,46 @@ +### YamlMime:TSEnum +name: Excel.DataSourceType +uid: excel!Excel.DataSourceType:enum +package: excel! +fullName: Excel.DataSourceType +summary: Represents a command type of `DataConnection`. +remarks: >- + \[ [API set: ExcelApi + 1.15](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: localRange + uid: excel!Excel.DataSourceType.localRange:member + package: excel! + summary: >- + The data source type is a range in the current workbook. + + + * \[ [API set: ExcelApi + 1.15](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"LocalRange"' + - name: localTable + uid: excel!Excel.DataSourceType.localTable:member + package: excel! + summary: >- + The data source type is a table in the current workbook. + + + * \[ [API set: ExcelApi + 1.15](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"LocalTable"' + - name: unknown + uid: excel!Excel.DataSourceType.unknown:member + package: excel! + summary: >- + The data source type is unknown or unsupported. + + + * \[ [API set: ExcelApi + 1.15](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Unknown"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.datavalidation.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.datavalidation.yml new file mode 100644 index 0000000000..c010b219dc --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.datavalidation.yml @@ -0,0 +1,464 @@ +### YamlMime:TSType +name: Excel.DataValidation +uid: excel!Excel.DataValidation:class +package: excel! +fullName: Excel.DataValidation +summary: >- + Represents the data validation applied to the current range. To learn more + about the data validation object model, read [Add data validation to Excel + ranges](https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-data-validation). +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.DataValidation#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: errorAlert + uid: excel!Excel.DataValidation#errorAlert:member + package: excel! + fullName: errorAlert + summary: Error alert when user enters invalid data. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/22-data-validation/data-validation.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Decision"); + const commentsRange = + sheet.tables.getItem("NameOptionsTable").columns.getItem("Comments").getDataBodyRange(); + + // When you are developing, it is a good practice to + // clear the dataValidation object with each run of your code. + commentsRange.dataValidation.clear(); + + // If the value of A2 is contained in the value of C2, then + // SEARCH(A2,C2) returns the number where it begins. Otherwise, + // it does not return a number. + let redundantStringRule = { + custom: { + formula: "=NOT(ISNUMBER(SEARCH(A2,C2)))" + } + }; + commentsRange.dataValidation.rule = redundantStringRule; + commentsRange.dataValidation.errorAlert = { + message: "It is redundant to include the baby name in the comment.", + showAlert: true, + style: "Information", + title: "Baby Name in Comment" + }; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'errorAlert: Excel.DataValidationErrorAlert;' + return: + type: + - name: ignoreBlanks + uid: excel!Excel.DataValidation#ignoreBlanks:member + package: excel! + fullName: ignoreBlanks + summary: >- + Specifies if data validation will be performed on blank cells. Default is + `true`. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'ignoreBlanks: boolean;' + return: + type: boolean + - name: prompt + uid: excel!Excel.DataValidation#prompt:member + package: excel! + fullName: prompt + summary: Prompt when users select a cell. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/22-data-validation/data-validation.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Decision"); + const rankingRange = sheet.tables.getItem("NameOptionsTable").columns.getItem("Ranking").getDataBodyRange(); + + // When you are developing, it is a good practice to + // clear the dataValidation object with each run of your code. + rankingRange.dataValidation.clear(); + + let greaterThanZeroRule = { + wholeNumber: { + formula1: 0, + operator: Excel.DataValidationOperator.greaterThan + } + }; + rankingRange.dataValidation.rule = greaterThanZeroRule; + + rankingRange.dataValidation.prompt = { + message: "Please enter a positive number.", + showPrompt: true, + title: "Positive numbers only." + }; + + rankingRange.dataValidation.errorAlert = { + message: "Sorry, only positive numbers are allowed", + showAlert: true, + style: "Stop", + title: "Negative Number Entered" + }; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'prompt: Excel.DataValidationPrompt;' + return: + type: + - name: rule + uid: excel!Excel.DataValidation#rule:member + package: excel! + fullName: rule + summary: >- + Data validation rule that contains different type of data validation + criteria. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/22-data-validation/data-validation.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Decision"); + const nameRange = + sheet.tables.getItem("NameOptionsTable").columns.getItem("Baby Name").getDataBodyRange(); + + // When you are developing, it is a good practice to + // clear the dataValidation object with each run of your code. + nameRange.dataValidation.clear(); + + const nameSourceRange = context.workbook.worksheets.getItem("Names").getRange("A1:A3"); + + let approvedListRule = { + list: { + inCellDropDown: true, + source: nameSourceRange + } + }; + nameRange.dataValidation.rule = approvedListRule; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'rule: Excel.DataValidationRule;' + return: + type: + - name: type + uid: excel!Excel.DataValidation#type:member + package: excel! + fullName: type + summary: Type of the data validation, see `Excel.DataValidationType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly type: Excel.DataValidationType | "None" | "WholeNumber" | + "Decimal" | "List" | "Date" | "Time" | "TextLength" | "Custom" | + "Inconsistent" | "MixedCriteria"; + return: + type: >- + | "None" | + "WholeNumber" | "Decimal" | "List" | "Date" | "Time" | "TextLength" | + "Custom" | "Inconsistent" | "MixedCriteria" + - name: valid + uid: excel!Excel.DataValidation#valid:member + package: excel! + fullName: valid + summary: >- + Represents if all cell values are valid according to the data validation + rules. Returns `true` if all cell values are valid, or `false` if all cell + values are invalid. Returns `null` if there are both valid and invalid + cell values within the range. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly valid: boolean;' + return: + type: boolean +methods: + - name: clear() + uid: excel!Excel.DataValidation#clear:member(1) + package: excel! + fullName: clear() + summary: Clears the data validation from the current range. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'clear(): void;' + return: + type: void + description: '' + - name: getInvalidCells() + uid: excel!Excel.DataValidation#getInvalidCells:member(1) + package: excel! + fullName: getInvalidCells() + summary: >- + Returns a `RangeAreas` object, comprising one or more rectangular ranges, + with invalid cell values. If all cell values are valid, this function will + throw an `ItemNotFound` error. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getInvalidCells(): Excel.RangeAreas;' + return: + type: + description: '' + - name: getInvalidCellsOrNullObject() + uid: excel!Excel.DataValidation#getInvalidCellsOrNullObject:member(1) + package: excel! + fullName: getInvalidCellsOrNullObject() + summary: >- + Returns a `RangeAreas` object, comprising one or more rectangular ranges, + with invalid cell values. If all cell values are valid, this function will + return `null`. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getInvalidCellsOrNullObject(): Excel.RangeAreas;' + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.DataValidation#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.DataValidationLoadOptions): + Excel.DataValidation; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.DataValidation#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.DataValidation;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.DataValidation#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.DataValidation; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.DataValidation#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.DataValidationUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.DataValidation#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.DataValidation): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.DataValidation#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.DataValidation` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.DataValidationData`) that + contains shallow copies of any loaded child properties from the original + object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.DataValidationData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.datavalidationalertstyle.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.datavalidationalertstyle.yml new file mode 100644 index 0000000000..7f91910c1c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.datavalidationalertstyle.yml @@ -0,0 +1,36 @@ +### YamlMime:TSEnum +name: Excel.DataValidationAlertStyle +uid: excel!Excel.DataValidationAlertStyle:enum +package: excel! +fullName: Excel.DataValidationAlertStyle +summary: >- + Represents the data validation error alert style. The default is `Stop`. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: information + uid: excel!Excel.DataValidationAlertStyle.information:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Information"' + - name: stop + uid: excel!Excel.DataValidationAlertStyle.stop:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Stop"' + - name: warning + uid: excel!Excel.DataValidationAlertStyle.warning:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Warning"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.datavalidationerroralert.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.datavalidationerroralert.yml new file mode 100644 index 0000000000..f5dfde1895 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.datavalidationerroralert.yml @@ -0,0 +1,82 @@ +### YamlMime:TSType +name: Excel.DataValidationErrorAlert +uid: excel!Excel.DataValidationErrorAlert:interface +package: excel! +fullName: Excel.DataValidationErrorAlert +summary: Represents the error alert properties for the data validation. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: message + uid: excel!Excel.DataValidationErrorAlert#message:member + package: excel! + fullName: message + summary: Represents the error alert message. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'message: string;' + return: + type: string + - name: showAlert + uid: excel!Excel.DataValidationErrorAlert#showAlert:member + package: excel! + fullName: showAlert + summary: >- + Specifies whether to show an error alert dialog when a user enters invalid + data. The default is `true`. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showAlert: boolean;' + return: + type: boolean + - name: style + uid: excel!Excel.DataValidationErrorAlert#style:member + package: excel! + fullName: style + summary: >- + The data validation alert type, please see + `Excel.DataValidationAlertStyle` for details. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + style: Excel.DataValidationAlertStyle | "Stop" | "Warning" | + "Information"; + return: + type: >- + | "Stop" | + "Warning" | "Information" + - name: title + uid: excel!Excel.DataValidationErrorAlert#title:member + package: excel! + fullName: title + summary: Represents the error alert dialog title. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'title: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.datavalidationoperator.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.datavalidationoperator.yml new file mode 100644 index 0000000000..8ed2e8e001 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.datavalidationoperator.yml @@ -0,0 +1,113 @@ +### YamlMime:TSEnum +name: Excel.DataValidationOperator +uid: excel!Excel.DataValidationOperator:enum +package: excel! +fullName: Excel.DataValidationOperator +summary: Represents the data validation operator enum. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/22-data-validation/data-validation.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Decision"); + const rankingRange = sheet.tables.getItem("NameOptionsTable").columns.getItem("Ranking").getDataBodyRange(); + + // When you are developing, it is a good practice to + // clear the dataValidation object with each run of your code. + rankingRange.dataValidation.clear(); + + let greaterThanZeroRule = { + wholeNumber: { + formula1: 0, + operator: Excel.DataValidationOperator.greaterThan + } + }; + rankingRange.dataValidation.rule = greaterThanZeroRule; + + rankingRange.dataValidation.prompt = { + message: "Please enter a positive number.", + showPrompt: true, + title: "Positive numbers only." + }; + + rankingRange.dataValidation.errorAlert = { + message: "Sorry, only positive numbers are allowed", + showAlert: true, + style: "Stop", + title: "Negative Number Entered" + }; + + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: between + uid: excel!Excel.DataValidationOperator.between:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Between"' + - name: equalTo + uid: excel!Excel.DataValidationOperator.equalTo:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"EqualTo"' + - name: greaterThan + uid: excel!Excel.DataValidationOperator.greaterThan:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"GreaterThan"' + - name: greaterThanOrEqualTo + uid: excel!Excel.DataValidationOperator.greaterThanOrEqualTo:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"GreaterThanOrEqualTo"' + - name: lessThan + uid: excel!Excel.DataValidationOperator.lessThan:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LessThan"' + - name: lessThanOrEqualTo + uid: excel!Excel.DataValidationOperator.lessThanOrEqualTo:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LessThanOrEqualTo"' + - name: notBetween + uid: excel!Excel.DataValidationOperator.notBetween:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"NotBetween"' + - name: notEqualTo + uid: excel!Excel.DataValidationOperator.notEqualTo:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"NotEqualTo"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.datavalidationprompt.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.datavalidationprompt.yml new file mode 100644 index 0000000000..19550b04a6 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.datavalidationprompt.yml @@ -0,0 +1,61 @@ +### YamlMime:TSType +name: Excel.DataValidationPrompt +uid: excel!Excel.DataValidationPrompt:interface +package: excel! +fullName: Excel.DataValidationPrompt +summary: Represents the user prompt properties for the data validation. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: message + uid: excel!Excel.DataValidationPrompt#message:member + package: excel! + fullName: message + summary: Specifies the message of the prompt. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'message: string;' + return: + type: string + - name: showPrompt + uid: excel!Excel.DataValidationPrompt#showPrompt:member + package: excel! + fullName: showPrompt + summary: >- + Specifies if a prompt is shown when a user selects a cell with data + validation. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showPrompt: boolean;' + return: + type: boolean + - name: title + uid: excel!Excel.DataValidationPrompt#title:member + package: excel! + fullName: title + summary: Specifies the title for the prompt. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'title: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.datavalidationrule.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.datavalidationrule.yml new file mode 100644 index 0000000000..85ea09039a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.datavalidationrule.yml @@ -0,0 +1,200 @@ +### YamlMime:TSType +name: Excel.DataValidationRule +uid: excel!Excel.DataValidationRule:interface +package: excel! +fullName: Excel.DataValidationRule +summary: >- + A data validation rule contains different types of data validation. You can + only use one of them at a time according the `Excel.DataValidationType`. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: custom + uid: excel!Excel.DataValidationRule#custom:member + package: excel! + fullName: custom + summary: Custom data validation criteria. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'custom?: Excel.CustomDataValidation;' + return: + type: + - name: date + uid: excel!Excel.DataValidationRule#date:member + package: excel! + fullName: date + summary: Date data validation criteria. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'date?: Excel.DateTimeDataValidation;' + return: + type: + - name: decimal + uid: excel!Excel.DataValidationRule#decimal:member + package: excel! + fullName: decimal + summary: Decimal data validation criteria. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'decimal?: Excel.BasicDataValidation;' + return: + type: + - name: list + uid: excel!Excel.DataValidationRule#list:member + package: excel! + fullName: list + summary: List data validation criteria. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/22-data-validation/data-validation.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Decision"); + const nameRange = + sheet.tables.getItem("NameOptionsTable").columns.getItem("Baby Name").getDataBodyRange(); + + // When you are developing, it is a good practice to + // clear the dataValidation object with each run of your code. + nameRange.dataValidation.clear(); + + const nameSourceRange = context.workbook.worksheets.getItem("Names").getRange("A1:A3"); + + let approvedListRule = { + list: { + inCellDropDown: true, + source: nameSourceRange + } + }; + nameRange.dataValidation.rule = approvedListRule; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'list?: Excel.ListDataValidation;' + return: + type: + - name: textLength + uid: excel!Excel.DataValidationRule#textLength:member + package: excel! + fullName: textLength + summary: Text length data validation criteria. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textLength?: Excel.BasicDataValidation;' + return: + type: + - name: time + uid: excel!Excel.DataValidationRule#time:member + package: excel! + fullName: time + summary: Time data validation criteria. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'time?: Excel.DateTimeDataValidation;' + return: + type: + - name: wholeNumber + uid: excel!Excel.DataValidationRule#wholeNumber:member + package: excel! + fullName: wholeNumber + summary: Whole number data validation criteria. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/22-data-validation/data-validation.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Decision"); + const rankingRange = sheet.tables.getItem("NameOptionsTable").columns.getItem("Ranking").getDataBodyRange(); + + // When you are developing, it is a good practice to + // clear the dataValidation object with each run of your code. + rankingRange.dataValidation.clear(); + + let greaterThanZeroRule = { + wholeNumber: { + formula1: 0, + operator: Excel.DataValidationOperator.greaterThan + } + }; + rankingRange.dataValidation.rule = greaterThanZeroRule; + + rankingRange.dataValidation.prompt = { + message: "Please enter a positive number.", + showPrompt: true, + title: "Positive numbers only." + }; + + rankingRange.dataValidation.errorAlert = { + message: "Sorry, only positive numbers are allowed", + showAlert: true, + style: "Stop", + title: "Negative Number Entered" + }; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'wholeNumber?: Excel.BasicDataValidation;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.datavalidationtype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.datavalidationtype.yml new file mode 100644 index 0000000000..25644de484 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.datavalidationtype.yml @@ -0,0 +1,116 @@ +### YamlMime:TSEnum +name: Excel.DataValidationType +uid: excel!Excel.DataValidationType:enum +package: excel! +fullName: Excel.DataValidationType +summary: Represents the data validation type enum. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: custom + uid: excel!Excel.DataValidationType.custom:member + package: excel! + summary: >- + The custom data validation type. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Custom"' + - name: date + uid: excel!Excel.DataValidationType.date:member + package: excel! + summary: >- + The date data validation type. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Date"' + - name: decimal + uid: excel!Excel.DataValidationType.decimal:member + package: excel! + summary: >- + The decimal data validation type. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Decimal"' + - name: inconsistent + uid: excel!Excel.DataValidationType.inconsistent:member + package: excel! + summary: >- + Inconsistent means that the range has inconsistent data validation, + indicating that there are different rules on different cells. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Inconsistent"' + - name: list + uid: excel!Excel.DataValidationType.list:member + package: excel! + summary: >- + The list data validation type. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"List"' + - name: mixedCriteria + uid: excel!Excel.DataValidationType.mixedCriteria:member + package: excel! + summary: >- + Mixed criteria means that the range has data validation present on some + but not all cells. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"MixedCriteria"' + - name: none + uid: excel!Excel.DataValidationType.none:member + package: excel! + summary: >- + None means allow any value, indicating that there is no data validation in + the range. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"None"' + - name: textLength + uid: excel!Excel.DataValidationType.textLength:member + package: excel! + summary: >- + The text length data validation type. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"TextLength"' + - name: time + uid: excel!Excel.DataValidationType.time:member + package: excel! + summary: >- + The time data validation type. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Time"' + - name: wholeNumber + uid: excel!Excel.DataValidationType.wholeNumber:member + package: excel! + summary: >- + The whole number data validation type. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"WholeNumber"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.datefiltercondition.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.datefiltercondition.yml new file mode 100644 index 0000000000..afb4ddbdfa --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.datefiltercondition.yml @@ -0,0 +1,509 @@ +### YamlMime:TSEnum +name: Excel.DateFilterCondition +uid: excel!Excel.DateFilterCondition:enum +package: excel! +fullName: Excel.DateFilterCondition +summary: >- + Enum representing all accepted conditions by which a date filter can be + applied. Used to configure the type of PivotFilter that is applied to the + field. +remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotfilters.yaml + + + await Excel.run(async (context) => { + // Add a date-based PivotFilter. + + // Get the PivotTable. + const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales"); + + // PivotFilters can only be applied to PivotHierarchies that are being used for pivoting. + // If it's not already there, add "Date Updated" to the hierarchies. + let dateHierarchy = pivotTable.rowHierarchies.getItemOrNullObject("Date Updated"); + await context.sync(); + if (dateHierarchy.isNullObject) { + dateHierarchy = pivotTable.rowHierarchies.add(pivotTable.hierarchies.getItem("Date Updated")); + } + + // Apply a date filter to filter out anything logged before August. + const filterField = dateHierarchy.fields.getItem("Date Updated"); + const dateFilter = { + condition: Excel.DateFilterCondition.afterOrEqualTo, + comparator: { + date: "2020-08-01", + specificity: Excel.FilterDatetimeSpecificity.month + } + }; + filterField.applyFilter({ dateFilter: dateFilter }); + + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: after + uid: excel!Excel.DateFilterCondition.after:member + package: excel! + summary: >- + Date is after comparator date. + + + Required Criteria: {`comparator`}. Optional Criteria: + {`wholeDays`}. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"After"' + - name: afterOrEqualTo + uid: excel!Excel.DateFilterCondition.afterOrEqualTo:member + package: excel! + summary: >- + Date is after or equal to comparator date. + + + Required Criteria: {`comparator`}. Optional Criteria: + {`wholeDays`}. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"AfterOrEqualTo"' + - name: allDatesInPeriodApril + uid: excel!Excel.DateFilterCondition.allDatesInPeriodApril:member + package: excel! + summary: >- + Date is in April. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"AllDatesInPeriodApril"' + - name: allDatesInPeriodAugust + uid: excel!Excel.DateFilterCondition.allDatesInPeriodAugust:member + package: excel! + summary: >- + Date is in August. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"AllDatesInPeriodAugust"' + - name: allDatesInPeriodDecember + uid: excel!Excel.DateFilterCondition.allDatesInPeriodDecember:member + package: excel! + summary: >- + Date is in December. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"AllDatesInPeriodDecember"' + - name: allDatesInPeriodFebruary + uid: excel!Excel.DateFilterCondition.allDatesInPeriodFebruary:member + package: excel! + summary: >- + Date is in February. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"AllDatesInPeriodFebruary"' + - name: allDatesInPeriodJanuary + uid: excel!Excel.DateFilterCondition.allDatesInPeriodJanuary:member + package: excel! + summary: >- + Date is in January. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"AllDatesInPeriodJanuary"' + - name: allDatesInPeriodJuly + uid: excel!Excel.DateFilterCondition.allDatesInPeriodJuly:member + package: excel! + summary: >- + Date is in July. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"AllDatesInPeriodJuly"' + - name: allDatesInPeriodJune + uid: excel!Excel.DateFilterCondition.allDatesInPeriodJune:member + package: excel! + summary: >- + Date is in June. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"AllDatesInPeriodJune"' + - name: allDatesInPeriodMarch + uid: excel!Excel.DateFilterCondition.allDatesInPeriodMarch:member + package: excel! + summary: >- + Date is in March. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"AllDatesInPeriodMarch"' + - name: allDatesInPeriodMay + uid: excel!Excel.DateFilterCondition.allDatesInPeriodMay:member + package: excel! + summary: >- + Date is in May. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"AllDatesInPeriodMay"' + - name: allDatesInPeriodNovember + uid: excel!Excel.DateFilterCondition.allDatesInPeriodNovember:member + package: excel! + summary: >- + Date is in November. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"AllDatesInPeriodNovember"' + - name: allDatesInPeriodOctober + uid: excel!Excel.DateFilterCondition.allDatesInPeriodOctober:member + package: excel! + summary: >- + Date is in October. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"AllDatesInPeriodOctober"' + - name: allDatesInPeriodQuarter1 + uid: excel!Excel.DateFilterCondition.allDatesInPeriodQuarter1:member + package: excel! + summary: >- + Date is in Quarter 1. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"AllDatesInPeriodQuarter1"' + - name: allDatesInPeriodQuarter2 + uid: excel!Excel.DateFilterCondition.allDatesInPeriodQuarter2:member + package: excel! + summary: >- + Date is in Quarter 2. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"AllDatesInPeriodQuarter2"' + - name: allDatesInPeriodQuarter3 + uid: excel!Excel.DateFilterCondition.allDatesInPeriodQuarter3:member + package: excel! + summary: >- + Date is in Quarter 3. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"AllDatesInPeriodQuarter3"' + - name: allDatesInPeriodQuarter4 + uid: excel!Excel.DateFilterCondition.allDatesInPeriodQuarter4:member + package: excel! + summary: >- + Date is in Quarter 4. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"AllDatesInPeriodQuarter4"' + - name: allDatesInPeriodSeptember + uid: excel!Excel.DateFilterCondition.allDatesInPeriodSeptember:member + package: excel! + summary: >- + Date is in September. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"AllDatesInPeriodSeptember"' + - name: before + uid: excel!Excel.DateFilterCondition.before:member + package: excel! + summary: >- + Date is before comparator date. + + + Required Criteria: {`comparator`}. Optional Criteria: + {`wholeDays`}. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Before"' + - name: beforeOrEqualTo + uid: excel!Excel.DateFilterCondition.beforeOrEqualTo:member + package: excel! + summary: >- + Date is before or equal to comparator date. + + + Required Criteria: {`comparator`}. Optional Criteria: + {`wholeDays`}. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"BeforeOrEqualTo"' + - name: between + uid: excel!Excel.DateFilterCondition.between:member + package: excel! + summary: >- + Between `lowerBound` and `upperBound` dates. + + + Required Criteria: {`lowerBound`, `upperBound`}. + Optional Criteria: {`wholeDays`, `exclusive`}. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Between"' + - name: equals + uid: excel!Excel.DateFilterCondition.equals:member + package: excel! + summary: >- + Equals comparator criterion. + + + Required Criteria: {`comparator`}. Optional Criteria: + {`wholeDays`, `exclusive`}. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Equals"' + - name: lastMonth + uid: excel!Excel.DateFilterCondition.lastMonth:member + package: excel! + summary: >- + Date is last month. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"LastMonth"' + - name: lastQuarter + uid: excel!Excel.DateFilterCondition.lastQuarter:member + package: excel! + summary: >- + Date is last quarter. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"LastQuarter"' + - name: lastWeek + uid: excel!Excel.DateFilterCondition.lastWeek:member + package: excel! + summary: >- + Date is last week. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"LastWeek"' + - name: lastYear + uid: excel!Excel.DateFilterCondition.lastYear:member + package: excel! + summary: >- + Date is last year. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"LastYear"' + - name: nextMonth + uid: excel!Excel.DateFilterCondition.nextMonth:member + package: excel! + summary: >- + Date is next month. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"NextMonth"' + - name: nextQuarter + uid: excel!Excel.DateFilterCondition.nextQuarter:member + package: excel! + summary: >- + Date is next quarter. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"NextQuarter"' + - name: nextWeek + uid: excel!Excel.DateFilterCondition.nextWeek:member + package: excel! + summary: >- + Date is next week. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"NextWeek"' + - name: nextYear + uid: excel!Excel.DateFilterCondition.nextYear:member + package: excel! + summary: >- + Date is next year. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"NextYear"' + - name: thisMonth + uid: excel!Excel.DateFilterCondition.thisMonth:member + package: excel! + summary: >- + Date is this month. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ThisMonth"' + - name: thisQuarter + uid: excel!Excel.DateFilterCondition.thisQuarter:member + package: excel! + summary: >- + Date is this quarter. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ThisQuarter"' + - name: thisWeek + uid: excel!Excel.DateFilterCondition.thisWeek:member + package: excel! + summary: >- + Date is this week. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ThisWeek"' + - name: thisYear + uid: excel!Excel.DateFilterCondition.thisYear:member + package: excel! + summary: >- + Date is this year. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ThisYear"' + - name: today + uid: excel!Excel.DateFilterCondition.today:member + package: excel! + summary: >- + Date is today. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Today"' + - name: tomorrow + uid: excel!Excel.DateFilterCondition.tomorrow:member + package: excel! + summary: >- + Date is tomorrow. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Tomorrow"' + - name: unknown + uid: excel!Excel.DateFilterCondition.unknown:member + package: excel! + summary: >- + `DateFilterCondition` is unknown or unsupported. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Unknown"' + - name: yearToDate + uid: excel!Excel.DateFilterCondition.yearToDate:member + package: excel! + summary: >- + Date is in the same year to date. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"YearToDate"' + - name: yesterday + uid: excel!Excel.DateFilterCondition.yesterday:member + package: excel! + summary: >- + Date is yesterday. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Yesterday"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.datetimedatavalidation.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.datetimedatavalidation.yml new file mode 100644 index 0000000000..195ad3695d --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.datetimedatavalidation.yml @@ -0,0 +1,81 @@ +### YamlMime:TSType +name: Excel.DateTimeDataValidation +uid: excel!Excel.DateTimeDataValidation:interface +package: excel! +fullName: Excel.DateTimeDataValidation +summary: Represents the date data validation criteria. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: formula1 + uid: excel!Excel.DateTimeDataValidation#formula1:member + package: excel! + fullName: formula1 + summary: >- + Specifies the right-hand operand when the operator property is set to a + binary operator such as GreaterThan (the left-hand operand is the value + the user tries to enter in the cell). With the ternary operators Between + and NotBetween, specifies the lower bound operand. When setting the value, + it can be passed in as a Date, a Range object, or a string formula (where + the string is either a stringified date/time in ISO8601 format, a cell + reference like "=A1", or a formula like "=MIN(A1, B1)"). When retrieving + the value, it will always be returned as a string formula, for example: + "=10", "=A1", "=SUM(A1:B5)", etc. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formula1: string | Date | Range;' + return: + type: string | Date | + - name: formula2 + uid: excel!Excel.DateTimeDataValidation#formula2:member + package: excel! + fullName: formula2 + summary: >- + With the ternary operators Between and NotBetween, specifies the upper + bound operand. Is not used with the binary operators, such as GreaterThan. + When setting the value, it can be passed in as a Date, a Range object, or + a string (where the string is either a stringified date/time in ISO8601 + format, a cell reference like "=A1", or a formula like "=MIN(A1, B1)"). + When retrieving the value, it will always be returned as a string formula, + for example: "=10", "=A1", "=SUM(A1:B5)", etc. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formula2?: string | Date | Range;' + return: + type: string | Date | + - name: operator + uid: excel!Excel.DateTimeDataValidation#operator:member + package: excel! + fullName: operator + summary: The operator to use for validating the data. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + operator: Excel.DataValidationOperator | "Between" | "NotBetween" | + "EqualTo" | "NotEqualTo" | "GreaterThan" | "LessThan" | + "GreaterThanOrEqualTo" | "LessThanOrEqualTo"; + return: + type: >- + | "Between" | + "NotBetween" | "EqualTo" | "NotEqualTo" | "GreaterThan" | "LessThan" | + "GreaterThanOrEqualTo" | "LessThanOrEqualTo" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.datetimeformatinfo.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.datetimeformatinfo.yml new file mode 100644 index 0000000000..96816a664f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.datetimeformatinfo.yml @@ -0,0 +1,224 @@ +### YamlMime:TSType +name: Excel.DatetimeFormatInfo +uid: excel!Excel.DatetimeFormatInfo:class +package: excel! +fullName: Excel.DatetimeFormatInfo +summary: >- + Defines the culturally appropriate format of displaying numbers. This is based + on current system culture settings. +remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.DatetimeFormatInfo#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: dateSeparator + uid: excel!Excel.DatetimeFormatInfo#dateSeparator:member + package: excel! + fullName: dateSeparator + summary: >- + Gets the string used as the date separator. This is based on current + system settings. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly dateSeparator: string;' + return: + type: string + - name: longDatePattern + uid: excel!Excel.DatetimeFormatInfo#longDatePattern:member + package: excel! + fullName: longDatePattern + summary: >- + Gets the format string for a long date value. This is based on current + system settings. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly longDatePattern: string;' + return: + type: string + - name: longTimePattern + uid: excel!Excel.DatetimeFormatInfo#longTimePattern:member + package: excel! + fullName: longTimePattern + summary: >- + Gets the format string for a long time value. This is based on current + system settings. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly longTimePattern: string;' + return: + type: string + - name: shortDatePattern + uid: excel!Excel.DatetimeFormatInfo#shortDatePattern:member + package: excel! + fullName: shortDatePattern + summary: >- + Gets the format string for a short date value. This is based on current + system settings. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly shortDatePattern: string;' + return: + type: string + - name: timeSeparator + uid: excel!Excel.DatetimeFormatInfo#timeSeparator:member + package: excel! + fullName: timeSeparator + summary: >- + Gets the string used as the time separator. This is based on current + system settings. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly timeSeparator: string;' + return: + type: string +methods: + - name: load(options) + uid: excel!Excel.DatetimeFormatInfo#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.DatetimeFormatInfoLoadOptions): + Excel.DatetimeFormatInfo; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.DatetimeFormatInfo#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.DatetimeFormatInfo;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.DatetimeFormatInfo#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.DatetimeFormatInfo; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.DatetimeFormatInfo#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.DatetimeFormatInfo` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.DatetimeFormatInfoData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.DatetimeFormatInfoData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.deleteshiftdirection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.deleteshiftdirection.yml new file mode 100644 index 0000000000..2fcd382d9e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.deleteshiftdirection.yml @@ -0,0 +1,48 @@ +### YamlMime:TSEnum +name: Excel.DeleteShiftDirection +uid: excel!Excel.DeleteShiftDirection:enum +package: excel! +fullName: Excel.DeleteShiftDirection +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-worksheet.yaml + + + // This function deletes data from a range and sets the delete shift direction + to "up". + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const range = sheet.getRange("A5:F5"); + range.delete(Excel.DeleteShiftDirection.up); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: left + uid: excel!Excel.DeleteShiftDirection.left:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Left"' + - name: up + uid: excel!Excel.DeleteShiftDirection.up:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Up"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.div0errorcellvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.div0errorcellvalue.yml new file mode 100644 index 0000000000..b49ed85c63 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.div0errorcellvalue.yml @@ -0,0 +1,85 @@ +### YamlMime:TSType +name: Excel.Div0ErrorCellValue +uid: excel!Excel.Div0ErrorCellValue:interface +package: excel! +fullName: Excel.Div0ErrorCellValue +summary: Represents the value of a cell containing a \#DIV/0! error. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: basicType + uid: excel!Excel.Div0ErrorCellValue#basicType:member + package: excel! + fullName: basicType + summary: >- + Represents the value that would be returned by `Range.valueTypes` for a + cell with this value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicType?: RangeValueType.error | "Error";' + return: + type: | "Error" + - name: basicValue + uid: excel!Excel.Div0ErrorCellValue#basicValue:member + package: excel! + fullName: basicValue + summary: >- + Represents the value that would be returned by `Range.values` for a cell + with this value. When accessed through a `valuesAsJson` property, this + string value aligns with the en-US locale. When accessed through a + `valuesAsJsonLocal` property, this string value aligns with the user's + display locale. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicValue?: "#DIV/0!" | string;' + return: + type: '"#DIV/0!" | string' + - name: errorType + uid: excel!Excel.Div0ErrorCellValue#errorType:member + package: excel! + fullName: errorType + summary: Represents the type of `ErrorCellValue`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'errorType?: ErrorCellValueType.div0 | "Div0";' + return: + type: | "Div0" + - name: type + uid: excel!Excel.Div0ErrorCellValue#type:member + package: excel! + fullName: type + summary: Represents the type of this cell value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: CellValueType.error | "Error";' + return: + type: | "Error" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.documentproperties.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.documentproperties.yml new file mode 100644 index 0000000000..a0ed8e7abb --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.documentproperties.yml @@ -0,0 +1,393 @@ +### YamlMime:TSType +name: Excel.DocumentProperties +uid: excel!Excel.DocumentProperties:class +package: excel! +fullName: Excel.DocumentProperties +summary: Represents workbook properties. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: author + uid: excel!Excel.DocumentProperties#author:member + package: excel! + fullName: author + summary: The author of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'author: string;' + return: + type: string + - name: category + uid: excel!Excel.DocumentProperties#category:member + package: excel! + fullName: category + summary: The category of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'category: string;' + return: + type: string + - name: comments + uid: excel!Excel.DocumentProperties#comments:member + package: excel! + fullName: comments + summary: >- + The Comments field in the metadata of the workbook. These have no + connection to comments by users made in the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'comments: string;' + return: + type: string + - name: company + uid: excel!Excel.DocumentProperties#company:member + package: excel! + fullName: company + summary: The company of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'company: string;' + return: + type: string + - name: context + uid: excel!Excel.DocumentProperties#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: creationDate + uid: excel!Excel.DocumentProperties#creationDate:member + package: excel! + fullName: creationDate + summary: Gets the creation date of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly creationDate: Date;' + return: + type: Date + - name: custom + uid: excel!Excel.DocumentProperties#custom:member + package: excel! + fullName: custom + summary: Gets the collection of custom properties of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/26-document/custom-properties.yaml + + + await Excel.run(async (context) => { + // Load the keys and values of all custom properties. + const customDocProperties = context.workbook.properties.custom; + customDocProperties.load(["key", "value"]); + await context.sync(); + + // Log each custom property to the console. + // Note that your document may have more properties than those you have set using this snippet. + customDocProperties.items.forEach((property) => { + console.log(`${property.key}:${property.value}`); + }); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly custom: Excel.CustomPropertyCollection;' + return: + type: + - name: keywords + uid: excel!Excel.DocumentProperties#keywords:member + package: excel! + fullName: keywords + summary: The keywords of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'keywords: string;' + return: + type: string + - name: lastAuthor + uid: excel!Excel.DocumentProperties#lastAuthor:member + package: excel! + fullName: lastAuthor + summary: Gets the last author of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly lastAuthor: string;' + return: + type: string + - name: manager + uid: excel!Excel.DocumentProperties#manager:member + package: excel! + fullName: manager + summary: The manager of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'manager: string;' + return: + type: string + - name: revisionNumber + uid: excel!Excel.DocumentProperties#revisionNumber:member + package: excel! + fullName: revisionNumber + summary: Gets the revision number of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'revisionNumber: number;' + return: + type: number + - name: subject + uid: excel!Excel.DocumentProperties#subject:member + package: excel! + fullName: subject + summary: The subject of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'subject: string;' + return: + type: string + - name: title + uid: excel!Excel.DocumentProperties#title:member + package: excel! + fullName: title + summary: The title of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'title: string;' + return: + type: string +methods: + - name: load(options) + uid: excel!Excel.DocumentProperties#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.DocumentPropertiesLoadOptions): + Excel.DocumentProperties; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.DocumentProperties#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.DocumentProperties;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.DocumentProperties#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.DocumentProperties; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.DocumentProperties#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.DocumentPropertiesUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.DocumentProperties#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.DocumentProperties): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.DocumentProperties#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.DocumentProperties` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.DocumentPropertiesData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.DocumentPropertiesData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.documentpropertyitem.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.documentpropertyitem.yml new file mode 100644 index 0000000000..31baad6702 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.documentpropertyitem.yml @@ -0,0 +1,125 @@ +### YamlMime:TSEnum +name: Excel.DocumentPropertyItem +uid: excel!Excel.DocumentPropertyItem:enum +package: excel! +fullName: Excel.DocumentPropertyItem +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: appName + uid: excel!Excel.DocumentPropertyItem.appName:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"AppName"' + - name: author + uid: excel!Excel.DocumentPropertyItem.author:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Author"' + - name: category + uid: excel!Excel.DocumentPropertyItem.category:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Category"' + - name: comments + uid: excel!Excel.DocumentPropertyItem.comments:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Comments"' + - name: company + uid: excel!Excel.DocumentPropertyItem.company:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Company"' + - name: creation + uid: excel!Excel.DocumentPropertyItem.creation:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Creation"' + - name: format + uid: excel!Excel.DocumentPropertyItem.format:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Format"' + - name: keywords + uid: excel!Excel.DocumentPropertyItem.keywords:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Keywords"' + - name: lastAuth + uid: excel!Excel.DocumentPropertyItem.lastAuth:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LastAuth"' + - name: lastPrint + uid: excel!Excel.DocumentPropertyItem.lastPrint:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LastPrint"' + - name: lastSave + uid: excel!Excel.DocumentPropertyItem.lastSave:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LastSave"' + - name: manager + uid: excel!Excel.DocumentPropertyItem.manager:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Manager"' + - name: revision + uid: excel!Excel.DocumentPropertyItem.revision:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Revision"' + - name: subject + uid: excel!Excel.DocumentPropertyItem.subject:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Subject"' + - name: template + uid: excel!Excel.DocumentPropertyItem.template:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Template"' + - name: title + uid: excel!Excel.DocumentPropertyItem.title:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Title"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.documentpropertytype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.documentpropertytype.yml new file mode 100644 index 0000000000..01447bf07c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.documentpropertytype.yml @@ -0,0 +1,48 @@ +### YamlMime:TSEnum +name: Excel.DocumentPropertyType +uid: excel!Excel.DocumentPropertyType:enum +package: excel! +fullName: Excel.DocumentPropertyType +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: boolean + uid: excel!Excel.DocumentPropertyType.boolean:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Boolean"' + - name: date + uid: excel!Excel.DocumentPropertyType.date:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Date"' + - name: float + uid: excel!Excel.DocumentPropertyType.float:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Float"' + - name: number + uid: excel!Excel.DocumentPropertyType.number:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Number"' + - name: string + uid: excel!Excel.DocumentPropertyType.string:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"String"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.doublecellvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.doublecellvalue.yml new file mode 100644 index 0000000000..098c555569 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.doublecellvalue.yml @@ -0,0 +1,234 @@ +### YamlMime:TSType +name: Excel.DoubleCellValue +uid: excel!Excel.DoubleCellValue:interface +package: excel! +fullName: Excel.DoubleCellValue +summary: Represents the value of a cell containing a double. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: basicType + uid: excel!Excel.DoubleCellValue#basicType:member + package: excel! + fullName: basicType + summary: >- + Represents the value that would be returned by `Range.valueTypes` for a + cell with this value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicType?: RangeValueType.double | "Double";' + return: + type: | "Double" + - name: basicValue + uid: excel!Excel.DoubleCellValue#basicValue:member + package: excel! + fullName: basicValue + summary: >- + Represents the value that would be returned by `Range.values` for a cell + with this value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicValue: number;' + return: + type: number + - name: layouts + uid: excel!Excel.DoubleCellValue#layouts:member + package: excel! + fullName: layouts + summary: Represents layout information for views of this double value. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'layouts?: BasicViewLayouts;' + return: + type: + - name: numberFormat + uid: excel!Excel.DoubleCellValue#numberFormat:member + package: excel! + fullName: numberFormat + summary: >- + Returns the number format string that is used to display this value. When + accessed through a `valuesAsJson` property, this number format string is + in the en-US locale. When accessed through a `valuesAsJsonLocal` property, + this number format is in the user's display locale. Number format strings + must conform to Excel guidelines. To learn more, see [Review guidelines + for customizing a number + format](https://support.microsoft.com/office/c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5). + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-formatted-number.yaml + + + // This function creates a double data type, + + // and sets the format of this data type as a currency. + + await Excel.run(async (context) => { + // Get the Sample worksheet and a range on that sheet. + const sheet = context.workbook.worksheets.getItemOrNullObject("Sample"); + const currencyRange = sheet.getRange("A2"); + + // Write a number formatted as currency to cell A2. + currencyRange.valuesAsJson = [ + [ + { + type: Excel.CellValueType.double, + basicValue: 12.34, + numberFormat: "$* #,##0.00" + } + ] + ]; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat?: string;' + return: + type: string + - name: properties + uid: excel!Excel.DoubleCellValue#properties:member + package: excel! + fullName: properties + summary: Represents additional properties of this double value. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: |- + properties?: { + [key: string]: EntityPropertyType; + }; + return: + type: |- + { + [key: string]: ; + } + - name: provider + uid: excel!Excel.DoubleCellValue#provider:member + package: excel! + fullName: provider + summary: >- + Represents information that describes the service that provided the data + in this `DoubleCellValue`. This information can be used for + branding in card view. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'provider?: CellValueProviderAttributes;' + return: + type: + - name: referencedValues + uid: excel!Excel.DoubleCellValue#referencedValues:member + package: excel! + fullName: referencedValues + summary: >- + Represents the cell values which are referenced within + `DoubleCellValue.properties`. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'referencedValues?: ReferencedValue[];' + return: + type: [] + - name: type + uid: excel!Excel.DoubleCellValue#type:member + package: excel! + fullName: type + summary: Represents the type of this cell value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-formatted-number.yaml + + + // This function creates a double data type, + + // and sets the format of this data type as a date. + + await Excel.run(async (context) => { + // Get the Sample worksheet and a range on that sheet. + const sheet = context.workbook.worksheets.getItemOrNullObject("Sample"); + const dateRange = sheet.getRange("A1"); + + // Write a number formatted as a date to cell A1. + dateRange.valuesAsJson = [ + [ + { + type: Excel.CellValueType.double, + basicValue: 32889.0, + numberFormat: "m/d/yyyy" + } + ] + ]; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'type: CellValueType.double | "Double";' + return: + type: | "Double" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.dynamicfiltercriteria.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.dynamicfiltercriteria.yml new file mode 100644 index 0000000000..ade8967de7 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.dynamicfiltercriteria.yml @@ -0,0 +1,289 @@ +### YamlMime:TSEnum +name: Excel.DynamicFilterCriteria +uid: excel!Excel.DynamicFilterCriteria:enum +package: excel! +fullName: Excel.DynamicFilterCriteria +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/46-table/filter-data.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + + const expensesTable = sheet.tables.getItem("ExpensesTable"); + + let filter = expensesTable.columns.getItem("Amount").filter; + filter.apply({ + filterOn: Excel.FilterOn.dynamic, + dynamicCriteria: Excel.DynamicFilterCriteria.belowAverage + }); + + filter = expensesTable.columns.getItem("Category").filter; + filter.apply({ + filterOn: Excel.FilterOn.values, + values: ["Restaurant", "Groceries"] + }); + + await context.sync(); + }); + ``` + +isPreview: false +isDeprecated: false +fields: + - name: aboveAverage + uid: excel!Excel.DynamicFilterCriteria.aboveAverage:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"AboveAverage"' + - name: allDatesInPeriodApril + uid: excel!Excel.DynamicFilterCriteria.allDatesInPeriodApril:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"AllDatesInPeriodApril"' + - name: allDatesInPeriodAugust + uid: excel!Excel.DynamicFilterCriteria.allDatesInPeriodAugust:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"AllDatesInPeriodAugust"' + - name: allDatesInPeriodDecember + uid: excel!Excel.DynamicFilterCriteria.allDatesInPeriodDecember:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"AllDatesInPeriodDecember"' + - name: allDatesInPeriodFebruray + uid: excel!Excel.DynamicFilterCriteria.allDatesInPeriodFebruray:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"AllDatesInPeriodFebruray"' + - name: allDatesInPeriodJanuary + uid: excel!Excel.DynamicFilterCriteria.allDatesInPeriodJanuary:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"AllDatesInPeriodJanuary"' + - name: allDatesInPeriodJuly + uid: excel!Excel.DynamicFilterCriteria.allDatesInPeriodJuly:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"AllDatesInPeriodJuly"' + - name: allDatesInPeriodJune + uid: excel!Excel.DynamicFilterCriteria.allDatesInPeriodJune:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"AllDatesInPeriodJune"' + - name: allDatesInPeriodMarch + uid: excel!Excel.DynamicFilterCriteria.allDatesInPeriodMarch:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"AllDatesInPeriodMarch"' + - name: allDatesInPeriodMay + uid: excel!Excel.DynamicFilterCriteria.allDatesInPeriodMay:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"AllDatesInPeriodMay"' + - name: allDatesInPeriodNovember + uid: excel!Excel.DynamicFilterCriteria.allDatesInPeriodNovember:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"AllDatesInPeriodNovember"' + - name: allDatesInPeriodOctober + uid: excel!Excel.DynamicFilterCriteria.allDatesInPeriodOctober:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"AllDatesInPeriodOctober"' + - name: allDatesInPeriodQuarter1 + uid: excel!Excel.DynamicFilterCriteria.allDatesInPeriodQuarter1:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"AllDatesInPeriodQuarter1"' + - name: allDatesInPeriodQuarter2 + uid: excel!Excel.DynamicFilterCriteria.allDatesInPeriodQuarter2:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"AllDatesInPeriodQuarter2"' + - name: allDatesInPeriodQuarter3 + uid: excel!Excel.DynamicFilterCriteria.allDatesInPeriodQuarter3:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"AllDatesInPeriodQuarter3"' + - name: allDatesInPeriodQuarter4 + uid: excel!Excel.DynamicFilterCriteria.allDatesInPeriodQuarter4:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"AllDatesInPeriodQuarter4"' + - name: allDatesInPeriodSeptember + uid: excel!Excel.DynamicFilterCriteria.allDatesInPeriodSeptember:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"AllDatesInPeriodSeptember"' + - name: belowAverage + uid: excel!Excel.DynamicFilterCriteria.belowAverage:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"BelowAverage"' + - name: lastMonth + uid: excel!Excel.DynamicFilterCriteria.lastMonth:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LastMonth"' + - name: lastQuarter + uid: excel!Excel.DynamicFilterCriteria.lastQuarter:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LastQuarter"' + - name: lastWeek + uid: excel!Excel.DynamicFilterCriteria.lastWeek:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LastWeek"' + - name: lastYear + uid: excel!Excel.DynamicFilterCriteria.lastYear:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LastYear"' + - name: nextMonth + uid: excel!Excel.DynamicFilterCriteria.nextMonth:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"NextMonth"' + - name: nextQuarter + uid: excel!Excel.DynamicFilterCriteria.nextQuarter:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"NextQuarter"' + - name: nextWeek + uid: excel!Excel.DynamicFilterCriteria.nextWeek:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"NextWeek"' + - name: nextYear + uid: excel!Excel.DynamicFilterCriteria.nextYear:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"NextYear"' + - name: thisMonth + uid: excel!Excel.DynamicFilterCriteria.thisMonth:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ThisMonth"' + - name: thisQuarter + uid: excel!Excel.DynamicFilterCriteria.thisQuarter:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ThisQuarter"' + - name: thisWeek + uid: excel!Excel.DynamicFilterCriteria.thisWeek:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ThisWeek"' + - name: thisYear + uid: excel!Excel.DynamicFilterCriteria.thisYear:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ThisYear"' + - name: today + uid: excel!Excel.DynamicFilterCriteria.today:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Today"' + - name: tomorrow + uid: excel!Excel.DynamicFilterCriteria.tomorrow:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Tomorrow"' + - name: unknown + uid: excel!Excel.DynamicFilterCriteria.unknown:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Unknown"' + - name: yearToDate + uid: excel!Excel.DynamicFilterCriteria.yearToDate:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"YearToDate"' + - name: yesterday + uid: excel!Excel.DynamicFilterCriteria.yesterday:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Yesterday"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.emptycellcontrol.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.emptycellcontrol.yml new file mode 100644 index 0000000000..eab01639d5 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.emptycellcontrol.yml @@ -0,0 +1,29 @@ +### YamlMime:TSType +name: Excel.EmptyCellControl +uid: excel!Excel.EmptyCellControl:interface +package: excel! +fullName: Excel.EmptyCellControl +summary: >- + Represents an empty cell control. This represents the state where a cell does + not have a control. +remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: type + uid: excel!Excel.EmptyCellControl#type:member + package: excel! + fullName: type + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'type: CellControlType.empty;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.emptycellvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.emptycellvalue.yml new file mode 100644 index 0000000000..39cbccdc5d --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.emptycellvalue.yml @@ -0,0 +1,66 @@ +### YamlMime:TSType +name: Excel.EmptyCellValue +uid: excel!Excel.EmptyCellValue:interface +package: excel! +fullName: Excel.EmptyCellValue +summary: Represents the value of a cell that's empty and has no formulas or data. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: basicType + uid: excel!Excel.EmptyCellValue#basicType:member + package: excel! + fullName: basicType + summary: >- + Represents the value that would be returned by `Range.valueTypes` for a + cell with this value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicType?: RangeValueType.empty | "Empty";' + return: + type: | "Empty" + - name: basicValue + uid: excel!Excel.EmptyCellValue#basicValue:member + package: excel! + fullName: basicValue + summary: >- + Represents the value that would be returned by `Range.values` for a cell + with this value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicValue?: "";' + return: + type: '""' + - name: type + uid: excel!Excel.EmptyCellValue#type:member + package: excel! + fullName: type + summary: Represents the type of this cell value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: CellValueType.empty | "Empty";' + return: + type: | "Empty" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.entitycardlayout.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.entitycardlayout.yml new file mode 100644 index 0000000000..79647849b2 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.entitycardlayout.yml @@ -0,0 +1,31 @@ +### YamlMime:TSType +name: Excel.EntityCardLayout +uid: excel!Excel.EntityCardLayout:interface +package: excel! +fullName: Excel.EntityCardLayout +summary: Represents a card layout that is best used for an entity. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: layout + uid: excel!Excel.EntityCardLayout#layout:member + package: excel! + fullName: layout + summary: Represents the type of this layout. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'layout?: "Entity";' + return: + type: '"Entity"' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.entitycardlayouttype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.entitycardlayouttype.yml new file mode 100644 index 0000000000..1fc05d7679 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.entitycardlayouttype.yml @@ -0,0 +1,24 @@ +### YamlMime:TSEnum +name: Excel.EntityCardLayoutType +uid: excel!Excel.EntityCardLayoutType:enum +package: excel! +fullName: Excel.EntityCardLayoutType +summary: Types of entity card layouts. +remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: entity + uid: excel!Excel.EntityCardLayoutType.entity:member + package: excel! + summary: >- + Entity layout of the entity card. + + + * \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Entity"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.entitycellvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.entitycellvalue.yml new file mode 100644 index 0000000000..255079db0d --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.entitycellvalue.yml @@ -0,0 +1,162 @@ +### YamlMime:TSType +name: Excel.EntityCellValue +uid: excel!Excel.EntityCellValue:interface +package: excel! +fullName: Excel.EntityCellValue +summary: Represents a set of properties without a schema or defined structure. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: basicType + uid: excel!Excel.EntityCellValue#basicType:member + package: excel! + fullName: basicType + summary: >- + Represents the value that would be returned by `Range.valueTypes` for a + cell with this value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicType?: RangeValueType.error | "Error";' + return: + type: | "Error" + - name: basicValue + uid: excel!Excel.EntityCellValue#basicValue:member + package: excel! + fullName: basicValue + summary: >- + Represents the value that would be returned by `Range.values` for a cell + with this value. When accessed through a `valuesAsJson` property, this + string value aligns with the en-US locale. When accessed through a + `valuesAsJsonLocal` property, this string value aligns with the user's + display locale. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicValue?: "#VALUE!" | string;' + return: + type: '"#VALUE!" | string' + - name: layouts + uid: excel!Excel.EntityCellValue#layouts:member + package: excel! + fullName: layouts + summary: Represents layout information for views of this entity. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'layouts?: EntityViewLayouts;' + return: + type: + - name: properties + uid: excel!Excel.EntityCellValue#properties:member + package: excel! + fullName: properties + summary: Represents the properties of this entity and their metadata. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: |- + properties?: { + [key: string]: EntityPropertyType; + }; + return: + type: |- + { + [key: string]: ; + } + - name: provider + uid: excel!Excel.EntityCellValue#provider:member + package: excel! + fullName: provider + summary: >- + Represents information that describes the service that provided the data + in this `EntityCellValue`. This information can be used for + branding in entity cards. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'provider?: CellValueProviderAttributes;' + return: + type: + - name: referencedValues + uid: excel!Excel.EntityCellValue#referencedValues:member + package: excel! + fullName: referencedValues + summary: >- + Represents the cell values which are referenced within + `EntityCellValue.properties`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'referencedValues?: ReferencedValue[];' + return: + type: [] + - name: text + uid: excel!Excel.EntityCellValue#text:member + package: excel! + fullName: text + summary: Represents the text shown when a cell with this value is rendered. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'text?: string;' + return: + type: string + - name: type + uid: excel!Excel.EntityCellValue#type:member + package: excel! + fullName: type + summary: Represents the type of this cell value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: CellValueType.entity | ReferenceValueType.entity | "Entity";' + return: + type: >- + | | "Entity" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.entitycompactlayout.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.entitycompactlayout.yml new file mode 100644 index 0000000000..2ca37c46eb --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.entitycompactlayout.yml @@ -0,0 +1,30 @@ +### YamlMime:TSType +name: Excel.EntityCompactLayout +uid: excel!Excel.EntityCompactLayout:interface +package: excel! +fullName: Excel.EntityCompactLayout +summary: The compact layout properties for an entity. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: icon + uid: excel!Excel.EntityCompactLayout#icon:member + package: excel! + fullName: icon + summary: Specifies the name of the icon which is used to open the card. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'icon?: string | EntityCompactLayoutIcons;' + return: + type: string | diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.entitycompactlayouticons.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.entitycompactlayouticons.yml new file mode 100644 index 0000000000..1909c1268c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.entitycompactlayouticons.yml @@ -0,0 +1,6104 @@ +### YamlMime:TSEnum +name: Excel.EntityCompactLayoutIcons +uid: excel!Excel.EntityCompactLayoutIcons:enum +package: excel! +fullName: Excel.EntityCompactLayoutIcons +summary: >- + The list of icons available for `EntityCompactLayout`. An icon + displays in the Excel UI, either to the left of the title in a cell that + contains an entity card, or to the left of the title of a referenced entity + inside an entity card. Selecting the icon opens the entity card. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-entity-icons.yaml + + + function createEntitiesWithIcons(icons): Excel.EntityCellValue[][] { + /* This method creates an entity data type for each + * icon in the `EntityCompactLayoutIcons` enum, + * and then displays the icon name with its icon. + */ + let entities = []; + icons.forEach(function(iconName, index, array) { + let icon = iconNames[iconName]; + entities.push([ + { + type: "Entity", + text: iconName, + properties: {}, + layouts: { + compact: { + icon + } + } + } + ]); + }); + return entities; + } + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: accessibility + uid: excel!Excel.EntityCompactLayoutIcons.accessibility:member + package: excel! + summary: >- + Accessibility icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Accessibility"' + - name: airplane + uid: excel!Excel.EntityCompactLayoutIcons.airplane:member + package: excel! + summary: >- + Airplane icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Airplane"' + - name: airplaneTakeOff + uid: excel!Excel.EntityCompactLayoutIcons.airplaneTakeOff:member + package: excel! + summary: >- + Airplane taking off icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"AirplaneTakeOff"' + - name: album + uid: excel!Excel.EntityCompactLayoutIcons.album:member + package: excel! + summary: >- + Album icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Album"' + - name: alert + uid: excel!Excel.EntityCompactLayoutIcons.alert:member + package: excel! + summary: >- + Alert icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Alert"' + - name: alertUrgent + uid: excel!Excel.EntityCompactLayoutIcons.alertUrgent:member + package: excel! + summary: >- + Alert urgent icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"AlertUrgent"' + - name: animal + uid: excel!Excel.EntityCompactLayoutIcons.animal:member + package: excel! + summary: >- + Animal icon. Displays as a pawprint. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Animal"' + - name: animalCat + uid: excel!Excel.EntityCompactLayoutIcons.animalCat:member + package: excel! + summary: >- + Animal cat icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"AnimalCat"' + - name: animalDog + uid: excel!Excel.EntityCompactLayoutIcons.animalDog:member + package: excel! + summary: >- + Animal dog icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"AnimalDog"' + - name: animalRabbit + uid: excel!Excel.EntityCompactLayoutIcons.animalRabbit:member + package: excel! + summary: >- + Animal rabbit icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"AnimalRabbit"' + - name: animalTurtle + uid: excel!Excel.EntityCompactLayoutIcons.animalTurtle:member + package: excel! + summary: >- + Animal turtle icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"AnimalTurtle"' + - name: appFolder + uid: excel!Excel.EntityCompactLayoutIcons.appFolder:member + package: excel! + summary: >- + App folder icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"AppFolder"' + - name: appGeneric + uid: excel!Excel.EntityCompactLayoutIcons.appGeneric:member + package: excel! + summary: >- + App generic icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"AppGeneric"' + - name: apple + uid: excel!Excel.EntityCompactLayoutIcons.apple:member + package: excel! + summary: >- + Apple icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Apple"' + - name: approvalsApp + uid: excel!Excel.EntityCompactLayoutIcons.approvalsApp:member + package: excel! + summary: >- + Approvals app icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ApprovalsApp"' + - name: archive + uid: excel!Excel.EntityCompactLayoutIcons.archive:member + package: excel! + summary: >- + Archive icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Archive"' + - name: archiveMultiple + uid: excel!Excel.EntityCompactLayoutIcons.archiveMultiple:member + package: excel! + summary: >- + Archive multiple icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ArchiveMultiple"' + - name: arrowTrendingLines + uid: excel!Excel.EntityCompactLayoutIcons.arrowTrendingLines:member + package: excel! + summary: >- + Arrow trending lines icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ArrowTrendingLines"' + - name: art + uid: excel!Excel.EntityCompactLayoutIcons.art:member + package: excel! + summary: >- + Art icon. Displays as a paint palette. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Art"' + - name: atom + uid: excel!Excel.EntityCompactLayoutIcons.atom:member + package: excel! + summary: >- + Atom icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Atom"' + - name: attach + uid: excel!Excel.EntityCompactLayoutIcons.attach:member + package: excel! + summary: >- + Attach icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Attach"' + - name: automobile + uid: excel!Excel.EntityCompactLayoutIcons.automobile:member + package: excel! + summary: >- + Automobile icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Automobile"' + - name: autosum + uid: excel!Excel.EntityCompactLayoutIcons.autosum:member + package: excel! + summary: >- + Autosum icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Autosum"' + - name: backpack + uid: excel!Excel.EntityCompactLayoutIcons.backpack:member + package: excel! + summary: >- + Backpack icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Backpack"' + - name: badge + uid: excel!Excel.EntityCompactLayoutIcons.badge:member + package: excel! + summary: >- + Badge icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Badge"' + - name: balloon + uid: excel!Excel.EntityCompactLayoutIcons.balloon:member + package: excel! + summary: >- + Balloon icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Balloon"' + - name: bank + uid: excel!Excel.EntityCompactLayoutIcons.bank:member + package: excel! + summary: >- + Bank icon. Displays as a building with pillars and a triangular roof. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Bank"' + - name: barcodeScanner + uid: excel!Excel.EntityCompactLayoutIcons.barcodeScanner:member + package: excel! + summary: >- + Barcode scanner icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"BarcodeScanner"' + - name: basketball + uid: excel!Excel.EntityCompactLayoutIcons.basketball:member + package: excel! + summary: >- + Basketball icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Basketball"' + - name: battery0 + uid: excel!Excel.EntityCompactLayoutIcons.battery0:member + package: excel! + summary: >- + Battery empty icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Battery0"' + - name: battery10 + uid: excel!Excel.EntityCompactLayoutIcons.battery10:member + package: excel! + summary: >- + Battery full icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Battery10"' + - name: beach + uid: excel!Excel.EntityCompactLayoutIcons.beach:member + package: excel! + summary: >- + Beach icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Beach"' + - name: beaker + uid: excel!Excel.EntityCompactLayoutIcons.beaker:member + package: excel! + summary: >- + Beaker icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Beaker"' + - name: bed + uid: excel!Excel.EntityCompactLayoutIcons.bed:member + package: excel! + summary: >- + Bed icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Bed"' + - name: binFull + uid: excel!Excel.EntityCompactLayoutIcons.binFull:member + package: excel! + summary: >- + Bin full icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"BinFull"' + - name: bird + uid: excel!Excel.EntityCompactLayoutIcons.bird:member + package: excel! + summary: >- + Bird icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Bird"' + - name: bluetooth + uid: excel!Excel.EntityCompactLayoutIcons.bluetooth:member + package: excel! + summary: >- + Bluetooth icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Bluetooth"' + - name: board + uid: excel!Excel.EntityCompactLayoutIcons.board:member + package: excel! + summary: >- + Board icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Board"' + - name: boardGames + uid: excel!Excel.EntityCompactLayoutIcons.boardGames:member + package: excel! + summary: >- + Board games icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"BoardGames"' + - name: book + uid: excel!Excel.EntityCompactLayoutIcons.book:member + package: excel! + summary: >- + Book icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Book"' + - name: bookmark + uid: excel!Excel.EntityCompactLayoutIcons.bookmark:member + package: excel! + summary: >- + Bookmark icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Bookmark"' + - name: bookmarkMultiple + uid: excel!Excel.EntityCompactLayoutIcons.bookmarkMultiple:member + package: excel! + summary: >- + Bookmark multiple icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"BookmarkMultiple"' + - name: bot + uid: excel!Excel.EntityCompactLayoutIcons.bot:member + package: excel! + summary: >- + Bot icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Bot"' + - name: bowlChopsticks + uid: excel!Excel.EntityCompactLayoutIcons.bowlChopsticks:member + package: excel! + summary: >- + Bowl chopsticks icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"BowlChopsticks"' + - name: box + uid: excel!Excel.EntityCompactLayoutIcons.box:member + package: excel! + summary: >- + Box icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Box"' + - name: boxMultiple + uid: excel!Excel.EntityCompactLayoutIcons.boxMultiple:member + package: excel! + summary: >- + Box multiple icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"BoxMultiple"' + - name: brainCircuit + uid: excel!Excel.EntityCompactLayoutIcons.brainCircuit:member + package: excel! + summary: >- + Brain circuit icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"BrainCircuit"' + - name: branch + uid: excel!Excel.EntityCompactLayoutIcons.branch:member + package: excel! + summary: >- + Branch icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Branch"' + - name: branchFork + uid: excel!Excel.EntityCompactLayoutIcons.branchFork:member + package: excel! + summary: >- + Branch fork icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"BranchFork"' + - name: branchRequest + uid: excel!Excel.EntityCompactLayoutIcons.branchRequest:member + package: excel! + summary: >- + Branch request icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"BranchRequest"' + - name: bridge + uid: excel!Excel.EntityCompactLayoutIcons.bridge:member + package: excel! + summary: >- + Bridge icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Bridge"' + - name: briefcase + uid: excel!Excel.EntityCompactLayoutIcons.briefcase:member + package: excel! + summary: >- + Briefcase icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Briefcase"' + - name: briefcaseMedical + uid: excel!Excel.EntityCompactLayoutIcons.briefcaseMedical:member + package: excel! + summary: >- + Briefcase medical icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"BriefcaseMedical"' + - name: broadActivityFeed + uid: excel!Excel.EntityCompactLayoutIcons.broadActivityFeed:member + package: excel! + summary: >- + Broad activity feed icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"BroadActivityFeed"' + - name: broom + uid: excel!Excel.EntityCompactLayoutIcons.broom:member + package: excel! + summary: >- + Broom icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Broom"' + - name: bug + uid: excel!Excel.EntityCompactLayoutIcons.bug:member + package: excel! + summary: >- + Bug icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Bug"' + - name: building + uid: excel!Excel.EntityCompactLayoutIcons.building:member + package: excel! + summary: >- + Building icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Building"' + - name: buildingBank + uid: excel!Excel.EntityCompactLayoutIcons.buildingBank:member + package: excel! + summary: >- + Building bank icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"BuildingBank"' + - name: buildingFactory + uid: excel!Excel.EntityCompactLayoutIcons.buildingFactory:member + package: excel! + summary: >- + Building factory icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"BuildingFactory"' + - name: buildingGovernment + uid: excel!Excel.EntityCompactLayoutIcons.buildingGovernment:member + package: excel! + summary: >- + Building government icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"BuildingGovernment"' + - name: buildingHome + uid: excel!Excel.EntityCompactLayoutIcons.buildingHome:member + package: excel! + summary: >- + Building home icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"BuildingHome"' + - name: buildingLighthouse + uid: excel!Excel.EntityCompactLayoutIcons.buildingLighthouse:member + package: excel! + summary: >- + Building lighthouse icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"BuildingLighthouse"' + - name: buildingMultiple + uid: excel!Excel.EntityCompactLayoutIcons.buildingMultiple:member + package: excel! + summary: >- + Building multiple icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"BuildingMultiple"' + - name: buildingRetail + uid: excel!Excel.EntityCompactLayoutIcons.buildingRetail:member + package: excel! + summary: >- + Building retail icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"BuildingRetail"' + - name: buildingRetailMore + uid: excel!Excel.EntityCompactLayoutIcons.buildingRetailMore:member + package: excel! + summary: >- + Building retail more icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"BuildingRetailMore"' + - name: buildingRetailToolbox + uid: excel!Excel.EntityCompactLayoutIcons.buildingRetailToolbox:member + package: excel! + summary: >- + Building retail toolbox icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"BuildingRetailToolbox"' + - name: buildingShop + uid: excel!Excel.EntityCompactLayoutIcons.buildingShop:member + package: excel! + summary: >- + Building shop icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"BuildingShop"' + - name: buildingSkyscraper + uid: excel!Excel.EntityCompactLayoutIcons.buildingSkyscraper:member + package: excel! + summary: >- + Building skyscraper icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"BuildingSkyscraper"' + - name: calculator + uid: excel!Excel.EntityCompactLayoutIcons.calculator:member + package: excel! + summary: >- + Calculator icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Calculator"' + - name: calendarLtr + uid: excel!Excel.EntityCompactLayoutIcons.calendarLtr:member + package: excel! + summary: >- + Calendar left to right icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CalendarLtr"' + - name: calendarRtl + uid: excel!Excel.EntityCompactLayoutIcons.calendarRtl:member + package: excel! + summary: >- + Calendar right to left icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CalendarRtl"' + - name: call + uid: excel!Excel.EntityCompactLayoutIcons.call:member + package: excel! + summary: >- + Call icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Call"' + - name: calligraphyPen + uid: excel!Excel.EntityCompactLayoutIcons.calligraphyPen:member + package: excel! + summary: >- + Calligraphy pen icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CalligraphyPen"' + - name: camera + uid: excel!Excel.EntityCompactLayoutIcons.camera:member + package: excel! + summary: >- + Camera icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Camera"' + - name: cameraDome + uid: excel!Excel.EntityCompactLayoutIcons.cameraDome:member + package: excel! + summary: >- + Camera dome icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CameraDome"' + - name: car + uid: excel!Excel.EntityCompactLayoutIcons.car:member + package: excel! + summary: >- + Car icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Car"' + - name: cart + uid: excel!Excel.EntityCompactLayoutIcons.cart:member + package: excel! + summary: >- + Cart icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Cart"' + - name: cat + uid: excel!Excel.EntityCompactLayoutIcons.cat:member + package: excel! + summary: >- + Cat icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Cat"' + - name: certificate + uid: excel!Excel.EntityCompactLayoutIcons.certificate:member + package: excel! + summary: >- + Certificate icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Certificate"' + - name: chartMultiple + uid: excel!Excel.EntityCompactLayoutIcons.chartMultiple:member + package: excel! + summary: >- + Chart multiple icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ChartMultiple"' + - name: chat + uid: excel!Excel.EntityCompactLayoutIcons.chat:member + package: excel! + summary: >- + Chat icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Chat"' + - name: chatMultiple + uid: excel!Excel.EntityCompactLayoutIcons.chatMultiple:member + package: excel! + summary: >- + Chat multiple icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ChatMultiple"' + - name: chatVideo + uid: excel!Excel.EntityCompactLayoutIcons.chatVideo:member + package: excel! + summary: >- + Chat video icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ChatVideo"' + - name: check + uid: excel!Excel.EntityCompactLayoutIcons.check:member + package: excel! + summary: >- + Check icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Check"' + - name: checkboxChecked + uid: excel!Excel.EntityCompactLayoutIcons.checkboxChecked:member + package: excel! + summary: >- + Checkbox checked icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CheckboxChecked"' + - name: checkboxUnchecked + uid: excel!Excel.EntityCompactLayoutIcons.checkboxUnchecked:member + package: excel! + summary: >- + Checkbox unchecked icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CheckboxUnchecked"' + - name: checkmark + uid: excel!Excel.EntityCompactLayoutIcons.checkmark:member + package: excel! + summary: >- + Checkmark icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Checkmark"' + - name: chess + uid: excel!Excel.EntityCompactLayoutIcons.chess:member + package: excel! + summary: >- + Chess icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Chess"' + - name: city + uid: excel!Excel.EntityCompactLayoutIcons.city:member + package: excel! + summary: >- + City icon. Displays as multiple tall buildings. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"City"' + - name: class + uid: excel!Excel.EntityCompactLayoutIcons.class:member + package: excel! + summary: >- + Class icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Class"' + - name: classification + uid: excel!Excel.EntityCompactLayoutIcons.classification:member + package: excel! + summary: >- + Classification icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Classification"' + - name: clipboard + uid: excel!Excel.EntityCompactLayoutIcons.clipboard:member + package: excel! + summary: >- + Clipboard icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Clipboard"' + - name: clipboardDataBar + uid: excel!Excel.EntityCompactLayoutIcons.clipboardDataBar:member + package: excel! + summary: >- + Clipboard data bar icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ClipboardDataBar"' + - name: clipboardPulse + uid: excel!Excel.EntityCompactLayoutIcons.clipboardPulse:member + package: excel! + summary: >- + Clipboard pulse icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ClipboardPulse"' + - name: clipboardTask + uid: excel!Excel.EntityCompactLayoutIcons.clipboardTask:member + package: excel! + summary: >- + Clipboard task icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ClipboardTask"' + - name: clock + uid: excel!Excel.EntityCompactLayoutIcons.clock:member + package: excel! + summary: >- + Clock icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Clock"' + - name: clockAlarm + uid: excel!Excel.EntityCompactLayoutIcons.clockAlarm:member + package: excel! + summary: >- + Clock alarm icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ClockAlarm"' + - name: cloud + uid: excel!Excel.EntityCompactLayoutIcons.cloud:member + package: excel! + summary: >- + Cloud icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Cloud"' + - name: cloudWords + uid: excel!Excel.EntityCompactLayoutIcons.cloudWords:member + package: excel! + summary: >- + Cloud words icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CloudWords"' + - name: code + uid: excel!Excel.EntityCompactLayoutIcons.code:member + package: excel! + summary: >- + Code icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Code"' + - name: collections + uid: excel!Excel.EntityCompactLayoutIcons.collections:member + package: excel! + summary: >- + Collections icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Collections"' + - name: comment + uid: excel!Excel.EntityCompactLayoutIcons.comment:member + package: excel! + summary: >- + Comment icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Comment"' + - name: commentMultiple + uid: excel!Excel.EntityCompactLayoutIcons.commentMultiple:member + package: excel! + summary: >- + Comment multiple icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CommentMultiple"' + - name: communication + uid: excel!Excel.EntityCompactLayoutIcons.communication:member + package: excel! + summary: >- + Communication icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Communication"' + - name: compassNorthwest + uid: excel!Excel.EntityCompactLayoutIcons.compassNorthwest:member + package: excel! + summary: >- + Compass northwest icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CompassNorthwest"' + - name: conferenceRoom + uid: excel!Excel.EntityCompactLayoutIcons.conferenceRoom:member + package: excel! + summary: >- + Conference room icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ConferenceRoom"' + - name: connector + uid: excel!Excel.EntityCompactLayoutIcons.connector:member + package: excel! + summary: >- + Connector icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Connector"' + - name: constellation + uid: excel!Excel.EntityCompactLayoutIcons.constellation:member + package: excel! + summary: >- + Constellation icon. Displays dots in the shape of Ursa Major. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Constellation"' + - name: contactCard + uid: excel!Excel.EntityCompactLayoutIcons.contactCard:member + package: excel! + summary: >- + Contact card icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ContactCard"' + - name: cookies + uid: excel!Excel.EntityCompactLayoutIcons.cookies:member + package: excel! + summary: >- + Cookies icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Cookies"' + - name: couch + uid: excel!Excel.EntityCompactLayoutIcons.couch:member + package: excel! + summary: >- + Couch icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Couch"' + - name: creditCardPerson + uid: excel!Excel.EntityCompactLayoutIcons.creditCardPerson:member + package: excel! + summary: >- + Credit card person icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CreditCardPerson"' + - name: creditCardToolbox + uid: excel!Excel.EntityCompactLayoutIcons.creditCardToolbox:member + package: excel! + summary: >- + Credit card toolbox icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CreditCardToolbox"' + - name: cube + uid: excel!Excel.EntityCompactLayoutIcons.cube:member + package: excel! + summary: >- + Cube icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Cube"' + - name: cubeMultiple + uid: excel!Excel.EntityCompactLayoutIcons.cubeMultiple:member + package: excel! + summary: >- + Cube multiple icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CubeMultiple"' + - name: cubeTree + uid: excel!Excel.EntityCompactLayoutIcons.cubeTree:member + package: excel! + summary: >- + Cube tree icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CubeTree"' + - name: currencyDollarEuro + uid: excel!Excel.EntityCompactLayoutIcons.currencyDollarEuro:member + package: excel! + summary: >- + Currency dollar euro icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CurrencyDollarEuro"' + - name: currencyDollarRupee + uid: excel!Excel.EntityCompactLayoutIcons.currencyDollarRupee:member + package: excel! + summary: >- + Currency dollar rupee icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CurrencyDollarRupee"' + - name: dataArea + uid: excel!Excel.EntityCompactLayoutIcons.dataArea:member + package: excel! + summary: >- + Data area icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"DataArea"' + - name: database + uid: excel!Excel.EntityCompactLayoutIcons.database:member + package: excel! + summary: >- + Database icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Database"' + - name: databaseMultiple + uid: excel!Excel.EntityCompactLayoutIcons.databaseMultiple:member + package: excel! + summary: >- + Database multiple icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"DatabaseMultiple"' + - name: dataFunnel + uid: excel!Excel.EntityCompactLayoutIcons.dataFunnel:member + package: excel! + summary: >- + Data funnel icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"DataFunnel"' + - name: dataHistogram + uid: excel!Excel.EntityCompactLayoutIcons.dataHistogram:member + package: excel! + summary: >- + Data histogram icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"DataHistogram"' + - name: dataLine + uid: excel!Excel.EntityCompactLayoutIcons.dataLine:member + package: excel! + summary: >- + Data line icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"DataLine"' + - name: dataPie + uid: excel!Excel.EntityCompactLayoutIcons.dataPie:member + package: excel! + summary: >- + Data pie icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"DataPie"' + - name: dataScatter + uid: excel!Excel.EntityCompactLayoutIcons.dataScatter:member + package: excel! + summary: >- + Data scatter icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"DataScatter"' + - name: dataSunburst + uid: excel!Excel.EntityCompactLayoutIcons.dataSunburst:member + package: excel! + summary: >- + Data sunburst icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"DataSunburst"' + - name: dataTreemap + uid: excel!Excel.EntityCompactLayoutIcons.dataTreemap:member + package: excel! + summary: >- + Data treemap icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"DataTreemap"' + - name: dataWaterfall + uid: excel!Excel.EntityCompactLayoutIcons.dataWaterfall:member + package: excel! + summary: >- + Data waterfall icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"DataWaterfall"' + - name: dataWhisker + uid: excel!Excel.EntityCompactLayoutIcons.dataWhisker:member + package: excel! + summary: >- + Data whisker icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"DataWhisker"' + - name: dentist + uid: excel!Excel.EntityCompactLayoutIcons.dentist:member + package: excel! + summary: >- + Dentist icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Dentist"' + - name: designIdeas + uid: excel!Excel.EntityCompactLayoutIcons.designIdeas:member + package: excel! + summary: >- + Design ideas icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"DesignIdeas"' + - name: desktop + uid: excel!Excel.EntityCompactLayoutIcons.desktop:member + package: excel! + summary: >- + Desktop icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Desktop"' + - name: desktopMac + uid: excel!Excel.EntityCompactLayoutIcons.desktopMac:member + package: excel! + summary: >- + Desktop Mac icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"DesktopMac"' + - name: developerBoard + uid: excel!Excel.EntityCompactLayoutIcons.developerBoard:member + package: excel! + summary: >- + Developer board icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"DeveloperBoard"' + - name: deviceMeetingRoom + uid: excel!Excel.EntityCompactLayoutIcons.deviceMeetingRoom:member + package: excel! + summary: >- + Device meeting room icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"DeviceMeetingRoom"' + - name: diagram + uid: excel!Excel.EntityCompactLayoutIcons.diagram:member + package: excel! + summary: >- + Diagram icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Diagram"' + - name: dialpad + uid: excel!Excel.EntityCompactLayoutIcons.dialpad:member + package: excel! + summary: >- + Dialpad icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Dialpad"' + - name: diamond + uid: excel!Excel.EntityCompactLayoutIcons.diamond:member + package: excel! + summary: >- + Diamond icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Diamond"' + - name: dinosaur + uid: excel!Excel.EntityCompactLayoutIcons.dinosaur:member + package: excel! + summary: >- + Dinosaur icon. Displays as a long-necked dinosaur, similar to a + Brachiosaurus. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Dinosaur"' + - name: directions + uid: excel!Excel.EntityCompactLayoutIcons.directions:member + package: excel! + summary: >- + Directions icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Directions"' + - name: disaster + uid: excel!Excel.EntityCompactLayoutIcons.disaster:member + package: excel! + summary: >- + Disaster icon. Displays as a house sinking in a flood. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Disaster"' + - name: diversity + uid: excel!Excel.EntityCompactLayoutIcons.diversity:member + package: excel! + summary: >- + Diversity icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Diversity"' + - name: dNA + uid: excel!Excel.EntityCompactLayoutIcons.dNA:member + package: excel! + summary: >- + DNA icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"DNA"' + - name: doctor + uid: excel!Excel.EntityCompactLayoutIcons.doctor:member + package: excel! + summary: >- + Doctor icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Doctor"' + - name: document + uid: excel!Excel.EntityCompactLayoutIcons.document:member + package: excel! + summary: >- + Document icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Document"' + - name: documentData + uid: excel!Excel.EntityCompactLayoutIcons.documentData:member + package: excel! + summary: >- + Document data icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"DocumentData"' + - name: documentLandscape + uid: excel!Excel.EntityCompactLayoutIcons.documentLandscape:member + package: excel! + summary: >- + Document landscape icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"DocumentLandscape"' + - name: documentMultiple + uid: excel!Excel.EntityCompactLayoutIcons.documentMultiple:member + package: excel! + summary: >- + Document multiple icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"DocumentMultiple"' + - name: documentPdf + uid: excel!Excel.EntityCompactLayoutIcons.documentPdf:member + package: excel! + summary: >- + Document PDF icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"DocumentPdf"' + - name: documentQueue + uid: excel!Excel.EntityCompactLayoutIcons.documentQueue:member + package: excel! + summary: >- + Document queue icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"DocumentQueue"' + - name: documentText + uid: excel!Excel.EntityCompactLayoutIcons.documentText:member + package: excel! + summary: >- + Document text icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"DocumentText"' + - name: dog + uid: excel!Excel.EntityCompactLayoutIcons.dog:member + package: excel! + summary: >- + Dog icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Dog"' + - name: door + uid: excel!Excel.EntityCompactLayoutIcons.door:member + package: excel! + summary: >- + Door icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Door"' + - name: doorTag + uid: excel!Excel.EntityCompactLayoutIcons.doorTag:member + package: excel! + summary: >- + Door tag icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"DoorTag"' + - name: drafts + uid: excel!Excel.EntityCompactLayoutIcons.drafts:member + package: excel! + summary: >- + Drafts icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Drafts"' + - name: drama + uid: excel!Excel.EntityCompactLayoutIcons.drama:member + package: excel! + summary: >- + Drama icon. Displays as a pair of theatre masks. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Drama"' + - name: drinkBeer + uid: excel!Excel.EntityCompactLayoutIcons.drinkBeer:member + package: excel! + summary: >- + Drink beer icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"DrinkBeer"' + - name: drinkCoffee + uid: excel!Excel.EntityCompactLayoutIcons.drinkCoffee:member + package: excel! + summary: >- + Drink coffee icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"DrinkCoffee"' + - name: drinkMargarita + uid: excel!Excel.EntityCompactLayoutIcons.drinkMargarita:member + package: excel! + summary: >- + Drink margarita icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"DrinkMargarita"' + - name: drinkToGo + uid: excel!Excel.EntityCompactLayoutIcons.drinkToGo:member + package: excel! + summary: >- + Drink to go icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"DrinkToGo"' + - name: drinkWine + uid: excel!Excel.EntityCompactLayoutIcons.drinkWine:member + package: excel! + summary: >- + Drink wine icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"DrinkWine"' + - name: driveTrain + uid: excel!Excel.EntityCompactLayoutIcons.driveTrain:member + package: excel! + summary: >- + Drive train icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"DriveTrain"' + - name: drop + uid: excel!Excel.EntityCompactLayoutIcons.drop:member + package: excel! + summary: >- + Drop icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Drop"' + - name: dualScreen + uid: excel!Excel.EntityCompactLayoutIcons.dualScreen:member + package: excel! + summary: >- + Dual screen icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"DualScreen"' + - name: dumbbell + uid: excel!Excel.EntityCompactLayoutIcons.dumbbell:member + package: excel! + summary: >- + Dumbbell icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Dumbbell"' + - name: earth + uid: excel!Excel.EntityCompactLayoutIcons.earth:member + package: excel! + summary: >- + Earth icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Earth"' + - name: emoji + uid: excel!Excel.EntityCompactLayoutIcons.emoji:member + package: excel! + summary: >- + Emoji icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Emoji"' + - name: emojiAngry + uid: excel!Excel.EntityCompactLayoutIcons.emojiAngry:member + package: excel! + summary: >- + Emoji angry icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"EmojiAngry"' + - name: emojiHand + uid: excel!Excel.EntityCompactLayoutIcons.emojiHand:member + package: excel! + summary: >- + Emoji hand icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"EmojiHand"' + - name: emojiLaugh + uid: excel!Excel.EntityCompactLayoutIcons.emojiLaugh:member + package: excel! + summary: >- + Emoji laugh icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"EmojiLaugh"' + - name: emojiMeh + uid: excel!Excel.EntityCompactLayoutIcons.emojiMeh:member + package: excel! + summary: >- + Emoji meh icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"EmojiMeh"' + - name: emojiMultiple + uid: excel!Excel.EntityCompactLayoutIcons.emojiMultiple:member + package: excel! + summary: >- + Emoji multiple icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"EmojiMultiple"' + - name: emojiSad + uid: excel!Excel.EntityCompactLayoutIcons.emojiSad:member + package: excel! + summary: >- + Emoji sad icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"EmojiSad"' + - name: emojiSadSlight + uid: excel!Excel.EntityCompactLayoutIcons.emojiSadSlight:member + package: excel! + summary: >- + Emoji sad slight icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"EmojiSadSlight"' + - name: emojiSmileSlight + uid: excel!Excel.EntityCompactLayoutIcons.emojiSmileSlight:member + package: excel! + summary: >- + Emoji smile slight icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"EmojiSmileSlight"' + - name: emojiSparkle + uid: excel!Excel.EntityCompactLayoutIcons.emojiSparkle:member + package: excel! + summary: >- + Emoji sparkle icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"EmojiSparkle"' + - name: emojiSurprise + uid: excel!Excel.EntityCompactLayoutIcons.emojiSurprise:member + package: excel! + summary: >- + Emoji surprise icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"EmojiSurprise"' + - name: engine + uid: excel!Excel.EntityCompactLayoutIcons.engine:member + package: excel! + summary: >- + Engine icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Engine"' + - name: eraser + uid: excel!Excel.EntityCompactLayoutIcons.eraser:member + package: excel! + summary: >- + Eraser icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Eraser"' + - name: eye + uid: excel!Excel.EntityCompactLayoutIcons.eye:member + package: excel! + summary: >- + Eye icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Eye"' + - name: eyedropper + uid: excel!Excel.EntityCompactLayoutIcons.eyedropper:member + package: excel! + summary: >- + Eyedropper icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Eyedropper"' + - name: fax + uid: excel!Excel.EntityCompactLayoutIcons.fax:member + package: excel! + summary: >- + Fax icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Fax"' + - name: fingerprint + uid: excel!Excel.EntityCompactLayoutIcons.fingerprint:member + package: excel! + summary: >- + Fingerprint icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Fingerprint"' + - name: firstAid + uid: excel!Excel.EntityCompactLayoutIcons.firstAid:member + package: excel! + summary: >- + First aid icon. Displays as a briefcase with a medical cross symbol. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"FirstAid"' + - name: flag + uid: excel!Excel.EntityCompactLayoutIcons.flag:member + package: excel! + summary: >- + Flag icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Flag"' + - name: flash + uid: excel!Excel.EntityCompactLayoutIcons.flash:member + package: excel! + summary: >- + Flash icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Flash"' + - name: flashlight + uid: excel!Excel.EntityCompactLayoutIcons.flashlight:member + package: excel! + summary: >- + Flashlight icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Flashlight"' + - name: flow + uid: excel!Excel.EntityCompactLayoutIcons.flow:member + package: excel! + summary: >- + Flow icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Flow"' + - name: flowchart + uid: excel!Excel.EntityCompactLayoutIcons.flowchart:member + package: excel! + summary: >- + Flowchart icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Flowchart"' + - name: folder + uid: excel!Excel.EntityCompactLayoutIcons.folder:member + package: excel! + summary: >- + Folder icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Folder"' + - name: folderOpen + uid: excel!Excel.EntityCompactLayoutIcons.folderOpen:member + package: excel! + summary: >- + Folder open icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"FolderOpen"' + - name: folderOpenVertical + uid: excel!Excel.EntityCompactLayoutIcons.folderOpenVertical:member + package: excel! + summary: >- + Folder open vertical icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"FolderOpenVertical"' + - name: folderPerson + uid: excel!Excel.EntityCompactLayoutIcons.folderPerson:member + package: excel! + summary: >- + Folder person icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"FolderPerson"' + - name: folderZip + uid: excel!Excel.EntityCompactLayoutIcons.folderZip:member + package: excel! + summary: >- + Folder zip icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"FolderZip"' + - name: food + uid: excel!Excel.EntityCompactLayoutIcons.food:member + package: excel! + summary: >- + Food icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Food"' + - name: foodApple + uid: excel!Excel.EntityCompactLayoutIcons.foodApple:member + package: excel! + summary: >- + Food apple icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"FoodApple"' + - name: foodCake + uid: excel!Excel.EntityCompactLayoutIcons.foodCake:member + package: excel! + summary: >- + Food cake icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"FoodCake"' + - name: foodEgg + uid: excel!Excel.EntityCompactLayoutIcons.foodEgg:member + package: excel! + summary: >- + Food egg icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"FoodEgg"' + - name: foodGrains + uid: excel!Excel.EntityCompactLayoutIcons.foodGrains:member + package: excel! + summary: >- + Food grains icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"FoodGrains"' + - name: foodPizza + uid: excel!Excel.EntityCompactLayoutIcons.foodPizza:member + package: excel! + summary: >- + Food pizza icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"FoodPizza"' + - name: foodToast + uid: excel!Excel.EntityCompactLayoutIcons.foodToast:member + package: excel! + summary: >- + Food toast icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"FoodToast"' + - name: galaxy + uid: excel!Excel.EntityCompactLayoutIcons.galaxy:member + package: excel! + summary: >- + Galaxy icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Galaxy"' + - name: games + uid: excel!Excel.EntityCompactLayoutIcons.games:member + package: excel! + summary: >- + Games icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Games"' + - name: ganttChart + uid: excel!Excel.EntityCompactLayoutIcons.ganttChart:member + package: excel! + summary: >- + Gantt chart icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"GanttChart"' + - name: gas + uid: excel!Excel.EntityCompactLayoutIcons.gas:member + package: excel! + summary: >- + Gas icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Gas"' + - name: gasPump + uid: excel!Excel.EntityCompactLayoutIcons.gasPump:member + package: excel! + summary: >- + Gas pump icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"GasPump"' + - name: gauge + uid: excel!Excel.EntityCompactLayoutIcons.gauge:member + package: excel! + summary: >- + Gauge icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Gauge"' + - name: gavel + uid: excel!Excel.EntityCompactLayoutIcons.gavel:member + package: excel! + summary: >- + Gavel icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Gavel"' + - name: generic + uid: excel!Excel.EntityCompactLayoutIcons.generic:member + package: excel! + summary: >- + The default icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Generic"' + - name: gift + uid: excel!Excel.EntityCompactLayoutIcons.gift:member + package: excel! + summary: >- + Gift icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Gift"' + - name: giftCard + uid: excel!Excel.EntityCompactLayoutIcons.giftCard:member + package: excel! + summary: >- + Gift card icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"GiftCard"' + - name: glasses + uid: excel!Excel.EntityCompactLayoutIcons.glasses:member + package: excel! + summary: >- + Glasses icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Glasses"' + - name: globe + uid: excel!Excel.EntityCompactLayoutIcons.globe:member + package: excel! + summary: >- + Globe icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Globe"' + - name: globeSurface + uid: excel!Excel.EntityCompactLayoutIcons.globeSurface:member + package: excel! + summary: >- + Globe surface icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"GlobeSurface"' + - name: grid + uid: excel!Excel.EntityCompactLayoutIcons.grid:member + package: excel! + summary: >- + Grid icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Grid"' + - name: gridDots + uid: excel!Excel.EntityCompactLayoutIcons.gridDots:member + package: excel! + summary: >- + Grid dots icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"GridDots"' + - name: gridKanban + uid: excel!Excel.EntityCompactLayoutIcons.gridKanban:member + package: excel! + summary: >- + Grid Kanban icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"GridKanban"' + - name: guardian + uid: excel!Excel.EntityCompactLayoutIcons.guardian:member + package: excel! + summary: >- + Guardian icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Guardian"' + - name: guest + uid: excel!Excel.EntityCompactLayoutIcons.guest:member + package: excel! + summary: >- + Guest icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Guest"' + - name: guitar + uid: excel!Excel.EntityCompactLayoutIcons.guitar:member + package: excel! + summary: >- + Guitar icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Guitar"' + - name: handLeft + uid: excel!Excel.EntityCompactLayoutIcons.handLeft:member + package: excel! + summary: >- + Hand left icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"HandLeft"' + - name: handRight + uid: excel!Excel.EntityCompactLayoutIcons.handRight:member + package: excel! + summary: >- + Hand right icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"HandRight"' + - name: handshake + uid: excel!Excel.EntityCompactLayoutIcons.handshake:member + package: excel! + summary: >- + Handshake icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Handshake"' + - name: hardDrive + uid: excel!Excel.EntityCompactLayoutIcons.hardDrive:member + package: excel! + summary: >- + Hard drive icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"HardDrive"' + - name: hatGraduation + uid: excel!Excel.EntityCompactLayoutIcons.hatGraduation:member + package: excel! + summary: >- + Graduation hat icon. Displays as a hat with a tassel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"HatGraduation"' + - name: headphones + uid: excel!Excel.EntityCompactLayoutIcons.headphones:member + package: excel! + summary: >- + Headphones icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Headphones"' + - name: headphonesSoundWave + uid: excel!Excel.EntityCompactLayoutIcons.headphonesSoundWave:member + package: excel! + summary: >- + Headphones sound wave icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"HeadphonesSoundWave"' + - name: headset + uid: excel!Excel.EntityCompactLayoutIcons.headset:member + package: excel! + summary: >- + Headset icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Headset"' + - name: headsetVr + uid: excel!Excel.EntityCompactLayoutIcons.headsetVr:member + package: excel! + summary: >- + Headset VR icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"HeadsetVr"' + - name: heart + uid: excel!Excel.EntityCompactLayoutIcons.heart:member + package: excel! + summary: >- + Heart icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Heart"' + - name: heartBroken + uid: excel!Excel.EntityCompactLayoutIcons.heartBroken:member + package: excel! + summary: >- + Heart broken icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"HeartBroken"' + - name: heartCircle + uid: excel!Excel.EntityCompactLayoutIcons.heartCircle:member + package: excel! + summary: >- + Heart circle icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"HeartCircle"' + - name: heartHuman + uid: excel!Excel.EntityCompactLayoutIcons.heartHuman:member + package: excel! + summary: >- + Human heart icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"HeartHuman"' + - name: heartPulse + uid: excel!Excel.EntityCompactLayoutIcons.heartPulse:member + package: excel! + summary: >- + Heart pulse icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"HeartPulse"' + - name: history + uid: excel!Excel.EntityCompactLayoutIcons.history:member + package: excel! + summary: >- + History icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"History"' + - name: home + uid: excel!Excel.EntityCompactLayoutIcons.home:member + package: excel! + summary: >- + Home icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Home"' + - name: homeMore + uid: excel!Excel.EntityCompactLayoutIcons.homeMore:member + package: excel! + summary: >- + Home more icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"HomeMore"' + - name: homePerson + uid: excel!Excel.EntityCompactLayoutIcons.homePerson:member + package: excel! + summary: >- + Home person icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"HomePerson"' + - name: icons + uid: excel!Excel.EntityCompactLayoutIcons.icons:member + package: excel! + summary: >- + Icons icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Icons"' + - name: image + uid: excel!Excel.EntityCompactLayoutIcons.image:member + package: excel! + summary: >- + Image icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Image"' + - name: imageGlobe + uid: excel!Excel.EntityCompactLayoutIcons.imageGlobe:member + package: excel! + summary: >- + Image globe icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ImageGlobe"' + - name: imageMultiple + uid: excel!Excel.EntityCompactLayoutIcons.imageMultiple:member + package: excel! + summary: >- + Image multiple icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ImageMultiple"' + - name: iot + uid: excel!Excel.EntityCompactLayoutIcons.iot:member + package: excel! + summary: >- + IoT icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Iot"' + - name: joystick + uid: excel!Excel.EntityCompactLayoutIcons.joystick:member + package: excel! + summary: >- + Joystick icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Joystick"' + - name: justice + uid: excel!Excel.EntityCompactLayoutIcons.justice:member + package: excel! + summary: >- + Justice icon. Displays as the scales of justice. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Justice"' + - name: key + uid: excel!Excel.EntityCompactLayoutIcons.key:member + package: excel! + summary: >- + Key icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Key"' + - name: keyboard + uid: excel!Excel.EntityCompactLayoutIcons.keyboard:member + package: excel! + summary: >- + Keyboard icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Keyboard"' + - name: keyboardLayoutSplit + uid: excel!Excel.EntityCompactLayoutIcons.keyboardLayoutSplit:member + package: excel! + summary: >- + Keyboard layout split icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"KeyboardLayoutSplit"' + - name: keyMultiple + uid: excel!Excel.EntityCompactLayoutIcons.keyMultiple:member + package: excel! + summary: >- + Key multiple icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"KeyMultiple"' + - name: languages + uid: excel!Excel.EntityCompactLayoutIcons.languages:member + package: excel! + summary: >- + Languages icon. Displays as a document and a globe. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Languages"' + - name: laptop + uid: excel!Excel.EntityCompactLayoutIcons.laptop:member + package: excel! + summary: >- + Laptop icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Laptop"' + - name: lasso + uid: excel!Excel.EntityCompactLayoutIcons.lasso:member + package: excel! + summary: >- + Lasso icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Lasso"' + - name: launcherSettings + uid: excel!Excel.EntityCompactLayoutIcons.launcherSettings:member + package: excel! + summary: >- + Launcher settings icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"LauncherSettings"' + - name: layer + uid: excel!Excel.EntityCompactLayoutIcons.layer:member + package: excel! + summary: >- + Layer icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Layer"' + - name: leaf + uid: excel!Excel.EntityCompactLayoutIcons.leaf:member + package: excel! + summary: >- + Leaf icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Leaf"' + - name: leafOne + uid: excel!Excel.EntityCompactLayoutIcons.leafOne:member + package: excel! + summary: >- + Leaf one icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"LeafOne"' + - name: leafThree + uid: excel!Excel.EntityCompactLayoutIcons.leafThree:member + package: excel! + summary: >- + Leaf three icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"LeafThree"' + - name: leafTwo + uid: excel!Excel.EntityCompactLayoutIcons.leafTwo:member + package: excel! + summary: >- + Leaf two icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"LeafTwo"' + - name: library + uid: excel!Excel.EntityCompactLayoutIcons.library:member + package: excel! + summary: >- + Library icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Library"' + - name: lightbulb + uid: excel!Excel.EntityCompactLayoutIcons.lightbulb:member + package: excel! + summary: >- + Lightbulb icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Lightbulb"' + - name: lightbulbFilament + uid: excel!Excel.EntityCompactLayoutIcons.lightbulbFilament:member + package: excel! + summary: >- + Lightbulb filament icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"LightbulbFilament"' + - name: likert + uid: excel!Excel.EntityCompactLayoutIcons.likert:member + package: excel! + summary: >- + Likert icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Likert"' + - name: link + uid: excel!Excel.EntityCompactLayoutIcons.link:member + package: excel! + summary: >- + Link icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Link"' + - name: localLanguage + uid: excel!Excel.EntityCompactLayoutIcons.localLanguage:member + package: excel! + summary: >- + Local language icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"LocalLanguage"' + - name: location + uid: excel!Excel.EntityCompactLayoutIcons.location:member + package: excel! + summary: >- + Location icon. Displays as a map marker. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Location"' + - name: lockClosed + uid: excel!Excel.EntityCompactLayoutIcons.lockClosed:member + package: excel! + summary: >- + Lock closed icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"LockClosed"' + - name: lockMultiple + uid: excel!Excel.EntityCompactLayoutIcons.lockMultiple:member + package: excel! + summary: >- + Lock multiple icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"LockMultiple"' + - name: lockOpen + uid: excel!Excel.EntityCompactLayoutIcons.lockOpen:member + package: excel! + summary: >- + Lock open icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"LockOpen"' + - name: lottery + uid: excel!Excel.EntityCompactLayoutIcons.lottery:member + package: excel! + summary: >- + Lottery icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Lottery"' + - name: luggage + uid: excel!Excel.EntityCompactLayoutIcons.luggage:member + package: excel! + summary: >- + Luggage icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Luggage"' + - name: mail + uid: excel!Excel.EntityCompactLayoutIcons.mail:member + package: excel! + summary: >- + Mail icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Mail"' + - name: mailInbox + uid: excel!Excel.EntityCompactLayoutIcons.mailInbox:member + package: excel! + summary: >- + Mail inbox icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"MailInbox"' + - name: mailMultiple + uid: excel!Excel.EntityCompactLayoutIcons.mailMultiple:member + package: excel! + summary: >- + Mail multiple icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"MailMultiple"' + - name: map + uid: excel!Excel.EntityCompactLayoutIcons.map:member + package: excel! + summary: >- + Map icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Map"' + - name: mapPin + uid: excel!Excel.EntityCompactLayoutIcons.mapPin:member + package: excel! + summary: >- + Map pin icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"MapPin"' + - name: markdown + uid: excel!Excel.EntityCompactLayoutIcons.markdown:member + package: excel! + summary: >- + Markdown icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Markdown"' + - name: mathFormula + uid: excel!Excel.EntityCompactLayoutIcons.mathFormula:member + package: excel! + summary: >- + Math formula icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"MathFormula"' + - name: mathSymbols + uid: excel!Excel.EntityCompactLayoutIcons.mathSymbols:member + package: excel! + summary: >- + Math symbols icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"MathSymbols"' + - name: max + uid: excel!Excel.EntityCompactLayoutIcons.max:member + package: excel! + summary: >- + Max icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Max"' + - name: megaphone + uid: excel!Excel.EntityCompactLayoutIcons.megaphone:member + package: excel! + summary: >- + Megaphone icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Megaphone"' + - name: megaphoneLoud + uid: excel!Excel.EntityCompactLayoutIcons.megaphoneLoud:member + package: excel! + summary: >- + Megaphone loud icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"MegaphoneLoud"' + - name: mention + uid: excel!Excel.EntityCompactLayoutIcons.mention:member + package: excel! + summary: >- + Mention icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Mention"' + - name: mic + uid: excel!Excel.EntityCompactLayoutIcons.mic:member + package: excel! + summary: >- + Mic icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Mic"' + - name: microscope + uid: excel!Excel.EntityCompactLayoutIcons.microscope:member + package: excel! + summary: >- + Microscope icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Microscope"' + - name: midi + uid: excel!Excel.EntityCompactLayoutIcons.midi:member + package: excel! + summary: >- + Midi icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Midi"' + - name: molecule + uid: excel!Excel.EntityCompactLayoutIcons.molecule:member + package: excel! + summary: >- + Molecule icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Molecule"' + - name: money + uid: excel!Excel.EntityCompactLayoutIcons.money:member + package: excel! + summary: >- + Money icon. Displays as paper money and coins. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Money"' + - name: moneyHand + uid: excel!Excel.EntityCompactLayoutIcons.moneyHand:member + package: excel! + summary: >- + Money hand icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"MoneyHand"' + - name: mountain + uid: excel!Excel.EntityCompactLayoutIcons.mountain:member + package: excel! + summary: >- + Mountain icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Mountain"' + - name: movieCamera + uid: excel!Excel.EntityCompactLayoutIcons.movieCamera:member + package: excel! + summary: >- + Movie camera icon. Displays as a video camera. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"MovieCamera"' + - name: moviesAndTv + uid: excel!Excel.EntityCompactLayoutIcons.moviesAndTv:member + package: excel! + summary: >- + Movies and TV icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"MoviesAndTv"' + - name: musicNote + uid: excel!Excel.EntityCompactLayoutIcons.musicNote:member + package: excel! + summary: >- + Music note icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"MusicNote"' + - name: musicNote1 + uid: excel!Excel.EntityCompactLayoutIcons.musicNote1:member + package: excel! + summary: >- + Music note icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"MusicNote1"' + - name: musicNote2 + uid: excel!Excel.EntityCompactLayoutIcons.musicNote2:member + package: excel! + summary: >- + Music double note icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"MusicNote2"' + - name: myLocation + uid: excel!Excel.EntityCompactLayoutIcons.myLocation:member + package: excel! + summary: >- + My location icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"MyLocation"' + - name: nByN + uid: excel!Excel.EntityCompactLayoutIcons.nByN:member + package: excel! + summary: >- + N by N icon. Displays as a three by three grid. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"NByN"' + - name: nByOne + uid: excel!Excel.EntityCompactLayoutIcons.nByOne:member + package: excel! + summary: >- + N by one icon. Displays as a three by one grid. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"NByOne"' + - name: news + uid: excel!Excel.EntityCompactLayoutIcons.news:member + package: excel! + summary: >- + News icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"News"' + - name: notablePeople + uid: excel!Excel.EntityCompactLayoutIcons.notablePeople:member + package: excel! + summary: >- + Notable people icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"NotablePeople"' + - name: note + uid: excel!Excel.EntityCompactLayoutIcons.note:member + package: excel! + summary: >- + Note icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Note"' + - name: notebook + uid: excel!Excel.EntityCompactLayoutIcons.notebook:member + package: excel! + summary: >- + Notebook icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Notebook"' + - name: notepad + uid: excel!Excel.EntityCompactLayoutIcons.notepad:member + package: excel! + summary: >- + Notepad icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Notepad"' + - name: notepadPerson + uid: excel!Excel.EntityCompactLayoutIcons.notepadPerson:member + package: excel! + summary: >- + Notepad person icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"NotepadPerson"' + - name: oneByN + uid: excel!Excel.EntityCompactLayoutIcons.oneByN:member + package: excel! + summary: >- + One by N icon. Displays as a one by three grid. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"OneByN"' + - name: oneByOne + uid: excel!Excel.EntityCompactLayoutIcons.oneByOne:member + package: excel! + summary: >- + One by one icon. Displays as a one by one grid. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"OneByOne"' + - name: options + uid: excel!Excel.EntityCompactLayoutIcons.options:member + package: excel! + summary: >- + Options icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Options"' + - name: organization + uid: excel!Excel.EntityCompactLayoutIcons.organization:member + package: excel! + summary: >- + Organization icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Organization"' + - name: organizationHorizontal + uid: excel!Excel.EntityCompactLayoutIcons.organizationHorizontal:member + package: excel! + summary: >- + Organization horizontal icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"OrganizationHorizontal"' + - name: oval + uid: excel!Excel.EntityCompactLayoutIcons.oval:member + package: excel! + summary: >- + Oval icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Oval"' + - name: paintBrush + uid: excel!Excel.EntityCompactLayoutIcons.paintBrush:member + package: excel! + summary: >- + Paint brush icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"PaintBrush"' + - name: paintBucket + uid: excel!Excel.EntityCompactLayoutIcons.paintBucket:member + package: excel! + summary: >- + Paint bucket icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"PaintBucket"' + - name: partlySunnyWeather + uid: excel!Excel.EntityCompactLayoutIcons.partlySunnyWeather:member + package: excel! + summary: >- + Partly sunny weather icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"PartlySunnyWeather"' + - name: password + uid: excel!Excel.EntityCompactLayoutIcons.password:member + package: excel! + summary: >- + Password icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Password"' + - name: patch + uid: excel!Excel.EntityCompactLayoutIcons.patch:member + package: excel! + summary: >- + Patch icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Patch"' + - name: patient + uid: excel!Excel.EntityCompactLayoutIcons.patient:member + package: excel! + summary: >- + Patient icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Patient"' + - name: payment + uid: excel!Excel.EntityCompactLayoutIcons.payment:member + package: excel! + summary: >- + Payment icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Payment"' + - name: pen + uid: excel!Excel.EntityCompactLayoutIcons.pen:member + package: excel! + summary: >- + Pen icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Pen"' + - name: pentagon + uid: excel!Excel.EntityCompactLayoutIcons.pentagon:member + package: excel! + summary: >- + Pentagon icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Pentagon"' + - name: people + uid: excel!Excel.EntityCompactLayoutIcons.people:member + package: excel! + summary: >- + People icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"People"' + - name: peopleAudience + uid: excel!Excel.EntityCompactLayoutIcons.peopleAudience:member + package: excel! + summary: >- + People audience icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"PeopleAudience"' + - name: peopleCall + uid: excel!Excel.EntityCompactLayoutIcons.peopleCall:member + package: excel! + summary: >- + People call icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"PeopleCall"' + - name: peopleCommunity + uid: excel!Excel.EntityCompactLayoutIcons.peopleCommunity:member + package: excel! + summary: >- + People community icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"PeopleCommunity"' + - name: peopleMoney + uid: excel!Excel.EntityCompactLayoutIcons.peopleMoney:member + package: excel! + summary: >- + People money icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"PeopleMoney"' + - name: peopleQueue + uid: excel!Excel.EntityCompactLayoutIcons.peopleQueue:member + package: excel! + summary: >- + People queue icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"PeopleQueue"' + - name: peopleTeam + uid: excel!Excel.EntityCompactLayoutIcons.peopleTeam:member + package: excel! + summary: >- + People team icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"PeopleTeam"' + - name: peopleToolbox + uid: excel!Excel.EntityCompactLayoutIcons.peopleToolbox:member + package: excel! + summary: >- + People toolbox icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"PeopleToolbox"' + - name: person + uid: excel!Excel.EntityCompactLayoutIcons.person:member + package: excel! + summary: >- + Person icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Person"' + - name: personBoard + uid: excel!Excel.EntityCompactLayoutIcons.personBoard:member + package: excel! + summary: >- + Person board icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"PersonBoard"' + - name: personCall + uid: excel!Excel.EntityCompactLayoutIcons.personCall:member + package: excel! + summary: >- + Person call icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"PersonCall"' + - name: personChat + uid: excel!Excel.EntityCompactLayoutIcons.personChat:member + package: excel! + summary: >- + Person chat icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"PersonChat"' + - name: personFeedback + uid: excel!Excel.EntityCompactLayoutIcons.personFeedback:member + package: excel! + summary: >- + Person feedback icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"PersonFeedback"' + - name: personSupport + uid: excel!Excel.EntityCompactLayoutIcons.personSupport:member + package: excel! + summary: >- + Person support icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"PersonSupport"' + - name: personVoice + uid: excel!Excel.EntityCompactLayoutIcons.personVoice:member + package: excel! + summary: >- + Person voice icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"PersonVoice"' + - name: phone + uid: excel!Excel.EntityCompactLayoutIcons.phone:member + package: excel! + summary: >- + Phone icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Phone"' + - name: phoneDesktop + uid: excel!Excel.EntityCompactLayoutIcons.phoneDesktop:member + package: excel! + summary: >- + Phone desktop icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"PhoneDesktop"' + - name: phoneLaptop + uid: excel!Excel.EntityCompactLayoutIcons.phoneLaptop:member + package: excel! + summary: >- + Phone laptop icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"PhoneLaptop"' + - name: phoneShake + uid: excel!Excel.EntityCompactLayoutIcons.phoneShake:member + package: excel! + summary: >- + Phone shake icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"PhoneShake"' + - name: phoneTablet + uid: excel!Excel.EntityCompactLayoutIcons.phoneTablet:member + package: excel! + summary: >- + Phone tablet icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"PhoneTablet"' + - name: phoneVibrate + uid: excel!Excel.EntityCompactLayoutIcons.phoneVibrate:member + package: excel! + summary: >- + Phone vibrate icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"PhoneVibrate"' + - name: photoFilter + uid: excel!Excel.EntityCompactLayoutIcons.photoFilter:member + package: excel! + summary: >- + Photo filter icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"PhotoFilter"' + - name: pi + uid: excel!Excel.EntityCompactLayoutIcons.pi:member + package: excel! + summary: >- + Pi icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Pi"' + - name: pictureInPicture + uid: excel!Excel.EntityCompactLayoutIcons.pictureInPicture:member + package: excel! + summary: >- + Picture in picture icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"PictureInPicture"' + - name: pilates + uid: excel!Excel.EntityCompactLayoutIcons.pilates:member + package: excel! + summary: >- + Pilates icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Pilates"' + - name: pill + uid: excel!Excel.EntityCompactLayoutIcons.pill:member + package: excel! + summary: >- + Pill icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Pill"' + - name: pin + uid: excel!Excel.EntityCompactLayoutIcons.pin:member + package: excel! + summary: >- + Pin icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Pin"' + - name: pipeline + uid: excel!Excel.EntityCompactLayoutIcons.pipeline:member + package: excel! + summary: >- + Pipeline icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Pipeline"' + - name: planet + uid: excel!Excel.EntityCompactLayoutIcons.planet:member + package: excel! + summary: >- + Planet icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Planet"' + - name: playingCards + uid: excel!Excel.EntityCompactLayoutIcons.playingCards:member + package: excel! + summary: >- + Playing cards icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"PlayingCards"' + - name: plugConnected + uid: excel!Excel.EntityCompactLayoutIcons.plugConnected:member + package: excel! + summary: >- + Plug connected icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"PlugConnected"' + - name: plugDisconnected + uid: excel!Excel.EntityCompactLayoutIcons.plugDisconnected:member + package: excel! + summary: >- + Plug disconnected icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"PlugDisconnected"' + - name: pointScan + uid: excel!Excel.EntityCompactLayoutIcons.pointScan:member + package: excel! + summary: >- + Point scan icon. Displays as a target focus symbol. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"PointScan"' + - name: poll + uid: excel!Excel.EntityCompactLayoutIcons.poll:member + package: excel! + summary: >- + Poll icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Poll"' + - name: power + uid: excel!Excel.EntityCompactLayoutIcons.power:member + package: excel! + summary: >- + Power icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Power"' + - name: predictions + uid: excel!Excel.EntityCompactLayoutIcons.predictions:member + package: excel! + summary: >- + Predictions icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Predictions"' + - name: premium + uid: excel!Excel.EntityCompactLayoutIcons.premium:member + package: excel! + summary: >- + Premium icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Premium"' + - name: presenter + uid: excel!Excel.EntityCompactLayoutIcons.presenter:member + package: excel! + summary: >- + Presenter icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Presenter"' + - name: previewLink + uid: excel!Excel.EntityCompactLayoutIcons.previewLink:member + package: excel! + summary: >- + Preview link icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"PreviewLink"' + - name: print + uid: excel!Excel.EntityCompactLayoutIcons.print:member + package: excel! + summary: >- + Print icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Print"' + - name: production + uid: excel!Excel.EntityCompactLayoutIcons.production:member + package: excel! + summary: >- + Production icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Production"' + - name: prohibited + uid: excel!Excel.EntityCompactLayoutIcons.prohibited:member + package: excel! + summary: >- + Prohibited icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Prohibited"' + - name: projectionScreen + uid: excel!Excel.EntityCompactLayoutIcons.projectionScreen:member + package: excel! + summary: >- + Projection screen icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ProjectionScreen"' + - name: protocolHandler + uid: excel!Excel.EntityCompactLayoutIcons.protocolHandler:member + package: excel! + summary: >- + Protocol handler icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ProtocolHandler"' + - name: pulse + uid: excel!Excel.EntityCompactLayoutIcons.pulse:member + package: excel! + summary: >- + Pulse icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Pulse"' + - name: pulseSquare + uid: excel!Excel.EntityCompactLayoutIcons.pulseSquare:member + package: excel! + summary: >- + Pulse square icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"PulseSquare"' + - name: puzzlePiece + uid: excel!Excel.EntityCompactLayoutIcons.puzzlePiece:member + package: excel! + summary: >- + Puzzle piece icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"PuzzlePiece"' + - name: qrCode + uid: excel!Excel.EntityCompactLayoutIcons.qrCode:member + package: excel! + summary: >- + QR code icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"QrCode"' + - name: radar + uid: excel!Excel.EntityCompactLayoutIcons.radar:member + package: excel! + summary: >- + Radar icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Radar"' + - name: ram + uid: excel!Excel.EntityCompactLayoutIcons.ram:member + package: excel! + summary: >- + Ram icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Ram"' + - name: readingList + uid: excel!Excel.EntityCompactLayoutIcons.readingList:member + package: excel! + summary: >- + Reading list icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ReadingList"' + - name: realEstate + uid: excel!Excel.EntityCompactLayoutIcons.realEstate:member + package: excel! + summary: >- + Real estate icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"RealEstate"' + - name: receipt + uid: excel!Excel.EntityCompactLayoutIcons.receipt:member + package: excel! + summary: >- + Receipt icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Receipt"' + - name: reward + uid: excel!Excel.EntityCompactLayoutIcons.reward:member + package: excel! + summary: >- + Reward icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Reward"' + - name: rhombus + uid: excel!Excel.EntityCompactLayoutIcons.rhombus:member + package: excel! + summary: >- + Rhombus icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Rhombus"' + - name: ribbon + uid: excel!Excel.EntityCompactLayoutIcons.ribbon:member + package: excel! + summary: >- + Ribbon icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Ribbon"' + - name: ribbonStar + uid: excel!Excel.EntityCompactLayoutIcons.ribbonStar:member + package: excel! + summary: >- + Ribbon star icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"RibbonStar"' + - name: roadCone + uid: excel!Excel.EntityCompactLayoutIcons.roadCone:member + package: excel! + summary: >- + Road cone icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"RoadCone"' + - name: rocket + uid: excel!Excel.EntityCompactLayoutIcons.rocket:member + package: excel! + summary: >- + Rocket icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Rocket"' + - name: router + uid: excel!Excel.EntityCompactLayoutIcons.router:member + package: excel! + summary: >- + Router icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Router"' + - name: rss + uid: excel!Excel.EntityCompactLayoutIcons.rss:member + package: excel! + summary: >- + RSS icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Rss"' + - name: ruler + uid: excel!Excel.EntityCompactLayoutIcons.ruler:member + package: excel! + summary: >- + Ruler icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Ruler"' + - name: run + uid: excel!Excel.EntityCompactLayoutIcons.run:member + package: excel! + summary: >- + Run icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Run"' + - name: running + uid: excel!Excel.EntityCompactLayoutIcons.running:member + package: excel! + summary: >- + Running icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Running"' + - name: satellite + uid: excel!Excel.EntityCompactLayoutIcons.satellite:member + package: excel! + summary: >- + Satellite icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Satellite"' + - name: save + uid: excel!Excel.EntityCompactLayoutIcons.save:member + package: excel! + summary: >- + Save icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Save"' + - name: savings + uid: excel!Excel.EntityCompactLayoutIcons.savings:member + package: excel! + summary: >- + Savings icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Savings"' + - name: scales + uid: excel!Excel.EntityCompactLayoutIcons.scales:member + package: excel! + summary: >- + Scales icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Scales"' + - name: scan + uid: excel!Excel.EntityCompactLayoutIcons.scan:member + package: excel! + summary: >- + Scan icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Scan"' + - name: scratchpad + uid: excel!Excel.EntityCompactLayoutIcons.scratchpad:member + package: excel! + summary: >- + Scratchpad icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Scratchpad"' + - name: screenPerson + uid: excel!Excel.EntityCompactLayoutIcons.screenPerson:member + package: excel! + summary: >- + Screen person icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ScreenPerson"' + - name: screenshot + uid: excel!Excel.EntityCompactLayoutIcons.screenshot:member + package: excel! + summary: >- + Screenshot icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Screenshot"' + - name: search + uid: excel!Excel.EntityCompactLayoutIcons.search:member + package: excel! + summary: >- + Search icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Search"' + - name: serialPort + uid: excel!Excel.EntityCompactLayoutIcons.serialPort:member + package: excel! + summary: >- + Serial port icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"SerialPort"' + - name: server + uid: excel!Excel.EntityCompactLayoutIcons.server:member + package: excel! + summary: >- + Server icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Server"' + - name: serverMultiple + uid: excel!Excel.EntityCompactLayoutIcons.serverMultiple:member + package: excel! + summary: >- + Server multiple icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ServerMultiple"' + - name: serviceBell + uid: excel!Excel.EntityCompactLayoutIcons.serviceBell:member + package: excel! + summary: >- + Service bell icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ServiceBell"' + - name: settings + uid: excel!Excel.EntityCompactLayoutIcons.settings:member + package: excel! + summary: >- + Settings icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Settings"' + - name: shapes + uid: excel!Excel.EntityCompactLayoutIcons.shapes:member + package: excel! + summary: >- + Shapes icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Shapes"' + - name: shield + uid: excel!Excel.EntityCompactLayoutIcons.shield:member + package: excel! + summary: >- + Shield icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Shield"' + - name: shieldTask + uid: excel!Excel.EntityCompactLayoutIcons.shieldTask:member + package: excel! + summary: >- + Shield task icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ShieldTask"' + - name: shoppingBag + uid: excel!Excel.EntityCompactLayoutIcons.shoppingBag:member + package: excel! + summary: >- + Shopping bag icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ShoppingBag"' + - name: signature + uid: excel!Excel.EntityCompactLayoutIcons.signature:member + package: excel! + summary: >- + Signature icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Signature"' + - name: sim + uid: excel!Excel.EntityCompactLayoutIcons.sim:member + package: excel! + summary: >- + Sim icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Sim"' + - name: sleep + uid: excel!Excel.EntityCompactLayoutIcons.sleep:member + package: excel! + summary: >- + Sleep icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Sleep"' + - name: smartwatch + uid: excel!Excel.EntityCompactLayoutIcons.smartwatch:member + package: excel! + summary: >- + Smartwatch icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Smartwatch"' + - name: soundSource + uid: excel!Excel.EntityCompactLayoutIcons.soundSource:member + package: excel! + summary: >- + Sound source icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"SoundSource"' + - name: soundWaveCircle + uid: excel!Excel.EntityCompactLayoutIcons.soundWaveCircle:member + package: excel! + summary: >- + Sound wave circle icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"SoundWaveCircle"' + - name: sparkle + uid: excel!Excel.EntityCompactLayoutIcons.sparkle:member + package: excel! + summary: >- + Sparkle icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Sparkle"' + - name: speaker0 + uid: excel!Excel.EntityCompactLayoutIcons.speaker0:member + package: excel! + summary: >- + Speaker icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Speaker0"' + - name: speaker2 + uid: excel!Excel.EntityCompactLayoutIcons.speaker2:member + package: excel! + summary: >- + Speaker with sound wave icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Speaker2"' + - name: sport + uid: excel!Excel.EntityCompactLayoutIcons.sport:member + package: excel! + summary: >- + Sport icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Sport"' + - name: sportAmericanFootball + uid: excel!Excel.EntityCompactLayoutIcons.sportAmericanFootball:member + package: excel! + summary: >- + Sport american football icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"SportAmericanFootball"' + - name: sportBaseball + uid: excel!Excel.EntityCompactLayoutIcons.sportBaseball:member + package: excel! + summary: >- + Sport baseball icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"SportBaseball"' + - name: sportBasketball + uid: excel!Excel.EntityCompactLayoutIcons.sportBasketball:member + package: excel! + summary: >- + Sport basketball icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"SportBasketball"' + - name: sportHockey + uid: excel!Excel.EntityCompactLayoutIcons.sportHockey:member + package: excel! + summary: >- + Sport hockey icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"SportHockey"' + - name: sportSoccer + uid: excel!Excel.EntityCompactLayoutIcons.sportSoccer:member + package: excel! + summary: >- + Sport soccer icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"SportSoccer"' + - name: squareMultiple + uid: excel!Excel.EntityCompactLayoutIcons.squareMultiple:member + package: excel! + summary: >- + Square multiple icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"SquareMultiple"' + - name: squareShadow + uid: excel!Excel.EntityCompactLayoutIcons.squareShadow:member + package: excel! + summary: >- + Square shadow icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"SquareShadow"' + - name: squaresNested + uid: excel!Excel.EntityCompactLayoutIcons.squaresNested:member + package: excel! + summary: >- + Squares nested icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"SquaresNested"' + - name: stack + uid: excel!Excel.EntityCompactLayoutIcons.stack:member + package: excel! + summary: >- + Stack icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Stack"' + - name: stackStar + uid: excel!Excel.EntityCompactLayoutIcons.stackStar:member + package: excel! + summary: >- + Stack star icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"StackStar"' + - name: star + uid: excel!Excel.EntityCompactLayoutIcons.star:member + package: excel! + summary: >- + Star icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Star"' + - name: starFilled + uid: excel!Excel.EntityCompactLayoutIcons.starFilled:member + package: excel! + summary: >- + Star filled icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"StarFilled"' + - name: starHalf + uid: excel!Excel.EntityCompactLayoutIcons.starHalf:member + package: excel! + summary: >- + Star half icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"StarHalf"' + - name: starLineHorizontal3 + uid: excel!Excel.EntityCompactLayoutIcons.starLineHorizontal3:member + package: excel! + summary: >- + Star with 3 horizontal lines icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"StarLineHorizontal3"' + - name: starOneQuarter + uid: excel!Excel.EntityCompactLayoutIcons.starOneQuarter:member + package: excel! + summary: >- + Star one quarter icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"StarOneQuarter"' + - name: starThreeQuarter + uid: excel!Excel.EntityCompactLayoutIcons.starThreeQuarter:member + package: excel! + summary: >- + Star three quarter icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"StarThreeQuarter"' + - name: status + uid: excel!Excel.EntityCompactLayoutIcons.status:member + package: excel! + summary: >- + Status icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Status"' + - name: steps + uid: excel!Excel.EntityCompactLayoutIcons.steps:member + package: excel! + summary: >- + Steps icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Steps"' + - name: stethoscope + uid: excel!Excel.EntityCompactLayoutIcons.stethoscope:member + package: excel! + summary: >- + Stethoscope icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Stethoscope"' + - name: sticker + uid: excel!Excel.EntityCompactLayoutIcons.sticker:member + package: excel! + summary: >- + Sticker icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Sticker"' + - name: storage + uid: excel!Excel.EntityCompactLayoutIcons.storage:member + package: excel! + summary: >- + Storage icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Storage"' + - name: stream + uid: excel!Excel.EntityCompactLayoutIcons.stream:member + package: excel! + summary: >- + Stream icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Stream"' + - name: streamInput + uid: excel!Excel.EntityCompactLayoutIcons.streamInput:member + package: excel! + summary: >- + Stream input icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"StreamInput"' + - name: streamInputOutput + uid: excel!Excel.EntityCompactLayoutIcons.streamInputOutput:member + package: excel! + summary: >- + Stream input output icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"StreamInputOutput"' + - name: streamOutput + uid: excel!Excel.EntityCompactLayoutIcons.streamOutput:member + package: excel! + summary: >- + Stream output icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"StreamOutput"' + - name: styleGuide + uid: excel!Excel.EntityCompactLayoutIcons.styleGuide:member + package: excel! + summary: >- + Style guide icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"StyleGuide"' + - name: subGrid + uid: excel!Excel.EntityCompactLayoutIcons.subGrid:member + package: excel! + summary: >- + Sub grid icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"SubGrid"' + - name: subtitles + uid: excel!Excel.EntityCompactLayoutIcons.subtitles:member + package: excel! + summary: >- + Subtitles icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Subtitles"' + - name: surfaceEarbuds + uid: excel!Excel.EntityCompactLayoutIcons.surfaceEarbuds:member + package: excel! + summary: >- + Surface earbuds icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"SurfaceEarbuds"' + - name: surfaceHub + uid: excel!Excel.EntityCompactLayoutIcons.surfaceHub:member + package: excel! + summary: >- + Surface hub icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"SurfaceHub"' + - name: symbols + uid: excel!Excel.EntityCompactLayoutIcons.symbols:member + package: excel! + summary: >- + Symbols icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Symbols"' + - name: syringe + uid: excel!Excel.EntityCompactLayoutIcons.syringe:member + package: excel! + summary: >- + Syringe icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Syringe"' + - name: system + uid: excel!Excel.EntityCompactLayoutIcons.system:member + package: excel! + summary: >- + System icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"System"' + - name: tabDesktop + uid: excel!Excel.EntityCompactLayoutIcons.tabDesktop:member + package: excel! + summary: >- + Tab desktop icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"TabDesktop"' + - name: tabInprivateAccount + uid: excel!Excel.EntityCompactLayoutIcons.tabInprivateAccount:member + package: excel! + summary: >- + Tab InPrivate account icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"TabInprivateAccount"' + - name: table + uid: excel!Excel.EntityCompactLayoutIcons.table:member + package: excel! + summary: >- + Table icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Table"' + - name: tableImage + uid: excel!Excel.EntityCompactLayoutIcons.tableImage:member + package: excel! + summary: >- + Table image icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"TableImage"' + - name: tableMultiple + uid: excel!Excel.EntityCompactLayoutIcons.tableMultiple:member + package: excel! + summary: >- + Table multiple icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"TableMultiple"' + - name: tablet + uid: excel!Excel.EntityCompactLayoutIcons.tablet:member + package: excel! + summary: >- + Tablet icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Tablet"' + - name: tabs + uid: excel!Excel.EntityCompactLayoutIcons.tabs:member + package: excel! + summary: >- + Tabs icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Tabs"' + - name: tag + uid: excel!Excel.EntityCompactLayoutIcons.tag:member + package: excel! + summary: >- + Tag icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Tag"' + - name: tagCircle + uid: excel!Excel.EntityCompactLayoutIcons.tagCircle:member + package: excel! + summary: >- + Tag circle icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"TagCircle"' + - name: tagMultiple + uid: excel!Excel.EntityCompactLayoutIcons.tagMultiple:member + package: excel! + summary: >- + Tag multiple icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"TagMultiple"' + - name: target + uid: excel!Excel.EntityCompactLayoutIcons.target:member + package: excel! + summary: >- + Target icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Target"' + - name: targetArrow + uid: excel!Excel.EntityCompactLayoutIcons.targetArrow:member + package: excel! + summary: >- + Target arrow icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"TargetArrow"' + - name: teddy + uid: excel!Excel.EntityCompactLayoutIcons.teddy:member + package: excel! + summary: >- + Teddy icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Teddy"' + - name: temperature + uid: excel!Excel.EntityCompactLayoutIcons.temperature:member + package: excel! + summary: >- + Temperature icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Temperature"' + - name: tent + uid: excel!Excel.EntityCompactLayoutIcons.tent:member + package: excel! + summary: >- + Tent icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Tent"' + - name: tetrisApp + uid: excel!Excel.EntityCompactLayoutIcons.tetrisApp:member + package: excel! + summary: >- + Tetris app icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"TetrisApp"' + - name: textbox + uid: excel!Excel.EntityCompactLayoutIcons.textbox:member + package: excel! + summary: >- + Textbox icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Textbox"' + - name: textQuote + uid: excel!Excel.EntityCompactLayoutIcons.textQuote:member + package: excel! + summary: >- + Text quote icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"TextQuote"' + - name: thinking + uid: excel!Excel.EntityCompactLayoutIcons.thinking:member + package: excel! + summary: >- + Thinking icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Thinking"' + - name: thumbDislike + uid: excel!Excel.EntityCompactLayoutIcons.thumbDislike:member + package: excel! + summary: >- + Thumb dislike icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ThumbDislike"' + - name: thumbLike + uid: excel!Excel.EntityCompactLayoutIcons.thumbLike:member + package: excel! + summary: >- + Thumb like icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ThumbLike"' + - name: ticketDiagonal + uid: excel!Excel.EntityCompactLayoutIcons.ticketDiagonal:member + package: excel! + summary: >- + Ticket diagonal icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"TicketDiagonal"' + - name: ticketHorizontal + uid: excel!Excel.EntityCompactLayoutIcons.ticketHorizontal:member + package: excel! + summary: >- + Ticket horizontal icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"TicketHorizontal"' + - name: timeAndWeather + uid: excel!Excel.EntityCompactLayoutIcons.timeAndWeather:member + package: excel! + summary: >- + Time and weather icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"TimeAndWeather"' + - name: timeline + uid: excel!Excel.EntityCompactLayoutIcons.timeline:member + package: excel! + summary: >- + Timeline icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Timeline"' + - name: timer + uid: excel!Excel.EntityCompactLayoutIcons.timer:member + package: excel! + summary: >- + Timer icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Timer"' + - name: toolbox + uid: excel!Excel.EntityCompactLayoutIcons.toolbox:member + package: excel! + summary: >- + Toolbox icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Toolbox"' + - name: topSpeed + uid: excel!Excel.EntityCompactLayoutIcons.topSpeed:member + package: excel! + summary: >- + Top speed icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"TopSpeed"' + - name: translate + uid: excel!Excel.EntityCompactLayoutIcons.translate:member + package: excel! + summary: >- + Translate icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Translate"' + - name: transmission + uid: excel!Excel.EntityCompactLayoutIcons.transmission:member + package: excel! + summary: >- + Transmission icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Transmission"' + - name: treeDeciduous + uid: excel!Excel.EntityCompactLayoutIcons.treeDeciduous:member + package: excel! + summary: >- + Tree deciduous icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"TreeDeciduous"' + - name: treeEvergreen + uid: excel!Excel.EntityCompactLayoutIcons.treeEvergreen:member + package: excel! + summary: >- + Tree evergreen icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"TreeEvergreen"' + - name: trophy + uid: excel!Excel.EntityCompactLayoutIcons.trophy:member + package: excel! + summary: >- + Trophy icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Trophy"' + - name: tv + uid: excel!Excel.EntityCompactLayoutIcons.tv:member + package: excel! + summary: >- + TV icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Tv"' + - name: tvUsb + uid: excel!Excel.EntityCompactLayoutIcons.tvUsb:member + package: excel! + summary: >- + TV USB icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"TvUsb"' + - name: umbrella + uid: excel!Excel.EntityCompactLayoutIcons.umbrella:member + package: excel! + summary: >- + Umbrella icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Umbrella"' + - name: usbPlug + uid: excel!Excel.EntityCompactLayoutIcons.usbPlug:member + package: excel! + summary: >- + USB plug icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"UsbPlug"' + - name: usbStick + uid: excel!Excel.EntityCompactLayoutIcons.usbStick:member + package: excel! + summary: >- + USB stick icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"UsbStick"' + - name: vault + uid: excel!Excel.EntityCompactLayoutIcons.vault:member + package: excel! + summary: >- + Vault icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Vault"' + - name: vehicleBicycle + uid: excel!Excel.EntityCompactLayoutIcons.vehicleBicycle:member + package: excel! + summary: >- + Vehicle bicycle icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"VehicleBicycle"' + - name: vehicleBus + uid: excel!Excel.EntityCompactLayoutIcons.vehicleBus:member + package: excel! + summary: >- + Vehicle bus icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"VehicleBus"' + - name: vehicleCab + uid: excel!Excel.EntityCompactLayoutIcons.vehicleCab:member + package: excel! + summary: >- + Vehicle cab icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"VehicleCab"' + - name: vehicleCar + uid: excel!Excel.EntityCompactLayoutIcons.vehicleCar:member + package: excel! + summary: >- + Vehicle car icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"VehicleCar"' + - name: vehicleCarCollision + uid: excel!Excel.EntityCompactLayoutIcons.vehicleCarCollision:member + package: excel! + summary: >- + Vehicle car collision icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"VehicleCarCollision"' + - name: vehicleCarProfileLtr + uid: excel!Excel.EntityCompactLayoutIcons.vehicleCarProfileLtr:member + package: excel! + summary: >- + Vehicle car profile left-to-right icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"VehicleCarProfileLtr"' + - name: vehicleCarProfileRtl + uid: excel!Excel.EntityCompactLayoutIcons.vehicleCarProfileRtl:member + package: excel! + summary: >- + Vehicle car profile right-to-left icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"VehicleCarProfileRtl"' + - name: vehicleShip + uid: excel!Excel.EntityCompactLayoutIcons.vehicleShip:member + package: excel! + summary: >- + Vehicle ship icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"VehicleShip"' + - name: vehicleSubway + uid: excel!Excel.EntityCompactLayoutIcons.vehicleSubway:member + package: excel! + summary: >- + Vehicle subway icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"VehicleSubway"' + - name: vehicleTruck + uid: excel!Excel.EntityCompactLayoutIcons.vehicleTruck:member + package: excel! + summary: >- + Vehicle truck icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"VehicleTruck"' + - name: vehicleTruckBag + uid: excel!Excel.EntityCompactLayoutIcons.vehicleTruckBag:member + package: excel! + summary: >- + Vehicle truck bag icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"VehicleTruckBag"' + - name: vehicleTruckCube + uid: excel!Excel.EntityCompactLayoutIcons.vehicleTruckCube:member + package: excel! + summary: >- + Vehicle truck cube icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"VehicleTruckCube"' + - name: vehicleTruckProfile + uid: excel!Excel.EntityCompactLayoutIcons.vehicleTruckProfile:member + package: excel! + summary: >- + Vehicle truck profile icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"VehicleTruckProfile"' + - name: video + uid: excel!Excel.EntityCompactLayoutIcons.video:member + package: excel! + summary: >- + Video icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Video"' + - name: video360 + uid: excel!Excel.EntityCompactLayoutIcons.video360:member + package: excel! + summary: >- + Video 360 icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Video360"' + - name: videoChat + uid: excel!Excel.EntityCompactLayoutIcons.videoChat:member + package: excel! + summary: >- + Video chat icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"VideoChat"' + - name: videoClip + uid: excel!Excel.EntityCompactLayoutIcons.videoClip:member + package: excel! + summary: >- + Video clip icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"VideoClip"' + - name: videoClipMultiple + uid: excel!Excel.EntityCompactLayoutIcons.videoClipMultiple:member + package: excel! + summary: >- + Video clip multiple icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"VideoClipMultiple"' + - name: videoPerson + uid: excel!Excel.EntityCompactLayoutIcons.videoPerson:member + package: excel! + summary: >- + Video person icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"VideoPerson"' + - name: videoRecording + uid: excel!Excel.EntityCompactLayoutIcons.videoRecording:member + package: excel! + summary: >- + Video recording icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"VideoRecording"' + - name: videoSecurity + uid: excel!Excel.EntityCompactLayoutIcons.videoSecurity:member + package: excel! + summary: >- + Video security icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"VideoSecurity"' + - name: viewDesktop + uid: excel!Excel.EntityCompactLayoutIcons.viewDesktop:member + package: excel! + summary: >- + View desktop icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ViewDesktop"' + - name: viewDesktopMobile + uid: excel!Excel.EntityCompactLayoutIcons.viewDesktopMobile:member + package: excel! + summary: >- + View desktop mobile icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ViewDesktopMobile"' + - name: violin + uid: excel!Excel.EntityCompactLayoutIcons.violin:member + package: excel! + summary: >- + Violin icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Violin"' + - name: virtualNetwork + uid: excel!Excel.EntityCompactLayoutIcons.virtualNetwork:member + package: excel! + summary: >- + Virtual network icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"VirtualNetwork"' + - name: voicemail + uid: excel!Excel.EntityCompactLayoutIcons.voicemail:member + package: excel! + summary: >- + Voicemail icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Voicemail"' + - name: vote + uid: excel!Excel.EntityCompactLayoutIcons.vote:member + package: excel! + summary: >- + Vote icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Vote"' + - name: walkieTalkie + uid: excel!Excel.EntityCompactLayoutIcons.walkieTalkie:member + package: excel! + summary: >- + Walkie talkie icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"WalkieTalkie"' + - name: wallet + uid: excel!Excel.EntityCompactLayoutIcons.wallet:member + package: excel! + summary: >- + Wallet icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Wallet"' + - name: walletCreditCard + uid: excel!Excel.EntityCompactLayoutIcons.walletCreditCard:member + package: excel! + summary: >- + Wallet credit card icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"WalletCreditCard"' + - name: wallpaper + uid: excel!Excel.EntityCompactLayoutIcons.wallpaper:member + package: excel! + summary: >- + Wallpaper icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Wallpaper"' + - name: wand + uid: excel!Excel.EntityCompactLayoutIcons.wand:member + package: excel! + summary: >- + Wand icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Wand"' + - name: warning + uid: excel!Excel.EntityCompactLayoutIcons.warning:member + package: excel! + summary: >- + Warning icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Warning"' + - name: weatherBlowingSnow + uid: excel!Excel.EntityCompactLayoutIcons.weatherBlowingSnow:member + package: excel! + summary: >- + Weather blowing snow icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"WeatherBlowingSnow"' + - name: weatherCloudy + uid: excel!Excel.EntityCompactLayoutIcons.weatherCloudy:member + package: excel! + summary: >- + Weather cloudy icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"WeatherCloudy"' + - name: weatherDrizzle + uid: excel!Excel.EntityCompactLayoutIcons.weatherDrizzle:member + package: excel! + summary: >- + Weather drizzle icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"WeatherDrizzle"' + - name: weatherDuststorm + uid: excel!Excel.EntityCompactLayoutIcons.weatherDuststorm:member + package: excel! + summary: >- + Weather duststorm icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"WeatherDuststorm"' + - name: weatherFog + uid: excel!Excel.EntityCompactLayoutIcons.weatherFog:member + package: excel! + summary: >- + Weather fog icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"WeatherFog"' + - name: weatherHailDay + uid: excel!Excel.EntityCompactLayoutIcons.weatherHailDay:member + package: excel! + summary: >- + Weather hail day icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"WeatherHailDay"' + - name: weatherHailNight + uid: excel!Excel.EntityCompactLayoutIcons.weatherHailNight:member + package: excel! + summary: >- + Weather hail night icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"WeatherHailNight"' + - name: weatherHaze + uid: excel!Excel.EntityCompactLayoutIcons.weatherHaze:member + package: excel! + summary: >- + Weather haze icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"WeatherHaze"' + - name: weatherMoon + uid: excel!Excel.EntityCompactLayoutIcons.weatherMoon:member + package: excel! + summary: >- + Weather moon icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"WeatherMoon"' + - name: weatherPartlyCloudyDay + uid: excel!Excel.EntityCompactLayoutIcons.weatherPartlyCloudyDay:member + package: excel! + summary: >- + Weather partly cloudy day icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"WeatherPartlyCloudyDay"' + - name: weatherPartlyCloudyNight + uid: excel!Excel.EntityCompactLayoutIcons.weatherPartlyCloudyNight:member + package: excel! + summary: >- + Weather partly cloudy night icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"WeatherPartlyCloudyNight"' + - name: weatherRain + uid: excel!Excel.EntityCompactLayoutIcons.weatherRain:member + package: excel! + summary: >- + Weather rain icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"WeatherRain"' + - name: weatherRainShowersDay + uid: excel!Excel.EntityCompactLayoutIcons.weatherRainShowersDay:member + package: excel! + summary: >- + Weather rain showers day icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"WeatherRainShowersDay"' + - name: weatherRainShowersNight + uid: excel!Excel.EntityCompactLayoutIcons.weatherRainShowersNight:member + package: excel! + summary: >- + Weather rain showers night icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"WeatherRainShowersNight"' + - name: weatherRainSnow + uid: excel!Excel.EntityCompactLayoutIcons.weatherRainSnow:member + package: excel! + summary: >- + Weather rain snow icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"WeatherRainSnow"' + - name: weatherSnow + uid: excel!Excel.EntityCompactLayoutIcons.weatherSnow:member + package: excel! + summary: >- + Weather snow icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"WeatherSnow"' + - name: weatherSnowflake + uid: excel!Excel.EntityCompactLayoutIcons.weatherSnowflake:member + package: excel! + summary: >- + Weather snowflake icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"WeatherSnowflake"' + - name: weatherSnowShowerDay + uid: excel!Excel.EntityCompactLayoutIcons.weatherSnowShowerDay:member + package: excel! + summary: >- + Weather snow shower day icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"WeatherSnowShowerDay"' + - name: weatherSnowShowerNight + uid: excel!Excel.EntityCompactLayoutIcons.weatherSnowShowerNight:member + package: excel! + summary: >- + Weather snow shower night icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"WeatherSnowShowerNight"' + - name: weatherSqualls + uid: excel!Excel.EntityCompactLayoutIcons.weatherSqualls:member + package: excel! + summary: >- + Weather squalls icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"WeatherSqualls"' + - name: weatherSunnyHigh + uid: excel!Excel.EntityCompactLayoutIcons.weatherSunnyHigh:member + package: excel! + summary: >- + Weather sunny high icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"WeatherSunnyHigh"' + - name: weatherSunnyLow + uid: excel!Excel.EntityCompactLayoutIcons.weatherSunnyLow:member + package: excel! + summary: >- + Weather sunny low icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"WeatherSunnyLow"' + - name: weatherThunderstorm + uid: excel!Excel.EntityCompactLayoutIcons.weatherThunderstorm:member + package: excel! + summary: >- + Weather thunderstorm icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"WeatherThunderstorm"' + - name: webAsset + uid: excel!Excel.EntityCompactLayoutIcons.webAsset:member + package: excel! + summary: >- + Web asset icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"WebAsset"' + - name: whiteboard + uid: excel!Excel.EntityCompactLayoutIcons.whiteboard:member + package: excel! + summary: >- + Whiteboard icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Whiteboard"' + - name: wifi1 + uid: excel!Excel.EntityCompactLayoutIcons.wifi1:member + package: excel! + summary: >- + Wifi signal with 3 bars icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Wifi1"' + - name: wifi2 + uid: excel!Excel.EntityCompactLayoutIcons.wifi2:member + package: excel! + summary: >- + Wifi signal with 2 bars icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Wifi2"' + - name: window + uid: excel!Excel.EntityCompactLayoutIcons.window:member + package: excel! + summary: >- + Window icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Window"' + - name: windowMultiple + uid: excel!Excel.EntityCompactLayoutIcons.windowMultiple:member + package: excel! + summary: >- + Window multiple icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"WindowMultiple"' + - name: windowWrench + uid: excel!Excel.EntityCompactLayoutIcons.windowWrench:member + package: excel! + summary: >- + Window wrench icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"WindowWrench"' + - name: wrench + uid: excel!Excel.EntityCompactLayoutIcons.wrench:member + package: excel! + summary: >- + Wrench icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Wrench"' + - name: wrenchScrewdriver + uid: excel!Excel.EntityCompactLayoutIcons.wrenchScrewdriver:member + package: excel! + summary: >- + Wrench screwdriver icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"WrenchScrewdriver"' + - name: xray + uid: excel!Excel.EntityCompactLayoutIcons.xray:member + package: excel! + summary: >- + X-ray icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Xray"' + - name: yoga + uid: excel!Excel.EntityCompactLayoutIcons.yoga:member + package: excel! + summary: >- + Yoga icon. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Yoga"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.entitypropertyextraproperties.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.entitypropertyextraproperties.yml new file mode 100644 index 0000000000..3a9cd15924 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.entitypropertyextraproperties.yml @@ -0,0 +1,32 @@ +### YamlMime:TSType +name: Excel.EntityPropertyExtraProperties +uid: excel!Excel.EntityPropertyExtraProperties:interface +package: excel! +fullName: Excel.EntityPropertyExtraProperties +summary: >- + Properties used by `CellValueAndPropertyMetadata`. These properties + refer to the metadata and not to a `CellValue`. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: propertyMetadata + uid: excel!Excel.EntityPropertyExtraProperties#propertyMetadata:member + package: excel! + fullName: propertyMetadata + summary: Represents metadata about the property. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'propertyMetadata?: CellValuePropertyMetadata;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.entitypropertytype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.entitypropertytype.yml new file mode 100644 index 0000000000..bc54a6eff6 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.entitypropertytype.yml @@ -0,0 +1,20 @@ +### YamlMime:TSTypeAlias +name: Excel.EntityPropertyType +uid: excel!Excel.EntityPropertyType:type +package: excel! +fullName: Excel.EntityPropertyType +summary: Represents the value of a property. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), + [Excel.CellValue](/javascript/api/excel/excel.cellvalue) + +isPreview: false +isDeprecated: false +syntax: export type EntityPropertyType = CellValueAndPropertyMetadata | CellValue; diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.entityviewlayouts.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.entityviewlayouts.yml new file mode 100644 index 0000000000..22c4101139 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.entityviewlayouts.yml @@ -0,0 +1,50 @@ +### YamlMime:TSType +name: Excel.EntityViewLayouts +uid: excel!Excel.EntityViewLayouts:interface +package: excel! +fullName: Excel.EntityViewLayouts +summary: Represents layout information for various views of the entity. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: card + uid: excel!Excel.EntityViewLayouts#card:member + package: excel! + fullName: card + summary: >- + Represents the layout of this entity in card view. If the `CardLayout` + object does not have a layout property, it is assumed to be "Entity". + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'card?: CardLayout;' + return: + type: + - name: compact + uid: excel!Excel.EntityViewLayouts#compact:member + package: excel! + fullName: compact + summary: >- + Represents the layout used when there is limited space to represent the + entity. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'compact?: CompactLayout;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.errorcellvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.errorcellvalue.yml new file mode 100644 index 0000000000..b88b1959c2 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.errorcellvalue.yml @@ -0,0 +1,72 @@ +### YamlMime:TSTypeAlias +name: Excel.ErrorCellValue +uid: excel!Excel.ErrorCellValue:type +package: excel! +fullName: Excel.ErrorCellValue +summary: Represents a cell value which contains an error. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + + + Learn more about the types in this type alias through the following links. + + + [Excel.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue), + [Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue), + [Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue), + [Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue), + [Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue), + [Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue), + [Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue), + [Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue), + [Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue), + [Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue), + [Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue), + [Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue), + [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue), + [Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue), + [Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue), + [Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue) + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml + + + // This function sets the value of cell A1 to a #BUSY! error using data types. + + await Excel.run(async (context) => { + // Retrieve the Sample worksheet and cell A1 on that sheet. + const sheet = context.workbook.worksheets.getItemOrNullObject("Sample"); + const range = sheet.getRange("A1"); + + // Get the error data type and set its type to `busy`. + const error: Excel.ErrorCellValue = { + type: Excel.CellValueType.error, + errorType: Excel.ErrorCellValueType.busy + }; + + // Set cell A1 as the busy error. + range.valuesAsJson = [[error]]; + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +syntax: >- + export type ErrorCellValue = BlockedErrorCellValue | BusyErrorCellValue | + CalcErrorCellValue | ConnectErrorCellValue | Div0ErrorCellValue | + ExternalErrorCellValue | FieldErrorCellValue | GettingDataErrorCellValue | + NotAvailableErrorCellValue | NameErrorCellValue | NullErrorCellValue | + NumErrorCellValue | PlaceholderErrorCellValue | RefErrorCellValue | + SpillErrorCellValue | ValueErrorCellValue; diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.errorcellvaluetype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.errorcellvaluetype.yml new file mode 100644 index 0000000000..0cf0da25d9 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.errorcellvaluetype.yml @@ -0,0 +1,219 @@ +### YamlMime:TSEnum +name: Excel.ErrorCellValueType +uid: excel!Excel.ErrorCellValueType:enum +package: excel! +fullName: Excel.ErrorCellValueType +summary: Represents the types of the `ErrorCellValue` object. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml + + + // This function sets the value of cell A1 to a #BUSY! error using data types. + + await Excel.run(async (context) => { + // Retrieve the Sample worksheet and cell A1 on that sheet. + const sheet = context.workbook.worksheets.getItemOrNullObject("Sample"); + const range = sheet.getRange("A1"); + + // Get the error data type and set its type to `busy`. + const error: Excel.ErrorCellValue = { + type: Excel.CellValueType.error, + errorType: Excel.ErrorCellValueType.busy + }; + + // Set cell A1 as the busy error. + range.valuesAsJson = [[error]]; + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: blocked + uid: excel!Excel.ErrorCellValueType.blocked:member + package: excel! + summary: >- + Represents a `BlockedErrorCellValue`. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Blocked"' + - name: busy + uid: excel!Excel.ErrorCellValueType.busy:member + package: excel! + summary: >- + Represents a `BusyErrorCellValue`. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Busy"' + - name: calc + uid: excel!Excel.ErrorCellValueType.calc:member + package: excel! + summary: >- + Represents a `CalcErrorCellValue`. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Calc"' + - name: connect + uid: excel!Excel.ErrorCellValueType.connect:member + package: excel! + summary: >- + Represents a `ConnectErrorCellValue`. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Connect"' + - name: div0 + uid: excel!Excel.ErrorCellValueType.div0:member + package: excel! + summary: >- + Represents a `Div0ErrorCellValue`. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Div0"' + - name: external + uid: excel!Excel.ErrorCellValueType.external:member + package: excel! + summary: >- + Represents an `ExternalErrorCellValue`. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"External"' + - name: field + uid: excel!Excel.ErrorCellValueType.field:member + package: excel! + summary: >- + Represents a `FieldErrorCellValue`. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Field"' + - name: gettingData + uid: excel!Excel.ErrorCellValueType.gettingData:member + package: excel! + summary: >- + Represents a `GettingDataErrorCellValue`. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"GettingData"' + - name: name + uid: excel!Excel.ErrorCellValueType.name:member + package: excel! + summary: >- + Represents a `NameErrorCellValue`. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Name"' + - name: notAvailable + uid: excel!Excel.ErrorCellValueType.notAvailable:member + package: excel! + summary: >- + Represents a `NotAvailableErrorCellValue`. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"NotAvailable"' + - name: 'null' + uid: excel!Excel.ErrorCellValueType.null:member + package: excel! + summary: >- + Represents a `NullErrorCellValue`. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Null"' + - name: num + uid: excel!Excel.ErrorCellValueType.num:member + package: excel! + summary: >- + Represents a `NumErrorCellValue`. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Num"' + - name: placeholder + uid: excel!Excel.ErrorCellValueType.placeholder:member + package: excel! + summary: >- + Represents a `PlaceholderErrorCellValue`. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Placeholder"' + - name: ref + uid: excel!Excel.ErrorCellValueType.ref:member + package: excel! + summary: >- + Represents a `RefErrorCellValue`. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Ref"' + - name: spill + uid: excel!Excel.ErrorCellValueType.spill:member + package: excel! + summary: >- + Represents a `SpillErrorCellValue`. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Spill"' + - name: value + uid: excel!Excel.ErrorCellValueType.value:member + package: excel! + summary: >- + Represents a `ValueErrorCellValue`. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Value"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.errorcodes.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.errorcodes.yml new file mode 100644 index 0000000000..85ac80664d --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.errorcodes.yml @@ -0,0 +1,176 @@ +### YamlMime:TSEnum +name: Excel.ErrorCodes +uid: excel!Excel.ErrorCodes:enum +package: excel! +fullName: Excel.ErrorCodes +summary: '' +remarks: '' + +isPreview: false +isDeprecated: false +fields: + - name: accessDenied + uid: excel!Excel.ErrorCodes.accessDenied:member + package: excel! + summary: '' + value: '"AccessDenied"' + - name: apiNotFound + uid: excel!Excel.ErrorCodes.apiNotFound:member + package: excel! + summary: '' + value: '"ApiNotFound"' + - name: conflict + uid: excel!Excel.ErrorCodes.conflict:member + package: excel! + summary: '' + value: '"Conflict"' + - name: emptyChartSeries + uid: excel!Excel.ErrorCodes.emptyChartSeries:member + package: excel! + summary: '' + value: '"EmptyChartSeries"' + - name: filteredRangeConflict + uid: excel!Excel.ErrorCodes.filteredRangeConflict:member + package: excel! + summary: '' + value: '"FilteredRangeConflict"' + - name: formulaLengthExceedsLimit + uid: excel!Excel.ErrorCodes.formulaLengthExceedsLimit:member + package: excel! + summary: '' + value: '"FormulaLengthExceedsLimit"' + - name: generalException + uid: excel!Excel.ErrorCodes.generalException:member + package: excel! + summary: '' + value: '"GeneralException"' + - name: inactiveWorkbook + uid: excel!Excel.ErrorCodes.inactiveWorkbook:member + package: excel! + summary: '' + value: '"InactiveWorkbook"' + - name: insertDeleteConflict + uid: excel!Excel.ErrorCodes.insertDeleteConflict:member + package: excel! + summary: '' + value: '"InsertDeleteConflict"' + - name: invalidArgument + uid: excel!Excel.ErrorCodes.invalidArgument:member + package: excel! + summary: '' + value: '"InvalidArgument"' + - name: invalidBinding + uid: excel!Excel.ErrorCodes.invalidBinding:member + package: excel! + summary: '' + value: '"InvalidBinding"' + - name: invalidOperation + uid: excel!Excel.ErrorCodes.invalidOperation:member + package: excel! + summary: '' + value: '"InvalidOperation"' + - name: invalidOperationInCellEditMode + uid: excel!Excel.ErrorCodes.invalidOperationInCellEditMode:member + package: excel! + summary: '' + value: '"InvalidOperationInCellEditMode"' + - name: invalidReference + uid: excel!Excel.ErrorCodes.invalidReference:member + package: excel! + summary: '' + value: '"InvalidReference"' + - name: invalidSelection + uid: excel!Excel.ErrorCodes.invalidSelection:member + package: excel! + summary: '' + value: '"InvalidSelection"' + - name: itemAlreadyExists + uid: excel!Excel.ErrorCodes.itemAlreadyExists:member + package: excel! + summary: '' + value: '"ItemAlreadyExists"' + - name: itemNotFound + uid: excel!Excel.ErrorCodes.itemNotFound:member + package: excel! + summary: '' + value: '"ItemNotFound"' + - name: mergedRangeConflict + uid: excel!Excel.ErrorCodes.mergedRangeConflict:member + package: excel! + summary: '' + value: '"MergedRangeConflict"' + - name: nonBlankCellOffSheet + uid: excel!Excel.ErrorCodes.nonBlankCellOffSheet:member + package: excel! + summary: '' + value: '"NonBlankCellOffSheet"' + - name: notImplemented + uid: excel!Excel.ErrorCodes.notImplemented:member + package: excel! + summary: '' + value: '"NotImplemented"' + - name: openWorkbookLinksBlocked + uid: excel!Excel.ErrorCodes.openWorkbookLinksBlocked:member + package: excel! + summary: '' + value: '"OpenWorkbookLinksBlocked"' + - name: operationCellsExceedLimit + uid: excel!Excel.ErrorCodes.operationCellsExceedLimit:member + package: excel! + summary: '' + value: '"OperationCellsExceedLimit"' + - name: pivotTableRangeConflict + uid: excel!Excel.ErrorCodes.pivotTableRangeConflict:member + package: excel! + summary: '' + value: '"PivotTableRangeConflict"' + - name: powerQueryRefreshResourceChallenge + uid: excel!Excel.ErrorCodes.powerQueryRefreshResourceChallenge:member + package: excel! + summary: '' + value: '"PowerQueryRefreshResourceChallenge"' + - name: rangeExceedsLimit + uid: excel!Excel.ErrorCodes.rangeExceedsLimit:member + package: excel! + summary: '' + value: '"RangeExceedsLimit"' + - name: rangeImageExceedsLimit + uid: excel!Excel.ErrorCodes.rangeImageExceedsLimit:member + package: excel! + summary: '' + value: '"RangeImageExceedsLimit"' + - name: refreshWorkbookLinksBlocked + uid: excel!Excel.ErrorCodes.refreshWorkbookLinksBlocked:member + package: excel! + summary: '' + value: '"RefreshWorkbookLinksBlocked"' + - name: requestAborted + uid: excel!Excel.ErrorCodes.requestAborted:member + package: excel! + summary: '' + value: '"RequestAborted"' + - name: responsePayloadSizeLimitExceeded + uid: excel!Excel.ErrorCodes.responsePayloadSizeLimitExceeded:member + package: excel! + summary: '' + value: '"ResponsePayloadSizeLimitExceeded"' + - name: unsupportedFeature + uid: excel!Excel.ErrorCodes.unsupportedFeature:member + package: excel! + summary: '' + value: '"UnsupportedFeature"' + - name: unsupportedFillType + uid: excel!Excel.ErrorCodes.unsupportedFillType:member + package: excel! + summary: '' + value: '"UnsupportedFillType"' + - name: unsupportedOperation + uid: excel!Excel.ErrorCodes.unsupportedOperation:member + package: excel! + summary: '' + value: '"UnsupportedOperation"' + - name: unsupportedSheet + uid: excel!Excel.ErrorCodes.unsupportedSheet:member + package: excel! + summary: '' + value: '"UnsupportedSheet"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.eventsource.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.eventsource.yml new file mode 100644 index 0000000000..049824967e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.eventsource.yml @@ -0,0 +1,33 @@ +### YamlMime:TSEnum +name: Excel.EventSource +uid: excel!Excel.EventSource:enum +package: excel! +fullName: Excel.EventSource +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: local + uid: excel!Excel.EventSource.local:member + package: excel! + summary: >- + Local means the event comes from a local user session. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Local"' + - name: remote + uid: excel!Excel.EventSource.remote:member + package: excel! + summary: >- + Remote means the event comes from a remote user session. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Remote"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.eventtriggersource.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.eventtriggersource.yml new file mode 100644 index 0000000000..d92abd37e2 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.eventtriggersource.yml @@ -0,0 +1,35 @@ +### YamlMime:TSEnum +name: Excel.EventTriggerSource +uid: excel!Excel.EventTriggerSource:enum +package: excel! +fullName: Excel.EventTriggerSource +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: thisLocalAddin + uid: excel!Excel.EventTriggerSource.thisLocalAddin:member + package: excel! + summary: >- + The event is triggered by the Office JS API of the current add-in. + + + * \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ThisLocalAddin"' + - name: unknown + uid: excel!Excel.EventTriggerSource.unknown:member + package: excel! + summary: >- + The event trigger source is unknown or currently unsupported. + + + * \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Unknown"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.eventtype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.eventtype.yml new file mode 100644 index 0000000000..6941dd0bd7 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.eventtype.yml @@ -0,0 +1,523 @@ +### YamlMime:TSEnum +name: Excel.EventType +uid: excel!Excel.EventType:enum +package: excel! +fullName: Excel.EventType +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: chartActivated + uid: excel!Excel.EventType.chartActivated:member + package: excel! + summary: >- + `ChartActivated` represents the type of event registered on a `Chart` or + `ChartCollection` and occurs when a chart activates. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ChartActivated"' + - name: chartAdded + uid: excel!Excel.EventType.chartAdded:member + package: excel! + summary: >- + `ChartAdded` represents the type of event registered on a + `ChartCollection` and occurs when a new chart is added to the worksheet. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ChartAdded"' + - name: chartDeactivated + uid: excel!Excel.EventType.chartDeactivated:member + package: excel! + summary: >- + `ChartDeactivated` represents the type of event registered on a `Chart` or + `ChartCollection` and occurs when a chart deactivates. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ChartDeactivated"' + - name: chartDeleted + uid: excel!Excel.EventType.chartDeleted:member + package: excel! + summary: >- + `ChartDeleted` represents the type of event registered on a + `ChartCollection` and occurs when a chart is deleted from the worksheet. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ChartDeleted"' + - name: commentAdded + uid: excel!Excel.EventType.commentAdded:member + package: excel! + summary: >- + `CommentAdded` represents the type of event that is registered on a + comment collection and occurs when comments are added. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"CommentAdded"' + - name: commentChanged + uid: excel!Excel.EventType.commentChanged:member + package: excel! + summary: >- + `CommentChanged` represents the type of event that is registered on a + comment collection and occurs when comments are changed. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"CommentChanged"' + - name: commentDeleted + uid: excel!Excel.EventType.commentDeleted:member + package: excel! + summary: >- + `CommentDeleted` represents the type of event that is registered on a + comment collection and occurs when comments are deleted. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"CommentDeleted"' + - name: linkedDataTypeLinkedDataTypeAdded + uid: excel!Excel.EventType.linkedDataTypeLinkedDataTypeAdded:member + package: excel! + summary: >- + `LinkedDataTypeAdded` represents the type of event registered on a + `LinkedDataType` and occurs when a new linked data type is added to the + workbook. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LinkedDataTypeLinkedDataTypeAdded"' + - name: linkedDataTypeRefreshModeChanged + uid: excel!Excel.EventType.linkedDataTypeRefreshModeChanged:member + package: excel! + summary: >- + `RefreshModeChanged` represents the type of event registered on a + `LinkedDataType` and occurs when the linked data type refresh mode is + changed. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LinkedDataTypeRefreshModeChanged"' + - name: linkedDataTypeRefreshRequestCompleted + uid: excel!Excel.EventType.linkedDataTypeRefreshRequestCompleted:member + package: excel! + summary: >- + `RefreshRequestCompleted` represents the type of event registered on a + `LinkedDataType` and occurs when a request to refresh a data source is + completed. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LinkedDataTypeRefreshRequestCompleted"' + - name: linkedEntityDataDomainLinkedEntityDataDomainAdded + uid: >- + excel!Excel.EventType.linkedEntityDataDomainLinkedEntityDataDomainAdded:member + package: excel! + summary: >- + LinkedEntityDataDomainAdded represents the type of event registered when a + new linked entity data domain is added to the workbook. + + + * \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"LinkedEntityDataDomainLinkedEntityDataDomainAdded"' + - name: linkedEntityDataDomainRefreshCompleted + uid: excel!Excel.EventType.linkedEntityDataDomainRefreshCompleted:member + package: excel! + summary: >- + LinkedEntityDataDomainRefreshCompleted represents the type of event + registered when the request to refresh `LinkedEntityCellValue` objects of + a linked entity data domain is completed. + + + * \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"LinkedEntityDataDomainRefreshCompleted"' + - name: linkedEntityDataDomainRefreshModeChanged + uid: excel!Excel.EventType.linkedEntityDataDomainRefreshModeChanged:member + package: excel! + summary: >- + LinkedEntityDataDomainRefreshModeChanged represents the type of event + registered when the `refreshMode` of a linked entity data domain is + changed. + + + * \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"LinkedEntityDataDomainRefreshModeChanged"' + - name: linkedWorkbookRefreshCompleted + uid: excel!Excel.EventType.linkedWorkbookRefreshCompleted:member + package: excel! + summary: >- + `WorkbookLinksRefreshCompleted` represents the type of event registered on + a linked Workbook and occurs when a linked workbook completes a refresh. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LinkedWorkbookRefreshCompleted"' + - name: linkedWorkbookWorkbookLinksChanged + uid: excel!Excel.EventType.linkedWorkbookWorkbookLinksChanged:member + package: excel! + summary: >- + `WorkbookLinksChanged` represents the type of event which is fired when a + workbook link is changed. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LinkedWorkbookWorkbookLinksChanged"' + - name: ribbonCommandExecuted + uid: excel!Excel.EventType.ribbonCommandExecuted:member + package: excel! + summary: >- + `RibbonCommandExecuted` represents the type of event registered on the + ribbon and occurs when a user clicks on the ribbon + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"RibbonCommandExecuted"' + - name: shapeActivated + uid: excel!Excel.EventType.shapeActivated:member + package: excel! + summary: >- + `ShapeActivated` represents the type of event that is registered on a + `Shape` and occurs when the shape activates. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ShapeActivated"' + - name: shapeDeactivated + uid: excel!Excel.EventType.shapeDeactivated:member + package: excel! + summary: >- + `ShapeDeactivated` represents the type of event that is registered on a + `Shape` and occurs when the shape deactivates. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ShapeDeactivated"' + - name: tableAdded + uid: excel!Excel.EventType.tableAdded:member + package: excel! + summary: >- + `TableAdded` represents the type of event registered on a + `TableCollection` and occurs when a table is added. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"TableAdded"' + - name: tableChanged + uid: excel!Excel.EventType.tableChanged:member + package: excel! + summary: >- + `TableChanged` represents the type of event registered on a `Table` and + occurs when data changes. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"TableChanged"' + - name: tableDeleted + uid: excel!Excel.EventType.tableDeleted:member + package: excel! + summary: >- + `TableDeleted` represents the type of event that is registered on a + `TableCollection` and occurs when a table is deleted. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"TableDeleted"' + - name: tableFiltered + uid: excel!Excel.EventType.tableFiltered:member + package: excel! + summary: >- + `TableFiltered` represents the type of event registered on a table or + `TableCollection` and occurs when the data of a table is filtered. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"TableFiltered"' + - name: tableSelectionChanged + uid: excel!Excel.EventType.tableSelectionChanged:member + package: excel! + summary: >- + `TableSelectionChanged` represents the type of event registered on a + `Table` and occurs when the selection changes. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"TableSelectionChanged"' + - name: visualChange + uid: excel!Excel.EventType.visualChange:member + package: excel! + summary: >- + `VisualChange` represents the type of event registered on a `Visual` and + occurs when there is a visual change. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"VisualChange"' + - name: visualSelectionChanged + uid: excel!Excel.EventType.visualSelectionChanged:member + package: excel! + summary: >- + `VisualSelectionChanged` represents the type of event registered on a + `VisualCollection` and occurs when the visual selection changes. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"VisualSelectionChanged"' + - name: workbookActivated + uid: excel!Excel.EventType.workbookActivated:member + package: excel! + summary: >- + `WorkbookActivated` represents the type of event which is fired when a + workbook is activated. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"WorkbookActivated"' + - name: workbookAutoSaveSettingChanged + uid: excel!Excel.EventType.workbookAutoSaveSettingChanged:member + package: excel! + summary: >- + `WorkbookAutoSaveSettingChanged` represents the type of event registered + on a workbook and occurs when there is an auto save setting change. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"WorkbookAutoSaveSettingChanged"' + - name: worksheetActivated + uid: excel!Excel.EventType.worksheetActivated:member + package: excel! + summary: >- + `WorksheetActivated` represents the type of event registered on a + `Worksheet` or `WorksheetCollection` and occurs when a worksheet + activates. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"WorksheetActivated"' + - name: worksheetAdded + uid: excel!Excel.EventType.worksheetAdded:member + package: excel! + summary: >- + `WorksheetAdded` represents the type of event registered on a + `WorksheetCollection` and occurs when a new worksheet is added to the + workbook. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"WorksheetAdded"' + - name: worksheetCalculated + uid: excel!Excel.EventType.worksheetCalculated:member + package: excel! + summary: >- + `WorksheetCalculated` represents the type of event registered on a + `Worksheet` or `WorksheetCollection` and occurs when a worksheet is + calculated. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"WorksheetCalculated"' + - name: worksheetChanged + uid: excel!Excel.EventType.worksheetChanged:member + package: excel! + summary: >- + `WorksheetChanged` represents the type of event registered on a + `Worksheet` or `WorksheetCollection` and occurs when data changes. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"WorksheetChanged"' + - name: worksheetColumnSorted + uid: excel!Excel.EventType.worksheetColumnSorted:member + package: excel! + summary: >- + `WorksheetColumnSorted` represents the type of event registered on a + worksheet and occurs columns are sorted. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"WorksheetColumnSorted"' + - name: worksheetDeactivated + uid: excel!Excel.EventType.worksheetDeactivated:member + package: excel! + summary: >- + `WorksheetDeactivated` represents the type of event registered on a + `Worksheet` or `WorksheetCollection` and occurs when a worksheet + deactivates. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"WorksheetDeactivated"' + - name: worksheetDeleted + uid: excel!Excel.EventType.worksheetDeleted:member + package: excel! + summary: >- + `WorksheetDeleted` represents the type of event registered on a + `WorksheetCollection` and occurs when a worksheet is deleted from the + workbook. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"WorksheetDeleted"' + - name: worksheetFiltered + uid: excel!Excel.EventType.worksheetFiltered:member + package: excel! + summary: >- + `WorksheetFiltered` represents the type of event registered on a worksheet + or `WorksheetCollection` and occurs when the data of an AutoFilter in the + worksheet is filtered. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"WorksheetFiltered"' + - name: worksheetFormatChanged + uid: excel!Excel.EventType.worksheetFormatChanged:member + package: excel! + summary: >- + `WorksheetFormatChanged` represents the type of event registered on a + worksheet and occurs when a format is changed. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"WorksheetFormatChanged"' + - name: worksheetFormulaChanged + uid: excel!Excel.EventType.worksheetFormulaChanged:member + package: excel! + summary: >- + `WorksheetFormulaChanged` represents the type of event registered on a + worksheet and occurs when a formula is changed. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"WorksheetFormulaChanged"' + - name: worksheetMoved + uid: excel!Excel.EventType.worksheetMoved:member + package: excel! + summary: >- + WorksheetMoved represents the type of event registered on a worksheet that + occurs when it is moved within a workbook. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"WorksheetMoved"' + - name: worksheetNameChanged + uid: excel!Excel.EventType.worksheetNameChanged:member + package: excel! + summary: >- + WorksheetNameChanged represents the type of event registered on a + worksheet that occurs when its name changes. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"WorksheetNameChanged"' + - name: worksheetProtectionChanged + uid: excel!Excel.EventType.worksheetProtectionChanged:member + package: excel! + summary: >- + WorksheetProtectionChanged represents the type of event registered on + worksheet, and occurs when protection status is changed. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"WorksheetProtectionChanged"' + - name: worksheetRowHiddenChanged + uid: excel!Excel.EventType.worksheetRowHiddenChanged:member + package: excel! + summary: >- + `WorksheetRowHiddenChanged` represents the type of event registered on a + worksheet and occurs when a row's hidden state is changed. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"WorksheetRowHiddenChanged"' + - name: worksheetRowSorted + uid: excel!Excel.EventType.worksheetRowSorted:member + package: excel! + summary: >- + `WorksheetRowSorted` represents the type of event registered on a + worksheet and occurs when rows are sorted. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"WorksheetRowSorted"' + - name: worksheetSelectionChanged + uid: excel!Excel.EventType.worksheetSelectionChanged:member + package: excel! + summary: >- + `WorksheetSelectionChanged` represents the type of event registered on a + `Worksheet` and occurs when the selection changes. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"WorksheetSelectionChanged"' + - name: worksheetSingleClicked + uid: excel!Excel.EventType.worksheetSingleClicked:member + package: excel! + summary: >- + `WorksheetSingleClicked` represents the type of event registered on a + worksheet and occurs when a cell is left-clicked or tapped. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"WorksheetSingleClicked"' + - name: worksheetVisibilityChanged + uid: excel!Excel.EventType.worksheetVisibilityChanged:member + package: excel! + summary: >- + WorksheetVisibilityChanged represents the type of event registered on a + worksheet that occurs when its visibility changes. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"WorksheetVisibilityChanged"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.externalerrorcellvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.externalerrorcellvalue.yml new file mode 100644 index 0000000000..400f7cea8b --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.externalerrorcellvalue.yml @@ -0,0 +1,105 @@ +### YamlMime:TSType +name: Excel.ExternalErrorCellValue +uid: excel!Excel.ExternalErrorCellValue:interface +package: excel! +fullName: Excel.ExternalErrorCellValue +summary: Represents the value of a cell containing an \#EXTERNAL! error. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: basicType + uid: excel!Excel.ExternalErrorCellValue#basicType:member + package: excel! + fullName: basicType + summary: >- + Represents the value that would be returned by `Range.valueTypes` for a + cell with this value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicType?: RangeValueType.error | "Error";' + return: + type: | "Error" + - name: basicValue + uid: excel!Excel.ExternalErrorCellValue#basicValue:member + package: excel! + fullName: basicValue + summary: >- + Represents the value that would be returned by `Range.values` for a cell + with this value. When accessed through a `valuesAsJson` property, this + string value aligns with the en-US locale. When accessed through a + `valuesAsJsonLocal` property, this string value aligns with the user's + display locale. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicValue?: "#EXTERNAL!" | string;' + return: + type: '"#EXTERNAL!" | string' + - name: errorSubType + uid: excel!Excel.ExternalErrorCellValue#errorSubType:member + package: excel! + fullName: errorSubType + summary: Represents the type of `ExternalErrorCellValue`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'errorSubType?: ExternalErrorCellValueSubType | "Unknown";' + return: + type: >- + | + "Unknown" + - name: errorType + uid: excel!Excel.ExternalErrorCellValue#errorType:member + package: excel! + fullName: errorType + summary: Represents the type of `ErrorCellValue`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'errorType?: ErrorCellValueType.external | "External";' + return: + type: >- + | + "External" + - name: type + uid: excel!Excel.ExternalErrorCellValue#type:member + package: excel! + fullName: type + summary: Represents the type of this cell value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: CellValueType.error | "Error";' + return: + type: | "Error" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.externalerrorcellvaluesubtype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.externalerrorcellvaluesubtype.yml new file mode 100644 index 0000000000..25127a9625 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.externalerrorcellvaluesubtype.yml @@ -0,0 +1,24 @@ +### YamlMime:TSEnum +name: Excel.ExternalErrorCellValueSubType +uid: excel!Excel.ExternalErrorCellValueSubType:enum +package: excel! +fullName: Excel.ExternalErrorCellValueSubType +summary: Represents types of \#EXTERNAL! errors. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: unknown + uid: excel!Excel.ExternalErrorCellValueSubType.unknown:member + package: excel! + summary: >- + An unknown type of error. Displays as error type \#EXTERNAL! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Unknown"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.fielderrorcellvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.fielderrorcellvalue.yml new file mode 100644 index 0000000000..753a6fb3bb --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.fielderrorcellvalue.yml @@ -0,0 +1,123 @@ +### YamlMime:TSType +name: Excel.FieldErrorCellValue +uid: excel!Excel.FieldErrorCellValue:interface +package: excel! +fullName: Excel.FieldErrorCellValue +summary: Represents the value of a cell containing a \#FIELD! error. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: basicType + uid: excel!Excel.FieldErrorCellValue#basicType:member + package: excel! + fullName: basicType + summary: >- + Represents the value that would be returned by `Range.valueTypes` for a + cell with this value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicType?: RangeValueType.error | "Error";' + return: + type: | "Error" + - name: basicValue + uid: excel!Excel.FieldErrorCellValue#basicValue:member + package: excel! + fullName: basicValue + summary: >- + Represents the value that would be returned by `Range.values` for a cell + with this value. When accessed through a `valuesAsJson` property, this + string value aligns with the en-US locale. When accessed through a + `valuesAsJsonLocal` property, this string value aligns with the user's + display locale. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicValue?: "#FIELD!" | string;' + return: + type: '"#FIELD!" | string' + - name: errorSubType + uid: excel!Excel.FieldErrorCellValue#errorSubType:member + package: excel! + fullName: errorSubType + summary: Represents the type of `FieldErrorCellValue`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + errorSubType?: FieldErrorCellValueSubType | "Unknown" | + "WebImageMissingFilePart" | "DataProviderError" | + "RichValueRelMissingFilePart"; + return: + type: >- + | "Unknown" + | "WebImageMissingFilePart" | "DataProviderError" | + "RichValueRelMissingFilePart" + - name: errorType + uid: excel!Excel.FieldErrorCellValue#errorType:member + package: excel! + fullName: errorType + summary: Represents the type of `ErrorCellValue`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'errorType?: ErrorCellValueType.field | "Field";' + return: + type: | "Field" + - name: fieldName + uid: excel!Excel.FieldErrorCellValue#fieldName:member + package: excel! + fullName: fieldName + summary: Represents the field which was not found by FIELDVALUE. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'fieldName?: string;' + return: + type: string + - name: type + uid: excel!Excel.FieldErrorCellValue#type:member + package: excel! + fullName: type + summary: Represents the type of this cell value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: CellValueType.error | "Error";' + return: + type: | "Error" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.fielderrorcellvaluesubtype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.fielderrorcellvaluesubtype.yml new file mode 100644 index 0000000000..44b4dd971a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.fielderrorcellvaluesubtype.yml @@ -0,0 +1,62 @@ +### YamlMime:TSEnum +name: Excel.FieldErrorCellValueSubType +uid: excel!Excel.FieldErrorCellValueSubType:enum +package: excel! +fullName: Excel.FieldErrorCellValueSubType +summary: Represents types of \#FIELD! errors. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: dataProviderError + uid: excel!Excel.FieldErrorCellValueSubType.dataProviderError:member + package: excel! + summary: >- + An error caused by an error from a data provider. Displays as error type + \#FIELD! in Excel. + + + * \[ [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: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"RichValueRelMissingFilePart"' + - name: unknown + uid: excel!Excel.FieldErrorCellValueSubType.unknown:member + package: excel! + summary: >- + An unknown type of error. Displays as error type \#FIELD! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Unknown"' + - name: webImageMissingFilePart + uid: excel!Excel.FieldErrorCellValueSubType.webImageMissingFilePart:member + package: excel! + summary: >- + An error caused by a missing file. In this case, the + RichValueWebImageValue.xml file is missing from the metro package. + Displays as error type \#FIELD! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"WebImageMissingFilePart"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.fillpattern.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.fillpattern.yml new file mode 100644 index 0000000000..3a41ad3d35 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.fillpattern.yml @@ -0,0 +1,244 @@ +### YamlMime:TSEnum +name: Excel.FillPattern +uid: excel!Excel.FillPattern:enum +package: excel! +fullName: Excel.FillPattern +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/cell-properties.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Creating the SettableCellProperties objects to use for the range. + // In your add-in, these should be created once, outside the function. + const topHeaderProps: Excel.SettableCellProperties = { + // The style property takes a string matching the name of an Excel style. + // Built-in style names are listed in the `BuiltInStyle` enum. + // Note that a style will overwrite any formatting, + // so do not use the format property with the style property. + style: "Heading1" + }; + + const headerProps: Excel.SettableCellProperties = { + // Any subproperties of format that are not set will not be changed when these cell properties are set. + format: { + fill: { + color: "Blue" + }, + font: { + color: "White", + bold: true + } + } + }; + + const nonApplicableProps: Excel.SettableCellProperties = { + format: { + fill: { + pattern: Excel.FillPattern.gray25 + }, + font: { + color: "Gray", + italic: true + } + } + }; + + const matchupScoreProps: Excel.SettableCellProperties = { + format: { + borders: { + bottom: { + style: Excel.BorderLineStyle.continuous + }, + left: { + style: Excel.BorderLineStyle.continuous + }, + right: { + style: Excel.BorderLineStyle.continuous + }, + top: { + style: Excel.BorderLineStyle.continuous + } + } + } + }; + + const range = sheet.getRange("A1:E5"); + + // You can use empty JSON objects to avoid changing a cell's properties. + range.setCellProperties([ + [topHeaderProps, {}, {}, {}, {}], + [{}, {}, headerProps, headerProps, headerProps], + [{}, headerProps, nonApplicableProps, matchupScoreProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, nonApplicableProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, matchupScoreProps, nonApplicableProps] + ]); + + sheet.getUsedRange().format.autofitColumns(); + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: checker + uid: excel!Excel.FillPattern.checker:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Checker"' + - name: crissCross + uid: excel!Excel.FillPattern.crissCross:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"CrissCross"' + - name: down + uid: excel!Excel.FillPattern.down:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Down"' + - name: gray16 + uid: excel!Excel.FillPattern.gray16:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Gray16"' + - name: gray25 + uid: excel!Excel.FillPattern.gray25:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Gray25"' + - name: gray50 + uid: excel!Excel.FillPattern.gray50:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Gray50"' + - name: gray75 + uid: excel!Excel.FillPattern.gray75:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Gray75"' + - name: gray8 + uid: excel!Excel.FillPattern.gray8:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Gray8"' + - name: grid + uid: excel!Excel.FillPattern.grid:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Grid"' + - name: horizontal + uid: excel!Excel.FillPattern.horizontal:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Horizontal"' + - name: lightDown + uid: excel!Excel.FillPattern.lightDown:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LightDown"' + - name: lightHorizontal + uid: excel!Excel.FillPattern.lightHorizontal:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LightHorizontal"' + - name: lightUp + uid: excel!Excel.FillPattern.lightUp:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LightUp"' + - name: lightVertical + uid: excel!Excel.FillPattern.lightVertical:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LightVertical"' + - name: linearGradient + uid: excel!Excel.FillPattern.linearGradient:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LinearGradient"' + - name: none + uid: excel!Excel.FillPattern.none:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"None"' + - name: rectangularGradient + uid: excel!Excel.FillPattern.rectangularGradient:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"RectangularGradient"' + - name: semiGray75 + uid: excel!Excel.FillPattern.semiGray75:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"SemiGray75"' + - name: solid + uid: excel!Excel.FillPattern.solid:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Solid"' + - name: up + uid: excel!Excel.FillPattern.up:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Up"' + - name: vertical + uid: excel!Excel.FillPattern.vertical:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Vertical"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.filter.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.filter.yml new file mode 100644 index 0000000000..867edf5fcc --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.filter.yml @@ -0,0 +1,472 @@ +### YamlMime:TSType +name: Excel.Filter +uid: excel!Excel.Filter:class +package: excel! +fullName: Excel.Filter +summary: Manages the filtering of a table's column. +remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.Filter#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: criteria + uid: excel!Excel.Filter#criteria:member + package: excel! + fullName: criteria + summary: The currently applied filter on the given column. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly criteria: Excel.FilterCriteria;' + return: + type: +methods: + - name: apply(criteria) + uid: excel!Excel.Filter#apply:member(1) + package: excel! + fullName: apply(criteria) + summary: Apply the given filter criteria on the given column. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'apply(criteria: Excel.FilterCriteria): void;' + parameters: + - id: criteria + description: The criteria to apply. + type: + return: + type: void + description: '' + - name: applyBottomItemsFilter(count) + uid: excel!Excel.Filter#applyBottomItemsFilter:member(1) + package: excel! + fullName: applyBottomItemsFilter(count) + summary: >- + Apply a "Bottom Item" filter to the column for the given number of + elements. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'applyBottomItemsFilter(count: number): void;' + parameters: + - id: count + description: The number of elements from the bottom to show. + type: number + return: + type: void + description: '' + - name: applyBottomPercentFilter(percent) + uid: excel!Excel.Filter#applyBottomPercentFilter:member(1) + package: excel! + fullName: applyBottomPercentFilter(percent) + summary: >- + Apply a "Bottom Percent" filter to the column for the given percentage of + elements. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'applyBottomPercentFilter(percent: number): void;' + parameters: + - id: percent + description: The percentage of elements from the bottom to show. + type: number + return: + type: void + description: '' + - name: applyCellColorFilter(color) + uid: excel!Excel.Filter#applyCellColorFilter:member(1) + package: excel! + fullName: applyCellColorFilter(color) + summary: Apply a "Cell Color" filter to the column for the given color. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'applyCellColorFilter(color: string): void;' + parameters: + - id: color + description: The background color of the cells to show. + type: string + return: + type: void + description: '' + - name: applyCustomFilter(criteria1, criteria2, oper) + uid: excel!Excel.Filter#applyCustomFilter:member(1) + package: excel! + fullName: applyCustomFilter(criteria1, criteria2, oper) + summary: Apply an "Icon" filter to the column for the given criteria strings. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + applyCustomFilter(criteria1: string, criteria2?: string, oper?: + Excel.FilterOperator): void; + parameters: + - id: criteria1 + description: The first criteria string. + type: string + - id: criteria2 + description: Optional. The second criteria string. + type: string + - id: oper + description: >- + Optional. The operator that describes how the two criteria are + joined. + type: + return: + type: void + description: '' + - name: applyCustomFilter(criteria1, criteria2, oper) + uid: excel!Excel.Filter#applyCustomFilter:member(2) + package: excel! + fullName: applyCustomFilter(criteria1, criteria2, oper) + summary: Apply an "Icon" filter to the column for the given criteria strings. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + applyCustomFilter(criteria1: string, criteria2?: string, oper?: "And" | + "Or"): void; + parameters: + - id: criteria1 + description: The first criteria string. + type: string + - id: criteria2 + description: Optional. The second criteria string. + type: string + - id: oper + description: >- + Optional. The operator that describes how the two criteria are + joined. + type: '"And" | "Or"' + return: + type: void + description: '' + - name: applyDynamicFilter(criteria) + uid: excel!Excel.Filter#applyDynamicFilter:member(1) + package: excel! + fullName: applyDynamicFilter(criteria) + summary: Apply a "Dynamic" filter to the column. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'applyDynamicFilter(criteria: Excel.DynamicFilterCriteria): void;' + parameters: + - id: criteria + description: The dynamic criteria to apply. + type: + return: + type: void + description: '' + - name: applyDynamicFilter(criteria) + uid: excel!Excel.Filter#applyDynamicFilter:member(2) + package: excel! + fullName: applyDynamicFilter(criteria) + summary: Apply a "Dynamic" filter to the column. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + applyDynamicFilter(criteria: "Unknown" | "AboveAverage" | + "AllDatesInPeriodApril" | "AllDatesInPeriodAugust" | + "AllDatesInPeriodDecember" | "AllDatesInPeriodFebruray" | + "AllDatesInPeriodJanuary" | "AllDatesInPeriodJuly" | + "AllDatesInPeriodJune" | "AllDatesInPeriodMarch" | "AllDatesInPeriodMay" + | "AllDatesInPeriodNovember" | "AllDatesInPeriodOctober" | + "AllDatesInPeriodQuarter1" | "AllDatesInPeriodQuarter2" | + "AllDatesInPeriodQuarter3" | "AllDatesInPeriodQuarter4" | + "AllDatesInPeriodSeptember" | "BelowAverage" | "LastMonth" | + "LastQuarter" | "LastWeek" | "LastYear" | "NextMonth" | "NextQuarter" | + "NextWeek" | "NextYear" | "ThisMonth" | "ThisQuarter" | "ThisWeek" | + "ThisYear" | "Today" | "Tomorrow" | "YearToDate" | "Yesterday"): void; + parameters: + - id: criteria + description: The dynamic criteria to apply. + type: >- + "Unknown" | "AboveAverage" | "AllDatesInPeriodApril" | + "AllDatesInPeriodAugust" | "AllDatesInPeriodDecember" | + "AllDatesInPeriodFebruray" | "AllDatesInPeriodJanuary" | + "AllDatesInPeriodJuly" | "AllDatesInPeriodJune" | + "AllDatesInPeriodMarch" | "AllDatesInPeriodMay" | + "AllDatesInPeriodNovember" | "AllDatesInPeriodOctober" | + "AllDatesInPeriodQuarter1" | "AllDatesInPeriodQuarter2" | + "AllDatesInPeriodQuarter3" | "AllDatesInPeriodQuarter4" | + "AllDatesInPeriodSeptember" | "BelowAverage" | "LastMonth" | + "LastQuarter" | "LastWeek" | "LastYear" | "NextMonth" | + "NextQuarter" | "NextWeek" | "NextYear" | "ThisMonth" | + "ThisQuarter" | "ThisWeek" | "ThisYear" | "Today" | "Tomorrow" | + "YearToDate" | "Yesterday" + return: + type: void + description: '' + - name: applyFontColorFilter(color) + uid: excel!Excel.Filter#applyFontColorFilter:member(1) + package: excel! + fullName: applyFontColorFilter(color) + summary: Apply a "Font Color" filter to the column for the given color. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'applyFontColorFilter(color: string): void;' + parameters: + - id: color + description: The font color of the cells to show. + type: string + return: + type: void + description: '' + - name: applyIconFilter(icon) + uid: excel!Excel.Filter#applyIconFilter:member(1) + package: excel! + fullName: applyIconFilter(icon) + summary: Apply an "Icon" filter to the column for the given icon. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'applyIconFilter(icon: Excel.Icon): void;' + parameters: + - id: icon + description: The icons of the cells to show. + type: + return: + type: void + description: '' + - name: applyTopItemsFilter(count) + uid: excel!Excel.Filter#applyTopItemsFilter:member(1) + package: excel! + fullName: applyTopItemsFilter(count) + summary: Apply a "Top Item" filter to the column for the given number of elements. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'applyTopItemsFilter(count: number): void;' + parameters: + - id: count + description: The number of elements from the top to show. + type: number + return: + type: void + description: '' + - name: applyTopPercentFilter(percent) + uid: excel!Excel.Filter#applyTopPercentFilter:member(1) + package: excel! + fullName: applyTopPercentFilter(percent) + summary: >- + Apply a "Top Percent" filter to the column for the given percentage of + elements. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'applyTopPercentFilter(percent: number): void;' + parameters: + - id: percent + description: The percentage of elements from the top to show. + type: number + return: + type: void + description: '' + - name: applyValuesFilter(values) + uid: excel!Excel.Filter#applyValuesFilter:member(1) + package: excel! + fullName: applyValuesFilter(values) + summary: Apply a "Values" filter to the column for the given values. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'applyValuesFilter(values: Array): void;' + parameters: + - id: values + description: >- + The list of values to show. This must be an array of strings or an + array of `Excel.FilterDateTime` objects. + type: >- + Array<string | > + return: + type: void + description: '' + - name: clear() + uid: excel!Excel.Filter#clear:member(1) + package: excel! + fullName: clear() + summary: Clear the filter on the given column. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'clear(): void;' + return: + type: void + description: '' + - name: load(options) + uid: excel!Excel.Filter#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(options?: Excel.Interfaces.FilterLoadOptions): Excel.Filter;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.Filter#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.Filter;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.Filter#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.Filter; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.Filter#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.Filter` object is + an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Excel.Interfaces.FilterData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.FilterData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.filtercriteria.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.filtercriteria.yml new file mode 100644 index 0000000000..ff6b9ebc02 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.filtercriteria.yml @@ -0,0 +1,229 @@ +### YamlMime:TSType +name: Excel.FilterCriteria +uid: excel!Excel.FilterCriteria:interface +package: excel! +fullName: Excel.FilterCriteria +summary: Represents the filtering criteria applied to a column. +remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: color + uid: excel!Excel.FilterCriteria#color:member + package: excel! + fullName: color + summary: >- + The HTML color string used to filter cells. Used with `cellColor` and + `fontColor` filtering. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: string;' + return: + type: string + - name: criterion1 + uid: excel!Excel.FilterCriteria#criterion1:member + package: excel! + fullName: criterion1 + summary: >- + The first criterion used to filter data. Used as an operator in the case + of `custom` filtering. For example ">50" for numbers + greater than 50, or "=*s" for values ending in "s". + + + Used as a number in the case of top/bottom items/percents (e.g., "5" for + the top 5 items if `filterOn` is set to `topItems`). + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'criterion1?: string;' + return: + type: string + - name: criterion2 + uid: excel!Excel.FilterCriteria#criterion2:member + package: excel! + fullName: criterion2 + summary: >- + The second criterion used to filter data. Only used as an operator in the + case of `custom` filtering. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'criterion2?: string;' + return: + type: string + - name: dynamicCriteria + uid: excel!Excel.FilterCriteria#dynamicCriteria:member + package: excel! + fullName: dynamicCriteria + summary: >- + The dynamic criteria from the `Excel.DynamicFilterCriteria` set to apply + on this column. Used with `dynamic` filtering. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + dynamicCriteria?: Excel.DynamicFilterCriteria | "Unknown" | + "AboveAverage" | "AllDatesInPeriodApril" | "AllDatesInPeriodAugust" | + "AllDatesInPeriodDecember" | "AllDatesInPeriodFebruray" | + "AllDatesInPeriodJanuary" | "AllDatesInPeriodJuly" | + "AllDatesInPeriodJune" | "AllDatesInPeriodMarch" | "AllDatesInPeriodMay" + | "AllDatesInPeriodNovember" | "AllDatesInPeriodOctober" | + "AllDatesInPeriodQuarter1" | "AllDatesInPeriodQuarter2" | + "AllDatesInPeriodQuarter3" | "AllDatesInPeriodQuarter4" | + "AllDatesInPeriodSeptember" | "BelowAverage" | "LastMonth" | + "LastQuarter" | "LastWeek" | "LastYear" | "NextMonth" | "NextQuarter" | + "NextWeek" | "NextYear" | "ThisMonth" | "ThisQuarter" | "ThisWeek" | + "ThisYear" | "Today" | "Tomorrow" | "YearToDate" | "Yesterday"; + return: + type: >- + | "Unknown" | + "AboveAverage" | "AllDatesInPeriodApril" | "AllDatesInPeriodAugust" | + "AllDatesInPeriodDecember" | "AllDatesInPeriodFebruray" | + "AllDatesInPeriodJanuary" | "AllDatesInPeriodJuly" | + "AllDatesInPeriodJune" | "AllDatesInPeriodMarch" | + "AllDatesInPeriodMay" | "AllDatesInPeriodNovember" | + "AllDatesInPeriodOctober" | "AllDatesInPeriodQuarter1" | + "AllDatesInPeriodQuarter2" | "AllDatesInPeriodQuarter3" | + "AllDatesInPeriodQuarter4" | "AllDatesInPeriodSeptember" | + "BelowAverage" | "LastMonth" | "LastQuarter" | "LastWeek" | "LastYear" + | "NextMonth" | "NextQuarter" | "NextWeek" | "NextYear" | "ThisMonth" + | "ThisQuarter" | "ThisWeek" | "ThisYear" | "Today" | "Tomorrow" | + "YearToDate" | "Yesterday" + - name: filterOn + uid: excel!Excel.FilterCriteria#filterOn:member + package: excel! + fullName: filterOn + summary: >- + The property used by the filter to determine whether the values should + stay visible. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-auto-filter.yaml + + + // This function adds a percentage AutoFilter to the active worksheet + + // and applies the filter to a column of the used range. + + await Excel.run(async (context) => { + // Retrieve the active worksheet and the used range on that worksheet. + const sheet = context.workbook.worksheets.getActiveWorksheet(); + const farmData = sheet.getUsedRange(); + + // Add a filter that will only show the rows with the top 50% of values in column 3. + sheet.autoFilter.apply(farmData, 3, { + criterion1: "50", + filterOn: Excel.FilterOn.topPercent + }); + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + filterOn: Excel.FilterOn | "BottomItems" | "BottomPercent" | "CellColor" + | "Dynamic" | "FontColor" | "Values" | "TopItems" | "TopPercent" | + "Icon" | "Custom"; + return: + type: >- + | "BottomItems" | + "BottomPercent" | "CellColor" | "Dynamic" | "FontColor" | "Values" | + "TopItems" | "TopPercent" | "Icon" | "Custom" + - name: icon + uid: excel!Excel.FilterCriteria#icon:member + package: excel! + fullName: icon + summary: The icon used to filter cells. Used with `icon` filtering. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'icon?: Excel.Icon;' + return: + type: + - name: operator + uid: excel!Excel.FilterCriteria#operator:member + package: excel! + fullName: operator + summary: >- + The operator used to combine criterion 1 and 2 when using `custom` + filtering. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'operator?: Excel.FilterOperator | "And" | "Or";' + return: + type: | "And" | "Or" + - name: subField + uid: excel!Excel.FilterCriteria#subField:member + package: excel! + fullName: subField + summary: The property used by the filter to do a rich filter on rich values. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'subField?: string;' + return: + type: string + - name: values + uid: excel!Excel.FilterCriteria#values:member + package: excel! + fullName: values + summary: The set of values to be used as part of `values` filtering. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'values?: Array;' + return: + type: >- + Array<string | > diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.filterdatetime.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.filterdatetime.yml new file mode 100644 index 0000000000..8b1a882174 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.filterdatetime.yml @@ -0,0 +1,51 @@ +### YamlMime:TSType +name: Excel.FilterDatetime +uid: excel!Excel.FilterDatetime:interface +package: excel! +fullName: Excel.FilterDatetime +summary: Represents how to filter a date when filtering on values. +remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: date + uid: excel!Excel.FilterDatetime#date:member + package: excel! + fullName: date + summary: The date in ISO8601 format used to filter data. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'date: string;' + return: + type: string + - name: specificity + uid: excel!Excel.FilterDatetime#specificity:member + package: excel! + fullName: specificity + summary: >- + How specific the date should be used to keep data. For example, if the + date is 2005-04-02 and the specificity is set to "month", the filter + operation will keep all rows with a date in the month of April 2005. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + specificity: Excel.FilterDatetimeSpecificity | "Year" | "Month" | "Day" + | "Hour" | "Minute" | "Second"; + return: + type: >- + | "Year" | + "Month" | "Day" | "Hour" | "Minute" | "Second" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.filterdatetimespecificity.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.filterdatetimespecificity.yml new file mode 100644 index 0000000000..4b0b1ed7ce --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.filterdatetimespecificity.yml @@ -0,0 +1,95 @@ +### YamlMime:TSEnum +name: Excel.FilterDatetimeSpecificity +uid: excel!Excel.FilterDatetimeSpecificity:enum +package: excel! +fullName: Excel.FilterDatetimeSpecificity +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotfilters.yaml + + + await Excel.run(async (context) => { + // Add a date-based PivotFilter. + + // Get the PivotTable. + const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales"); + + // PivotFilters can only be applied to PivotHierarchies that are being used for pivoting. + // If it's not already there, add "Date Updated" to the hierarchies. + let dateHierarchy = pivotTable.rowHierarchies.getItemOrNullObject("Date Updated"); + await context.sync(); + if (dateHierarchy.isNullObject) { + dateHierarchy = pivotTable.rowHierarchies.add(pivotTable.hierarchies.getItem("Date Updated")); + } + + // Apply a date filter to filter out anything logged before August. + const filterField = dateHierarchy.fields.getItem("Date Updated"); + const dateFilter = { + condition: Excel.DateFilterCondition.afterOrEqualTo, + comparator: { + date: "2020-08-01", + specificity: Excel.FilterDatetimeSpecificity.month + } + }; + filterField.applyFilter({ dateFilter: dateFilter }); + + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: day + uid: excel!Excel.FilterDatetimeSpecificity.day:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Day"' + - name: hour + uid: excel!Excel.FilterDatetimeSpecificity.hour:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Hour"' + - name: minute + uid: excel!Excel.FilterDatetimeSpecificity.minute:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Minute"' + - name: month + uid: excel!Excel.FilterDatetimeSpecificity.month:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Month"' + - name: second + uid: excel!Excel.FilterDatetimeSpecificity.second:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Second"' + - name: year + uid: excel!Excel.FilterDatetimeSpecificity.year:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Year"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.filteron.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.filteron.yml new file mode 100644 index 0000000000..c641cddce9 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.filteron.yml @@ -0,0 +1,109 @@ +### YamlMime:TSEnum +name: Excel.FilterOn +uid: excel!Excel.FilterOn:enum +package: excel! +fullName: Excel.FilterOn +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // This function adds a custom AutoFilter to the active worksheet + + // and applies the filter to a column of the used range. + + await Excel.run(async (context) => { + // Retrieve the active worksheet and the used range on that worksheet. + const sheet = context.workbook.worksheets.getActiveWorksheet(); + const farmData = sheet.getUsedRange(); + + // Add a filter that will only show the rows with values that end with the letter "e" in column 1. + sheet.autoFilter.apply(farmData, 1, { + criterion1: "=*e", + filterOn: Excel.FilterOn.custom + }); + + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: bottomItems + uid: excel!Excel.FilterOn.bottomItems:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"BottomItems"' + - name: bottomPercent + uid: excel!Excel.FilterOn.bottomPercent:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"BottomPercent"' + - name: cellColor + uid: excel!Excel.FilterOn.cellColor:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"CellColor"' + - name: custom + uid: excel!Excel.FilterOn.custom:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Custom"' + - name: dynamic + uid: excel!Excel.FilterOn.dynamic:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Dynamic"' + - name: fontColor + uid: excel!Excel.FilterOn.fontColor:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FontColor"' + - name: icon + uid: excel!Excel.FilterOn.icon:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Icon"' + - name: topItems + uid: excel!Excel.FilterOn.topItems:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"TopItems"' + - name: topPercent + uid: excel!Excel.FilterOn.topPercent:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"TopPercent"' + - name: values + uid: excel!Excel.FilterOn.values:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Values"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.filteroperator.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.filteroperator.yml new file mode 100644 index 0000000000..e228caaf22 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.filteroperator.yml @@ -0,0 +1,27 @@ +### YamlMime:TSEnum +name: Excel.FilterOperator +uid: excel!Excel.FilterOperator:enum +package: excel! +fullName: Excel.FilterOperator +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: and + uid: excel!Excel.FilterOperator.and:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"And"' + - name: or + uid: excel!Excel.FilterOperator.or:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Or"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.filterpivothierarchy.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.filterpivothierarchy.yml new file mode 100644 index 0000000000..466095f660 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.filterpivothierarchy.yml @@ -0,0 +1,279 @@ +### YamlMime:TSType +name: Excel.FilterPivotHierarchy +uid: excel!Excel.FilterPivotHierarchy:class +package: excel! +fullName: Excel.FilterPivotHierarchy +summary: Represents the Excel FilterPivotHierarchy. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.FilterPivotHierarchy#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: enableMultipleFilterItems + uid: excel!Excel.FilterPivotHierarchy#enableMultipleFilterItems:member + package: excel! + fullName: enableMultipleFilterItems + summary: Determines whether to allow multiple filter items. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'enableMultipleFilterItems: boolean;' + return: + type: boolean + - name: fields + uid: excel!Excel.FilterPivotHierarchy#fields:member + package: excel! + fullName: fields + summary: Returns the PivotFields associated with the FilterPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly fields: Excel.PivotFieldCollection;' + return: + type: + - name: id + uid: excel!Excel.FilterPivotHierarchy#id:member + package: excel! + fullName: id + summary: ID of the FilterPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly id: string;' + return: + type: string + - name: name + uid: excel!Excel.FilterPivotHierarchy#name:member + package: excel! + fullName: name + summary: Name of the FilterPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name: string;' + return: + type: string + - name: position + uid: excel!Excel.FilterPivotHierarchy#position:member + package: excel! + fullName: position + summary: Position of the FilterPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'position: number;' + return: + type: number +methods: + - name: load(options) + uid: excel!Excel.FilterPivotHierarchy#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.FilterPivotHierarchyLoadOptions): + Excel.FilterPivotHierarchy; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.FilterPivotHierarchy#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.FilterPivotHierarchy;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.FilterPivotHierarchy#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.FilterPivotHierarchy; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.FilterPivotHierarchy#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.FilterPivotHierarchyUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.FilterPivotHierarchy#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.FilterPivotHierarchy): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: setToDefault() + uid: excel!Excel.FilterPivotHierarchy#setToDefault:member(1) + package: excel! + fullName: setToDefault() + summary: Reset the FilterPivotHierarchy back to its default values. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'setToDefault(): void;' + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.FilterPivotHierarchy#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.FilterPivotHierarchy` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.FilterPivotHierarchyData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.FilterPivotHierarchyData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.filterpivothierarchycollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.filterpivothierarchycollection.yml new file mode 100644 index 0000000000..d14b20914c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.filterpivothierarchycollection.yml @@ -0,0 +1,255 @@ +### YamlMime:TSType +name: Excel.FilterPivotHierarchyCollection +uid: excel!Excel.FilterPivotHierarchyCollection:class +package: excel! +fullName: Excel.FilterPivotHierarchyCollection +summary: >- + Represents a collection of FilterPivotHierarchy items associated with the + PivotTable. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.FilterPivotHierarchyCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: excel!Excel.FilterPivotHierarchyCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.FilterPivotHierarchy[];' + return: + type: [] +methods: + - name: add(pivotHierarchy) + uid: excel!Excel.FilterPivotHierarchyCollection#add:member(1) + package: excel! + fullName: add(pivotHierarchy) + summary: >- + Adds the PivotHierarchy to the current axis. If the hierarchy is present + elsewhere on the row, column, or filter axis, it will be removed from that + location. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'add(pivotHierarchy: Excel.PivotHierarchy): Excel.FilterPivotHierarchy;' + parameters: + - id: pivotHierarchy + description: '' + type: + return: + type: + description: '' + - name: getCount() + uid: excel!Excel.FilterPivotHierarchyCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Gets the number of pivot hierarchies in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getItem(name) + uid: excel!Excel.FilterPivotHierarchyCollection#getItem:member(1) + package: excel! + fullName: getItem(name) + summary: Gets a FilterPivotHierarchy by its name or ID. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItem(name: string): Excel.FilterPivotHierarchy;' + parameters: + - id: name + description: Name of the FilterPivotHierarchy to be retrieved. + type: string + return: + type: + description: '' + - name: getItemOrNullObject(name) + uid: excel!Excel.FilterPivotHierarchyCollection#getItemOrNullObject:member(1) + package: excel! + fullName: getItemOrNullObject(name) + summary: >- + Gets a FilterPivotHierarchy by name. If the FilterPivotHierarchy does not + exist, then this method returns an object with its `isNullObject` property + set to `true`. For further information, see [*OrNullObject + methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemOrNullObject(name: string): Excel.FilterPivotHierarchy;' + parameters: + - id: name + description: Name of the FilterPivotHierarchy to be retrieved. + type: string + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.FilterPivotHierarchyCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: + Excel.Interfaces.FilterPivotHierarchyCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): + Excel.FilterPivotHierarchyCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.FilterPivotHierarchyCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNames?: string | string[]): + Excel.FilterPivotHierarchyCollection; + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.FilterPivotHierarchyCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.FilterPivotHierarchyCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: remove(filterPivotHierarchy) + uid: excel!Excel.FilterPivotHierarchyCollection#remove:member(1) + package: excel! + fullName: remove(filterPivotHierarchy) + summary: Removes the PivotHierarchy from the current axis. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'remove(filterPivotHierarchy: Excel.FilterPivotHierarchy): void;' + parameters: + - id: filterPivotHierarchy + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.FilterPivotHierarchyCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.FilterPivotHierarchyCollection` object is an API object, the + `toJSON` method returns a plain JavaScript object (typed as + `Excel.Interfaces.FilterPivotHierarchyCollectionData`) that + contains an "items" array with shallow copies of any loaded properties + from the collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.FilterPivotHierarchyCollectionData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.fivearrowsgrayset.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.fivearrowsgrayset.yml new file mode 100644 index 0000000000..338da02268 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.fivearrowsgrayset.yml @@ -0,0 +1,79 @@ +### YamlMime:TSType +name: Excel.FiveArrowsGraySet +uid: excel!Excel.FiveArrowsGraySet:interface +package: excel! +fullName: Excel.FiveArrowsGraySet +summary: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: grayDownArrow + uid: excel!Excel.FiveArrowsGraySet#grayDownArrow:member + package: excel! + fullName: grayDownArrow + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'grayDownArrow: Icon;' + return: + type: + - name: grayDownInclineArrow + uid: excel!Excel.FiveArrowsGraySet#grayDownInclineArrow:member + package: excel! + fullName: grayDownInclineArrow + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'grayDownInclineArrow: Icon;' + return: + type: + - name: graySideArrow + uid: excel!Excel.FiveArrowsGraySet#graySideArrow:member + package: excel! + fullName: graySideArrow + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'graySideArrow: Icon;' + return: + type: + - name: grayUpArrow + uid: excel!Excel.FiveArrowsGraySet#grayUpArrow:member + package: excel! + fullName: grayUpArrow + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'grayUpArrow: Icon;' + return: + type: + - name: grayUpInclineArrow + uid: excel!Excel.FiveArrowsGraySet#grayUpInclineArrow:member + package: excel! + fullName: grayUpInclineArrow + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'grayUpInclineArrow: Icon;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.fivearrowsset.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.fivearrowsset.yml new file mode 100644 index 0000000000..a78a581ce5 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.fivearrowsset.yml @@ -0,0 +1,79 @@ +### YamlMime:TSType +name: Excel.FiveArrowsSet +uid: excel!Excel.FiveArrowsSet:interface +package: excel! +fullName: Excel.FiveArrowsSet +summary: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: greenUpArrow + uid: excel!Excel.FiveArrowsSet#greenUpArrow:member + package: excel! + fullName: greenUpArrow + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'greenUpArrow: Icon;' + return: + type: + - name: redDownArrow + uid: excel!Excel.FiveArrowsSet#redDownArrow:member + package: excel! + fullName: redDownArrow + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'redDownArrow: Icon;' + return: + type: + - name: yellowDownInclineArrow + uid: excel!Excel.FiveArrowsSet#yellowDownInclineArrow:member + package: excel! + fullName: yellowDownInclineArrow + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'yellowDownInclineArrow: Icon;' + return: + type: + - name: yellowSideArrow + uid: excel!Excel.FiveArrowsSet#yellowSideArrow:member + package: excel! + fullName: yellowSideArrow + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'yellowSideArrow: Icon;' + return: + type: + - name: yellowUpInclineArrow + uid: excel!Excel.FiveArrowsSet#yellowUpInclineArrow:member + package: excel! + fullName: yellowUpInclineArrow + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'yellowUpInclineArrow: Icon;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.fiveboxesset.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.fiveboxesset.yml new file mode 100644 index 0000000000..d37682378a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.fiveboxesset.yml @@ -0,0 +1,79 @@ +### YamlMime:TSType +name: Excel.FiveBoxesSet +uid: excel!Excel.FiveBoxesSet:interface +package: excel! +fullName: Excel.FiveBoxesSet +summary: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: fourFilledBoxes + uid: excel!Excel.FiveBoxesSet#fourFilledBoxes:member + package: excel! + fullName: fourFilledBoxes + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'fourFilledBoxes: Icon;' + return: + type: + - name: noFilledBoxes + uid: excel!Excel.FiveBoxesSet#noFilledBoxes:member + package: excel! + fullName: noFilledBoxes + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'noFilledBoxes: Icon;' + return: + type: + - name: oneFilledBox + uid: excel!Excel.FiveBoxesSet#oneFilledBox:member + package: excel! + fullName: oneFilledBox + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'oneFilledBox: Icon;' + return: + type: + - name: threeFilledBoxes + uid: excel!Excel.FiveBoxesSet#threeFilledBoxes:member + package: excel! + fullName: threeFilledBoxes + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'threeFilledBoxes: Icon;' + return: + type: + - name: twoFilledBoxes + uid: excel!Excel.FiveBoxesSet#twoFilledBoxes:member + package: excel! + fullName: twoFilledBoxes + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'twoFilledBoxes: Icon;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.fivequartersset.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.fivequartersset.yml new file mode 100644 index 0000000000..353734aaec --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.fivequartersset.yml @@ -0,0 +1,79 @@ +### YamlMime:TSType +name: Excel.FiveQuartersSet +uid: excel!Excel.FiveQuartersSet:interface +package: excel! +fullName: Excel.FiveQuartersSet +summary: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: blackCircle + uid: excel!Excel.FiveQuartersSet#blackCircle:member + package: excel! + fullName: blackCircle + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'blackCircle: Icon;' + return: + type: + - name: circleWithOneWhiteQuarter + uid: excel!Excel.FiveQuartersSet#circleWithOneWhiteQuarter:member + package: excel! + fullName: circleWithOneWhiteQuarter + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'circleWithOneWhiteQuarter: Icon;' + return: + type: + - name: circleWithThreeWhiteQuarters + uid: excel!Excel.FiveQuartersSet#circleWithThreeWhiteQuarters:member + package: excel! + fullName: circleWithThreeWhiteQuarters + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'circleWithThreeWhiteQuarters: Icon;' + return: + type: + - name: circleWithTwoWhiteQuarters + uid: excel!Excel.FiveQuartersSet#circleWithTwoWhiteQuarters:member + package: excel! + fullName: circleWithTwoWhiteQuarters + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'circleWithTwoWhiteQuarters: Icon;' + return: + type: + - name: whiteCircleAllWhiteQuarters + uid: excel!Excel.FiveQuartersSet#whiteCircleAllWhiteQuarters:member + package: excel! + fullName: whiteCircleAllWhiteQuarters + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'whiteCircleAllWhiteQuarters: Icon;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.fiveratingset.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.fiveratingset.yml new file mode 100644 index 0000000000..10e9f17aab --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.fiveratingset.yml @@ -0,0 +1,79 @@ +### YamlMime:TSType +name: Excel.FiveRatingSet +uid: excel!Excel.FiveRatingSet:interface +package: excel! +fullName: Excel.FiveRatingSet +summary: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: fourBars + uid: excel!Excel.FiveRatingSet#fourBars:member + package: excel! + fullName: fourBars + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'fourBars: Icon;' + return: + type: + - name: noBars + uid: excel!Excel.FiveRatingSet#noBars:member + package: excel! + fullName: noBars + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'noBars: Icon;' + return: + type: + - name: oneBar + uid: excel!Excel.FiveRatingSet#oneBar:member + package: excel! + fullName: oneBar + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'oneBar: Icon;' + return: + type: + - name: threeBars + uid: excel!Excel.FiveRatingSet#threeBars:member + package: excel! + fullName: threeBars + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'threeBars: Icon;' + return: + type: + - name: twoBars + uid: excel!Excel.FiveRatingSet#twoBars:member + package: excel! + fullName: twoBars + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'twoBars: Icon;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.formatprotection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.formatprotection.yml new file mode 100644 index 0000000000..607a818045 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.formatprotection.yml @@ -0,0 +1,220 @@ +### YamlMime:TSType +name: Excel.FormatProtection +uid: excel!Excel.FormatProtection:class +package: excel! +fullName: Excel.FormatProtection +summary: Represents the format protection of a range object. +remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.FormatProtection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: formulaHidden + uid: excel!Excel.FormatProtection#formulaHidden:member + package: excel! + fullName: formulaHidden + summary: >- + Specifies if Excel hides the formula for the cells in the range. A `null` + value indicates that the entire range doesn't have a uniform formula + hidden setting. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulaHidden: boolean;' + return: + type: boolean + - name: locked + uid: excel!Excel.FormatProtection#locked:member + package: excel! + fullName: locked + summary: >- + Specifies if Excel locks the cells in the object. A `null` value indicates + that the entire range doesn't have a uniform lock setting. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'locked: boolean;' + return: + type: boolean +methods: + - name: load(options) + uid: excel!Excel.FormatProtection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.FormatProtectionLoadOptions): + Excel.FormatProtection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.FormatProtection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.FormatProtection;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.FormatProtection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.FormatProtection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.FormatProtection#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.FormatProtectionUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.FormatProtection#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.FormatProtection): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.FormatProtection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.FormatProtection` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.FormatProtectionData`) that + contains shallow copies of any loaded child properties from the original + object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.FormatProtectionData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.formattednumbercellvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.formattednumbercellvalue.yml new file mode 100644 index 0000000000..bb53cc7a13 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.formattednumbercellvalue.yml @@ -0,0 +1,106 @@ +### YamlMime:TSType +name: Excel.FormattedNumberCellValue +uid: excel!Excel.FormattedNumberCellValue:interface +package: excel! +fullName: Excel.FormattedNumberCellValue +summary: >- + Represents the value of a cell containing a number with a format string. + Number format strings must conform to Excel guidelines. To learn more, see + [Review guidelines for customizing a number + format](https://support.microsoft.com/office/c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5). In this scenario, the format is applied to the value and not to the cell, + so the value retains its format string throughout calculation. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: true +customDeprecatedMessage: >- + As of \[Api set: ExcelApi 1.19\], use + [DoubleCellValue](https://learn.microsoft.com/javascript/api/excel/excel.doublecellvalue) + instead. +type: interface +properties: + - name: basicType + uid: excel!Excel.FormattedNumberCellValue#basicType:member + package: excel! + fullName: basicType + summary: >- + Represents the value that would be returned by `Range.valueTypes` for a + cell with this value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: true + customDeprecatedMessage: 'Deprecated since \[Api set: ExcelApi 1.19\].' + syntax: + content: 'basicType?: RangeValueType.double | "Double";' + return: + type: | "Double" + - name: basicValue + uid: excel!Excel.FormattedNumberCellValue#basicValue:member + package: excel! + fullName: basicValue + summary: >- + Represents the value that would be returned by `Range.values` for a cell + with this value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: true + customDeprecatedMessage: 'Deprecated since \[Api set: ExcelApi 1.19\].' + syntax: + content: 'basicValue: number;' + return: + type: number + - name: numberFormat + uid: excel!Excel.FormattedNumberCellValue#numberFormat:member + package: excel! + fullName: numberFormat + summary: >- + Returns the number format string that is used to display this value. When + accessed through a `valuesAsJson` property, this number format string is + in the en-US locale. When accessed through a `valuesAsJsonLocal` property, + this number format is in the user's display locale. Number format strings + must conform to Excel guidelines. To learn more, see [Review guidelines + for customizing a number + format](https://support.microsoft.com/office/c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5). + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: true + customDeprecatedMessage: 'Deprecated since \[Api set: ExcelApi 1.19\].' + syntax: + content: 'numberFormat: string;' + return: + type: string + - name: type + uid: excel!Excel.FormattedNumberCellValue#type:member + package: excel! + fullName: type + summary: Represents the type of this cell value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: true + customDeprecatedMessage: 'Deprecated since \[Api set: ExcelApi 1.19\].' + syntax: + content: 'type: CellValueType.formattedNumber | "FormattedNumber";' + return: + type: >- + | + "FormattedNumber" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.formulachangedeventdetail.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.formulachangedeventdetail.yml new file mode 100644 index 0000000000..0b84ce8977 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.formulachangedeventdetail.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: Excel.FormulaChangedEventDetail +uid: excel!Excel.FormulaChangedEventDetail:interface +package: excel! +fullName: Excel.FormulaChangedEventDetail +summary: Provides information about a changed formula during a formula changed event. +remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: cellAddress + uid: excel!Excel.FormulaChangedEventDetail#cellAddress:member + package: excel! + fullName: cellAddress + summary: The address of the cell that contains the changed formula. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'cellAddress: string;' + return: + type: string + - name: previousFormula + uid: excel!Excel.FormulaChangedEventDetail#previousFormula:member + package: excel! + fullName: previousFormula + summary: Represents the previous formula, before it was changed. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'previousFormula: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.fourarrowsgrayset.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.fourarrowsgrayset.yml new file mode 100644 index 0000000000..4ecacde7ec --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.fourarrowsgrayset.yml @@ -0,0 +1,66 @@ +### YamlMime:TSType +name: Excel.FourArrowsGraySet +uid: excel!Excel.FourArrowsGraySet:interface +package: excel! +fullName: Excel.FourArrowsGraySet +summary: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: grayDownArrow + uid: excel!Excel.FourArrowsGraySet#grayDownArrow:member + package: excel! + fullName: grayDownArrow + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'grayDownArrow: Icon;' + return: + type: + - name: grayDownInclineArrow + uid: excel!Excel.FourArrowsGraySet#grayDownInclineArrow:member + package: excel! + fullName: grayDownInclineArrow + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'grayDownInclineArrow: Icon;' + return: + type: + - name: grayUpArrow + uid: excel!Excel.FourArrowsGraySet#grayUpArrow:member + package: excel! + fullName: grayUpArrow + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'grayUpArrow: Icon;' + return: + type: + - name: grayUpInclineArrow + uid: excel!Excel.FourArrowsGraySet#grayUpInclineArrow:member + package: excel! + fullName: grayUpInclineArrow + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'grayUpInclineArrow: Icon;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.fourarrowsset.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.fourarrowsset.yml new file mode 100644 index 0000000000..7bfad23e65 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.fourarrowsset.yml @@ -0,0 +1,66 @@ +### YamlMime:TSType +name: Excel.FourArrowsSet +uid: excel!Excel.FourArrowsSet:interface +package: excel! +fullName: Excel.FourArrowsSet +summary: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: greenUpArrow + uid: excel!Excel.FourArrowsSet#greenUpArrow:member + package: excel! + fullName: greenUpArrow + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'greenUpArrow: Icon;' + return: + type: + - name: redDownArrow + uid: excel!Excel.FourArrowsSet#redDownArrow:member + package: excel! + fullName: redDownArrow + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'redDownArrow: Icon;' + return: + type: + - name: yellowDownInclineArrow + uid: excel!Excel.FourArrowsSet#yellowDownInclineArrow:member + package: excel! + fullName: yellowDownInclineArrow + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'yellowDownInclineArrow: Icon;' + return: + type: + - name: yellowUpInclineArrow + uid: excel!Excel.FourArrowsSet#yellowUpInclineArrow:member + package: excel! + fullName: yellowUpInclineArrow + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'yellowUpInclineArrow: Icon;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.fourratingset.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.fourratingset.yml new file mode 100644 index 0000000000..14e30a190c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.fourratingset.yml @@ -0,0 +1,66 @@ +### YamlMime:TSType +name: Excel.FourRatingSet +uid: excel!Excel.FourRatingSet:interface +package: excel! +fullName: Excel.FourRatingSet +summary: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: fourBars + uid: excel!Excel.FourRatingSet#fourBars:member + package: excel! + fullName: fourBars + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'fourBars: Icon;' + return: + type: + - name: oneBar + uid: excel!Excel.FourRatingSet#oneBar:member + package: excel! + fullName: oneBar + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'oneBar: Icon;' + return: + type: + - name: threeBars + uid: excel!Excel.FourRatingSet#threeBars:member + package: excel! + fullName: threeBars + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'threeBars: Icon;' + return: + type: + - name: twoBars + uid: excel!Excel.FourRatingSet#twoBars:member + package: excel! + fullName: twoBars + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'twoBars: Icon;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.fourredtoblackset.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.fourredtoblackset.yml new file mode 100644 index 0000000000..a1bafc3c5f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.fourredtoblackset.yml @@ -0,0 +1,66 @@ +### YamlMime:TSType +name: Excel.FourRedToBlackSet +uid: excel!Excel.FourRedToBlackSet:interface +package: excel! +fullName: Excel.FourRedToBlackSet +summary: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: blackCircle + uid: excel!Excel.FourRedToBlackSet#blackCircle:member + package: excel! + fullName: blackCircle + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'blackCircle: Icon;' + return: + type: + - name: grayCircle + uid: excel!Excel.FourRedToBlackSet#grayCircle:member + package: excel! + fullName: grayCircle + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'grayCircle: Icon;' + return: + type: + - name: pinkCircle + uid: excel!Excel.FourRedToBlackSet#pinkCircle:member + package: excel! + fullName: pinkCircle + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'pinkCircle: Icon;' + return: + type: + - name: redCircle + uid: excel!Excel.FourRedToBlackSet#redCircle:member + package: excel! + fullName: redCircle + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'redCircle: Icon;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.fourtrafficlightsset.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.fourtrafficlightsset.yml new file mode 100644 index 0000000000..4726b76b2e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.fourtrafficlightsset.yml @@ -0,0 +1,66 @@ +### YamlMime:TSType +name: Excel.FourTrafficLightsSet +uid: excel!Excel.FourTrafficLightsSet:interface +package: excel! +fullName: Excel.FourTrafficLightsSet +summary: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: blackCircleWithBorder + uid: excel!Excel.FourTrafficLightsSet#blackCircleWithBorder:member + package: excel! + fullName: blackCircleWithBorder + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'blackCircleWithBorder: Icon;' + return: + type: + - name: greenCircle + uid: excel!Excel.FourTrafficLightsSet#greenCircle:member + package: excel! + fullName: greenCircle + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'greenCircle: Icon;' + return: + type: + - name: redCircleWithBorder + uid: excel!Excel.FourTrafficLightsSet#redCircleWithBorder:member + package: excel! + fullName: redCircleWithBorder + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'redCircleWithBorder: Icon;' + return: + type: + - name: yellowCircle + uid: excel!Excel.FourTrafficLightsSet#yellowCircle:member + package: excel! + fullName: yellowCircle + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'yellowCircle: Icon;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.functioncellvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.functioncellvalue.yml new file mode 100644 index 0000000000..b1f83d2ff4 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.functioncellvalue.yml @@ -0,0 +1,19 @@ +### YamlMime:TSTypeAlias +name: Excel.FunctionCellValue +uid: excel!Excel.FunctionCellValue:type +package: excel! +fullName: Excel.FunctionCellValue +summary: Represents a cell value which can be evaluated as a function. +remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.JavaScriptCustomFunctionReferenceCellValue](/javascript/api/excel/excel.javascriptcustomfunctionreferencecellvalue) + +isPreview: false +isDeprecated: false +syntax: export type FunctionCellValue = JavaScriptCustomFunctionReferenceCellValue; diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.functioncellvaluetype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.functioncellvaluetype.yml new file mode 100644 index 0000000000..5d74ee0b2e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.functioncellvaluetype.yml @@ -0,0 +1,27 @@ +### YamlMime:TSEnum +name: Excel.FunctionCellValueType +uid: excel!Excel.FunctionCellValueType:enum +package: excel! +fullName: Excel.FunctionCellValueType +summary: Represents the types of the `FunctionCellValue` object. +remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: javaScriptReference + uid: excel!Excel.FunctionCellValueType.javaScriptReference:member + package: excel! + summary: >- + Reference to a JavaScript custom function. For more information, see + [Create custom functions in + Excel](https://learn.microsoft.com/office/dev/add-ins/excel/custom-functions-overview). + + + * \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"JavaScriptReference"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.functionresult.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.functionresult.yml new file mode 100644 index 0000000000..284e8ba2e5 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.functionresult.yml @@ -0,0 +1,167 @@ +### YamlMime:TSType +name: Excel.FunctionResult +uid: excel!Excel.FunctionResult:class +package: excel! +fullName: Excel.FunctionResult +summary: An object containing the result of a function-evaluation operation +remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.FunctionResult#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: error + uid: excel!Excel.FunctionResult#error:member + package: excel! + fullName: error + summary: >- + Error value (such as "\#DIV/0") representing the error. If the error + string is not set, then the function succeeded, and its result is written + to the Value field. The error is always in the English locale. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly error: string;' + return: + type: string + - name: value + uid: excel!Excel.FunctionResult#value:member + package: excel! + fullName: value + summary: >- + The value of function evaluation. The value field will be populated only + if no error has occurred (i.e., the Error property is not set). + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly value: T;' + return: + type: T +methods: + - name: load(options) + uid: excel!Excel.FunctionResult#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.FunctionResultLoadOptions): + FunctionResult; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: <T> + description: '' + - name: load(propertyNames) + uid: excel!Excel.FunctionResult#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): FunctionResult;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: <T> + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.FunctionResult#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): FunctionResult; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: <T> + description: '' + - name: toJSON() + uid: excel!Excel.FunctionResult#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `FunctionResult` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Interfaces.FunctionResultData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Interfaces.FunctionResultData;' + return: + type: >- + <T> + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.functions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.functions.yml new file mode 100644 index 0000000000..8027793fe6 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.functions.yml @@ -0,0 +1,13882 @@ +### YamlMime:TSType +name: Excel.Functions +uid: excel!Excel.Functions:class +package: excel! +fullName: Excel.Functions +summary: An object for evaluating Excel functions. +remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-built-in-functions.yaml + + + await Excel.run(async (context) => { + // This function uses VLOOKUP to find data in the "Wrench" row on the worksheet. + let range = context.workbook.worksheets.getItem("Sample").getRange("A1:D4"); + + // Get the value in the second column in the "Wrench" row. + let unitSoldInNov = context.workbook.functions.vlookup("Wrench", range, 2, false); + unitSoldInNov.load("value"); + + await context.sync(); + console.log(" Number of wrenches sold in November = " + unitSoldInNov.value); + }); + + ``` + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.Functions#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: +methods: + - name: abs(number) + uid: excel!Excel.Functions#abs:member(1) + package: excel! + fullName: abs(number) + summary: Returns the absolute value of a number, a number without its sign. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + abs(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: Is the real number for which you want the absolute value. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: >- + accrInt(issue, firstInterest, settlement, rate, par, frequency, basis, + calcMethod) + uid: excel!Excel.Functions#accrInt:member(1) + package: excel! + fullName: >- + accrInt(issue, firstInterest, settlement, rate, par, frequency, basis, + calcMethod) + summary: Returns the accrued interest for a security that pays periodic interest. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + accrInt(issue: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, firstInterest: number + | string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, settlement: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, rate: + number | string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, par: number | string | boolean | Excel.Range + | Excel.RangeReference | Excel.FunctionResult, frequency: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, basis?: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, + calcMethod?: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: issue + description: Is the security's issue date, expressed as a serial date number. + type: >- + number | string | boolean | | + | <any> + - id: firstInterest + description: >- + Is the security's first interest date, expressed as a serial date + number. + type: >- + number | string | boolean | | + | <any> + - id: settlement + description: >- + Is the security's settlement date, expressed as a serial date + number. + type: >- + number | string | boolean | | + | <any> + - id: rate + description: Is the security's annual coupon rate. + type: >- + number | string | boolean | | + | <any> + - id: par + description: Is the security's par value. + type: >- + number | string | boolean | | + | <any> + - id: frequency + description: Is the number of coupon payments per year. + type: >- + number | string | boolean | | + | <any> + - id: basis + description: Is the type of day count basis to use. + type: >- + number | string | boolean | | + | <any> + - id: calcMethod + description: >- + Is a logical value: to accrued interest from issue date = TRUE or + omitted; to calculate from last coupon payment date = FALSE. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: accrIntM(issue, settlement, rate, par, basis) + uid: excel!Excel.Functions#accrIntM:member(1) + package: excel! + fullName: accrIntM(issue, settlement, rate, par, basis) + summary: >- + Returns the accrued interest for a security that pays interest at + maturity. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + accrIntM(issue: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, settlement: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, rate: number | string | boolean | Excel.Range + | Excel.RangeReference | Excel.FunctionResult, par: number | string + | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, basis?: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: issue + description: Is the security's issue date, expressed as a serial date number. + type: >- + number | string | boolean | | + | <any> + - id: settlement + description: Is the security's maturity date, expressed as a serial date number. + type: >- + number | string | boolean | | + | <any> + - id: rate + description: Is the security's annual coupon rate. + type: >- + number | string | boolean | | + | <any> + - id: par + description: Is the security's par value. + type: >- + number | string | boolean | | + | <any> + - id: basis + description: Is the type of day count basis to use. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: acos(number) + uid: excel!Excel.Functions#acos:member(1) + package: excel! + fullName: acos(number) + summary: >- + Returns the arccosine of a number, in radians in the range 0 to Pi. The + arccosine is the angle whose cosine is Number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + acos(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: Is the cosine of the angle you want and must be from -1 to 1. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: acosh(number) + uid: excel!Excel.Functions#acosh:member(1) + package: excel! + fullName: acosh(number) + summary: Returns the inverse hyperbolic cosine of a number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + acosh(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: Is any real number equal to or greater than 1. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: acot(number) + uid: excel!Excel.Functions#acot:member(1) + package: excel! + fullName: acot(number) + summary: Returns the arccotangent of a number, in radians in the range 0 to Pi. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + acot(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: Is the cotangent of the angle you want. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: acoth(number) + uid: excel!Excel.Functions#acoth:member(1) + package: excel! + fullName: acoth(number) + summary: Returns the inverse hyperbolic cotangent of a number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + acoth(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: Is the hyperbolic cotangent of the angle that you want. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: amorDegrc(cost, datePurchased, firstPeriod, salvage, period, rate, basis) + uid: excel!Excel.Functions#amorDegrc:member(1) + package: excel! + fullName: amorDegrc(cost, datePurchased, firstPeriod, salvage, period, rate, basis) + summary: >- + Returns the prorated linear depreciation of an asset for each accounting + period. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + amorDegrc(cost: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, datePurchased: number + | string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, firstPeriod: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, salvage: + number | string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, period: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, rate: + number | string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, basis?: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: cost + description: Is the cost of the asset. + type: >- + number | string | boolean | | + | <any> + - id: datePurchased + description: Is the date the asset is purchased. + type: >- + number | string | boolean | | + | <any> + - id: firstPeriod + description: Is the date of the end of the first period. + type: >- + number | string | boolean | | + | <any> + - id: salvage + description: Is the salvage value at the end of life of the asset. + type: >- + number | string | boolean | | + | <any> + - id: period + description: Is the period. + type: >- + number | string | boolean | | + | <any> + - id: rate + description: Is the rate of depreciation. + type: >- + number | string | boolean | | + | <any> + - id: basis + description: >- + Year\_basis : 0 for year of 360 days, 1 for actual, 3 for year of + 365 days. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: amorLinc(cost, datePurchased, firstPeriod, salvage, period, rate, basis) + uid: excel!Excel.Functions#amorLinc:member(1) + package: excel! + fullName: amorLinc(cost, datePurchased, firstPeriod, salvage, period, rate, basis) + summary: >- + Returns the prorated linear depreciation of an asset for each accounting + period. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + amorLinc(cost: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, datePurchased: number + | string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, firstPeriod: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, salvage: + number | string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, period: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, rate: + number | string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, basis?: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: cost + description: Is the cost of the asset. + type: >- + number | string | boolean | | + | <any> + - id: datePurchased + description: Is the date the asset is purchased. + type: >- + number | string | boolean | | + | <any> + - id: firstPeriod + description: Is the date of the end of the first period. + type: >- + number | string | boolean | | + | <any> + - id: salvage + description: Is the salvage value at the end of life of the asset. + type: >- + number | string | boolean | | + | <any> + - id: period + description: Is the period. + type: >- + number | string | boolean | | + | <any> + - id: rate + description: Is the rate of depreciation. + type: >- + number | string | boolean | | + | <any> + - id: basis + description: >- + Year\_basis : 0 for year of 360 days, 1 for actual, 3 for year of + 365 days. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: and(values) + uid: excel!Excel.Functions#and:member(1) + package: excel! + fullName: and(values) + summary: >- + Checks whether all arguments are TRUE, and returns TRUE if all arguments + are TRUE. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + and(...values: Array>): FunctionResult; + parameters: + - id: values + description: >- + List of parameters, whose elements are 1 to 255 conditions you want + to test that can be either TRUE or FALSE and can be logical values, + arrays, or references. + type: >- + Array<boolean | | | <any>> + return: + type: <boolean> + description: '' + - name: arabic(text) + uid: excel!Excel.Functions#arabic:member(1) + package: excel! + fullName: arabic(text) + summary: Converts a Roman numeral to Arabic. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + arabic(text: string | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: text + description: Is the Roman numeral you want to convert. + type: >- + string | | | <any> + return: + type: <number> + description: '' + - name: areas(reference) + uid: excel!Excel.Functions#areas:member(1) + package: excel! + fullName: areas(reference) + summary: >- + Returns the number of areas in a reference. An area is a range of + contiguous cells or a single cell. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + areas(reference: Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: reference + description: >- + Is a reference to a cell or range of cells and can refer to multiple + areas. + type: >- + | | <any> + return: + type: <number> + description: '' + - name: asc(text) + uid: excel!Excel.Functions#asc:member(1) + package: excel! + fullName: asc(text) + summary: >- + Changes full-width (double-byte) characters to half-width (single-byte) + characters. Use with double-byte character sets (DBCS). + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + asc(text: string | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: text + description: Is a text, or a reference to a cell containing a text. + type: >- + string | | | <any> + return: + type: <string> + description: '' + - name: asin(number) + uid: excel!Excel.Functions#asin:member(1) + package: excel! + fullName: asin(number) + summary: Returns the arcsine of a number in radians, in the range -Pi/2 to Pi/2. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + asin(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: Is the sine of the angle you want and must be from -1 to 1. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: asinh(number) + uid: excel!Excel.Functions#asinh:member(1) + package: excel! + fullName: asinh(number) + summary: Returns the inverse hyperbolic sine of a number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + asinh(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: Is any real number equal to or greater than 1. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: atan(number) + uid: excel!Excel.Functions#atan:member(1) + package: excel! + fullName: atan(number) + summary: Returns the arctangent of a number in radians, in the range -Pi/2 to Pi/2. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + atan(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: Is the tangent of the angle you want. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: atan2(xNum, yNum) + uid: excel!Excel.Functions#atan2:member(1) + package: excel! + fullName: atan2(xNum, yNum) + summary: >- + Returns the arctangent of the specified x- and y- coordinates, in radians + between -Pi and Pi, excluding -Pi. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + atan2(xNum: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, yNum: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: xNum + description: Is the x-coordinate of the point. + type: >- + number | | | <any> + - id: yNum + description: Is the y-coordinate of the point. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: atanh(number) + uid: excel!Excel.Functions#atanh:member(1) + package: excel! + fullName: atanh(number) + summary: Returns the inverse hyperbolic tangent of a number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + atanh(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: Is any real number between -1 and 1 excluding -1 and 1. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: aveDev(values) + uid: excel!Excel.Functions#aveDev:member(1) + package: excel! + fullName: aveDev(values) + summary: >- + Returns the average of the absolute deviations of data points from their + mean. Arguments can be numbers or names, arrays, or references that + contain numbers. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + aveDev(...values: Array>): FunctionResult; + parameters: + - id: values + description: >- + List of parameters, whose elements are 1 to 255 arguments for which + you want the average of the absolute deviations. + type: >- + Array<number | | | <any>> + return: + type: <number> + description: '' + - name: average(values) + uid: excel!Excel.Functions#average:member(1) + package: excel! + fullName: average(values) + summary: >- + Returns the average (arithmetic mean) of its arguments, which can be + numbers or names, arrays, or references that contain numbers. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + average(...values: Array>): FunctionResult; + parameters: + - id: values + description: >- + List of parameters, whose elements are 1 to 255 numeric arguments + for which you want the average. + type: >- + Array<number | | | <any>> + return: + type: <number> + description: '' + - name: averageA(values) + uid: excel!Excel.Functions#averageA:member(1) + package: excel! + fullName: averageA(values) + summary: >- + Returns the average (arithmetic mean) of its arguments, evaluating text + and FALSE in arguments as 0; TRUE evaluates as 1. Arguments can be + numbers, names, arrays, or references. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + averageA(...values: Array>): FunctionResult; + parameters: + - id: values + description: >- + List of parameters, whose elements are 1 to 255 arguments for which + you want the average. + type: >- + Array<number | | | <any>> + return: + type: <number> + description: '' + - name: averageIf(range, criteria, averageRange) + uid: excel!Excel.Functions#averageIf:member(1) + package: excel! + fullName: averageIf(range, criteria, averageRange) + summary: >- + Finds average(arithmetic mean) for the cells specified by a given + condition or criteria. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + averageIf(range: Excel.Range | Excel.RangeReference | + Excel.FunctionResult, criteria: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, + averageRange?: Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: range + description: Is the range of cells you want evaluated. + type: >- + | | <any> + - id: criteria + description: >- + Is the condition or criteria in the form of a number, expression, or + text that defines which cells will be used to find the average. + type: >- + number | string | boolean | | + | <any> + - id: averageRange + description: >- + Are the actual cells to be used to find the average. If omitted, the + cells in range are used. + type: >- + | | <any> + return: + type: <number> + description: '' + - name: averageIfs(averageRange, values) + uid: excel!Excel.Functions#averageIfs:member(1) + package: excel! + fullName: averageIfs(averageRange, values) + summary: >- + Finds average(arithmetic mean) for the cells specified by a given set of + conditions or criteria. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + averageIfs(averageRange: Excel.Range | Excel.RangeReference | + Excel.FunctionResult, ...values: Array | number | string | + boolean>): FunctionResult; + parameters: + - id: averageRange + description: Are the actual cells to be used to find the average. + type: >- + | | <any> + - id: values + description: >- + List of parameters, where the first element of each pair is the Is + the range of cells you want evaluated for the particular condition , + and the second element is is the condition or criteria in the form + of a number, expression, or text that defines which cells will be + used to find the average. + type: >- + Array< | | <any> | number | + string | boolean> + return: + type: <number> + description: '' + - name: bahtText(number) + uid: excel!Excel.Functions#bahtText:member(1) + package: excel! + fullName: bahtText(number) + summary: Converts a number to text (baht). + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + bahtText(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: Is a number that you want to convert. + type: >- + number | | | <any> + return: + type: <string> + description: '' + - name: base(number, radix, minLength) + uid: excel!Excel.Functions#base:member(1) + package: excel! + fullName: base(number, radix, minLength) + summary: Converts a number into a text representation with the given radix (base). + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + base(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, radix: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, minLength?: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: number + description: Is the number that you want to convert. + type: >- + number | | | <any> + - id: radix + description: Is the base Radix that you want to convert the number into. + type: >- + number | | | <any> + - id: minLength + description: >- + Is the minimum length of the returned string. If omitted leading + zeros are not added. + type: >- + number | | | <any> + return: + type: <string> + description: '' + - name: besselI(x, n) + uid: excel!Excel.Functions#besselI:member(1) + package: excel! + fullName: besselI(x, n) + summary: Returns the modified Bessel function In(x). + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + besselI(x: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, n: number | string | + boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: x + description: Is the value at which to evaluate the function. + type: >- + number | string | boolean | | + | <any> + - id: 'n' + description: Is the order of the Bessel function. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: besselJ(x, n) + uid: excel!Excel.Functions#besselJ:member(1) + package: excel! + fullName: besselJ(x, n) + summary: Returns the Bessel function Jn(x). + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + besselJ(x: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, n: number | string | + boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: x + description: Is the value at which to evaluate the function. + type: >- + number | string | boolean | | + | <any> + - id: 'n' + description: Is the order of the Bessel function. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: besselK(x, n) + uid: excel!Excel.Functions#besselK:member(1) + package: excel! + fullName: besselK(x, n) + summary: Returns the modified Bessel function Kn(x). + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + besselK(x: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, n: number | string | + boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: x + description: Is the value at which to evaluate the function. + type: >- + number | string | boolean | | + | <any> + - id: 'n' + description: Is the order of the function. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: besselY(x, n) + uid: excel!Excel.Functions#besselY:member(1) + package: excel! + fullName: besselY(x, n) + summary: Returns the Bessel function Yn(x). + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + besselY(x: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, n: number | string | + boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: x + description: Is the value at which to evaluate the function. + type: >- + number | string | boolean | | + | <any> + - id: 'n' + description: Is the order of the function. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: beta_Dist(x, alpha, beta, cumulative, A, B) + uid: excel!Excel.Functions#beta_Dist:member(1) + package: excel! + fullName: beta_Dist(x, alpha, beta, cumulative, A, B) + summary: Returns the beta probability distribution function. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + beta_Dist(x: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, alpha: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, beta: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, + cumulative: boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, A?: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, B?: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: x + description: Is the value between A and B at which to evaluate the function. + type: >- + number | | | <any> + - id: alpha + description: Is a parameter to the distribution and must be greater than 0. + type: >- + number | | | <any> + - id: beta + description: Is a parameter to the distribution and must be greater than 0. + type: >- + number | | | <any> + - id: cumulative + description: >- + Is a logical value: for the cumulative distribution function, use + TRUE; for the probability density function, use FALSE. + type: >- + boolean | | | <any> + - id: A + description: Is an optional lower bound to the interval of x. If omitted, A = 0. + type: >- + number | | | <any> + - id: B + description: Is an optional upper bound to the interval of x. If omitted, B = 1. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: beta_Inv(probability, alpha, beta, A, B) + uid: excel!Excel.Functions#beta_Inv:member(1) + package: excel! + fullName: beta_Inv(probability, alpha, beta, A, B) + summary: >- + Returns the inverse of the cumulative beta probability density function + (BETA.DIST). + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + beta_Inv(probability: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, alpha: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, beta: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, A?: + number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, + B?: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: probability + description: Is a probability associated with the beta distribution. + type: >- + number | | | <any> + - id: alpha + description: Is a parameter to the distribution and must be greater than 0. + type: >- + number | | | <any> + - id: beta + description: Is a parameter to the distribution and must be greater than 0. + type: >- + number | | | <any> + - id: A + description: Is an optional lower bound to the interval of x. If omitted, A = 0. + type: >- + number | | | <any> + - id: B + description: Is an optional upper bound to the interval of x. If omitted, B = 1. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: bin2Dec(number) + uid: excel!Excel.Functions#bin2Dec:member(1) + package: excel! + fullName: bin2Dec(number) + summary: Converts a binary number to decimal. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + bin2Dec(number: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: number + description: Is the binary number you want to convert. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: bin2Hex(number, places) + uid: excel!Excel.Functions#bin2Hex:member(1) + package: excel! + fullName: bin2Hex(number, places) + summary: Converts a binary number to hexadecimal. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + bin2Hex(number: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, places?: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: Is the binary number you want to convert. + type: >- + number | string | boolean | | + | <any> + - id: places + description: Is the number of characters to use. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: bin2Oct(number, places) + uid: excel!Excel.Functions#bin2Oct:member(1) + package: excel! + fullName: bin2Oct(number, places) + summary: Converts a binary number to octal. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + bin2Oct(number: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, places?: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: Is the binary number you want to convert. + type: >- + number | string | boolean | | + | <any> + - id: places + description: Is the number of characters to use. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: binom_Dist_Range(trials, probabilityS, numberS, numberS2) + uid: excel!Excel.Functions#binom_Dist_Range:member(1) + package: excel! + fullName: binom_Dist_Range(trials, probabilityS, numberS, numberS2) + summary: Returns the probability of a trial result using a binomial distribution. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + binom_Dist_Range(trials: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, probabilityS: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, numberS: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, + numberS2?: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: trials + description: Is the number of independent trials. + type: >- + number | | | <any> + - id: probabilityS + description: Is the probability of success on each trial. + type: >- + number | | | <any> + - id: numberS + description: Is the number of successes in trials. + type: >- + number | | | <any> + - id: numberS2 + description: >- + If provided this function returns the probability that the number of + successful trials shall lie between numberS and numberS2. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: binom_Dist(numberS, trials, probabilityS, cumulative) + uid: excel!Excel.Functions#binom_Dist:member(1) + package: excel! + fullName: binom_Dist(numberS, trials, probabilityS, cumulative) + summary: Returns the individual term binomial distribution probability. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + binom_Dist(numberS: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, trials: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, probabilityS: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, + cumulative: boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: numberS + description: Is the number of successes in trials. + type: >- + number | | | <any> + - id: trials + description: Is the number of independent trials. + type: >- + number | | | <any> + - id: probabilityS + description: Is the probability of success on each trial. + type: >- + number | | | <any> + - id: cumulative + description: >- + Is a logical value: for the cumulative distribution function, use + TRUE; for the probability mass function, use FALSE. + type: >- + boolean | | | <any> + return: + type: <number> + description: '' + - name: binom_Inv(trials, probabilityS, alpha) + uid: excel!Excel.Functions#binom_Inv:member(1) + package: excel! + fullName: binom_Inv(trials, probabilityS, alpha) + summary: >- + Returns the smallest value for which the cumulative binomial distribution + is greater than or equal to a criterion value. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + binom_Inv(trials: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, probabilityS: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, alpha: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: trials + description: Is the number of Bernoulli trials. + type: >- + number | | | <any> + - id: probabilityS + description: >- + Is the probability of success on each trial, a number between 0 and + 1 inclusive. + type: >- + number | | | <any> + - id: alpha + description: Is the criterion value, a number between 0 and 1 inclusive. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: bitand(number1, number2) + uid: excel!Excel.Functions#bitand:member(1) + package: excel! + fullName: bitand(number1, number2) + summary: Returns a bitwise 'And' of two numbers. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + bitand(number1: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, number2: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: number1 + description: >- + Is the decimal representation of the binary number you want to + evaluate. + type: >- + number | | | <any> + - id: number2 + description: >- + Is the decimal representation of the binary number you want to + evaluate. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: bitlshift(number, shiftAmount) + uid: excel!Excel.Functions#bitlshift:member(1) + package: excel! + fullName: bitlshift(number, shiftAmount) + summary: Returns a number shifted left by shift\_amount bits. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + bitlshift(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, shiftAmount: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: number + description: >- + Is the decimal representation of the binary number you want to + evaluate. + type: >- + number | | | <any> + - id: shiftAmount + description: Is the number of bits that you want to shift Number left by. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: bitor(number1, number2) + uid: excel!Excel.Functions#bitor:member(1) + package: excel! + fullName: bitor(number1, number2) + summary: Returns a bitwise 'Or' of two numbers. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + bitor(number1: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, number2: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: number1 + description: >- + Is the decimal representation of the binary number you want to + evaluate. + type: >- + number | | | <any> + - id: number2 + description: >- + Is the decimal representation of the binary number you want to + evaluate. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: bitrshift(number, shiftAmount) + uid: excel!Excel.Functions#bitrshift:member(1) + package: excel! + fullName: bitrshift(number, shiftAmount) + summary: Returns a number shifted right by shift\_amount bits. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + bitrshift(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, shiftAmount: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: number + description: >- + Is the decimal representation of the binary number you want to + evaluate. + type: >- + number | | | <any> + - id: shiftAmount + description: Is the number of bits that you want to shift Number right by. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: bitxor(number1, number2) + uid: excel!Excel.Functions#bitxor:member(1) + package: excel! + fullName: bitxor(number1, number2) + summary: Returns a bitwise 'Exclusive Or' of two numbers. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + bitxor(number1: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, number2: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: number1 + description: >- + Is the decimal representation of the binary number you want to + evaluate. + type: >- + number | | | <any> + - id: number2 + description: >- + Is the decimal representation of the binary number you want to + evaluate. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: ceiling_Math(number, significance, mode) + uid: excel!Excel.Functions#ceiling_Math:member(1) + package: excel! + fullName: ceiling_Math(number, significance, mode) + summary: >- + Rounds a number up, to the nearest integer or to the nearest multiple of + significance. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + ceiling_Math(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, significance?: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, mode?: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: number + description: Is the value you want to round. + type: >- + number | | | <any> + - id: significance + description: Is the multiple to which you want to round. + type: >- + number | | | <any> + - id: mode + description: When given and nonzero this function will round away from zero. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: ceiling_Precise(number, significance) + uid: excel!Excel.Functions#ceiling_Precise:member(1) + package: excel! + fullName: ceiling_Precise(number, significance) + summary: >- + Rounds a number up, to the nearest integer or to the nearest multiple of + significance. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + ceiling_Precise(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, significance?: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: number + description: Is the value you want to round. + type: >- + number | | | <any> + - id: significance + description: Is the multiple to which you want to round. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: char(number) + uid: excel!Excel.Functions#char:member(1) + package: excel! + fullName: char(number) + summary: >- + Returns the character specified by the code number from the character set + for your computer. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + char(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: Is a number between 1 and 255 specifying which character you want. + type: >- + number | | | <any> + return: + type: <string> + description: '' + - name: chiSq_Dist_RT(x, degFreedom) + uid: excel!Excel.Functions#chiSq_Dist_RT:member(1) + package: excel! + fullName: chiSq_Dist_RT(x, degFreedom) + summary: Returns the right-tailed probability of the chi-squared distribution. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + chiSq_Dist_RT(x: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, degFreedom: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: x + description: >- + Is the value at which you want to evaluate the distribution, a + nonnegative number. + type: >- + number | | | <any> + - id: degFreedom + description: >- + Is the number of degrees of freedom, a number between 1 and 10^10, + excluding 10^10. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: chiSq_Dist(x, degFreedom, cumulative) + uid: excel!Excel.Functions#chiSq_Dist:member(1) + package: excel! + fullName: chiSq_Dist(x, degFreedom, cumulative) + summary: Returns the left-tailed probability of the chi-squared distribution. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + chiSq_Dist(x: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, degFreedom: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, cumulative: boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: x + description: >- + Is the value at which you want to evaluate the distribution, a + nonnegative number. + type: >- + number | | | <any> + - id: degFreedom + description: >- + Is the number of degrees of freedom, a number between 1 and 10^10, + excluding 10^10. + type: >- + number | | | <any> + - id: cumulative + description: >- + Is a logical value for the function to return: the cumulative + distribution function = TRUE; the probability density function = + FALSE. + type: >- + boolean | | | <any> + return: + type: <number> + description: '' + - name: chiSq_Inv_RT(probability, degFreedom) + uid: excel!Excel.Functions#chiSq_Inv_RT:member(1) + package: excel! + fullName: chiSq_Inv_RT(probability, degFreedom) + summary: >- + Returns the inverse of the right-tailed probability of the chi-squared + distribution. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + chiSq_Inv_RT(probability: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, degFreedom: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: probability + description: >- + Is a probability associated with the chi-squared distribution, a + value between 0 and 1 inclusive. + type: >- + number | | | <any> + - id: degFreedom + description: >- + Is the number of degrees of freedom, a number between 1 and 10^10, + excluding 10^10. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: chiSq_Inv(probability, degFreedom) + uid: excel!Excel.Functions#chiSq_Inv:member(1) + package: excel! + fullName: chiSq_Inv(probability, degFreedom) + summary: >- + Returns the inverse of the left-tailed probability of the chi-squared + distribution. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + chiSq_Inv(probability: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, degFreedom: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: probability + description: >- + Is a probability associated with the chi-squared distribution, a + value between 0 and 1 inclusive. + type: >- + number | | | <any> + - id: degFreedom + description: >- + Is the number of degrees of freedom, a number between 1 and 10^10, + excluding 10^10. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: choose(indexNum, values) + uid: excel!Excel.Functions#choose:member(1) + package: excel! + fullName: choose(indexNum, values) + summary: >- + Chooses a value or action to perform from a list of values, based on an + index number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + choose(indexNum: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, ...values: Array>): + FunctionResult; + parameters: + - id: indexNum + description: >- + Specifies which value argument is selected. indexNum must be between + 1 and 254, or a formula or a reference to a number between 1 and + 254. + type: >- + number | | | <any> + - id: values + description: >- + List of parameters, whose elements are 1 to 254 numbers, cell + references, defined names, formulas, functions, or text arguments + from which CHOOSE selects. + type: >- + Array< | number | string | + boolean | | + <any>> + return: + type: >- + <number | string | + boolean> + description: '' + - name: clean(text) + uid: excel!Excel.Functions#clean:member(1) + package: excel! + fullName: clean(text) + summary: Removes all nonprintable characters from text. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + clean(text: string | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: text + description: >- + Is any worksheet information from which you want to remove + nonprintable characters. + type: >- + string | | | <any> + return: + type: <string> + description: '' + - name: code(text) + uid: excel!Excel.Functions#code:member(1) + package: excel! + fullName: code(text) + summary: >- + Returns a numeric code for the first character in a text string, in the + character set used by your computer. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + code(text: string | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: text + description: Is the text for which you want the code of the first character. + type: >- + string | | | <any> + return: + type: <number> + description: '' + - name: columns(array) + uid: excel!Excel.Functions#columns:member(1) + package: excel! + fullName: columns(array) + summary: Returns the number of columns in an array or reference. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + columns(array: Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: array + description: >- + Is an array or array formula, or a reference to a range of cells for + which you want the number of columns. + type: >- + | | <any> + return: + type: <number> + description: '' + - name: combin(number, numberChosen) + uid: excel!Excel.Functions#combin:member(1) + package: excel! + fullName: combin(number, numberChosen) + summary: Returns the number of combinations for a given number of items. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + combin(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, numberChosen: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: number + description: Is the total number of items. + type: >- + number | | | <any> + - id: numberChosen + description: Is the number of items in each combination. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: combina(number, numberChosen) + uid: excel!Excel.Functions#combina:member(1) + package: excel! + fullName: combina(number, numberChosen) + summary: >- + Returns the number of combinations with repetitions for a given number of + items. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + combina(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, numberChosen: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: number + description: Is the total number of items. + type: >- + number | | | <any> + - id: numberChosen + description: Is the number of items in each combination. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: complex(realNum, iNum, suffix) + uid: excel!Excel.Functions#complex:member(1) + package: excel! + fullName: complex(realNum, iNum, suffix) + summary: Converts real and imaginary coefficients into a complex number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + complex(realNum: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, iNum: number | string + | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, suffix?: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: realNum + description: Is the real coefficient of the complex number. + type: >- + number | string | boolean | | + | <any> + - id: iNum + description: Is the imaginary coefficient of the complex number. + type: >- + number | string | boolean | | + | <any> + - id: suffix + description: Is the suffix for the imaginary component of the complex number. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: concatenate(values) + uid: excel!Excel.Functions#concatenate:member(1) + package: excel! + fullName: concatenate(values) + summary: Joins several text strings into one text string. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + concatenate(...values: Array>): FunctionResult; + parameters: + - id: values + description: >- + List of parameters, whose elements are 1 to 255 text strings to be + joined into a single text string and can be text strings, numbers, + or single-cell references. + type: >- + Array<string | | | <any>> + return: + type: <string> + description: '' + - name: confidence_Norm(alpha, standardDev, size) + uid: excel!Excel.Functions#confidence_Norm:member(1) + package: excel! + fullName: confidence_Norm(alpha, standardDev, size) + summary: >- + Returns the confidence interval for a population mean, using a normal + distribution. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + confidence_Norm(alpha: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, standardDev: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, size: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: alpha + description: >- + Is the significance level used to compute the confidence level, a + number greater than 0 and less than 1. + type: >- + number | | | <any> + - id: standardDev + description: >- + Is the population standard deviation for the data range and is + assumed to be known. standardDev must be greater than 0. + type: >- + number | | | <any> + - id: size + description: Is the sample size. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: confidence_T(alpha, standardDev, size) + uid: excel!Excel.Functions#confidence_T:member(1) + package: excel! + fullName: confidence_T(alpha, standardDev, size) + summary: >- + Returns the confidence interval for a population mean, using a Student's T + distribution. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + confidence_T(alpha: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, standardDev: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, size: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: alpha + description: >- + Is the significance level used to compute the confidence level, a + number greater than 0 and less than 1. + type: >- + number | | | <any> + - id: standardDev + description: >- + Is the population standard deviation for the data range and is + assumed to be known. standardDev must be greater than 0. + type: >- + number | | | <any> + - id: size + description: Is the sample size. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: convert(number, fromUnit, toUnit) + uid: excel!Excel.Functions#convert:member(1) + package: excel! + fullName: convert(number, fromUnit, toUnit) + summary: Converts a number from one measurement system to another. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + convert(number: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, fromUnit: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, toUnit: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: number + description: Is the value in from\_units to convert. + type: >- + number | string | boolean | | + | <any> + - id: fromUnit + description: Is the units for number. + type: >- + number | string | boolean | | + | <any> + - id: toUnit + description: Is the units for the result. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: cos(number) + uid: excel!Excel.Functions#cos:member(1) + package: excel! + fullName: cos(number) + summary: Returns the cosine of an angle. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + cos(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: Is the angle in radians for which you want the cosine. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: cosh(number) + uid: excel!Excel.Functions#cosh:member(1) + package: excel! + fullName: cosh(number) + summary: Returns the hyperbolic cosine of a number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + cosh(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: Is any real number. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: cot(number) + uid: excel!Excel.Functions#cot:member(1) + package: excel! + fullName: cot(number) + summary: Returns the cotangent of an angle. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + cot(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: Is the angle in radians for which you want the cotangent. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: coth(number) + uid: excel!Excel.Functions#coth:member(1) + package: excel! + fullName: coth(number) + summary: Returns the hyperbolic cotangent of a number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + coth(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: Is the angle in radians for which you want the hyperbolic cotangent. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: count(values) + uid: excel!Excel.Functions#count:member(1) + package: excel! + fullName: count(values) + summary: Counts the number of cells in a range that contain numbers. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + count(...values: Array>): FunctionResult; + parameters: + - id: values + description: >- + List of parameters, whose elements are 1 to 255 arguments that can + contain or refer to a variety of different types of data, but only + numbers are counted. + type: >- + Array<number | | | <any>> + return: + type: <number> + description: '' + - name: countA(values) + uid: excel!Excel.Functions#countA:member(1) + package: excel! + fullName: countA(values) + summary: Counts the number of cells in a range that are not empty. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + countA(...values: Array>): FunctionResult; + parameters: + - id: values + description: >- + List of parameters, whose elements are 1 to 255 arguments + representing the values and cells you want to count. Values can be + any type of information. + type: >- + Array<number | | | <any>> + return: + type: <number> + description: '' + - name: countBlank(range) + uid: excel!Excel.Functions#countBlank:member(1) + package: excel! + fullName: countBlank(range) + summary: Counts the number of empty cells in a specified range of cells. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + countBlank(range: Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: range + description: Is the range from which you want to count the empty cells. + type: >- + | | <any> + return: + type: <number> + description: '' + - name: countIf(range, criteria) + uid: excel!Excel.Functions#countIf:member(1) + package: excel! + fullName: countIf(range, criteria) + summary: Counts the number of cells within a range that meet the given condition. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + countIf(range: Excel.Range | Excel.RangeReference | + Excel.FunctionResult, criteria: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: range + description: Is the range of cells from which you want to count nonblank cells. + type: >- + | | <any> + - id: criteria + description: >- + Is the condition in the form of a number, expression, or text that + defines which cells will be counted. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: countIfs(values) + uid: excel!Excel.Functions#countIfs:member(1) + package: excel! + fullName: countIfs(values) + summary: >- + Counts the number of cells specified by a given set of conditions or + criteria. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + countIfs(...values: Array | number | string | boolean>): + FunctionResult; + parameters: + - id: values + description: >- + List of parameters, where the first element of each pair is the Is + the range of cells you want evaluated for the particular condition , + and the second element is is the condition in the form of a number, + expression, or text that defines which cells will be counted. + type: >- + Array< | | <any> | number | + string | boolean> + return: + type: <number> + description: '' + - name: coupDayBs(settlement, maturity, frequency, basis) + uid: excel!Excel.Functions#coupDayBs:member(1) + package: excel! + fullName: coupDayBs(settlement, maturity, frequency, basis) + summary: >- + Returns the number of days from the beginning of the coupon period to the + settlement date. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + coupDayBs(settlement: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, maturity: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, frequency: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, basis?: + number | string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: settlement + description: >- + Is the security's settlement date, expressed as a serial date + number. + type: >- + number | string | boolean | | + | <any> + - id: maturity + description: Is the security's maturity date, expressed as a serial date number. + type: >- + number | string | boolean | | + | <any> + - id: frequency + description: Is the number of coupon payments per year. + type: >- + number | string | boolean | | + | <any> + - id: basis + description: Is the type of day count basis to use. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: coupDays(settlement, maturity, frequency, basis) + uid: excel!Excel.Functions#coupDays:member(1) + package: excel! + fullName: coupDays(settlement, maturity, frequency, basis) + summary: >- + Returns the number of days in the coupon period that contains the + settlement date. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + coupDays(settlement: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, maturity: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, frequency: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, basis?: + number | string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: settlement + description: >- + Is the security's settlement date, expressed as a serial date + number. + type: >- + number | string | boolean | | + | <any> + - id: maturity + description: Is the security's maturity date, expressed as a serial date number. + type: >- + number | string | boolean | | + | <any> + - id: frequency + description: Is the number of coupon payments per year. + type: >- + number | string | boolean | | + | <any> + - id: basis + description: Is the type of day count basis to use. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: coupDaysNc(settlement, maturity, frequency, basis) + uid: excel!Excel.Functions#coupDaysNc:member(1) + package: excel! + fullName: coupDaysNc(settlement, maturity, frequency, basis) + summary: >- + Returns the number of days from the settlement date to the next coupon + date. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + coupDaysNc(settlement: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, maturity: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, frequency: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, basis?: + number | string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: settlement + description: >- + Is the security's settlement date, expressed as a serial date + number. + type: >- + number | string | boolean | | + | <any> + - id: maturity + description: Is the security's maturity date, expressed as a serial date number. + type: >- + number | string | boolean | | + | <any> + - id: frequency + description: Is the number of coupon payments per year. + type: >- + number | string | boolean | | + | <any> + - id: basis + description: Is the type of day count basis to use. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: coupNcd(settlement, maturity, frequency, basis) + uid: excel!Excel.Functions#coupNcd:member(1) + package: excel! + fullName: coupNcd(settlement, maturity, frequency, basis) + summary: Returns the next coupon date after the settlement date. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + coupNcd(settlement: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, maturity: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, frequency: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, basis?: + number | string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: settlement + description: >- + Is the security's settlement date, expressed as a serial date + number. + type: >- + number | string | boolean | | + | <any> + - id: maturity + description: Is the security's maturity date, expressed as a serial date number. + type: >- + number | string | boolean | | + | <any> + - id: frequency + description: Is the number of coupon payments per year. + type: >- + number | string | boolean | | + | <any> + - id: basis + description: Is the type of day count basis to use. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: coupNum(settlement, maturity, frequency, basis) + uid: excel!Excel.Functions#coupNum:member(1) + package: excel! + fullName: coupNum(settlement, maturity, frequency, basis) + summary: >- + Returns the number of coupons payable between the settlement date and + maturity date. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + coupNum(settlement: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, maturity: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, frequency: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, basis?: + number | string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: settlement + description: >- + Is the security's settlement date, expressed as a serial date + number. + type: >- + number | string | boolean | | + | <any> + - id: maturity + description: Is the security's maturity date, expressed as a serial date number. + type: >- + number | string | boolean | | + | <any> + - id: frequency + description: Is the number of coupon payments per year. + type: >- + number | string | boolean | | + | <any> + - id: basis + description: Is the type of day count basis to use. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: coupPcd(settlement, maturity, frequency, basis) + uid: excel!Excel.Functions#coupPcd:member(1) + package: excel! + fullName: coupPcd(settlement, maturity, frequency, basis) + summary: Returns the previous coupon date before the settlement date. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + coupPcd(settlement: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, maturity: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, frequency: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, basis?: + number | string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: settlement + description: >- + Is the security's settlement date, expressed as a serial date + number. + type: >- + number | string | boolean | | + | <any> + - id: maturity + description: Is the security's maturity date, expressed as a serial date number. + type: >- + number | string | boolean | | + | <any> + - id: frequency + description: Is the number of coupon payments per year. + type: >- + number | string | boolean | | + | <any> + - id: basis + description: Is the type of day count basis to use. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: csc(number) + uid: excel!Excel.Functions#csc:member(1) + package: excel! + fullName: csc(number) + summary: Returns the cosecant of an angle. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + csc(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: Is the angle in radians for which you want the cosecant. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: csch(number) + uid: excel!Excel.Functions#csch:member(1) + package: excel! + fullName: csch(number) + summary: Returns the hyperbolic cosecant of an angle. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + csch(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: Is the angle in radians for which you want the hyperbolic cosecant. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: cumIPmt(rate, nper, pv, startPeriod, endPeriod, type) + uid: excel!Excel.Functions#cumIPmt:member(1) + package: excel! + fullName: cumIPmt(rate, nper, pv, startPeriod, endPeriod, type) + summary: Returns the cumulative interest paid between two periods. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + cumIPmt(rate: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, nper: number | string + | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, pv: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, startPeriod: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, endPeriod: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, type: + number | string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: rate + description: Is the interest rate. + type: >- + number | string | boolean | | + | <any> + - id: nper + description: Is the total number of payment periods. + type: >- + number | string | boolean | | + | <any> + - id: pv + description: Is the present value. + type: >- + number | string | boolean | | + | <any> + - id: startPeriod + description: Is the first period in the calculation. + type: >- + number | string | boolean | | + | <any> + - id: endPeriod + description: Is the last period in the calculation. + type: >- + number | string | boolean | | + | <any> + - id: type + description: Is the timing of the payment. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: cumPrinc(rate, nper, pv, startPeriod, endPeriod, type) + uid: excel!Excel.Functions#cumPrinc:member(1) + package: excel! + fullName: cumPrinc(rate, nper, pv, startPeriod, endPeriod, type) + summary: Returns the cumulative principal paid on a loan between two periods. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + cumPrinc(rate: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, nper: number | string + | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, pv: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, startPeriod: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, endPeriod: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, type: + number | string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: rate + description: Is the interest rate. + type: >- + number | string | boolean | | + | <any> + - id: nper + description: Is the total number of payment periods. + type: >- + number | string | boolean | | + | <any> + - id: pv + description: Is the present value. + type: >- + number | string | boolean | | + | <any> + - id: startPeriod + description: Is the first period in the calculation. + type: >- + number | string | boolean | | + | <any> + - id: endPeriod + description: Is the last period in the calculation. + type: >- + number | string | boolean | | + | <any> + - id: type + description: Is the timing of the payment. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: date(year, month, day) + uid: excel!Excel.Functions#date:member(1) + package: excel! + fullName: date(year, month, day) + summary: >- + Returns the number that represents the date in Microsoft Excel date-time + code. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + date(year: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, month: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, day: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: year + description: >- + Is a number from 1900 or 1904 (depending on the workbook's date + system) to 9999. + type: >- + number | | | <any> + - id: month + description: Is a number from 1 to 12 representing the month of the year. + type: >- + number | | | <any> + - id: day + description: Is a number from 1 to 31 representing the day of the month. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: datevalue(dateText) + uid: excel!Excel.Functions#datevalue:member(1) + package: excel! + fullName: datevalue(dateText) + summary: >- + Converts a date in the form of text to a number that represents the date + in Microsoft Excel date-time code. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + datevalue(dateText: string | number | Excel.Range | Excel.RangeReference + | Excel.FunctionResult): FunctionResult; + parameters: + - id: dateText + description: >- + Is text that represents a date in a Microsoft Excel date format, + between 1/1/1900 or 1/1/1904 (depending on the workbook's date + system) and 12/31/9999. + type: >- + string | number | | | <any> + return: + type: <number> + description: '' + - name: daverage(database, field, criteria) + uid: excel!Excel.Functions#daverage:member(1) + package: excel! + fullName: daverage(database, field, criteria) + summary: >- + Averages the values in a column in a list or database that match + conditions you specify. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + daverage(database: Excel.Range | Excel.RangeReference | + Excel.FunctionResult, field: number | string | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, criteria: string | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: database + description: >- + Is the range of cells that makes up the list or database. A database + is a list of related data. + type: >- + | | <any> + - id: field + description: >- + Is either the label of the column in double quotation marks or a + number that represents the column's position in the list. + type: >- + number | string | | | <any> + - id: criteria + description: >- + Is the range of cells that contains the conditions you specify. The + range includes a column label and one cell below the label for a + condition. + type: >- + string | | | <any> + return: + type: <number> + description: '' + - name: day(serialNumber) + uid: excel!Excel.Functions#day:member(1) + package: excel! + fullName: day(serialNumber) + summary: Returns the day of the month, a number from 1 to 31. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + day(serialNumber: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: serialNumber + description: Is a number in the date-time code used by Microsoft Excel. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: days(endDate, startDate) + uid: excel!Excel.Functions#days:member(1) + package: excel! + fullName: days(endDate, startDate) + summary: Returns the number of days between the two dates. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + days(endDate: string | number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, startDate: string | number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: endDate + description: >- + startDate and endDate are the two dates between which you want to + know the number of days. + type: >- + string | number | | | <any> + - id: startDate + description: >- + startDate and endDate are the two dates between which you want to + know the number of days. + type: >- + string | number | | | <any> + return: + type: <number> + description: '' + - name: days360(startDate, endDate, method) + uid: excel!Excel.Functions#days360:member(1) + package: excel! + fullName: days360(startDate, endDate, method) + summary: >- + Returns the number of days between two dates based on a 360-day year + (twelve 30-day months). + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + days360(startDate: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, endDate: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, method?: boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: startDate + description: >- + startDate and endDate are the two dates between which you want to + know the number of days. + type: >- + number | | | <any> + - id: endDate + description: >- + startDate and endDate are the two dates between which you want to + know the number of days. + type: >- + number | | | <any> + - id: method + description: >- + Is a logical value specifying the calculation method: U.S. (NASD) = + FALSE or omitted; European = TRUE. + type: >- + boolean | | | <any> + return: + type: <number> + description: '' + - name: db(cost, salvage, life, period, month) + uid: excel!Excel.Functions#db:member(1) + package: excel! + fullName: db(cost, salvage, life, period, month) + summary: >- + Returns the depreciation of an asset for a specified period using the + fixed-declining balance method. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + db(cost: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, salvage: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, life: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, period: + number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, + month?: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: cost + description: Is the initial cost of the asset. + type: >- + number | | | <any> + - id: salvage + description: Is the salvage value at the end of the life of the asset. + type: >- + number | | | <any> + - id: life + description: >- + Is the number of periods over which the asset is being depreciated + (sometimes called the useful life of the asset). + type: >- + number | | | <any> + - id: period + description: >- + Is the period for which you want to calculate the depreciation. + Period must use the same units as Life. + type: >- + number | | | <any> + - id: month + description: >- + Is the number of months in the first year. If month is omitted, it + is assumed to be 12. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: dbcs(text) + uid: excel!Excel.Functions#dbcs:member(1) + package: excel! + fullName: dbcs(text) + summary: >- + Changes half-width (single-byte) characters within a character string to + full-width (double-byte) characters. Use with double-byte character sets + (DBCS). + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + dbcs(text: string | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: text + description: Is a text, or a reference to a cell containing a text. + type: >- + string | | | <any> + return: + type: <string> + description: '' + - name: dcount(database, field, criteria) + uid: excel!Excel.Functions#dcount:member(1) + package: excel! + fullName: dcount(database, field, criteria) + summary: >- + Counts the cells containing numbers in the field (column) of records in + the database that match the conditions you specify. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + dcount(database: Excel.Range | Excel.RangeReference | + Excel.FunctionResult, field: number | string | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, criteria: string | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: database + description: >- + Is the range of cells that makes up the list or database. A database + is a list of related data. + type: >- + | | <any> + - id: field + description: >- + Is either the label of the column in double quotation marks or a + number that represents the column's position in the list. + type: >- + number | string | | | <any> + - id: criteria + description: >- + Is the range of cells that contains the conditions you specify. The + range includes a column label and one cell below the label for a + condition. + type: >- + string | | | <any> + return: + type: <number> + description: '' + - name: dcountA(database, field, criteria) + uid: excel!Excel.Functions#dcountA:member(1) + package: excel! + fullName: dcountA(database, field, criteria) + summary: >- + Counts nonblank cells in the field (column) of records in the database + that match the conditions you specify. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + dcountA(database: Excel.Range | Excel.RangeReference | + Excel.FunctionResult, field: number | string | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, criteria: string | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: database + description: >- + Is the range of cells that makes up the list or database. A database + is a list of related data. + type: >- + | | <any> + - id: field + description: >- + Is either the label of the column in double quotation marks or a + number that represents the column's position in the list. + type: >- + number | string | | | <any> + - id: criteria + description: >- + Is the range of cells that contains the conditions you specify. The + range includes a column label and one cell below the label for a + condition. + type: >- + string | | | <any> + return: + type: <number> + description: '' + - name: ddb(cost, salvage, life, period, factor) + uid: excel!Excel.Functions#ddb:member(1) + package: excel! + fullName: ddb(cost, salvage, life, period, factor) + summary: >- + Returns the depreciation of an asset for a specified period using the + double-declining balance method or some other method you specify. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + ddb(cost: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, salvage: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, life: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, period: + number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, + factor?: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: cost + description: Is the initial cost of the asset. + type: >- + number | | | <any> + - id: salvage + description: Is the salvage value at the end of the life of the asset. + type: >- + number | | | <any> + - id: life + description: >- + Is the number of periods over which the asset is being depreciated + (sometimes called the useful life of the asset). + type: >- + number | | | <any> + - id: period + description: >- + Is the period for which you want to calculate the depreciation. + Period must use the same units as Life. + type: >- + number | | | <any> + - id: factor + description: >- + Is the rate at which the balance declines. If Factor is omitted, it + is assumed to be 2 (the double-declining balance method). + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: dec2Bin(number, places) + uid: excel!Excel.Functions#dec2Bin:member(1) + package: excel! + fullName: dec2Bin(number, places) + summary: Converts a decimal number to binary. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + dec2Bin(number: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, places?: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: Is the decimal integer you want to convert. + type: >- + number | string | boolean | | + | <any> + - id: places + description: Is the number of characters to use. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: dec2Hex(number, places) + uid: excel!Excel.Functions#dec2Hex:member(1) + package: excel! + fullName: dec2Hex(number, places) + summary: Converts a decimal number to hexadecimal. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + dec2Hex(number: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, places?: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: Is the decimal integer you want to convert. + type: >- + number | string | boolean | | + | <any> + - id: places + description: Is the number of characters to use. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: dec2Oct(number, places) + uid: excel!Excel.Functions#dec2Oct:member(1) + package: excel! + fullName: dec2Oct(number, places) + summary: Converts a decimal number to octal. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + dec2Oct(number: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, places?: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: Is the decimal integer you want to convert. + type: >- + number | string | boolean | | + | <any> + - id: places + description: Is the number of characters to use. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: decimal(number, radix) + uid: excel!Excel.Functions#decimal:member(1) + package: excel! + fullName: decimal(number, radix) + summary: >- + Converts a text representation of a number in a given base into a decimal + number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + decimal(number: string | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, radix: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: number + description: Is the number that you want to convert. + type: >- + string | | | <any> + - id: radix + description: Is the base Radix of the number you are converting. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: degrees(angle) + uid: excel!Excel.Functions#degrees:member(1) + package: excel! + fullName: degrees(angle) + summary: Converts radians to degrees. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + degrees(angle: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: angle + description: Is the angle in radians that you want to convert. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: delta(number1, number2) + uid: excel!Excel.Functions#delta:member(1) + package: excel! + fullName: delta(number1, number2) + summary: Tests whether two numbers are equal. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + delta(number1: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, number2?: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number1 + description: Is the first number. + type: >- + number | string | boolean | | + | <any> + - id: number2 + description: Is the second number. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: devSq(values) + uid: excel!Excel.Functions#devSq:member(1) + package: excel! + fullName: devSq(values) + summary: >- + Returns the sum of squares of deviations of data points from their sample + mean. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + devSq(...values: Array>): FunctionResult; + parameters: + - id: values + description: >- + List of parameters, whose elements are 1 to 255 arguments, or an + array or array reference, on which you want DEVSQ to calculate. + type: >- + Array<number | | | <any>> + return: + type: <number> + description: '' + - name: dget(database, field, criteria) + uid: excel!Excel.Functions#dget:member(1) + package: excel! + fullName: dget(database, field, criteria) + summary: >- + Extracts from a database a single record that matches the conditions you + specify. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + dget(database: Excel.Range | Excel.RangeReference | + Excel.FunctionResult, field: number | string | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, criteria: string | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: database + description: >- + Is the range of cells that makes up the list or database. A database + is a list of related data. + type: >- + | | <any> + - id: field + description: >- + Is either the label of the column in double quotation marks or a + number that represents the column's position in the list. + type: >- + number | string | | | <any> + - id: criteria + description: >- + Is the range of cells that contains the conditions you specify. The + range includes a column label and one cell below the label for a + condition. + type: >- + string | | | <any> + return: + type: >- + <number | boolean | + string> + description: '' + - name: disc(settlement, maturity, pr, redemption, basis) + uid: excel!Excel.Functions#disc:member(1) + package: excel! + fullName: disc(settlement, maturity, pr, redemption, basis) + summary: Returns the discount rate for a security. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + disc(settlement: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, maturity: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, pr: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, redemption: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, basis?: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: settlement + description: >- + Is the security's settlement date, expressed as a serial date + number. + type: >- + number | string | boolean | | + | <any> + - id: maturity + description: Is the security's maturity date, expressed as a serial date number. + type: >- + number | string | boolean | | + | <any> + - id: pr + description: Is the security's price per $100 face value. + type: >- + number | string | boolean | | + | <any> + - id: redemption + description: Is the security's redemption value per $100 face value. + type: >- + number | string | boolean | | + | <any> + - id: basis + description: Is the type of day count basis to use. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: dmax(database, field, criteria) + uid: excel!Excel.Functions#dmax:member(1) + package: excel! + fullName: dmax(database, field, criteria) + summary: >- + Returns the largest number in the field (column) of records in the + database that match the conditions you specify. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + dmax(database: Excel.Range | Excel.RangeReference | + Excel.FunctionResult, field: number | string | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, criteria: string | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: database + description: >- + Is the range of cells that makes up the list or database. A database + is a list of related data. + type: >- + | | <any> + - id: field + description: >- + Is either the label of the column in double quotation marks or a + number that represents the column's position in the list. + type: >- + number | string | | | <any> + - id: criteria + description: >- + Is the range of cells that contains the conditions you specify. The + range includes a column label and one cell below the label for a + condition. + type: >- + string | | | <any> + return: + type: <number> + description: '' + - name: dmin(database, field, criteria) + uid: excel!Excel.Functions#dmin:member(1) + package: excel! + fullName: dmin(database, field, criteria) + summary: >- + Returns the smallest number in the field (column) of records in the + database that match the conditions you specify. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + dmin(database: Excel.Range | Excel.RangeReference | + Excel.FunctionResult, field: number | string | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, criteria: string | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: database + description: >- + Is the range of cells that makes up the list or database. A database + is a list of related data. + type: >- + | | <any> + - id: field + description: >- + Is either the label of the column in double quotation marks or a + number that represents the column's position in the list. + type: >- + number | string | | | <any> + - id: criteria + description: >- + Is the range of cells that contains the conditions you specify. The + range includes a column label and one cell below the label for a + condition. + type: >- + string | | | <any> + return: + type: <number> + description: '' + - name: dollar(number, decimals) + uid: excel!Excel.Functions#dollar:member(1) + package: excel! + fullName: dollar(number, decimals) + summary: Converts a number to text, using currency format. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + dollar(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, decimals?: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: number + description: >- + Is a number, a reference to a cell containing a number, or a formula + that evaluates to a number. + type: >- + number | | | <any> + - id: decimals + description: >- + Is the number of digits to the right of the decimal point. The + number is rounded as necessary; if omitted, Decimals = 2. + type: >- + number | | | <any> + return: + type: <string> + description: '' + - name: dollarDe(fractionalDollar, fraction) + uid: excel!Excel.Functions#dollarDe:member(1) + package: excel! + fullName: dollarDe(fractionalDollar, fraction) + summary: >- + Converts a dollar price, expressed as a fraction, into a dollar price, + expressed as a decimal number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + dollarDe(fractionalDollar: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, fraction: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: fractionalDollar + description: Is a number expressed as a fraction. + type: >- + number | string | boolean | | + | <any> + - id: fraction + description: Is the integer to use in the denominator of the fraction. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: dollarFr(decimalDollar, fraction) + uid: excel!Excel.Functions#dollarFr:member(1) + package: excel! + fullName: dollarFr(decimalDollar, fraction) + summary: >- + Converts a dollar price, expressed as a decimal number, into a dollar + price, expressed as a fraction. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + dollarFr(decimalDollar: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, fraction: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: decimalDollar + description: Is a decimal number. + type: >- + number | string | boolean | | + | <any> + - id: fraction + description: Is the integer to use in the denominator of a fraction. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: dproduct(database, field, criteria) + uid: excel!Excel.Functions#dproduct:member(1) + package: excel! + fullName: dproduct(database, field, criteria) + summary: >- + Multiplies the values in the field (column) of records in the database + that match the conditions you specify. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + dproduct(database: Excel.Range | Excel.RangeReference | + Excel.FunctionResult, field: number | string | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, criteria: string | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: database + description: >- + Is the range of cells that makes up the list or database. A database + is a list of related data. + type: >- + | | <any> + - id: field + description: >- + Is either the label of the column in double quotation marks or a + number that represents the column's position in the list. + type: >- + number | string | | | <any> + - id: criteria + description: >- + Is the range of cells that contains the conditions you specify. The + range includes a column label and one cell below the label for a + condition. + type: >- + string | | | <any> + return: + type: <number> + description: '' + - name: dstDev(database, field, criteria) + uid: excel!Excel.Functions#dstDev:member(1) + package: excel! + fullName: dstDev(database, field, criteria) + summary: >- + Estimates the standard deviation based on a sample from selected database + entries. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + dstDev(database: Excel.Range | Excel.RangeReference | + Excel.FunctionResult, field: number | string | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, criteria: string | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: database + description: >- + Is the range of cells that makes up the list or database. A database + is a list of related data. + type: >- + | | <any> + - id: field + description: >- + Is either the label of the column in double quotation marks or a + number that represents the column's position in the list. + type: >- + number | string | | | <any> + - id: criteria + description: >- + Is the range of cells that contains the conditions you specify. The + range includes a column label and one cell below the label for a + condition. + type: >- + string | | | <any> + return: + type: <number> + description: '' + - name: dstDevP(database, field, criteria) + uid: excel!Excel.Functions#dstDevP:member(1) + package: excel! + fullName: dstDevP(database, field, criteria) + summary: >- + Calculates the standard deviation based on the entire population of + selected database entries. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + dstDevP(database: Excel.Range | Excel.RangeReference | + Excel.FunctionResult, field: number | string | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, criteria: string | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: database + description: >- + Is the range of cells that makes up the list or database. A database + is a list of related data. + type: >- + | | <any> + - id: field + description: >- + Is either the label of the column in double quotation marks or a + number that represents the column's position in the list. + type: >- + number | string | | | <any> + - id: criteria + description: >- + Is the range of cells that contains the conditions you specify. The + range includes a column label and one cell below the label for a + condition. + type: >- + string | | | <any> + return: + type: <number> + description: '' + - name: dsum(database, field, criteria) + uid: excel!Excel.Functions#dsum:member(1) + package: excel! + fullName: dsum(database, field, criteria) + summary: >- + Adds the numbers in the field (column) of records in the database that + match the conditions you specify. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + dsum(database: Excel.Range | Excel.RangeReference | + Excel.FunctionResult, field: number | string | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, criteria: string | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: database + description: >- + Is the range of cells that makes up the list or database. A database + is a list of related data. + type: >- + | | <any> + - id: field + description: >- + Is either the label of the column in double quotation marks or a + number that represents the column's position in the list. + type: >- + number | string | | | <any> + - id: criteria + description: >- + Is the range of cells that contains the conditions you specify. The + range includes a column label and one cell below the label for a + condition. + type: >- + string | | | <any> + return: + type: <number> + description: '' + - name: duration(settlement, maturity, coupon, yld, frequency, basis) + uid: excel!Excel.Functions#duration:member(1) + package: excel! + fullName: duration(settlement, maturity, coupon, yld, frequency, basis) + summary: Returns the annual duration of a security with periodic interest payments. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + duration(settlement: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, maturity: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, coupon: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, yld: + number | string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, frequency: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, basis?: + number | string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: settlement + description: >- + Is the security's settlement date, expressed as a serial date + number. + type: >- + number | string | boolean | | + | <any> + - id: maturity + description: Is the security's maturity date, expressed as a serial date number. + type: >- + number | string | boolean | | + | <any> + - id: coupon + description: Is the security's annual coupon rate. + type: >- + number | string | boolean | | + | <any> + - id: yld + description: Is the security's annual yield. + type: >- + number | string | boolean | | + | <any> + - id: frequency + description: Is the number of coupon payments per year. + type: >- + number | string | boolean | | + | <any> + - id: basis + description: Is the type of day count basis to use. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: dvar(database, field, criteria) + uid: excel!Excel.Functions#dvar:member(1) + package: excel! + fullName: dvar(database, field, criteria) + summary: Estimates variance based on a sample from selected database entries. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + dvar(database: Excel.Range | Excel.RangeReference | + Excel.FunctionResult, field: number | string | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, criteria: string | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: database + description: >- + Is the range of cells that makes up the list or database. A database + is a list of related data. + type: >- + | | <any> + - id: field + description: >- + Is either the label of the column in double quotation marks or a + number that represents the column's position in the list. + type: >- + number | string | | | <any> + - id: criteria + description: >- + Is the range of cells that contains the conditions you specify. The + range includes a column label and one cell below the label for a + condition. + type: >- + string | | | <any> + return: + type: <number> + description: '' + - name: dvarP(database, field, criteria) + uid: excel!Excel.Functions#dvarP:member(1) + package: excel! + fullName: dvarP(database, field, criteria) + summary: >- + Calculates variance based on the entire population of selected database + entries. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + dvarP(database: Excel.Range | Excel.RangeReference | + Excel.FunctionResult, field: number | string | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, criteria: string | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: database + description: >- + Is the range of cells that makes up the list or database. A database + is a list of related data. + type: >- + | | <any> + - id: field + description: >- + Is either the label of the column in double quotation marks or a + number that represents the column's position in the list. + type: >- + number | string | | | <any> + - id: criteria + description: >- + Is the range of cells that contains the conditions you specify. The + range includes a column label and one cell below the label for a + condition. + type: >- + string | | | <any> + return: + type: <number> + description: '' + - name: ecma_Ceiling(number, significance) + uid: excel!Excel.Functions#ecma_Ceiling:member(1) + package: excel! + fullName: ecma_Ceiling(number, significance) + summary: >- + Rounds a number up, to the nearest integer or to the nearest multiple of + significance. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + ecma_Ceiling(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, significance: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: number + description: Is the value you want to round. + type: >- + number | | | <any> + - id: significance + description: Is the multiple to which you want to round. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: edate(startDate, months) + uid: excel!Excel.Functions#edate:member(1) + package: excel! + fullName: edate(startDate, months) + summary: >- + Returns the serial number of the date that is the indicated number of + months before or after the start date. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + edate(startDate: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, months: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: startDate + description: Is a serial date number that represents the start date. + type: >- + number | string | boolean | | + | <any> + - id: months + description: Is the number of months before or after startDate. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: effect(nominalRate, npery) + uid: excel!Excel.Functions#effect:member(1) + package: excel! + fullName: effect(nominalRate, npery) + summary: Returns the effective annual interest rate. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + effect(nominalRate: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, npery: number | string + | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: nominalRate + description: Is the nominal interest rate. + type: >- + number | string | boolean | | + | <any> + - id: npery + description: Is the number of compounding periods per year. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: eoMonth(startDate, months) + uid: excel!Excel.Functions#eoMonth:member(1) + package: excel! + fullName: eoMonth(startDate, months) + summary: >- + Returns the serial number of the last day of the month before or after a + specified number of months. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + eoMonth(startDate: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, months: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: startDate + description: Is a serial date number that represents the start date. + type: >- + number | string | boolean | | + | <any> + - id: months + description: Is the number of months before or after the startDate. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: erf_Precise(X) + uid: excel!Excel.Functions#erf_Precise:member(1) + package: excel! + fullName: erf_Precise(X) + summary: Returns the error function. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + erf_Precise(X: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: X + description: Is the lower bound for integrating ERF.PRECISE. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: erf(lowerLimit, upperLimit) + uid: excel!Excel.Functions#erf:member(1) + package: excel! + fullName: erf(lowerLimit, upperLimit) + summary: Returns the error function. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + erf(lowerLimit: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, upperLimit?: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: lowerLimit + description: Is the lower bound for integrating ERF. + type: >- + number | string | boolean | | + | <any> + - id: upperLimit + description: Is the upper bound for integrating ERF. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: erfC_Precise(X) + uid: excel!Excel.Functions#erfC_Precise:member(1) + package: excel! + fullName: erfC_Precise(X) + summary: Returns the complementary error function. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + erfC_Precise(X: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: X + description: Is the lower bound for integrating ERFC.PRECISE. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: erfC(x) + uid: excel!Excel.Functions#erfC:member(1) + package: excel! + fullName: erfC(x) + summary: Returns the complementary error function. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + erfC(x: number | string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: x + description: Is the lower bound for integrating ERF. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: error_Type(errorVal) + uid: excel!Excel.Functions#error_Type:member(1) + package: excel! + fullName: error_Type(errorVal) + summary: Returns a number matching an error value. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + error_Type(errorVal: string | number | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: errorVal + description: >- + Is the error value for which you want the identifying number, and + can be an actual error value or a reference to a cell containing an + error value. + type: >- + string | number | boolean | | + | <any> + return: + type: <number> + description: '' + - name: even(number) + uid: excel!Excel.Functions#even:member(1) + package: excel! + fullName: even(number) + summary: >- + Rounds a positive number up and negative number down to the nearest even + integer. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + even(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: Is the value to round. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: exact(text1, text2) + uid: excel!Excel.Functions#exact:member(1) + package: excel! + fullName: exact(text1, text2) + summary: >- + Checks whether two text strings are exactly the same, and returns TRUE or + FALSE. EXACT is case-sensitive. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + exact(text1: string | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, text2: string | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: text1 + description: Is the first text string. + type: >- + string | | | <any> + - id: text2 + description: Is the second text string. + type: >- + string | | | <any> + return: + type: <boolean> + description: '' + - name: exp(number) + uid: excel!Excel.Functions#exp:member(1) + package: excel! + fullName: exp(number) + summary: Returns e raised to the power of a given number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + exp(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: >- + Is the exponent applied to the base e. The constant e equals + 2.71828182845904, the base of the natural logarithm. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: expon_Dist(x, lambda, cumulative) + uid: excel!Excel.Functions#expon_Dist:member(1) + package: excel! + fullName: expon_Dist(x, lambda, cumulative) + summary: Returns the exponential distribution. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + expon_Dist(x: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, lambda: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, cumulative: boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: x + description: Is the value of the function, a nonnegative number. + type: >- + number | | | <any> + - id: lambda + description: Is the parameter value, a positive number. + type: >- + number | | | <any> + - id: cumulative + description: >- + Is a logical value for the function to return: the cumulative + distribution function = TRUE; the probability density function = + FALSE. + type: >- + boolean | | | <any> + return: + type: <number> + description: '' + - name: f_Dist_RT(x, degFreedom1, degFreedom2) + uid: excel!Excel.Functions#f_Dist_RT:member(1) + package: excel! + fullName: f_Dist_RT(x, degFreedom1, degFreedom2) + summary: >- + Returns the (right-tailed) F probability distribution (degree of + diversity) for two data sets. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + f_Dist_RT(x: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, degFreedom1: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, degFreedom2: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: x + description: >- + Is the value at which to evaluate the function, a nonnegative + number. + type: >- + number | | | <any> + - id: degFreedom1 + description: >- + Is the numerator degrees of freedom, a number between 1 and 10^10, + excluding 10^10. + type: >- + number | | | <any> + - id: degFreedom2 + description: >- + Is the denominator degrees of freedom, a number between 1 and 10^10, + excluding 10^10. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: f_Dist(x, degFreedom1, degFreedom2, cumulative) + uid: excel!Excel.Functions#f_Dist:member(1) + package: excel! + fullName: f_Dist(x, degFreedom1, degFreedom2, cumulative) + summary: >- + Returns the (left-tailed) F probability distribution (degree of diversity) + for two data sets. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + f_Dist(x: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, degFreedom1: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, degFreedom2: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, + cumulative: boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: x + description: >- + Is the value at which to evaluate the function, a nonnegative + number. + type: >- + number | | | <any> + - id: degFreedom1 + description: >- + Is the numerator degrees of freedom, a number between 1 and 10^10, + excluding 10^10. + type: >- + number | | | <any> + - id: degFreedom2 + description: >- + Is the denominator degrees of freedom, a number between 1 and 10^10, + excluding 10^10. + type: >- + number | | | <any> + - id: cumulative + description: >- + Is a logical value for the function to return: the cumulative + distribution function = TRUE; the probability density function = + FALSE. + type: >- + boolean | | | <any> + return: + type: <number> + description: '' + - name: f_Inv_RT(probability, degFreedom1, degFreedom2) + uid: excel!Excel.Functions#f_Inv_RT:member(1) + package: excel! + fullName: f_Inv_RT(probability, degFreedom1, degFreedom2) + summary: >- + Returns the inverse of the (right-tailed) F probability distribution: if p + = F.DIST.RT(x,...), then F.INV.RT(p,...) = x. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + f_Inv_RT(probability: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, degFreedom1: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, degFreedom2: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: probability + description: >- + Is a probability associated with the F cumulative distribution, a + number between 0 and 1 inclusive. + type: >- + number | | | <any> + - id: degFreedom1 + description: >- + Is the numerator degrees of freedom, a number between 1 and 10^10, + excluding 10^10. + type: >- + number | | | <any> + - id: degFreedom2 + description: >- + Is the denominator degrees of freedom, a number between 1 and 10^10, + excluding 10^10. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: f_Inv(probability, degFreedom1, degFreedom2) + uid: excel!Excel.Functions#f_Inv:member(1) + package: excel! + fullName: f_Inv(probability, degFreedom1, degFreedom2) + summary: >- + Returns the inverse of the (left-tailed) F probability distribution: if p + = F.DIST(x,...), then F.INV(p,...) = x. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + f_Inv(probability: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, degFreedom1: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, degFreedom2: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: probability + description: >- + Is a probability associated with the F cumulative distribution, a + number between 0 and 1 inclusive. + type: >- + number | | | <any> + - id: degFreedom1 + description: >- + Is the numerator degrees of freedom, a number between 1 and 10^10, + excluding 10^10. + type: >- + number | | | <any> + - id: degFreedom2 + description: >- + Is the denominator degrees of freedom, a number between 1 and 10^10, + excluding 10^10. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: fact(number) + uid: excel!Excel.Functions#fact:member(1) + package: excel! + fullName: fact(number) + summary: Returns the factorial of a number, equal to 1*2*3*...* Number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + fact(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: Is the nonnegative number you want the factorial of. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: factDouble(number) + uid: excel!Excel.Functions#factDouble:member(1) + package: excel! + fullName: factDouble(number) + summary: Returns the double factorial of a number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + factDouble(number: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: number + description: Is the value for which to return the double factorial. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: false() + uid: excel!Excel.Functions#false:member(1) + package: excel! + fullName: false() + summary: Returns the logical value FALSE. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'false(): FunctionResult;' + return: + type: <boolean> + description: '' + - name: find(findText, withinText, startNum) + uid: excel!Excel.Functions#find:member(1) + package: excel! + fullName: find(findText, withinText, startNum) + summary: >- + Returns the starting position of one text string within another text + string. FIND is case-sensitive. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + find(findText: string | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, withinText: string | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, startNum?: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: findText + description: >- + Is the text you want to find. Use double quotes (empty text) to + match the first character in withinText; wildcard characters not + allowed. + type: >- + string | | | <any> + - id: withinText + description: Is the text containing the text you want to find. + type: >- + string | | | <any> + - id: startNum + description: >- + Specifies the character at which to start the search. The first + character in withinText is character number 1. If omitted, startNum + = 1. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: findB(findText, withinText, startNum) + uid: excel!Excel.Functions#findB:member(1) + package: excel! + fullName: findB(findText, withinText, startNum) + summary: >- + Finds the starting position of one text string within another text string. + FINDB is case-sensitive. Use with double-byte character sets (DBCS). + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + findB(findText: string | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, withinText: string | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, startNum?: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: findText + description: Is the text you want to find. + type: >- + string | | | <any> + - id: withinText + description: Is the text containing the text you want to find. + type: >- + string | | | <any> + - id: startNum + description: Specifies the character at which to start the search. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: fisher(x) + uid: excel!Excel.Functions#fisher:member(1) + package: excel! + fullName: fisher(x) + summary: Returns the Fisher transformation. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + fisher(x: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: x + description: >- + Is the value for which you want the transformation, a number between + -1 and 1, excluding -1 and 1. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: fisherInv(y) + uid: excel!Excel.Functions#fisherInv:member(1) + package: excel! + fullName: fisherInv(y) + summary: >- + Returns the inverse of the Fisher transformation: if y = FISHER(x), then + FISHERINV(y) = x. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + fisherInv(y: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: 'y' + description: >- + Is the value for which you want to perform the inverse of the + transformation. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: fixed(number, decimals, noCommas) + uid: excel!Excel.Functions#fixed:member(1) + package: excel! + fullName: fixed(number, decimals, noCommas) + summary: >- + Rounds a number to the specified number of decimals and returns the result + as text with or without commas. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + fixed(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, decimals?: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, noCommas?: boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: number + description: Is the number you want to round and convert to text. + type: >- + number | | | <any> + - id: decimals + description: >- + Is the number of digits to the right of the decimal point. If + omitted, Decimals = 2. + type: >- + number | | | <any> + - id: noCommas + description: >- + Is a logical value: do not display commas in the returned text = + TRUE; do display commas in the returned text = FALSE or omitted. + type: >- + boolean | | | <any> + return: + type: <string> + description: '' + - name: floor_Math(number, significance, mode) + uid: excel!Excel.Functions#floor_Math:member(1) + package: excel! + fullName: floor_Math(number, significance, mode) + summary: >- + Rounds a number down, to the nearest integer or to the nearest multiple of + significance. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + floor_Math(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, significance?: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, mode?: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: number + description: Is the value you want to round. + type: >- + number | | | <any> + - id: significance + description: Is the multiple to which you want to round. + type: >- + number | | | <any> + - id: mode + description: When given and nonzero this function will round towards zero. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: floor_Precise(number, significance) + uid: excel!Excel.Functions#floor_Precise:member(1) + package: excel! + fullName: floor_Precise(number, significance) + summary: >- + Rounds a number down, to the nearest integer or to the nearest multiple of + significance. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + floor_Precise(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, significance?: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: number + description: Is the numeric value you want to round. + type: >- + number | | | <any> + - id: significance + description: Is the multiple to which you want to round. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: fv(rate, nper, pmt, pv, type) + uid: excel!Excel.Functions#fv:member(1) + package: excel! + fullName: fv(rate, nper, pmt, pv, type) + summary: >- + Returns the future value of an investment based on periodic, constant + payments and a constant interest rate. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + fv(rate: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, nper: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, pmt: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, pv?: + number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, + type?: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: rate + description: >- + Is the interest rate per period. For example, use 6%/4 for quarterly + payments at 6% APR. + type: >- + number | | | <any> + - id: nper + description: Is the total number of payment periods in the investment. + type: >- + number | | | <any> + - id: pmt + description: >- + Is the payment made each period; it cannot change over the life of + the investment. + type: >- + number | | | <any> + - id: pv + description: >- + Is the present value, or the lump-sum amount that a series of future + payments is worth now. If omitted, Pv = 0. + type: >- + number | | | <any> + - id: type + description: >- + Is a value representing the timing of payment: payment at the + beginning of the period = 1; payment at the end of the period = 0 or + omitted. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: fvschedule(principal, schedule) + uid: excel!Excel.Functions#fvschedule:member(1) + package: excel! + fullName: fvschedule(principal, schedule) + summary: >- + Returns the future value of an initial principal after applying a series + of compound interest rates. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + fvschedule(principal: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, schedule: number | + string | Excel.Range | boolean | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: principal + description: Is the present value. + type: >- + number | string | boolean | | + | <any> + - id: schedule + description: Is an array of interest rates to apply. + type: >- + number | string | | boolean | + | <any> + return: + type: <number> + description: '' + - name: gamma_Dist(x, alpha, beta, cumulative) + uid: excel!Excel.Functions#gamma_Dist:member(1) + package: excel! + fullName: gamma_Dist(x, alpha, beta, cumulative) + summary: Returns the gamma distribution. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + gamma_Dist(x: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, alpha: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, beta: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, + cumulative: boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: x + description: >- + Is the value at which you want to evaluate the distribution, a + nonnegative number. + type: >- + number | | | <any> + - id: alpha + description: Is a parameter to the distribution, a positive number. + type: >- + number | | | <any> + - id: beta + description: >- + Is a parameter to the distribution, a positive number. If beta = 1, + GAMMA.DIST returns the standard gamma distribution. + type: >- + number | | | <any> + - id: cumulative + description: >- + Is a logical value: return the cumulative distribution function = + TRUE; return the probability mass function = FALSE or omitted. + type: >- + boolean | | | <any> + return: + type: <number> + description: '' + - name: gamma_Inv(probability, alpha, beta) + uid: excel!Excel.Functions#gamma_Inv:member(1) + package: excel! + fullName: gamma_Inv(probability, alpha, beta) + summary: >- + Returns the inverse of the gamma cumulative distribution: if p = + GAMMA.DIST(x,...), then GAMMA.INV(p,...) = x. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + gamma_Inv(probability: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, alpha: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, beta: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: probability + description: >- + Is the probability associated with the gamma distribution, a number + between 0 and 1, inclusive. + type: >- + number | | | <any> + - id: alpha + description: Is a parameter to the distribution, a positive number. + type: >- + number | | | <any> + - id: beta + description: >- + Is a parameter to the distribution, a positive number. If beta = 1, + GAMMA.INV returns the inverse of the standard gamma distribution. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: gamma(x) + uid: excel!Excel.Functions#gamma:member(1) + package: excel! + fullName: gamma(x) + summary: Returns the Gamma function value. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + gamma(x: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: x + description: Is the value for which you want to calculate Gamma. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: gammaLn_Precise(x) + uid: excel!Excel.Functions#gammaLn_Precise:member(1) + package: excel! + fullName: gammaLn_Precise(x) + summary: Returns the natural logarithm of the gamma function. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + gammaLn_Precise(x: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: x + description: >- + Is the value for which you want to calculate GAMMALN.PRECISE, a + positive number. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: gammaLn(x) + uid: excel!Excel.Functions#gammaLn:member(1) + package: excel! + fullName: gammaLn(x) + summary: Returns the natural logarithm of the gamma function. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + gammaLn(x: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: x + description: >- + Is the value for which you want to calculate GAMMALN, a positive + number. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: gauss(x) + uid: excel!Excel.Functions#gauss:member(1) + package: excel! + fullName: gauss(x) + summary: Returns 0.5 less than the standard normal cumulative distribution. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + gauss(x: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: x + description: Is the value for which you want the distribution. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: gcd(values) + uid: excel!Excel.Functions#gcd:member(1) + package: excel! + fullName: gcd(values) + summary: Returns the greatest common divisor. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + gcd(...values: Array>): + FunctionResult; + parameters: + - id: values + description: List of parameters, whose elements are 1 to 255 values. + type: >- + Array<number | string | | + boolean | | + <any>> + return: + type: <number> + description: '' + - name: geoMean(values) + uid: excel!Excel.Functions#geoMean:member(1) + package: excel! + fullName: geoMean(values) + summary: Returns the geometric mean of an array or range of positive numeric data. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + geoMean(...values: Array>): FunctionResult; + parameters: + - id: values + description: >- + List of parameters, whose elements are 1 to 255 numbers or names, + arrays, or references that contain numbers for which you want the + mean. + type: >- + Array<number | | | <any>> + return: + type: <number> + description: '' + - name: geStep(number, step) + uid: excel!Excel.Functions#geStep:member(1) + package: excel! + fullName: geStep(number, step) + summary: Tests whether a number is greater than a threshold value. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + geStep(number: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, step?: number | string + | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: Is the value to test against step. + type: >- + number | string | boolean | | + | <any> + - id: step + description: Is the threshold value. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: harMean(values) + uid: excel!Excel.Functions#harMean:member(1) + package: excel! + fullName: harMean(values) + summary: >- + Returns the harmonic mean of a data set of positive numbers: the + reciprocal of the arithmetic mean of reciprocals. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + harMean(...values: Array>): FunctionResult; + parameters: + - id: values + description: >- + List of parameters, whose elements are 1 to 255 numbers or names, + arrays, or references that contain numbers for which you want the + harmonic mean. + type: >- + Array<number | | | <any>> + return: + type: <number> + description: '' + - name: hex2Bin(number, places) + uid: excel!Excel.Functions#hex2Bin:member(1) + package: excel! + fullName: hex2Bin(number, places) + summary: Converts a Hexadecimal number to binary. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + hex2Bin(number: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, places?: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: Is the hexadecimal number you want to convert. + type: >- + number | string | boolean | | + | <any> + - id: places + description: Is the number of characters to use. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: hex2Dec(number) + uid: excel!Excel.Functions#hex2Dec:member(1) + package: excel! + fullName: hex2Dec(number) + summary: Converts a hexadecimal number to decimal. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + hex2Dec(number: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: number + description: Is the hexadecimal number you want to convert. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: hex2Oct(number, places) + uid: excel!Excel.Functions#hex2Oct:member(1) + package: excel! + fullName: hex2Oct(number, places) + summary: Converts a hexadecimal number to octal. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + hex2Oct(number: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, places?: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: Is the hexadecimal number you want to convert. + type: >- + number | string | boolean | | + | <any> + - id: places + description: Is the number of characters to use. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: hlookup(lookupValue, tableArray, rowIndexNum, rangeLookup) + uid: excel!Excel.Functions#hlookup:member(1) + package: excel! + fullName: hlookup(lookupValue, tableArray, rowIndexNum, rangeLookup) + summary: >- + Looks for a value in the top row of a table or array of values and returns + the value in the same column from a row you specify. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + hlookup(lookupValue: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, tableArray: + Excel.Range | number | Excel.RangeReference | Excel.FunctionResult, + rowIndexNum: Excel.Range | number | Excel.RangeReference | + Excel.FunctionResult, rangeLookup?: boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): FunctionResult; + parameters: + - id: lookupValue + description: >- + Is the value to be found in the first row of the table and can be a + value, a reference, or a text string. + type: >- + number | string | boolean | | + | <any> + - id: tableArray + description: >- + Is a table of text, numbers, or logical values in which data is + looked up. tableArray can be a reference to a range or a range name. + type: >- + | number | | <any> + - id: rowIndexNum + description: >- + Is the row number in tableArray from which the matching value should + be returned. The first row of values in the table is row 1. + type: >- + | number | | <any> + - id: rangeLookup + description: >- + Is a logical value: to find the closest match in the top row (sorted + in ascending order) = TRUE or omitted; find an exact match = FALSE. + type: >- + boolean | | | <any> + return: + type: >- + <number | string | + boolean> + description: '' + - name: hour(serialNumber) + uid: excel!Excel.Functions#hour:member(1) + package: excel! + fullName: hour(serialNumber) + summary: Returns the hour as a number from 0 (12:00 A.M.) to 23 (11:00 P.M.). + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + hour(serialNumber: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: serialNumber + description: >- + Is a number in the date-time code used by Microsoft Excel, or text + in time format, such as 16:48:00 or 4:48:00 PM. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: hyperlink(linkLocation, friendlyName) + uid: excel!Excel.Functions#hyperlink:member(1) + package: excel! + fullName: hyperlink(linkLocation, friendlyName) + summary: >- + Creates a shortcut or jump that opens a document stored on your hard + drive, a network server, or on the Internet. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + hyperlink(linkLocation: string | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, friendlyName?: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: linkLocation + description: >- + Is the text giving the path and file name to the document to be + opened, a hard drive location, UNC address, or URL path. + type: >- + string | | | <any> + - id: friendlyName + description: >- + Is text or a number that is displayed in the cell. If omitted, the + cell displays the linkLocation text. + type: >- + number | string | boolean | | + | <any> + return: + type: >- + <number | string | + boolean> + description: '' + - name: hypGeom_Dist(sampleS, numberSample, populationS, numberPop, cumulative) + uid: excel!Excel.Functions#hypGeom_Dist:member(1) + package: excel! + fullName: hypGeom_Dist(sampleS, numberSample, populationS, numberPop, cumulative) + summary: Returns the hypergeometric distribution. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + hypGeom_Dist(sampleS: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, numberSample: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, populationS: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, + numberPop: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, cumulative: boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: sampleS + description: Is the number of successes in the sample. + type: >- + number | | | <any> + - id: numberSample + description: Is the size of the sample. + type: >- + number | | | <any> + - id: populationS + description: Is the number of successes in the population. + type: >- + number | | | <any> + - id: numberPop + description: Is the population size. + type: >- + number | | | <any> + - id: cumulative + description: >- + Is a logical value: for the cumulative distribution function, use + TRUE; for the probability density function, use FALSE. + type: >- + boolean | | | <any> + return: + type: <number> + description: '' + - name: if(logicalTest, valueIfTrue, valueIfFalse) + uid: excel!Excel.Functions#if:member(1) + package: excel! + fullName: if(logicalTest, valueIfTrue, valueIfFalse) + summary: >- + Checks whether a condition is met, and returns one value if TRUE, and + another value if FALSE. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + if(logicalTest: boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, valueIfTrue?: Excel.Range | number | string | + boolean | Excel.RangeReference | Excel.FunctionResult, + valueIfFalse?: Excel.Range | number | string | boolean | + Excel.RangeReference | Excel.FunctionResult): FunctionResult; + parameters: + - id: logicalTest + description: Is any value or expression that can be evaluated to TRUE or FALSE. + type: >- + boolean | | | <any> + - id: valueIfTrue + description: >- + Is the value that is returned if logicalTest is TRUE. If omitted, + TRUE is returned. You can nest up to seven IF functions. + type: >- + | number | string | boolean | + | <any> + - id: valueIfFalse + description: >- + Is the value that is returned if logicalTest is FALSE. If omitted, + FALSE is returned. + type: >- + | number | string | boolean | + | <any> + return: + type: >- + <number | string | + boolean> + description: '' + - name: imAbs(inumber) + uid: excel!Excel.Functions#imAbs:member(1) + package: excel! + fullName: imAbs(inumber) + summary: Returns the absolute value (modulus) of a complex number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + imAbs(inumber: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: inumber + description: Is a complex number for which you want the absolute value. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: imaginary(inumber) + uid: excel!Excel.Functions#imaginary:member(1) + package: excel! + fullName: imaginary(inumber) + summary: Returns the imaginary coefficient of a complex number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + imaginary(inumber: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: inumber + description: Is a complex number for which you want the imaginary coefficient. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: imArgument(inumber) + uid: excel!Excel.Functions#imArgument:member(1) + package: excel! + fullName: imArgument(inumber) + summary: Returns the argument q, an angle expressed in radians. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + imArgument(inumber: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: inumber + description: Is a complex number for which you want the argument. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: imConjugate(inumber) + uid: excel!Excel.Functions#imConjugate:member(1) + package: excel! + fullName: imConjugate(inumber) + summary: Returns the complex conjugate of a complex number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + imConjugate(inumber: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: inumber + description: Is a complex number for which you want the conjugate. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: imCos(inumber) + uid: excel!Excel.Functions#imCos:member(1) + package: excel! + fullName: imCos(inumber) + summary: Returns the cosine of a complex number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + imCos(inumber: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: inumber + description: Is a complex number for which you want the cosine. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: imCosh(inumber) + uid: excel!Excel.Functions#imCosh:member(1) + package: excel! + fullName: imCosh(inumber) + summary: Returns the hyperbolic cosine of a complex number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + imCosh(inumber: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: inumber + description: Is a complex number for which you want the hyperbolic cosine. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: imCot(inumber) + uid: excel!Excel.Functions#imCot:member(1) + package: excel! + fullName: imCot(inumber) + summary: Returns the cotangent of a complex number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + imCot(inumber: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: inumber + description: Is a complex number for which you want the cotangent. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: imCsc(inumber) + uid: excel!Excel.Functions#imCsc:member(1) + package: excel! + fullName: imCsc(inumber) + summary: Returns the cosecant of a complex number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + imCsc(inumber: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: inumber + description: Is a complex number for which you want the cosecant. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: imCsch(inumber) + uid: excel!Excel.Functions#imCsch:member(1) + package: excel! + fullName: imCsch(inumber) + summary: Returns the hyperbolic cosecant of a complex number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + imCsch(inumber: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: inumber + description: Is a complex number for which you want the hyperbolic cosecant. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: imDiv(inumber1, inumber2) + uid: excel!Excel.Functions#imDiv:member(1) + package: excel! + fullName: imDiv(inumber1, inumber2) + summary: Returns the quotient of two complex numbers. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + imDiv(inumber1: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, inumber2: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: inumber1 + description: Is the complex numerator or dividend. + type: >- + number | string | boolean | | + | <any> + - id: inumber2 + description: Is the complex denominator or divisor. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: imExp(inumber) + uid: excel!Excel.Functions#imExp:member(1) + package: excel! + fullName: imExp(inumber) + summary: Returns the exponential of a complex number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + imExp(inumber: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: inumber + description: Is a complex number for which you want the exponential. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: imLn(inumber) + uid: excel!Excel.Functions#imLn:member(1) + package: excel! + fullName: imLn(inumber) + summary: Returns the natural logarithm of a complex number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + imLn(inumber: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: inumber + description: Is a complex number for which you want the natural logarithm. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: imLog10(inumber) + uid: excel!Excel.Functions#imLog10:member(1) + package: excel! + fullName: imLog10(inumber) + summary: Returns the base-10 logarithm of a complex number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + imLog10(inumber: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: inumber + description: Is a complex number for which you want the common logarithm. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: imLog2(inumber) + uid: excel!Excel.Functions#imLog2:member(1) + package: excel! + fullName: imLog2(inumber) + summary: Returns the base-2 logarithm of a complex number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + imLog2(inumber: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: inumber + description: Is a complex number for which you want the base-2 logarithm. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: imPower(inumber, number) + uid: excel!Excel.Functions#imPower:member(1) + package: excel! + fullName: imPower(inumber, number) + summary: Returns a complex number raised to an integer power. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + imPower(inumber: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, number: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: inumber + description: Is a complex number you want to raise to a power. + type: >- + number | string | boolean | | + | <any> + - id: number + description: Is the power to which you want to raise the complex number. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: imProduct(values) + uid: excel!Excel.Functions#imProduct:member(1) + package: excel! + fullName: imProduct(values) + summary: Returns the product of 1 to 255 complex numbers. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + imProduct(...values: Array>): + FunctionResult; + parameters: + - id: values + description: >- + Inumber1, Inumber2,... are from 1 to 255 complex numbers to + multiply. + type: >- + Array< | number | string | + boolean | | + <any>> + return: + type: <number> + description: '' + - name: imReal(inumber) + uid: excel!Excel.Functions#imReal:member(1) + package: excel! + fullName: imReal(inumber) + summary: Returns the real coefficient of a complex number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + imReal(inumber: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: inumber + description: Is a complex number for which you want the real coefficient. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: imSec(inumber) + uid: excel!Excel.Functions#imSec:member(1) + package: excel! + fullName: imSec(inumber) + summary: Returns the secant of a complex number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + imSec(inumber: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: inumber + description: Is a complex number for which you want the secant. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: imSech(inumber) + uid: excel!Excel.Functions#imSech:member(1) + package: excel! + fullName: imSech(inumber) + summary: Returns the hyperbolic secant of a complex number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + imSech(inumber: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: inumber + description: Is a complex number for which you want the hyperbolic secant. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: imSin(inumber) + uid: excel!Excel.Functions#imSin:member(1) + package: excel! + fullName: imSin(inumber) + summary: Returns the sine of a complex number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + imSin(inumber: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: inumber + description: Is a complex number for which you want the sine. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: imSinh(inumber) + uid: excel!Excel.Functions#imSinh:member(1) + package: excel! + fullName: imSinh(inumber) + summary: Returns the hyperbolic sine of a complex number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + imSinh(inumber: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: inumber + description: Is a complex number for which you want the hyperbolic sine. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: imSqrt(inumber) + uid: excel!Excel.Functions#imSqrt:member(1) + package: excel! + fullName: imSqrt(inumber) + summary: Returns the square root of a complex number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + imSqrt(inumber: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: inumber + description: Is a complex number for which you want the square root. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: imSub(inumber1, inumber2) + uid: excel!Excel.Functions#imSub:member(1) + package: excel! + fullName: imSub(inumber1, inumber2) + summary: Returns the difference of two complex numbers. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + imSub(inumber1: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, inumber2: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: inumber1 + description: Is the complex number from which to subtract inumber2. + type: >- + number | string | boolean | | + | <any> + - id: inumber2 + description: Is the complex number to subtract from inumber1. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: imSum(values) + uid: excel!Excel.Functions#imSum:member(1) + package: excel! + fullName: imSum(values) + summary: Returns the sum of complex numbers. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + imSum(...values: Array>): + FunctionResult; + parameters: + - id: values + description: >- + List of parameters, whose elements are from 1 to 255 complex numbers + to add. + type: >- + Array< | number | string | + boolean | | + <any>> + return: + type: <number> + description: '' + - name: imTan(inumber) + uid: excel!Excel.Functions#imTan:member(1) + package: excel! + fullName: imTan(inumber) + summary: Returns the tangent of a complex number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + imTan(inumber: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: inumber + description: Is a complex number for which you want the tangent. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: int(number) + uid: excel!Excel.Functions#int:member(1) + package: excel! + fullName: int(number) + summary: Rounds a number down to the nearest integer. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + int(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: Is the real number you want to round down to an integer. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: intRate(settlement, maturity, investment, redemption, basis) + uid: excel!Excel.Functions#intRate:member(1) + package: excel! + fullName: intRate(settlement, maturity, investment, redemption, basis) + summary: Returns the interest rate for a fully invested security. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + intRate(settlement: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, maturity: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, investment: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, + redemption: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, basis?: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: settlement + description: >- + Is the security's settlement date, expressed as a serial date + number. + type: >- + number | string | boolean | | + | <any> + - id: maturity + description: Is the security's maturity date, expressed as a serial date number. + type: >- + number | string | boolean | | + | <any> + - id: investment + description: Is the amount invested in the security. + type: >- + number | string | boolean | | + | <any> + - id: redemption + description: Is the amount to be received at maturity. + type: >- + number | string | boolean | | + | <any> + - id: basis + description: Is the type of day count basis to use. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: ipmt(rate, per, nper, pv, fv, type) + uid: excel!Excel.Functions#ipmt:member(1) + package: excel! + fullName: ipmt(rate, per, nper, pv, fv, type) + summary: >- + Returns the interest payment for a given period for an investment, based + on periodic, constant payments and a constant interest rate. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + ipmt(rate: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, per: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, nper: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, pv: + number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, + fv?: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, type?: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: rate + description: >- + Is the interest rate per period. For example, use 6%/4 for quarterly + payments at 6% APR. + type: >- + number | | | <any> + - id: per + description: >- + Is the period for which you want to find the interest and must be in + the range 1 to Nper. + type: >- + number | | | <any> + - id: nper + description: Is the total number of payment periods in an investment. + type: >- + number | | | <any> + - id: pv + description: >- + Is the present value, or the lump-sum amount that a series of future + payments is worth now. + type: >- + number | | | <any> + - id: fv + description: >- + Is the future value, or a cash balance you want to attain after the + last payment is made. If omitted, Fv = 0. + type: >- + number | | | <any> + - id: type + description: >- + Is a logical value representing the timing of payment: at the end of + the period = 0 or omitted, at the beginning of the period = 1. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: irr(values, guess) + uid: excel!Excel.Functions#irr:member(1) + package: excel! + fullName: irr(values, guess) + summary: Returns the internal rate of return for a series of cash flows. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + irr(values: Excel.Range | Excel.RangeReference | + Excel.FunctionResult, guess?: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: values + description: >- + Is an array or a reference to cells that contain numbers for which + you want to calculate the internal rate of return. + type: >- + | | <any> + - id: guess + description: >- + Is a number that you guess is close to the result of IRR; 0.1 (10 + percent) if omitted. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: isErr(value) + uid: excel!Excel.Functions#isErr:member(1) + package: excel! + fullName: isErr(value) + summary: >- + Checks whether a value is an error other than \#N/A, and returns TRUE or + FALSE. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + isErr(value: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: value + description: >- + Is the value you want to test. Value can refer to a cell, a formula, + or a name that refers to a cell, formula, or value. + type: >- + number | string | boolean | | + | <any> + return: + type: <boolean> + description: '' + - name: isError(value) + uid: excel!Excel.Functions#isError:member(1) + package: excel! + fullName: isError(value) + summary: Checks whether a value is an error, and returns TRUE or FALSE. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + isError(value: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: value + description: >- + Is the value you want to test. Value can refer to a cell, a formula, + or a name that refers to a cell, formula, or value. + type: >- + number | string | boolean | | + | <any> + return: + type: <boolean> + description: '' + - name: isEven(number) + uid: excel!Excel.Functions#isEven:member(1) + package: excel! + fullName: isEven(number) + summary: Returns TRUE if the number is even. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + isEven(number: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: number + description: Is the value to test. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: isFormula(reference) + uid: excel!Excel.Functions#isFormula:member(1) + package: excel! + fullName: isFormula(reference) + summary: >- + Checks whether a reference is to a cell containing a formula, and returns + TRUE or FALSE. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + isFormula(reference: Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: reference + description: >- + Is a reference to the cell you want to test. Reference can be a cell + reference, a formula, or name that refers to a cell. + type: >- + | | <any> + return: + type: <boolean> + description: '' + - name: isLogical(value) + uid: excel!Excel.Functions#isLogical:member(1) + package: excel! + fullName: isLogical(value) + summary: >- + Checks whether a value is a logical value (TRUE or FALSE), and returns + TRUE or FALSE. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + isLogical(value: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: value + description: >- + Is the value you want to test. Value can refer to a cell, a formula, + or a name that refers to a cell, formula, or value. + type: >- + number | string | boolean | | + | <any> + return: + type: <boolean> + description: '' + - name: isNA(value) + uid: excel!Excel.Functions#isNA:member(1) + package: excel! + fullName: isNA(value) + summary: Checks whether a value is \#N/A, and returns TRUE or FALSE. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + isNA(value: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: value + description: >- + Is the value you want to test. Value can refer to a cell, a formula, + or a name that refers to a cell, formula, or value. + type: >- + number | string | boolean | | + | <any> + return: + type: <boolean> + description: '' + - name: isNonText(value) + uid: excel!Excel.Functions#isNonText:member(1) + package: excel! + fullName: isNonText(value) + summary: >- + Checks whether a value is not text (blank cells are not text), and returns + TRUE or FALSE. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + isNonText(value: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: value + description: >- + Is the value you want tested: a cell; a formula; or a name referring + to a cell, formula, or value. + type: >- + number | string | boolean | | + | <any> + return: + type: <boolean> + description: '' + - name: isNumber(value) + uid: excel!Excel.Functions#isNumber:member(1) + package: excel! + fullName: isNumber(value) + summary: Checks whether a value is a number, and returns TRUE or FALSE. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + isNumber(value: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: value + description: >- + Is the value you want to test. Value can refer to a cell, a formula, + or a name that refers to a cell, formula, or value. + type: >- + number | string | boolean | | + | <any> + return: + type: <boolean> + description: '' + - name: iso_Ceiling(number, significance) + uid: excel!Excel.Functions#iso_Ceiling:member(1) + package: excel! + fullName: iso_Ceiling(number, significance) + summary: >- + Rounds a number up, to the nearest integer or to the nearest multiple of + significance. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + iso_Ceiling(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, significance?: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: number + description: Is the value you want to round. + type: >- + number | | | <any> + - id: significance + description: Is the optional multiple to which you want to round. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: isOdd(number) + uid: excel!Excel.Functions#isOdd:member(1) + package: excel! + fullName: isOdd(number) + summary: Returns TRUE if the number is odd. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + isOdd(number: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: number + description: Is the value to test. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: isoWeekNum(date) + uid: excel!Excel.Functions#isoWeekNum:member(1) + package: excel! + fullName: isoWeekNum(date) + summary: Returns the ISO week number in the year for a given date. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + isoWeekNum(date: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: date + description: >- + Is the date-time code used by Microsoft Excel for date and time + calculation. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: ispmt(rate, per, nper, pv) + uid: excel!Excel.Functions#ispmt:member(1) + package: excel! + fullName: ispmt(rate, per, nper, pv) + summary: Returns the interest paid during a specific period of an investment. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + ispmt(rate: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, per: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, nper: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, pv: + number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: rate + description: >- + Interest rate per period. For example, use 6%/4 for quarterly + payments at 6% APR. + type: >- + number | | | <any> + - id: per + description: Period for which you want to find the interest. + type: >- + number | | | <any> + - id: nper + description: Number of payment periods in an investment. + type: >- + number | | | <any> + - id: pv + description: Lump sum amount that a series of future payments is right now. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: isref(value) + uid: excel!Excel.Functions#isref:member(1) + package: excel! + fullName: isref(value) + summary: Checks whether a value is a reference, and returns TRUE or FALSE. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + isref(value: Excel.Range | number | string | boolean | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: value + description: >- + Is the value you want to test. Value can refer to a cell, a formula, + or a name that refers to a cell, formula, or value. + type: >- + | number | string | boolean | + | <any> + return: + type: <boolean> + description: '' + - name: isText(value) + uid: excel!Excel.Functions#isText:member(1) + package: excel! + fullName: isText(value) + summary: Checks whether a value is text, and returns TRUE or FALSE. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + isText(value: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: value + description: >- + Is the value you want to test. Value can refer to a cell, a formula, + or a name that refers to a cell, formula, or value. + type: >- + number | string | boolean | | + | <any> + return: + type: <boolean> + description: '' + - name: kurt(values) + uid: excel!Excel.Functions#kurt:member(1) + package: excel! + fullName: kurt(values) + summary: Returns the kurtosis of a data set. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + kurt(...values: Array>): FunctionResult; + parameters: + - id: values + description: >- + List of parameters, whose elements are 1 to 255 numbers or names, + arrays, or references that contain numbers for which you want the + kurtosis. + type: >- + Array<number | | | <any>> + return: + type: <number> + description: '' + - name: large(array, k) + uid: excel!Excel.Functions#large:member(1) + package: excel! + fullName: large(array, k) + summary: >- + Returns the k-th largest value in a data set. For example, the fifth + largest number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + large(array: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, k: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: array + description: >- + Is the array or range of data for which you want to determine the + k-th largest value. + type: >- + number | | | <any> + - id: k + description: >- + Is the position (from the largest) in the array or cell range of the + value to return. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: lcm(values) + uid: excel!Excel.Functions#lcm:member(1) + package: excel! + fullName: lcm(values) + summary: Returns the least common multiple. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + lcm(...values: Array>): + FunctionResult; + parameters: + - id: values + description: >- + List of parameters, whose elements are 1 to 255 values for which you + want the least common multiple. + type: >- + Array<number | string | | + boolean | | + <any>> + return: + type: <number> + description: '' + - name: left(text, numChars) + uid: excel!Excel.Functions#left:member(1) + package: excel! + fullName: left(text, numChars) + summary: >- + Returns the specified number of characters from the start of a text + string. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + left(text: string | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, numChars?: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: text + description: Is the text string containing the characters you want to extract. + type: >- + string | | | <any> + - id: numChars + description: >- + Specifies how many characters you want LEFT to extract; 1 if + omitted. + type: >- + number | | | <any> + return: + type: <string> + description: '' + - name: leftb(text, numBytes) + uid: excel!Excel.Functions#leftb:member(1) + package: excel! + fullName: leftb(text, numBytes) + summary: >- + Returns the specified number of characters from the start of a text + string. Use with double-byte character sets (DBCS). + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + leftb(text: string | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, numBytes?: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: text + description: Is the text string containing the characters you want to extract. + type: >- + string | | | <any> + - id: numBytes + description: Specifies how many characters you want LEFT to return. + type: >- + number | | | <any> + return: + type: <string> + description: '' + - name: len(text) + uid: excel!Excel.Functions#len:member(1) + package: excel! + fullName: len(text) + summary: Returns the number of characters in a text string. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + len(text: string | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: text + description: >- + Is the text whose length you want to find. Spaces count as + characters. + type: >- + string | | | <any> + return: + type: <number> + description: '' + - name: lenb(text) + uid: excel!Excel.Functions#lenb:member(1) + package: excel! + fullName: lenb(text) + summary: >- + Returns the number of characters in a text string. Use with double-byte + character sets (DBCS). + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + lenb(text: string | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: text + description: Is the text whose length you want to find. + type: >- + string | | | <any> + return: + type: <number> + description: '' + - name: ln(number) + uid: excel!Excel.Functions#ln:member(1) + package: excel! + fullName: ln(number) + summary: Returns the natural logarithm of a number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + ln(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: >- + Is the positive real number for which you want the natural + logarithm. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: log(number, base) + uid: excel!Excel.Functions#log:member(1) + package: excel! + fullName: log(number, base) + summary: Returns the logarithm of a number to the base you specify. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + log(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, base?: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: number + description: Is the positive real number for which you want the logarithm. + type: >- + number | | | <any> + - id: base + description: Is the base of the logarithm; 10 if omitted. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: log10(number) + uid: excel!Excel.Functions#log10:member(1) + package: excel! + fullName: log10(number) + summary: Returns the base-10 logarithm of a number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + log10(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: >- + Is the positive real number for which you want the base-10 + logarithm. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: logNorm_Dist(x, mean, standardDev, cumulative) + uid: excel!Excel.Functions#logNorm_Dist:member(1) + package: excel! + fullName: logNorm_Dist(x, mean, standardDev, cumulative) + summary: >- + Returns the lognormal distribution of x, where ln(x) is normally + distributed with parameters Mean and Standard\_dev. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + logNorm_Dist(x: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, mean: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, standardDev: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, + cumulative: boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: x + description: Is the value at which to evaluate the function, a positive number. + type: >- + number | | | <any> + - id: mean + description: Is the mean of ln(x). + type: >- + number | | | <any> + - id: standardDev + description: Is the standard deviation of ln(x), a positive number. + type: >- + number | | | <any> + - id: cumulative + description: >- + Is a logical value: for the cumulative distribution function, use + TRUE; for the probability density function, use FALSE. + type: >- + boolean | | | <any> + return: + type: <number> + description: '' + - name: logNorm_Inv(probability, mean, standardDev) + uid: excel!Excel.Functions#logNorm_Inv:member(1) + package: excel! + fullName: logNorm_Inv(probability, mean, standardDev) + summary: >- + Returns the inverse of the lognormal cumulative distribution function of + x, where ln(x) is normally distributed with parameters Mean and + Standard\_dev. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + logNorm_Inv(probability: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, mean: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, standardDev: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: probability + description: >- + Is a probability associated with the lognormal distribution, a + number between 0 and 1, inclusive. + type: >- + number | | | <any> + - id: mean + description: Is the mean of ln(x). + type: >- + number | | | <any> + - id: standardDev + description: Is the standard deviation of ln(x), a positive number. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: lookup(lookupValue, lookupVector, resultVector) + uid: excel!Excel.Functions#lookup:member(1) + package: excel! + fullName: lookup(lookupValue, lookupVector, resultVector) + summary: >- + Looks up a value either from a one-row or one-column range or from an + array. Provided for backward compatibility. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + lookup(lookupValue: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, lookupVector: + Excel.Range | Excel.RangeReference | Excel.FunctionResult, + resultVector?: Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: lookupValue + description: >- + Is a value that LOOKUP searches for in lookupVector and can be a + number, text, a logical value, or a name or reference to a value. + type: >- + number | string | boolean | | + | <any> + - id: lookupVector + description: >- + Is a range that contains only one row or one column of text, + numbers, or logical values, placed in ascending order. + type: >- + | | <any> + - id: resultVector + description: >- + Is a range that contains only one row or column, the same size as + lookupVector. + type: >- + | | <any> + return: + type: >- + <number | string | + boolean> + description: '' + - name: lower(text) + uid: excel!Excel.Functions#lower:member(1) + package: excel! + fullName: lower(text) + summary: Converts all letters in a text string to lowercase. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + lower(text: string | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: text + description: >- + Is the text you want to convert to lowercase. Characters in Text + that are not letters are not changed. + type: >- + string | | | <any> + return: + type: <string> + description: '' + - name: match(lookupValue, lookupArray, matchType) + uid: excel!Excel.Functions#match:member(1) + package: excel! + fullName: match(lookupValue, lookupArray, matchType) + summary: >- + Returns the relative position of an item in an array that matches a + specified value in a specified order. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + match(lookupValue: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, lookupArray: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, + matchType?: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: lookupValue + description: >- + Is the value you use to find the value you want in the array, a + number, text, or logical value, or a reference to one of these. + type: >- + number | string | boolean | | + | <any> + - id: lookupArray + description: >- + Is a contiguous range of cells containing possible lookup values, an + array of values, or a reference to an array. + type: >- + number | | | <any> + - id: matchType + description: Is a number 1, 0, or -1 indicating which value to return. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: max(values) + uid: excel!Excel.Functions#max:member(1) + package: excel! + fullName: max(values) + summary: >- + Returns the largest value in a set of values. Ignores logical values and + text. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + max(...values: Array>): FunctionResult; + parameters: + - id: values + description: >- + List of parameters, whose elements are 1 to 255 numbers, empty + cells, logical values, or text numbers for which you want the + maximum. + type: >- + Array<number | | | <any>> + return: + type: <number> + description: '' + - name: maxA(values) + uid: excel!Excel.Functions#maxA:member(1) + package: excel! + fullName: maxA(values) + summary: >- + Returns the largest value in a set of values. Does not ignore logical + values and text. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + maxA(...values: Array>): FunctionResult; + parameters: + - id: values + description: >- + List of parameters, whose elements are 1 to 255 numbers, empty + cells, logical values, or text numbers for which you want the + maximum. + type: >- + Array<number | | | <any>> + return: + type: <number> + description: '' + - name: mduration(settlement, maturity, coupon, yld, frequency, basis) + uid: excel!Excel.Functions#mduration:member(1) + package: excel! + fullName: mduration(settlement, maturity, coupon, yld, frequency, basis) + summary: >- + Returns the Macauley modified duration for a security with an assumed par + value of $100. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + mduration(settlement: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, maturity: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, coupon: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, yld: + number | string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, frequency: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, basis?: + number | string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: settlement + description: >- + Is the security's settlement date, expressed as a serial date + number. + type: >- + number | string | boolean | | + | <any> + - id: maturity + description: Is the security's maturity date, expressed as a serial date number. + type: >- + number | string | boolean | | + | <any> + - id: coupon + description: Is the security's annual coupon rate. + type: >- + number | string | boolean | | + | <any> + - id: yld + description: Is the security's annual yield. + type: >- + number | string | boolean | | + | <any> + - id: frequency + description: Is the number of coupon payments per year. + type: >- + number | string | boolean | | + | <any> + - id: basis + description: Is the type of day count basis to use. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: median(values) + uid: excel!Excel.Functions#median:member(1) + package: excel! + fullName: median(values) + summary: >- + Returns the median, or the number in the middle of the set of given + numbers. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + median(...values: Array>): FunctionResult; + parameters: + - id: values + description: >- + List of parameters, whose elements are 1 to 255 numbers or names, + arrays, or references that contain numbers for which you want the + median. + type: >- + Array<number | | | <any>> + return: + type: <number> + description: '' + - name: mid(text, startNum, numChars) + uid: excel!Excel.Functions#mid:member(1) + package: excel! + fullName: mid(text, startNum, numChars) + summary: >- + Returns the characters from the middle of a text string, given a starting + position and length. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + mid(text: string | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, startNum: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, numChars: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: text + description: Is the text string from which you want to extract the characters. + type: >- + string | | | <any> + - id: startNum + description: >- + Is the position of the first character you want to extract. The + first character in Text is 1. + type: >- + number | | | <any> + - id: numChars + description: Specifies how many characters to return from Text. + type: >- + number | | | <any> + return: + type: <string> + description: '' + - name: midb(text, startNum, numBytes) + uid: excel!Excel.Functions#midb:member(1) + package: excel! + fullName: midb(text, startNum, numBytes) + summary: >- + Returns characters from the middle of a text string, given a starting + position and length. Use with double-byte character sets (DBCS). + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + midb(text: string | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, startNum: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, numBytes: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: text + description: Is the text string containing the characters you want to extract. + type: >- + string | | | <any> + - id: startNum + description: Is the position of the first character you want to extract in text. + type: >- + number | | | <any> + - id: numBytes + description: Specifies how many characters to return from text. + type: >- + number | | | <any> + return: + type: <string> + description: '' + - name: min(values) + uid: excel!Excel.Functions#min:member(1) + package: excel! + fullName: min(values) + summary: >- + Returns the smallest number in a set of values. Ignores logical values and + text. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + min(...values: Array>): FunctionResult; + parameters: + - id: values + description: >- + List of parameters, whose elements are 1 to 255 numbers, empty + cells, logical values, or text numbers for which you want the + minimum. + type: >- + Array<number | | | <any>> + return: + type: <number> + description: '' + - name: minA(values) + uid: excel!Excel.Functions#minA:member(1) + package: excel! + fullName: minA(values) + summary: >- + Returns the smallest value in a set of values. Does not ignore logical + values and text. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + minA(...values: Array>): FunctionResult; + parameters: + - id: values + description: >- + List of parameters, whose elements are 1 to 255 numbers, empty + cells, logical values, or text numbers for which you want the + minimum. + type: >- + Array<number | | | <any>> + return: + type: <number> + description: '' + - name: minute(serialNumber) + uid: excel!Excel.Functions#minute:member(1) + package: excel! + fullName: minute(serialNumber) + summary: Returns the minute, a number from 0 to 59. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + minute(serialNumber: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: serialNumber + description: >- + Is a number in the date-time code used by Microsoft Excel or text in + time format, such as 16:48:00 or 4:48:00 PM. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: mirr(values, financeRate, reinvestRate) + uid: excel!Excel.Functions#mirr:member(1) + package: excel! + fullName: mirr(values, financeRate, reinvestRate) + summary: >- + Returns the internal rate of return for a series of periodic cash flows, + considering both cost of investment and interest on reinvestment of cash. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + mirr(values: Excel.Range | Excel.RangeReference | + Excel.FunctionResult, financeRate: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, reinvestRate: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: values + description: >- + Is an array or a reference to cells that contain numbers that + represent a series of payments (negative) and income (positive) at + regular periods. + type: >- + | | <any> + - id: financeRate + description: Is the interest rate you pay on the money used in the cash flows. + type: >- + number | | | <any> + - id: reinvestRate + description: >- + Is the interest rate you receive on the cash flows as you reinvest + them. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: mod(number, divisor) + uid: excel!Excel.Functions#mod:member(1) + package: excel! + fullName: mod(number, divisor) + summary: Returns the remainder after a number is divided by a divisor. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + mod(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, divisor: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: number + description: >- + Is the number for which you want to find the remainder after the + division is performed. + type: >- + number | | | <any> + - id: divisor + description: Is the number by which you want to divide Number. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: month(serialNumber) + uid: excel!Excel.Functions#month:member(1) + package: excel! + fullName: month(serialNumber) + summary: Returns the month, a number from 1 (January) to 12 (December). + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + month(serialNumber: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: serialNumber + description: Is a number in the date-time code used by Microsoft Excel. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: mround(number, multiple) + uid: excel!Excel.Functions#mround:member(1) + package: excel! + fullName: mround(number, multiple) + summary: Returns a number rounded to the desired multiple. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + mround(number: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, multiple: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: Is the value to round. + type: >- + number | string | boolean | | + | <any> + - id: multiple + description: Is the multiple to which you want to round number. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: multiNomial(values) + uid: excel!Excel.Functions#multiNomial:member(1) + package: excel! + fullName: multiNomial(values) + summary: Returns the multinomial of a set of numbers. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + multiNomial(...values: Array>): + FunctionResult; + parameters: + - id: values + description: >- + List of parameters, whose elements are 1 to 255 values for which you + want the multinomial. + type: >- + Array<number | string | | + boolean | | + <any>> + return: + type: <number> + description: '' + - name: n(value) + uid: excel!Excel.Functions#n:member(1) + package: excel! + fullName: n(value) + summary: >- + Converts non-number value to a number, dates to serial numbers, TRUE to 1, + anything else to 0 (zero). + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + n(value: number | string | boolean | Excel.Range | Excel.RangeReference + | Excel.FunctionResult): FunctionResult; + parameters: + - id: value + description: Is the value you want converted. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: na() + uid: excel!Excel.Functions#na:member(1) + package: excel! + fullName: na() + summary: Returns the error value \#N/A (value not available). + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'na(): FunctionResult;' + return: + type: <number | string> + description: '' + - name: negBinom_Dist(numberF, numberS, probabilityS, cumulative) + uid: excel!Excel.Functions#negBinom_Dist:member(1) + package: excel! + fullName: negBinom_Dist(numberF, numberS, probabilityS, cumulative) + summary: >- + Returns the negative binomial distribution, the probability that there + will be Number\_f failures before the Number\_s-th success, with + Probability\_s probability of a success. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + negBinom_Dist(numberF: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, numberS: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, probabilityS: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, + cumulative: boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: numberF + description: Is the number of failures. + type: >- + number | | | <any> + - id: numberS + description: Is the threshold number of successes. + type: >- + number | | | <any> + - id: probabilityS + description: Is the probability of a success; a number between 0 and 1. + type: >- + number | | | <any> + - id: cumulative + description: >- + Is a logical value: for the cumulative distribution function, use + TRUE; for the probability mass function, use FALSE. + type: >- + boolean | | | <any> + return: + type: <number> + description: '' + - name: networkDays_Intl(startDate, endDate, weekend, holidays) + uid: excel!Excel.Functions#networkDays_Intl:member(1) + package: excel! + fullName: networkDays_Intl(startDate, endDate, weekend, holidays) + summary: >- + Returns the number of whole workdays between two dates with custom weekend + parameters. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + networkDays_Intl(startDate: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, endDate: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, weekend?: number | string | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, holidays?: number | + string | Excel.Range | boolean | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: startDate + description: Is a serial date number that represents the start date. + type: >- + number | string | boolean | | + | <any> + - id: endDate + description: Is a serial date number that represents the end date. + type: >- + number | string | boolean | | + | <any> + - id: weekend + description: Is a number or string specifying when weekends occur. + type: >- + number | string | | | <any> + - id: holidays + description: >- + Is an optional set of one or more serial date numbers to exclude + from the working calendar, such as state and federal holidays and + floating holidays. + type: >- + number | string | | boolean | + | <any> + return: + type: <number> + description: '' + - name: networkDays(startDate, endDate, holidays) + uid: excel!Excel.Functions#networkDays:member(1) + package: excel! + fullName: networkDays(startDate, endDate, holidays) + summary: Returns the number of whole workdays between two dates. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + networkDays(startDate: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, endDate: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, holidays?: number | string | Excel.Range | + boolean | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: startDate + description: Is a serial date number that represents the start date. + type: >- + number | string | boolean | | + | <any> + - id: endDate + description: Is a serial date number that represents the end date. + type: >- + number | string | boolean | | + | <any> + - id: holidays + description: >- + Is an optional set of one or more serial date numbers to exclude + from the working calendar, such as state and federal holidays and + floating holidays. + type: >- + number | string | | boolean | + | <any> + return: + type: <number> + description: '' + - name: nominal(effectRate, npery) + uid: excel!Excel.Functions#nominal:member(1) + package: excel! + fullName: nominal(effectRate, npery) + summary: Returns the annual nominal interest rate. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + nominal(effectRate: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, npery: number | string + | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: effectRate + description: Is the effective interest rate. + type: >- + number | string | boolean | | + | <any> + - id: npery + description: Is the number of compounding periods per year. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: norm_Dist(x, mean, standardDev, cumulative) + uid: excel!Excel.Functions#norm_Dist:member(1) + package: excel! + fullName: norm_Dist(x, mean, standardDev, cumulative) + summary: >- + Returns the normal distribution for the specified mean and standard + deviation. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + norm_Dist(x: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, mean: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, standardDev: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, + cumulative: boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: x + description: Is the value for which you want the distribution. + type: >- + number | | | <any> + - id: mean + description: Is the arithmetic mean of the distribution. + type: >- + number | | | <any> + - id: standardDev + description: Is the standard deviation of the distribution, a positive number. + type: >- + number | | | <any> + - id: cumulative + description: >- + Is a logical value: for the cumulative distribution function, use + TRUE; for the probability density function, use FALSE. + type: >- + boolean | | | <any> + return: + type: <number> + description: '' + - name: norm_Inv(probability, mean, standardDev) + uid: excel!Excel.Functions#norm_Inv:member(1) + package: excel! + fullName: norm_Inv(probability, mean, standardDev) + summary: >- + Returns the inverse of the normal cumulative distribution for the + specified mean and standard deviation. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + norm_Inv(probability: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, mean: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, standardDev: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: probability + description: >- + Is a probability corresponding to the normal distribution, a number + between 0 and 1 inclusive. + type: >- + number | | | <any> + - id: mean + description: Is the arithmetic mean of the distribution. + type: >- + number | | | <any> + - id: standardDev + description: Is the standard deviation of the distribution, a positive number. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: norm_S_Dist(z, cumulative) + uid: excel!Excel.Functions#norm_S_Dist:member(1) + package: excel! + fullName: norm_S_Dist(z, cumulative) + summary: >- + Returns the standard normal distribution (has a mean of zero and a + standard deviation of one). + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + norm_S_Dist(z: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, cumulative: boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: z + description: Is the value for which you want the distribution. + type: >- + number | | | <any> + - id: cumulative + description: >- + Is a logical value for the function to return: the cumulative + distribution function = TRUE; the probability density function = + FALSE. + type: >- + boolean | | | <any> + return: + type: <number> + description: '' + - name: norm_S_Inv(probability) + uid: excel!Excel.Functions#norm_S_Inv:member(1) + package: excel! + fullName: norm_S_Inv(probability) + summary: >- + Returns the inverse of the standard normal cumulative distribution (has a + mean of zero and a standard deviation of one). + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + norm_S_Inv(probability: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: probability + description: >- + Is a probability corresponding to the normal distribution, a number + between 0 and 1 inclusive. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: not(logical) + uid: excel!Excel.Functions#not:member(1) + package: excel! + fullName: not(logical) + summary: Changes FALSE to TRUE, or TRUE to FALSE. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + not(logical: boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: logical + description: Is a value or expression that can be evaluated to TRUE or FALSE. + type: >- + boolean | | | <any> + return: + type: <boolean> + description: '' + - name: now() + uid: excel!Excel.Functions#now:member(1) + package: excel! + fullName: now() + summary: Returns the current date and time formatted as a date and time. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'now(): FunctionResult;' + return: + type: <number> + description: '' + - name: nper(rate, pmt, pv, fv, type) + uid: excel!Excel.Functions#nper:member(1) + package: excel! + fullName: nper(rate, pmt, pv, fv, type) + summary: >- + Returns the number of periods for an investment based on periodic, + constant payments and a constant interest rate. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + nper(rate: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, pmt: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, pv: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, fv?: + number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, + type?: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: rate + description: >- + Is the interest rate per period. For example, use 6%/4 for quarterly + payments at 6% APR. + type: >- + number | | | <any> + - id: pmt + description: >- + Is the payment made each period; it cannot change over the life of + the investment. + type: >- + number | | | <any> + - id: pv + description: >- + Is the present value, or the lump-sum amount that a series of future + payments is worth now. + type: >- + number | | | <any> + - id: fv + description: >- + Is the future value, or a cash balance you want to attain after the + last payment is made. If omitted, zero is used. + type: >- + number | | | <any> + - id: type + description: >- + Is a logical value: payment at the beginning of the period = 1; + payment at the end of the period = 0 or omitted. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: npv(rate, values) + uid: excel!Excel.Functions#npv:member(1) + package: excel! + fullName: npv(rate, values) + summary: >- + Returns the net present value of an investment based on a discount rate + and a series of future payments (negative values) and income (positive + values). + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + npv(rate: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, ...values: Array>): + FunctionResult; + parameters: + - id: rate + description: Is the rate of discount over the length of one period. + type: >- + number | | | <any> + - id: values + description: >- + List of parameters, whose elements are 1 to 254 payments and income, + equally spaced in time and occurring at the end of each period. + type: >- + Array<number | | | <any>> + return: + type: <number> + description: '' + - name: numberValue(text, decimalSeparator, groupSeparator) + uid: excel!Excel.Functions#numberValue:member(1) + package: excel! + fullName: numberValue(text, decimalSeparator, groupSeparator) + summary: Converts text to number in a locale-independent manner. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + numberValue(text: string | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, decimalSeparator?: string | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, groupSeparator?: + string | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: text + description: Is the string representing the number you want to convert. + type: >- + string | | | <any> + - id: decimalSeparator + description: Is the character used as the decimal separator in the string. + type: >- + string | | | <any> + - id: groupSeparator + description: Is the character used as the group separator in the string. + type: >- + string | | | <any> + return: + type: <number> + description: '' + - name: oct2Bin(number, places) + uid: excel!Excel.Functions#oct2Bin:member(1) + package: excel! + fullName: oct2Bin(number, places) + summary: Converts an octal number to binary. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + oct2Bin(number: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, places?: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: Is the octal number you want to convert. + type: >- + number | string | boolean | | + | <any> + - id: places + description: Is the number of characters to use. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: oct2Dec(number) + uid: excel!Excel.Functions#oct2Dec:member(1) + package: excel! + fullName: oct2Dec(number) + summary: Converts an octal number to decimal. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + oct2Dec(number: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: number + description: Is the octal number you want to convert. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: oct2Hex(number, places) + uid: excel!Excel.Functions#oct2Hex:member(1) + package: excel! + fullName: oct2Hex(number, places) + summary: Converts an octal number to hexadecimal. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + oct2Hex(number: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, places?: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: Is the octal number you want to convert. + type: >- + number | string | boolean | | + | <any> + - id: places + description: Is the number of characters to use. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: odd(number) + uid: excel!Excel.Functions#odd:member(1) + package: excel! + fullName: odd(number) + summary: >- + Rounds a positive number up and negative number down to the nearest odd + integer. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + odd(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: Is the value to round. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: >- + oddFPrice(settlement, maturity, issue, firstCoupon, rate, yld, redemption, + frequency, basis) + uid: excel!Excel.Functions#oddFPrice:member(1) + package: excel! + fullName: >- + oddFPrice(settlement, maturity, issue, firstCoupon, rate, yld, redemption, + frequency, basis) + summary: >- + Returns the price per $100 face value of a security with an odd first + period. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + oddFPrice(settlement: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, maturity: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, issue: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, + firstCoupon: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, rate: number | string + | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, yld: number | string | boolean | Excel.Range + | Excel.RangeReference | Excel.FunctionResult, redemption: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, frequency: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, basis?: + number | string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: settlement + description: >- + Is the security's settlement date, expressed as a serial date + number. + type: >- + number | string | boolean | | + | <any> + - id: maturity + description: Is the security's maturity date, expressed as a serial date number. + type: >- + number | string | boolean | | + | <any> + - id: issue + description: Is the security's issue date, expressed as a serial date number. + type: >- + number | string | boolean | | + | <any> + - id: firstCoupon + description: >- + Is the security's first coupon date, expressed as a serial date + number. + type: >- + number | string | boolean | | + | <any> + - id: rate + description: Is the security's interest rate. + type: >- + number | string | boolean | | + | <any> + - id: yld + description: Is the security's annual yield. + type: >- + number | string | boolean | | + | <any> + - id: redemption + description: Is the security's redemption value per $100 face value. + type: >- + number | string | boolean | | + | <any> + - id: frequency + description: Is the number of coupon payments per year. + type: >- + number | string | boolean | | + | <any> + - id: basis + description: Is the type of day count basis to use. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: >- + oddFYield(settlement, maturity, issue, firstCoupon, rate, pr, redemption, + frequency, basis) + uid: excel!Excel.Functions#oddFYield:member(1) + package: excel! + fullName: >- + oddFYield(settlement, maturity, issue, firstCoupon, rate, pr, redemption, + frequency, basis) + summary: Returns the yield of a security with an odd first period. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + oddFYield(settlement: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, maturity: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, issue: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, + firstCoupon: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, rate: number | string + | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, pr: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, redemption: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, frequency: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, basis?: + number | string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: settlement + description: >- + Is the security's settlement date, expressed as a serial date + number. + type: >- + number | string | boolean | | + | <any> + - id: maturity + description: Is the security's maturity date, expressed as a serial date number. + type: >- + number | string | boolean | | + | <any> + - id: issue + description: Is the security's issue date, expressed as a serial date number. + type: >- + number | string | boolean | | + | <any> + - id: firstCoupon + description: >- + Is the security's first coupon date, expressed as a serial date + number. + type: >- + number | string | boolean | | + | <any> + - id: rate + description: Is the security's interest rate. + type: >- + number | string | boolean | | + | <any> + - id: pr + description: Is the security's price. + type: >- + number | string | boolean | | + | <any> + - id: redemption + description: Is the security's redemption value per $100 face value. + type: >- + number | string | boolean | | + | <any> + - id: frequency + description: Is the number of coupon payments per year. + type: >- + number | string | boolean | | + | <any> + - id: basis + description: Is the type of day count basis to use. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: >- + oddLPrice(settlement, maturity, lastInterest, rate, yld, redemption, + frequency, basis) + uid: excel!Excel.Functions#oddLPrice:member(1) + package: excel! + fullName: >- + oddLPrice(settlement, maturity, lastInterest, rate, yld, redemption, + frequency, basis) + summary: >- + Returns the price per $100 face value of a security with an odd last + period. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + oddLPrice(settlement: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, maturity: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, lastInterest: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, rate: + number | string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, yld: number | string | boolean | Excel.Range + | Excel.RangeReference | Excel.FunctionResult, redemption: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, frequency: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, basis?: + number | string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: settlement + description: >- + Is the security's settlement date, expressed as a serial date + number. + type: >- + number | string | boolean | | + | <any> + - id: maturity + description: Is the security's maturity date, expressed as a serial date number. + type: >- + number | string | boolean | | + | <any> + - id: lastInterest + description: >- + Is the security's last coupon date, expressed as a serial date + number. + type: >- + number | string | boolean | | + | <any> + - id: rate + description: Is the security's interest rate. + type: >- + number | string | boolean | | + | <any> + - id: yld + description: Is the security's annual yield. + type: >- + number | string | boolean | | + | <any> + - id: redemption + description: Is the security's redemption value per $100 face value. + type: >- + number | string | boolean | | + | <any> + - id: frequency + description: Is the number of coupon payments per year. + type: >- + number | string | boolean | | + | <any> + - id: basis + description: Is the type of day count basis to use. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: >- + oddLYield(settlement, maturity, lastInterest, rate, pr, redemption, + frequency, basis) + uid: excel!Excel.Functions#oddLYield:member(1) + package: excel! + fullName: >- + oddLYield(settlement, maturity, lastInterest, rate, pr, redemption, + frequency, basis) + summary: Returns the yield of a security with an odd last period. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + oddLYield(settlement: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, maturity: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, lastInterest: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, rate: + number | string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, pr: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, redemption: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, frequency: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, basis?: + number | string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: settlement + description: >- + Is the security's settlement date, expressed as a serial date + number. + type: >- + number | string | boolean | | + | <any> + - id: maturity + description: Is the security's maturity date, expressed as a serial date number. + type: >- + number | string | boolean | | + | <any> + - id: lastInterest + description: >- + Is the security's last coupon date, expressed as a serial date + number. + type: >- + number | string | boolean | | + | <any> + - id: rate + description: Is the security's interest rate. + type: >- + number | string | boolean | | + | <any> + - id: pr + description: Is the security's price. + type: >- + number | string | boolean | | + | <any> + - id: redemption + description: Is the security's redemption value per $100 face value. + type: >- + number | string | boolean | | + | <any> + - id: frequency + description: Is the number of coupon payments per year. + type: >- + number | string | boolean | | + | <any> + - id: basis + description: Is the type of day count basis to use. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: or(values) + uid: excel!Excel.Functions#or:member(1) + package: excel! + fullName: or(values) + summary: >- + Checks whether any of the arguments are TRUE, and returns TRUE or FALSE. + Returns FALSE only if all arguments are FALSE. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + or(...values: Array>): FunctionResult; + parameters: + - id: values + description: >- + List of parameters, whose elements are 1 to 255 conditions that you + want to test that can be either TRUE or FALSE. + type: >- + Array<boolean | | | <any>> + return: + type: <boolean> + description: '' + - name: pduration(rate, pv, fv) + uid: excel!Excel.Functions#pduration:member(1) + package: excel! + fullName: pduration(rate, pv, fv) + summary: >- + Returns the number of periods required by an investment to reach a + specified value. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + pduration(rate: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, pv: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, fv: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: rate + description: Is the interest rate per period. + type: >- + number | | | <any> + - id: pv + description: Is the present value of the investment. + type: >- + number | | | <any> + - id: fv + description: Is the desired future value of the investment. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: percentile_Exc(array, k) + uid: excel!Excel.Functions#percentile_Exc:member(1) + package: excel! + fullName: percentile_Exc(array, k) + summary: >- + Returns the k-th percentile of values in a range, where k is in the range + 0..1, exclusive. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + percentile_Exc(array: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, k: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: array + description: Is the array or range of data that defines relative standing. + type: >- + number | | | <any> + - id: k + description: Is the percentile value that is between 0 through 1, inclusive. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: percentile_Inc(array, k) + uid: excel!Excel.Functions#percentile_Inc:member(1) + package: excel! + fullName: percentile_Inc(array, k) + summary: >- + Returns the k-th percentile of values in a range, where k is in the range + 0..1, inclusive. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + percentile_Inc(array: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, k: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: array + description: Is the array or range of data that defines relative standing. + type: >- + number | | | <any> + - id: k + description: Is the percentile value that is between 0 through 1, inclusive. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: percentRank_Exc(array, x, significance) + uid: excel!Excel.Functions#percentRank_Exc:member(1) + package: excel! + fullName: percentRank_Exc(array, x, significance) + summary: >- + Returns the rank of a value in a data set as a percentage (0..1, + exclusive) of the data set. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + percentRank_Exc(array: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, x: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, significance?: number + | Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: array + description: >- + Is the array or range of data with numeric values that defines + relative standing. + type: >- + number | | | <any> + - id: x + description: Is the value for which you want to know the rank. + type: >- + number | | | <any> + - id: significance + description: >- + Is an optional value that identifies the number of significant + digits for the returned percentage, three digits if omitted + (0.xxx%). + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: percentRank_Inc(array, x, significance) + uid: excel!Excel.Functions#percentRank_Inc:member(1) + package: excel! + fullName: percentRank_Inc(array, x, significance) + summary: >- + Returns the rank of a value in a data set as a percentage (0..1, + inclusive) of the data set. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + percentRank_Inc(array: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, x: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, significance?: number + | Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: array + description: >- + Is the array or range of data with numeric values that defines + relative standing. + type: >- + number | | | <any> + - id: x + description: Is the value for which you want to know the rank. + type: >- + number | | | <any> + - id: significance + description: >- + Is an optional value that identifies the number of significant + digits for the returned percentage, three digits if omitted + (0.xxx%). + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: permut(number, numberChosen) + uid: excel!Excel.Functions#permut:member(1) + package: excel! + fullName: permut(number, numberChosen) + summary: >- + Returns the number of permutations for a given number of objects that can + be selected from the total objects. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + permut(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, numberChosen: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: number + description: Is the total number of objects. + type: >- + number | | | <any> + - id: numberChosen + description: Is the number of objects in each permutation. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: permutationa(number, numberChosen) + uid: excel!Excel.Functions#permutationa:member(1) + package: excel! + fullName: permutationa(number, numberChosen) + summary: >- + Returns the number of permutations for a given number of objects (with + repetitions) that can be selected from the total objects. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + permutationa(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, numberChosen: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: number + description: Is the total number of objects. + type: >- + number | | | <any> + - id: numberChosen + description: Is the number of objects in each permutation. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: phi(x) + uid: excel!Excel.Functions#phi:member(1) + package: excel! + fullName: phi(x) + summary: >- + Returns the value of the density function for a standard normal + distribution. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + phi(x: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: x + description: >- + Is the number for which you want the density of the standard normal + distribution. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: pi() + uid: excel!Excel.Functions#pi:member(1) + package: excel! + fullName: pi() + summary: Returns the value of Pi, 3.14159265358979, accurate to 15 digits. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'pi(): FunctionResult;' + return: + type: <number> + description: '' + - name: pmt(rate, nper, pv, fv, type) + uid: excel!Excel.Functions#pmt:member(1) + package: excel! + fullName: pmt(rate, nper, pv, fv, type) + summary: >- + Calculates the payment for a loan based on constant payments and a + constant interest rate. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + pmt(rate: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, nper: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, pv: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, fv?: + number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, + type?: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: rate + description: >- + Is the interest rate per period for the loan. For example, use 6%/4 + for quarterly payments at 6% APR. + type: >- + number | | | <any> + - id: nper + description: Is the total number of payments for the loan. + type: >- + number | | | <any> + - id: pv + description: >- + Is the present value: the total amount that a series of future + payments is worth now. + type: >- + number | | | <any> + - id: fv + description: >- + Is the future value, or a cash balance you want to attain after the + last payment is made, 0 (zero) if omitted. + type: >- + number | | | <any> + - id: type + description: >- + Is a logical value: payment at the beginning of the period = 1; + payment at the end of the period = 0 or omitted. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: poisson_Dist(x, mean, cumulative) + uid: excel!Excel.Functions#poisson_Dist:member(1) + package: excel! + fullName: poisson_Dist(x, mean, cumulative) + summary: Returns the Poisson distribution. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + poisson_Dist(x: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, mean: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, cumulative: boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: x + description: Is the number of events. + type: >- + number | | | <any> + - id: mean + description: Is the expected numeric value, a positive number. + type: >- + number | | | <any> + - id: cumulative + description: >- + Is a logical value: for the cumulative Poisson probability, use + TRUE; for the Poisson probability mass function, use FALSE. + type: >- + boolean | | | <any> + return: + type: <number> + description: '' + - name: power(number, power) + uid: excel!Excel.Functions#power:member(1) + package: excel! + fullName: power(number, power) + summary: Returns the result of a number raised to a power. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + power(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, power: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: number + description: Is the base number, any real number. + type: >- + number | | | <any> + - id: power + description: Is the exponent, to which the base number is raised. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: ppmt(rate, per, nper, pv, fv, type) + uid: excel!Excel.Functions#ppmt:member(1) + package: excel! + fullName: ppmt(rate, per, nper, pv, fv, type) + summary: >- + Returns the payment on the principal for a given investment based on + periodic, constant payments and a constant interest rate. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + ppmt(rate: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, per: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, nper: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, pv: + number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, + fv?: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, type?: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: rate + description: >- + Is the interest rate per period. For example, use 6%/4 for quarterly + payments at 6% APR. + type: >- + number | | | <any> + - id: per + description: Specifies the period and must be in the range 1 to nper. + type: >- + number | | | <any> + - id: nper + description: Is the total number of payment periods in an investment. + type: >- + number | | | <any> + - id: pv + description: >- + Is the present value: the total amount that a series of future + payments is worth now. + type: >- + number | | | <any> + - id: fv + description: >- + Is the future value, or cash balance you want to attain after the + last payment is made. + type: >- + number | | | <any> + - id: type + description: >- + Is a logical value: payment at the beginning of the period = 1; + payment at the end of the period = 0 or omitted. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: price(settlement, maturity, rate, yld, redemption, frequency, basis) + uid: excel!Excel.Functions#price:member(1) + package: excel! + fullName: price(settlement, maturity, rate, yld, redemption, frequency, basis) + summary: >- + Returns the price per $100 face value of a security that pays periodic + interest. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + price(settlement: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, maturity: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, rate: number | string | boolean | Excel.Range + | Excel.RangeReference | Excel.FunctionResult, yld: number | string + | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, redemption: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, + frequency: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, basis?: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: settlement + description: >- + Is the security's settlement date, expressed as a serial date + number. + type: >- + number | string | boolean | | + | <any> + - id: maturity + description: Is the security's maturity date, expressed as a serial date number. + type: >- + number | string | boolean | | + | <any> + - id: rate + description: Is the security's annual coupon rate. + type: >- + number | string | boolean | | + | <any> + - id: yld + description: Is the security's annual yield. + type: >- + number | string | boolean | | + | <any> + - id: redemption + description: Is the security's redemption value per $100 face value. + type: >- + number | string | boolean | | + | <any> + - id: frequency + description: Is the number of coupon payments per year. + type: >- + number | string | boolean | | + | <any> + - id: basis + description: Is the type of day count basis to use. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: priceDisc(settlement, maturity, discount, redemption, basis) + uid: excel!Excel.Functions#priceDisc:member(1) + package: excel! + fullName: priceDisc(settlement, maturity, discount, redemption, basis) + summary: Returns the price per $100 face value of a discounted security. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + priceDisc(settlement: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, maturity: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, discount: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, + redemption: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, basis?: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: settlement + description: >- + Is the security's settlement date, expressed as a serial date + number. + type: >- + number | string | boolean | | + | <any> + - id: maturity + description: Is the security's maturity date, expressed as a serial date number. + type: >- + number | string | boolean | | + | <any> + - id: discount + description: Is the security's discount rate. + type: >- + number | string | boolean | | + | <any> + - id: redemption + description: Is the security's redemption value per $100 face value. + type: >- + number | string | boolean | | + | <any> + - id: basis + description: Is the type of day count basis to use. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: priceMat(settlement, maturity, issue, rate, yld, basis) + uid: excel!Excel.Functions#priceMat:member(1) + package: excel! + fullName: priceMat(settlement, maturity, issue, rate, yld, basis) + summary: >- + Returns the price per $100 face value of a security that pays interest at + maturity. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + priceMat(settlement: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, maturity: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, issue: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, rate: + number | string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, yld: number | string | boolean | Excel.Range + | Excel.RangeReference | Excel.FunctionResult, basis?: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: settlement + description: >- + Is the security's settlement date, expressed as a serial date + number. + type: >- + number | string | boolean | | + | <any> + - id: maturity + description: Is the security's maturity date, expressed as a serial date number. + type: >- + number | string | boolean | | + | <any> + - id: issue + description: Is the security's issue date, expressed as a serial date number. + type: >- + number | string | boolean | | + | <any> + - id: rate + description: Is the security's interest rate at date of issue. + type: >- + number | string | boolean | | + | <any> + - id: yld + description: Is the security's annual yield. + type: >- + number | string | boolean | | + | <any> + - id: basis + description: Is the type of day count basis to use. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: product(values) + uid: excel!Excel.Functions#product:member(1) + package: excel! + fullName: product(values) + summary: Multiplies all the numbers given as arguments. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + product(...values: Array>): FunctionResult; + parameters: + - id: values + description: >- + List of parameters, whose elements are 1 to 255 numbers, logical + values, or text representations of numbers that you want to + multiply. + type: >- + Array<number | | | <any>> + return: + type: <number> + description: '' + - name: proper(text) + uid: excel!Excel.Functions#proper:member(1) + package: excel! + fullName: proper(text) + summary: >- + Converts a text string to proper case; the first letter in each word to + uppercase, and all other letters to lowercase. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + proper(text: string | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: text + description: >- + Is text enclosed in quotation marks, a formula that returns text, or + a reference to a cell containing text to partially capitalize. + type: >- + string | | | <any> + return: + type: <string> + description: '' + - name: pv(rate, nper, pmt, fv, type) + uid: excel!Excel.Functions#pv:member(1) + package: excel! + fullName: pv(rate, nper, pmt, fv, type) + summary: >- + Returns the present value of an investment: the total amount that a series + of future payments is worth now. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + pv(rate: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, nper: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, pmt: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, fv?: + number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, + type?: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: rate + description: >- + Is the interest rate per period. For example, use 6%/4 for quarterly + payments at 6% APR. + type: >- + number | | | <any> + - id: nper + description: Is the total number of payment periods in an investment. + type: >- + number | | | <any> + - id: pmt + description: >- + Is the payment made each period and cannot change over the life of + the investment. + type: >- + number | | | <any> + - id: fv + description: >- + Is the future value, or a cash balance you want to attain after the + last payment is made. + type: >- + number | | | <any> + - id: type + description: >- + Is a logical value: payment at the beginning of the period = 1; + payment at the end of the period = 0 or omitted. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: quartile_Exc(array, quart) + uid: excel!Excel.Functions#quartile_Exc:member(1) + package: excel! + fullName: quartile_Exc(array, quart) + summary: >- + Returns the quartile of a data set, based on percentile values from 0..1, + exclusive. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + quartile_Exc(array: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, quart: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: array + description: >- + Is the array or cell range of numeric values for which you want the + quartile value. + type: >- + number | | | <any> + - id: quart + description: >- + Is a number: minimum value = 0; 1st quartile = 1; median value = 2; + 3rd quartile = 3; maximum value = 4. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: quartile_Inc(array, quart) + uid: excel!Excel.Functions#quartile_Inc:member(1) + package: excel! + fullName: quartile_Inc(array, quart) + summary: >- + Returns the quartile of a data set, based on percentile values from 0..1, + inclusive. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + quartile_Inc(array: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, quart: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: array + description: >- + Is the array or cell range of numeric values for which you want the + quartile value. + type: >- + number | | | <any> + - id: quart + description: >- + Is a number: minimum value = 0; 1st quartile = 1; median value = 2; + 3rd quartile = 3; maximum value = 4. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: quotient(numerator, denominator) + uid: excel!Excel.Functions#quotient:member(1) + package: excel! + fullName: quotient(numerator, denominator) + summary: Returns the integer portion of a division. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + quotient(numerator: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, denominator: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: numerator + description: Is the dividend. + type: >- + number | string | boolean | | + | <any> + - id: denominator + description: Is the divisor. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: radians(angle) + uid: excel!Excel.Functions#radians:member(1) + package: excel! + fullName: radians(angle) + summary: Converts degrees to radians. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + radians(angle: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: angle + description: Is an angle in degrees that you want to convert. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: rand() + uid: excel!Excel.Functions#rand:member(1) + package: excel! + fullName: rand() + summary: >- + Returns a random number greater than or equal to 0 and less than 1, evenly + distributed (changes on recalculation). + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rand(): FunctionResult;' + return: + type: <number> + description: '' + - name: randBetween(bottom, top) + uid: excel!Excel.Functions#randBetween:member(1) + package: excel! + fullName: randBetween(bottom, top) + summary: Returns a random number between the numbers you specify. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + randBetween(bottom: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, top: number | string | + boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: bottom + description: Is the smallest integer RANDBETWEEN will return. + type: >- + number | string | boolean | | + | <any> + - id: top + description: Is the largest integer RANDBETWEEN will return. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: rank_Avg(number, ref, order) + uid: excel!Excel.Functions#rank_Avg:member(1) + package: excel! + fullName: rank_Avg(number, ref, order) + summary: >- + Returns the rank of a number in a list of numbers: its size relative to + other values in the list; if more than one value has the same rank, the + average rank is returned. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + rank_Avg(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, ref: Excel.Range | Excel.RangeReference | + Excel.FunctionResult, order?: boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: number + description: Is the number for which you want to find the rank. + type: >- + number | | | <any> + - id: ref + description: >- + Is an array of, or a reference to, a list of numbers. Nonnumeric + values are ignored. + type: >- + | | <any> + - id: order + description: >- + Is a number: rank in the list sorted descending = 0 or omitted; rank + in the list sorted ascending = any nonzero value. + type: >- + boolean | | | <any> + return: + type: <number> + description: '' + - name: rank_Eq(number, ref, order) + uid: excel!Excel.Functions#rank_Eq:member(1) + package: excel! + fullName: rank_Eq(number, ref, order) + summary: >- + Returns the rank of a number in a list of numbers: its size relative to + other values in the list; if more than one value has the same rank, the + top rank of that set of values is returned. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + rank_Eq(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, ref: Excel.Range | Excel.RangeReference | + Excel.FunctionResult, order?: boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: number + description: Is the number for which you want to find the rank. + type: >- + number | | | <any> + - id: ref + description: >- + Is an array of, or a reference to, a list of numbers. Nonnumeric + values are ignored. + type: >- + | | <any> + - id: order + description: >- + Is a number: rank in the list sorted descending = 0 or omitted; rank + in the list sorted ascending = any nonzero value. + type: >- + boolean | | | <any> + return: + type: <number> + description: '' + - name: rate(nper, pmt, pv, fv, type, guess) + uid: excel!Excel.Functions#rate:member(1) + package: excel! + fullName: rate(nper, pmt, pv, fv, type, guess) + summary: >- + Returns the interest rate per period of a loan or an investment. For + example, use 6%/4 for quarterly payments at 6% APR. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + rate(nper: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, pmt: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, pv: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, fv?: + number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, + type?: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, guess?: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: nper + description: Is the total number of payment periods for the loan or investment. + type: >- + number | | | <any> + - id: pmt + description: >- + Is the payment made each period and cannot change over the life of + the loan or investment. + type: >- + number | | | <any> + - id: pv + description: >- + Is the present value: the total amount that a series of future + payments is worth now. + type: >- + number | | | <any> + - id: fv + description: >- + Is the future value, or a cash balance you want to attain after the + last payment is made. If omitted, uses Fv = 0. + type: >- + number | | | <any> + - id: type + description: >- + Is a logical value: payment at the beginning of the period = 1; + payment at the end of the period = 0 or omitted. + type: >- + number | | | <any> + - id: guess + description: >- + Is your guess for what the rate will be; if omitted, Guess = 0.1 (10 + percent). + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: received(settlement, maturity, investment, discount, basis) + uid: excel!Excel.Functions#received:member(1) + package: excel! + fullName: received(settlement, maturity, investment, discount, basis) + summary: Returns the amount received at maturity for a fully invested security. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + received(settlement: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, maturity: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, investment: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, + discount: number | string | boolean | Excel.Range | Excel.RangeReference + | Excel.FunctionResult, basis?: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: settlement + description: >- + Is the security's settlement date, expressed as a serial date + number. + type: >- + number | string | boolean | | + | <any> + - id: maturity + description: Is the security's maturity date, expressed as a serial date number. + type: >- + number | string | boolean | | + | <any> + - id: investment + description: Is the amount invested in the security. + type: >- + number | string | boolean | | + | <any> + - id: discount + description: Is the security's discount rate. + type: >- + number | string | boolean | | + | <any> + - id: basis + description: Is the type of day count basis to use. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: replace(oldText, startNum, numChars, newText) + uid: excel!Excel.Functions#replace:member(1) + package: excel! + fullName: replace(oldText, startNum, numChars, newText) + summary: Replaces part of a text string with a different text string. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + replace(oldText: string | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, startNum: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, numChars: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, newText: + string | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: oldText + description: Is text in which you want to replace some characters. + type: >- + string | | | <any> + - id: startNum + description: >- + Is the position of the character in oldText that you want to replace + with newText. + type: >- + number | | | <any> + - id: numChars + description: Is the number of characters in oldText that you want to replace. + type: >- + number | | | <any> + - id: newText + description: Is the text that will replace characters in oldText. + type: >- + string | | | <any> + return: + type: <string> + description: '' + - name: replaceB(oldText, startNum, numBytes, newText) + uid: excel!Excel.Functions#replaceB:member(1) + package: excel! + fullName: replaceB(oldText, startNum, numBytes, newText) + summary: >- + Replaces part of a text string with a different text string. Use with + double-byte character sets (DBCS). + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + replaceB(oldText: string | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, startNum: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, numBytes: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, newText: + string | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: oldText + description: Is text in which you want to replace some characters. + type: >- + string | | | <any> + - id: startNum + description: >- + Is the position of the character in oldText that you want to replace + with newText. + type: >- + number | | | <any> + - id: numBytes + description: >- + Is the number of characters in oldText that you want to replace with + newText. + type: >- + number | | | <any> + - id: newText + description: Is the text that will replace characters in oldText. + type: >- + string | | | <any> + return: + type: <string> + description: '' + - name: rept(text, numberTimes) + uid: excel!Excel.Functions#rept:member(1) + package: excel! + fullName: rept(text, numberTimes) + summary: >- + Repeats text a given number of times. Use REPT to fill a cell with a + number of instances of a text string. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + rept(text: string | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, numberTimes: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: text + description: Is the text you want to repeat. + type: >- + string | | | <any> + - id: numberTimes + description: Is a positive number specifying the number of times to repeat text. + type: >- + number | | | <any> + return: + type: <string> + description: '' + - name: right(text, numChars) + uid: excel!Excel.Functions#right:member(1) + package: excel! + fullName: right(text, numChars) + summary: Returns the specified number of characters from the end of a text string. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + right(text: string | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, numChars?: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: text + description: Is the text string that contains the characters you want to extract. + type: >- + string | | | <any> + - id: numChars + description: Specifies how many characters you want to extract, 1 if omitted. + type: >- + number | | | <any> + return: + type: <string> + description: '' + - name: rightb(text, numBytes) + uid: excel!Excel.Functions#rightb:member(1) + package: excel! + fullName: rightb(text, numBytes) + summary: >- + Returns the specified number of characters from the end of a text string. + Use with double-byte character sets (DBCS). + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + rightb(text: string | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, numBytes?: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: text + description: Is the text string containing the characters you want to extract. + type: >- + string | | | <any> + - id: numBytes + description: Specifies how many characters you want to extract. + type: >- + number | | | <any> + return: + type: <string> + description: '' + - name: roman(number, form) + uid: excel!Excel.Functions#roman:member(1) + package: excel! + fullName: roman(number, form) + summary: Converts an Arabic numeral to Roman, as text. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + roman(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, form?: boolean | number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: number + description: Is the Arabic numeral you want to convert. + type: >- + number | | | <any> + - id: form + description: Is the number specifying the type of Roman numeral you want. + type: >- + boolean | number | | | <any> + return: + type: <string> + description: '' + - name: round(number, numDigits) + uid: excel!Excel.Functions#round:member(1) + package: excel! + fullName: round(number, numDigits) + summary: Rounds a number to a specified number of digits. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + round(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, numDigits: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: number + description: Is the number you want to round. + type: >- + number | | | <any> + - id: numDigits + description: >- + Is the number of digits to which you want to round. Negative rounds + to the left of the decimal point; zero to the nearest integer. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: roundDown(number, numDigits) + uid: excel!Excel.Functions#roundDown:member(1) + package: excel! + fullName: roundDown(number, numDigits) + summary: Rounds a number down, toward zero. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + roundDown(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, numDigits: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: number + description: Is any real number that you want rounded down. + type: >- + number | | | <any> + - id: numDigits + description: >- + Is the number of digits to which you want to round. Negative rounds + to the left of the decimal point; zero or omitted, to the nearest + integer. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: roundUp(number, numDigits) + uid: excel!Excel.Functions#roundUp:member(1) + package: excel! + fullName: roundUp(number, numDigits) + summary: Rounds a number up, away from zero. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + roundUp(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, numDigits: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: number + description: Is any real number that you want rounded up. + type: >- + number | | | <any> + - id: numDigits + description: >- + Is the number of digits to which you want to round. Negative rounds + to the left of the decimal point; zero or omitted, to the nearest + integer. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: rows(array) + uid: excel!Excel.Functions#rows:member(1) + package: excel! + fullName: rows(array) + summary: Returns the number of rows in a reference or array. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + rows(array: Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: array + description: >- + Is an array, an array formula, or a reference to a range of cells + for which you want the number of rows. + type: >- + | | <any> + return: + type: <number> + description: '' + - name: rri(nper, pv, fv) + uid: excel!Excel.Functions#rri:member(1) + package: excel! + fullName: rri(nper, pv, fv) + summary: Returns an equivalent interest rate for the growth of an investment. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + rri(nper: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, pv: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, fv: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: nper + description: Is the number of periods for the investment. + type: >- + number | | | <any> + - id: pv + description: Is the present value of the investment. + type: >- + number | | | <any> + - id: fv + description: Is the future value of the investment. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: sec(number) + uid: excel!Excel.Functions#sec:member(1) + package: excel! + fullName: sec(number) + summary: Returns the secant of an angle. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + sec(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: Is the angle in radians for which you want the secant. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: sech(number) + uid: excel!Excel.Functions#sech:member(1) + package: excel! + fullName: sech(number) + summary: Returns the hyperbolic secant of an angle. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + sech(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: Is the angle in radians for which you want the hyperbolic secant. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: second(serialNumber) + uid: excel!Excel.Functions#second:member(1) + package: excel! + fullName: second(serialNumber) + summary: Returns the second, a number from 0 to 59. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + second(serialNumber: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: serialNumber + description: >- + Is a number in the date-time code used by Microsoft Excel or text in + time format, such as 16:48:23 or 4:48:47 PM. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: seriesSum(x, n, m, coefficients) + uid: excel!Excel.Functions#seriesSum:member(1) + package: excel! + fullName: seriesSum(x, n, m, coefficients) + summary: Returns the sum of a power series based on the formula. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + seriesSum(x: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, n: number | string | + boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, m: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, coefficients: + Excel.Range | string | number | boolean | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: x + description: Is the input value to the power series. + type: >- + number | string | boolean | | + | <any> + - id: 'n' + description: Is the initial power to which you want to raise x. + type: >- + number | string | boolean | | + | <any> + - id: m + description: Is the step by which to increase n for each term in the series. + type: >- + number | string | boolean | | + | <any> + - id: coefficients + description: >- + Is a set of coefficients by which each successive power of x is + multiplied. + type: >- + | string | number | boolean | + | <any> + return: + type: <number> + description: '' + - name: sheet(value) + uid: excel!Excel.Functions#sheet:member(1) + package: excel! + fullName: sheet(value) + summary: Returns the sheet number of the referenced sheet. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + sheet(value?: Excel.Range | string | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: value + description: >- + Is the name of a sheet or a reference that you want the sheet number + of. If omitted the number of the sheet containing the function is + returned. + type: >- + | string | | <any> + return: + type: <number> + description: '' + - name: sheets(reference) + uid: excel!Excel.Functions#sheets:member(1) + package: excel! + fullName: sheets(reference) + summary: Returns the number of sheets in a reference. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + sheets(reference?: Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: reference + description: >- + Is a reference for which you want to know the number of sheets it + contains. If omitted the number of sheets in the workbook containing + the function is returned. + type: >- + | | <any> + return: + type: <number> + description: '' + - name: sign(number) + uid: excel!Excel.Functions#sign:member(1) + package: excel! + fullName: sign(number) + summary: >- + Returns the sign of a number: 1 if the number is positive, zero if the + number is zero, or -1 if the number is negative. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + sign(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: Is any real number. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: sin(number) + uid: excel!Excel.Functions#sin:member(1) + package: excel! + fullName: sin(number) + summary: Returns the sine of an angle. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + sin(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: >- + Is the angle in radians for which you want the sine. Degrees * + PI()/180 = radians. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: sinh(number) + uid: excel!Excel.Functions#sinh:member(1) + package: excel! + fullName: sinh(number) + summary: Returns the hyperbolic sine of a number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + sinh(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: Is any real number. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: skew_p(values) + uid: excel!Excel.Functions#skew_p:member(1) + package: excel! + fullName: skew_p(values) + summary: >- + Returns the skewness of a distribution based on a population: a + characterization of the degree of asymmetry of a distribution around its + mean. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + skew_p(...values: Array>): FunctionResult; + parameters: + - id: values + description: >- + List of parameters, whose elements are 1 to 254 numbers or names, + arrays, or references that contain numbers for which you want the + population skewness. + type: >- + Array<number | | | <any>> + return: + type: <number> + description: '' + - name: skew(values) + uid: excel!Excel.Functions#skew:member(1) + package: excel! + fullName: skew(values) + summary: >- + Returns the skewness of a distribution: a characterization of the degree + of asymmetry of a distribution around its mean. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + skew(...values: Array>): FunctionResult; + parameters: + - id: values + description: >- + List of parameters, whose elements are 1 to 255 numbers or names, + arrays, or references that contain numbers for which you want the + skewness. + type: >- + Array<number | | | <any>> + return: + type: <number> + description: '' + - name: sln(cost, salvage, life) + uid: excel!Excel.Functions#sln:member(1) + package: excel! + fullName: sln(cost, salvage, life) + summary: Returns the straight-line depreciation of an asset for one period. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + sln(cost: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, salvage: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, life: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: cost + description: Is the initial cost of the asset. + type: >- + number | | | <any> + - id: salvage + description: Is the salvage value at the end of the life of the asset. + type: >- + number | | | <any> + - id: life + description: >- + Is the number of periods over which the asset is being depreciated + (sometimes called the useful life of the asset). + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: small(array, k) + uid: excel!Excel.Functions#small:member(1) + package: excel! + fullName: small(array, k) + summary: >- + Returns the k-th smallest value in a data set. For example, the fifth + smallest number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + small(array: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, k: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: array + description: >- + Is an array or range of numerical data for which you want to + determine the k-th smallest value. + type: >- + number | | | <any> + - id: k + description: >- + Is the position (from the smallest) in the array or range of the + value to return. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: sqrt(number) + uid: excel!Excel.Functions#sqrt:member(1) + package: excel! + fullName: sqrt(number) + summary: Returns the square root of a number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + sqrt(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: Is the number for which you want the square root. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: sqrtPi(number) + uid: excel!Excel.Functions#sqrtPi:member(1) + package: excel! + fullName: sqrtPi(number) + summary: Returns the square root of (number * Pi). + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + sqrtPi(number: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: number + description: Is the number by which p is multiplied. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: standardize(x, mean, standardDev) + uid: excel!Excel.Functions#standardize:member(1) + package: excel! + fullName: standardize(x, mean, standardDev) + summary: >- + Returns a normalized value from a distribution characterized by a mean and + standard deviation. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + standardize(x: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, mean: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, standardDev: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: x + description: Is the value you want to normalize. + type: >- + number | | | <any> + - id: mean + description: Is the arithmetic mean of the distribution. + type: >- + number | | | <any> + - id: standardDev + description: Is the standard deviation of the distribution, a positive number. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: stDev_P(values) + uid: excel!Excel.Functions#stDev_P:member(1) + package: excel! + fullName: stDev_P(values) + summary: >- + Calculates standard deviation based on the entire population given as + arguments (ignores logical values and text). + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + stDev_P(...values: Array>): FunctionResult; + parameters: + - id: values + description: >- + List of parameters, whose elements are 1 to 255 numbers + corresponding to a population and can be numbers or references that + contain numbers. + type: >- + Array<number | | | <any>> + return: + type: <number> + description: '' + - name: stDev_S(values) + uid: excel!Excel.Functions#stDev_S:member(1) + package: excel! + fullName: stDev_S(values) + summary: >- + Estimates standard deviation based on a sample (ignores logical values and + text in the sample). + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + stDev_S(...values: Array>): FunctionResult; + parameters: + - id: values + description: >- + List of parameters, whose elements are 1 to 255 numbers + corresponding to a sample of a population and can be numbers or + references that contain numbers. + type: >- + Array<number | | | <any>> + return: + type: <number> + description: '' + - name: stDevA(values) + uid: excel!Excel.Functions#stDevA:member(1) + package: excel! + fullName: stDevA(values) + summary: >- + Estimates standard deviation based on a sample, including logical values + and text. Text and the logical value FALSE have the value 0; the logical + value TRUE has the value 1. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + stDevA(...values: Array>): FunctionResult; + parameters: + - id: values + description: >- + List of parameters, whose elements are 1 to 255 values corresponding + to a sample of a population and can be values or names or references + to values. + type: >- + Array<number | | | <any>> + return: + type: <number> + description: '' + - name: stDevPA(values) + uid: excel!Excel.Functions#stDevPA:member(1) + package: excel! + fullName: stDevPA(values) + summary: >- + Calculates standard deviation based on an entire population, including + logical values and text. Text and the logical value FALSE have the value + 0; the logical value TRUE has the value 1. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + stDevPA(...values: Array>): FunctionResult; + parameters: + - id: values + description: >- + List of parameters, whose elements are 1 to 255 values corresponding + to a population and can be values, names, arrays, or references that + contain values. + type: >- + Array<number | | | <any>> + return: + type: <number> + description: '' + - name: substitute(text, oldText, newText, instanceNum) + uid: excel!Excel.Functions#substitute:member(1) + package: excel! + fullName: substitute(text, oldText, newText, instanceNum) + summary: Replaces existing text with new text in a text string. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + substitute(text: string | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, oldText: string | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, newText: string | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, + instanceNum?: string | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: text + description: >- + Is the text or the reference to a cell containing text in which you + want to substitute characters. + type: >- + string | | | <any> + - id: oldText + description: >- + Is the existing text you want to replace. If the case of oldText + does not match the case of text, SUBSTITUTE will not replace the + text. + type: >- + string | | | <any> + - id: newText + description: Is the text you want to replace oldText with. + type: >- + string | | | <any> + - id: instanceNum + description: >- + Specifies which occurrence of oldText you want to replace. If + omitted, every instance of oldText is replaced. + type: >- + string | | | <any> + return: + type: <string> + description: '' + - name: subtotal(functionNum, values) + uid: excel!Excel.Functions#subtotal:member(1) + package: excel! + fullName: subtotal(functionNum, values) + summary: Returns a subtotal in a list or database. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + subtotal(functionNum: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, ...values: Array>): + FunctionResult; + parameters: + - id: functionNum + description: >- + Is the number 1 to 11 that specifies the summary function for the + subtotal. + type: >- + number | | | <any> + - id: values + description: >- + List of parameters, whose elements are 1 to 254 ranges or references + for which you want the subtotal. + type: >- + Array< | | <any>> + return: + type: <number> + description: '' + - name: sum(values) + uid: excel!Excel.Functions#sum:member(1) + package: excel! + fullName: sum(values) + summary: Adds all the numbers in a range of cells. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-built-in-functions.yaml + + + await Excel.run(async (context) => { + // This function uses VLOOKUP to find data in the "Wrench" row + // on the worksheet, and then it uses SUM to combine the values. + let range = context.workbook.worksheets.getItem("Sample").getRange("A1:D4"); + + // Get the values in the second, third, and fourth columns in the "Wrench" row, + // and combine those values with SUM. + let sumOfTwoLookups = context.workbook.functions.sum( + context.workbook.functions.vlookup("Wrench", range, 2, false), + context.workbook.functions.vlookup("Wrench", range, 3, false), + context.workbook.functions.vlookup("Wrench", range, 4, false) + ); + sumOfTwoLookups.load("value"); + + await context.sync(); + console.log(" Number of wrenches sold in November, December, and January = " + sumOfTwoLookups.value); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + sum(...values: Array>): FunctionResult; + parameters: + - id: values + description: >- + List of parameters, whose elements are 1 to 255 numbers to sum. + Logical values and text are ignored in cells, included if typed as + arguments. + type: >- + Array<number | | | <any>> + return: + type: <number> + description: '' + - name: sumIf(range, criteria, sumRange) + uid: excel!Excel.Functions#sumIf:member(1) + package: excel! + fullName: sumIf(range, criteria, sumRange) + summary: Adds the cells specified by a given condition or criteria. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + sumIf(range: Excel.Range | Excel.RangeReference | + Excel.FunctionResult, criteria: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, + sumRange?: Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: range + description: Is the range of cells you want evaluated. + type: >- + | | <any> + - id: criteria + description: >- + Is the condition or criteria in the form of a number, expression, or + text that defines which cells will be added. + type: >- + number | string | boolean | | + | <any> + - id: sumRange + description: >- + Are the actual cells to sum. If omitted, the cells in range are + used. + type: >- + | | <any> + return: + type: <number> + description: '' + - name: sumIfs(sumRange, values) + uid: excel!Excel.Functions#sumIfs:member(1) + package: excel! + fullName: sumIfs(sumRange, values) + summary: Adds the cells specified by a given set of conditions or criteria. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + sumIfs(sumRange: Excel.Range | Excel.RangeReference | + Excel.FunctionResult, ...values: Array | number | string | + boolean>): FunctionResult; + parameters: + - id: sumRange + description: Are the actual cells to sum. + type: >- + | | <any> + - id: values + description: >- + List of parameters, where the first element of each pair is the Is + the range of cells you want evaluated for the particular condition , + and the second element is is the condition or criteria in the form + of a number, expression, or text that defines which cells will be + added. + type: >- + Array< | | <any> | number | + string | boolean> + return: + type: <number> + description: '' + - name: sumSq(values) + uid: excel!Excel.Functions#sumSq:member(1) + package: excel! + fullName: sumSq(values) + summary: >- + Returns the sum of the squares of the arguments. The arguments can be + numbers, arrays, names, or references to cells that contain numbers. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + sumSq(...values: Array>): FunctionResult; + parameters: + - id: values + description: >- + List of parameters, whose elements are 1 to 255 numbers, arrays, + names, or references to arrays for which you want the sum of the + squares. + type: >- + Array<number | | | <any>> + return: + type: <number> + description: '' + - name: syd(cost, salvage, life, per) + uid: excel!Excel.Functions#syd:member(1) + package: excel! + fullName: syd(cost, salvage, life, per) + summary: >- + Returns the sum-of-years' digits depreciation of an asset for a specified + period. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + syd(cost: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, salvage: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, life: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, per: + number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: cost + description: Is the initial cost of the asset. + type: >- + number | | | <any> + - id: salvage + description: Is the salvage value at the end of the life of the asset. + type: >- + number | | | <any> + - id: life + description: >- + Is the number of periods over which the asset is being depreciated + (sometimes called the useful life of the asset). + type: >- + number | | | <any> + - id: per + description: Is the period and must use the same units as Life. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: t_Dist_2T(x, degFreedom) + uid: excel!Excel.Functions#t_Dist_2T:member(1) + package: excel! + fullName: t_Dist_2T(x, degFreedom) + summary: Returns the two-tailed Student's t-distribution. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + t_Dist_2T(x: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, degFreedom: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: x + description: Is the numeric value at which to evaluate the distribution. + type: >- + number | | | <any> + - id: degFreedom + description: >- + Is an integer indicating the number of degrees of freedom that + characterize the distribution. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: t_Dist_RT(x, degFreedom) + uid: excel!Excel.Functions#t_Dist_RT:member(1) + package: excel! + fullName: t_Dist_RT(x, degFreedom) + summary: Returns the right-tailed Student's t-distribution. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + t_Dist_RT(x: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, degFreedom: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: x + description: Is the numeric value at which to evaluate the distribution. + type: >- + number | | | <any> + - id: degFreedom + description: >- + Is an integer indicating the number of degrees of freedom that + characterize the distribution. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: t_Dist(x, degFreedom, cumulative) + uid: excel!Excel.Functions#t_Dist:member(1) + package: excel! + fullName: t_Dist(x, degFreedom, cumulative) + summary: Returns the left-tailed Student's t-distribution. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + t_Dist(x: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, degFreedom: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, cumulative: boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: x + description: Is the numeric value at which to evaluate the distribution. + type: >- + number | | | <any> + - id: degFreedom + description: >- + Is an integer indicating the number of degrees of freedom that + characterize the distribution. + type: >- + number | | | <any> + - id: cumulative + description: >- + Is a logical value: for the cumulative distribution function, use + TRUE; for the probability density function, use FALSE. + type: >- + boolean | | | <any> + return: + type: <number> + description: '' + - name: t_Inv_2T(probability, degFreedom) + uid: excel!Excel.Functions#t_Inv_2T:member(1) + package: excel! + fullName: t_Inv_2T(probability, degFreedom) + summary: Returns the two-tailed inverse of the Student's t-distribution. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + t_Inv_2T(probability: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, degFreedom: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: probability + description: >- + Is the probability associated with the two-tailed Student's + t-distribution, a number between 0 and 1 inclusive. + type: >- + number | | | <any> + - id: degFreedom + description: >- + Is a positive integer indicating the number of degrees of freedom to + characterize the distribution. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: t_Inv(probability, degFreedom) + uid: excel!Excel.Functions#t_Inv:member(1) + package: excel! + fullName: t_Inv(probability, degFreedom) + summary: Returns the left-tailed inverse of the Student's t-distribution. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + t_Inv(probability: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, degFreedom: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: probability + description: >- + Is the probability associated with the two-tailed Student's + t-distribution, a number between 0 and 1 inclusive. + type: >- + number | | | <any> + - id: degFreedom + description: >- + Is a positive integer indicating the number of degrees of freedom to + characterize the distribution. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: t(value) + uid: excel!Excel.Functions#t:member(1) + package: excel! + fullName: t(value) + summary: >- + Checks whether a value is text, and returns the text if it is, or returns + double quotes (empty text) if it is not. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + t(value: number | string | boolean | Excel.Range | Excel.RangeReference + | Excel.FunctionResult): FunctionResult; + parameters: + - id: value + description: Is the value to test. + type: >- + number | string | boolean | | + | <any> + return: + type: <string> + description: '' + - name: tan(number) + uid: excel!Excel.Functions#tan:member(1) + package: excel! + fullName: tan(number) + summary: Returns the tangent of an angle. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + tan(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: >- + Is the angle in radians for which you want the tangent. Degrees * + PI()/180 = radians. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: tanh(number) + uid: excel!Excel.Functions#tanh:member(1) + package: excel! + fullName: tanh(number) + summary: Returns the hyperbolic tangent of a number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + tanh(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: Is any real number. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: tbillEq(settlement, maturity, discount) + uid: excel!Excel.Functions#tbillEq:member(1) + package: excel! + fullName: tbillEq(settlement, maturity, discount) + summary: Returns the bond-equivalent yield for a treasury bill. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + tbillEq(settlement: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, maturity: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, discount: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: settlement + description: >- + Is the Treasury bill's settlement date, expressed as a serial date + number. + type: >- + number | string | boolean | | + | <any> + - id: maturity + description: >- + Is the Treasury bill's maturity date, expressed as a serial date + number. + type: >- + number | string | boolean | | + | <any> + - id: discount + description: Is the Treasury bill's discount rate. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: tbillPrice(settlement, maturity, discount) + uid: excel!Excel.Functions#tbillPrice:member(1) + package: excel! + fullName: tbillPrice(settlement, maturity, discount) + summary: Returns the price per $100 face value for a treasury bill. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + tbillPrice(settlement: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, maturity: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, discount: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: settlement + description: >- + Is the Treasury bill's settlement date, expressed as a serial date + number. + type: >- + number | string | boolean | | + | <any> + - id: maturity + description: >- + Is the Treasury bill's maturity date, expressed as a serial date + number. + type: >- + number | string | boolean | | + | <any> + - id: discount + description: Is the Treasury bill's discount rate. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: tbillYield(settlement, maturity, pr) + uid: excel!Excel.Functions#tbillYield:member(1) + package: excel! + fullName: tbillYield(settlement, maturity, pr) + summary: Returns the yield for a treasury bill. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + tbillYield(settlement: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, maturity: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, pr: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: settlement + description: >- + Is the Treasury bill's settlement date, expressed as a serial date + number. + type: >- + number | string | boolean | | + | <any> + - id: maturity + description: >- + Is the Treasury bill's maturity date, expressed as a serial date + number. + type: >- + number | string | boolean | | + | <any> + - id: pr + description: Is the Treasury Bill's price per $100 face value. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: text(value, formatText) + uid: excel!Excel.Functions#text:member(1) + package: excel! + fullName: text(value, formatText) + summary: Converts a value to text in a specific number format. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + text(value: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, formatText: string | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: value + description: >- + Is a number, a formula that evaluates to a numeric value, or a + reference to a cell containing a numeric value. + type: >- + number | string | boolean | | + | <any> + - id: formatText + description: >- + Is a number format in text form from the Category box on the Number + tab in the Format Cells dialog box. + type: >- + string | | | <any> + return: + type: <string> + description: '' + - name: time(hour, minute, second) + uid: excel!Excel.Functions#time:member(1) + package: excel! + fullName: time(hour, minute, second) + summary: >- + Converts hours, minutes, and seconds given as numbers to an Excel serial + number, formatted with a time format. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + time(hour: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, minute: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, second: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: hour + description: Is a number from 0 to 23 representing the hour. + type: >- + number | | | <any> + - id: minute + description: Is a number from 0 to 59 representing the minute. + type: >- + number | | | <any> + - id: second + description: Is a number from 0 to 59 representing the second. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: timevalue(timeText) + uid: excel!Excel.Functions#timevalue:member(1) + package: excel! + fullName: timevalue(timeText) + summary: >- + Converts a text time to an Excel serial number for a time, a number from 0 + (12:00:00 AM) to 0.999988426 (11:59:59 PM). Format the number with a time + format after entering the formula. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + timevalue(timeText: string | number | Excel.Range | Excel.RangeReference + | Excel.FunctionResult): FunctionResult; + parameters: + - id: timeText + description: >- + Is a text string that gives a time in any one of the Microsoft Excel + time formats (date information in the string is ignored). + type: >- + string | number | | | <any> + return: + type: <number> + description: '' + - name: today() + uid: excel!Excel.Functions#today:member(1) + package: excel! + fullName: today() + summary: Returns the current date formatted as a date. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'today(): FunctionResult;' + return: + type: <number> + description: '' + - name: toJSON() + uid: excel!Excel.Functions#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.Functions` object + is an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Excel.Interfaces.FunctionsData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + toJSON(): { + [key: string]: string; + }; + return: + type: |- + { + [key: string]: string; + } + description: '' + - name: trim(text) + uid: excel!Excel.Functions#trim:member(1) + package: excel! + fullName: trim(text) + summary: >- + Removes all spaces from a text string except for single spaces between + words. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + trim(text: string | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: text + description: Is the text from which you want spaces removed. + type: >- + string | | | <any> + return: + type: <string> + description: '' + - name: trimMean(array, percent) + uid: excel!Excel.Functions#trimMean:member(1) + package: excel! + fullName: trimMean(array, percent) + summary: Returns the mean of the interior portion of a set of data values. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + trimMean(array: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, percent: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: array + description: Is the range or array of values to trim and average. + type: >- + number | | | <any> + - id: percent + description: >- + Is the fractional number of data points to exclude from the top and + bottom of the data set. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: true() + uid: excel!Excel.Functions#true:member(1) + package: excel! + fullName: true() + summary: Returns the logical value TRUE. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'true(): FunctionResult;' + return: + type: <boolean> + description: '' + - name: trunc(number, numDigits) + uid: excel!Excel.Functions#trunc:member(1) + package: excel! + fullName: trunc(number, numDigits) + summary: >- + Truncates a number to an integer by removing the decimal, or fractional, + part of the number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + trunc(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, numDigits?: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: number + description: Is the number you want to truncate. + type: >- + number | | | <any> + - id: numDigits + description: >- + Is a number specifying the precision of the truncation, 0 (zero) if + omitted. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: type(value) + uid: excel!Excel.Functions#type:member(1) + package: excel! + fullName: type(value) + summary: >- + Returns an integer representing the data type of a value: number = 1; text + = 2; logical value = 4; error value = 16; array = 64; compound data = 128. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + type(value: boolean | string | number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: value + description: Can be any value. + type: >- + boolean | string | number | | + | <any> + return: + type: <number> + description: '' + - name: unichar(number) + uid: excel!Excel.Functions#unichar:member(1) + package: excel! + fullName: unichar(number) + summary: Returns the Unicode character referenced by the given numeric value. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + unichar(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: number + description: Is the Unicode number representing a character. + type: >- + number | | | <any> + return: + type: <string> + description: '' + - name: unicode(text) + uid: excel!Excel.Functions#unicode:member(1) + package: excel! + fullName: unicode(text) + summary: >- + Returns the number (code point) corresponding to the first character of + the text. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + unicode(text: string | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: text + description: Is the character that you want the Unicode value of. + type: >- + string | | | <any> + return: + type: <number> + description: '' + - name: upper(text) + uid: excel!Excel.Functions#upper:member(1) + package: excel! + fullName: upper(text) + summary: Converts a text string to all uppercase letters. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + upper(text: string | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: text + description: >- + Is the text you want converted to uppercase, a reference or a text + string. + type: >- + string | | | <any> + return: + type: <string> + description: '' + - name: usdollar(number, decimals) + uid: excel!Excel.Functions#usdollar:member(1) + package: excel! + fullName: usdollar(number, decimals) + summary: Converts a number to text, using currency format. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + usdollar(number: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, decimals?: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: number + description: >- + Is a number, a reference to a cell containing a number, or a formula + that evaluates to a number. + type: >- + number | | | <any> + - id: decimals + description: Is the number of digits to the right of the decimal point. + type: >- + number | | | <any> + return: + type: <string> + description: '' + - name: value(text) + uid: excel!Excel.Functions#value:member(1) + package: excel! + fullName: value(text) + summary: Converts a text string that represents a number to a number. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + value(text: string | boolean | number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: text + description: >- + Is the text enclosed in quotation marks or a reference to a cell + containing the text you want to convert. + type: >- + string | boolean | number | | + | <any> + return: + type: <number> + description: '' + - name: var_P(values) + uid: excel!Excel.Functions#var_P:member(1) + package: excel! + fullName: var_P(values) + summary: >- + Calculates variance based on the entire population (ignores logical values + and text in the population). + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + var_P(...values: Array>): FunctionResult; + parameters: + - id: values + description: >- + List of parameters, whose elements are 1 to 255 numeric arguments + corresponding to a population. + type: >- + Array<number | | | <any>> + return: + type: <number> + description: '' + - name: var_S(values) + uid: excel!Excel.Functions#var_S:member(1) + package: excel! + fullName: var_S(values) + summary: >- + Estimates variance based on a sample (ignores logical values and text in + the sample). + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + var_S(...values: Array>): FunctionResult; + parameters: + - id: values + description: >- + List of parameters, whose elements are 1 to 255 numeric arguments + corresponding to a sample of a population. + type: >- + Array<number | | | <any>> + return: + type: <number> + description: '' + - name: varA(values) + uid: excel!Excel.Functions#varA:member(1) + package: excel! + fullName: varA(values) + summary: >- + Estimates variance based on a sample, including logical values and text. + Text and the logical value FALSE have the value 0; the logical value TRUE + has the value 1. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + varA(...values: Array>): FunctionResult; + parameters: + - id: values + description: >- + List of parameters, whose elements are 1 to 255 value arguments + corresponding to a sample of a population. + type: >- + Array<number | | | <any>> + return: + type: <number> + description: '' + - name: varPA(values) + uid: excel!Excel.Functions#varPA:member(1) + package: excel! + fullName: varPA(values) + summary: >- + Calculates variance based on the entire population, including logical + values and text. Text and the logical value FALSE have the value 0; the + logical value TRUE has the value 1. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + varPA(...values: Array>): FunctionResult; + parameters: + - id: values + description: >- + List of parameters, whose elements are 1 to 255 value arguments + corresponding to a population. + type: >- + Array<number | | | <any>> + return: + type: <number> + description: '' + - name: vdb(cost, salvage, life, startPeriod, endPeriod, factor, noSwitch) + uid: excel!Excel.Functions#vdb:member(1) + package: excel! + fullName: vdb(cost, salvage, life, startPeriod, endPeriod, factor, noSwitch) + summary: >- + Returns the depreciation of an asset for any period you specify, including + partial periods, using the double-declining balance method or some other + method you specify. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + vdb(cost: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, salvage: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, life: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, + startPeriod: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, endPeriod: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, factor?: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, + noSwitch?: boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: cost + description: Is the initial cost of the asset. + type: >- + number | | | <any> + - id: salvage + description: Is the salvage value at the end of the life of the asset. + type: >- + number | | | <any> + - id: life + description: >- + Is the number of periods over which the asset is being depreciated + (sometimes called the useful life of the asset). + type: >- + number | | | <any> + - id: startPeriod + description: >- + Is the starting period for which you want to calculate the + depreciation, in the same units as Life. + type: >- + number | | | <any> + - id: endPeriod + description: >- + Is the ending period for which you want to calculate the + depreciation, in the same units as Life. + type: >- + number | | | <any> + - id: factor + description: >- + Is the rate at which the balance declines, 2 (double-declining + balance) if omitted. + type: >- + number | | | <any> + - id: noSwitch + description: >- + Switch to straight-line depreciation when depreciation is greater + than the declining balance = FALSE or omitted; do not switch = TRUE. + type: >- + boolean | | | <any> + return: + type: <number> + description: '' + - name: vlookup(lookupValue, tableArray, colIndexNum, rangeLookup) + uid: excel!Excel.Functions#vlookup:member(1) + package: excel! + fullName: vlookup(lookupValue, tableArray, colIndexNum, rangeLookup) + summary: >- + Looks for a value in the leftmost column of a table, and then returns a + value in the same row from a column you specify. By default, the table + must be sorted in an ascending order. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-built-in-functions.yaml + + + await Excel.run(async (context) => { + // This function uses VLOOKUP to find data in the "Wrench" row on the worksheet. + let range = context.workbook.worksheets.getItem("Sample").getRange("A1:D4"); + + // Get the value in the second column in the "Wrench" row. + let unitSoldInNov = context.workbook.functions.vlookup("Wrench", range, 2, false); + unitSoldInNov.load("value"); + + await context.sync(); + console.log(" Number of wrenches sold in November = " + unitSoldInNov.value); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + vlookup(lookupValue: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, tableArray: + Excel.Range | number | Excel.RangeReference | Excel.FunctionResult, + colIndexNum: Excel.Range | number | Excel.RangeReference | + Excel.FunctionResult, rangeLookup?: boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): FunctionResult; + parameters: + - id: lookupValue + description: >- + Is the value to be found in the first column of the table, and can + be a value, a reference, or a text string. + type: >- + number | string | boolean | | + | <any> + - id: tableArray + description: >- + Is a table of text, numbers, or logical values, in which data is + retrieved. tableArray can be a reference to a range or a range name. + type: >- + | number | | <any> + - id: colIndexNum + description: >- + Is the column number in tableArray from which the matching value + should be returned. The first column of values in the table is + column 1. + type: >- + | number | | <any> + - id: rangeLookup + description: >- + Is a logical value: to find the closest match in the first column + (sorted in ascending order) = TRUE or omitted; find an exact match = + FALSE. + type: >- + boolean | | | <any> + return: + type: >- + <number | string | + boolean> + description: '' + - name: weekday(serialNumber, returnType) + uid: excel!Excel.Functions#weekday:member(1) + package: excel! + fullName: weekday(serialNumber, returnType) + summary: Returns a number from 1 to 7 identifying the day of the week of a date. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + weekday(serialNumber: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, returnType?: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: serialNumber + description: Is a number that represents a date. + type: >- + number | | | <any> + - id: returnType + description: >- + Is a number: for Sunday=1 through Saturday=7, use 1; for Monday=1 + through Sunday=7, use 2; for Monday=0 through Sunday=6, use 3. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: weekNum(serialNumber, returnType) + uid: excel!Excel.Functions#weekNum:member(1) + package: excel! + fullName: weekNum(serialNumber, returnType) + summary: Returns the week number in the year. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + weekNum(serialNumber: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, returnType?: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: serialNumber + description: >- + Is the date-time code used by Microsoft Excel for date and time + calculation. + type: >- + number | string | boolean | | + | <any> + - id: returnType + description: Is a number (1 or 2) that determines the type of the return value. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: weibull_Dist(x, alpha, beta, cumulative) + uid: excel!Excel.Functions#weibull_Dist:member(1) + package: excel! + fullName: weibull_Dist(x, alpha, beta, cumulative) + summary: Returns the Weibull distribution. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + weibull_Dist(x: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, alpha: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, beta: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, + cumulative: boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: x + description: >- + Is the value at which to evaluate the function, a nonnegative + number. + type: >- + number | | | <any> + - id: alpha + description: Is a parameter to the distribution, a positive number. + type: >- + number | | | <any> + - id: beta + description: Is a parameter to the distribution, a positive number. + type: >- + number | | | <any> + - id: cumulative + description: >- + Is a logical value: for the cumulative distribution function, use + TRUE; for the probability mass function, use FALSE. + type: >- + boolean | | | <any> + return: + type: <number> + description: '' + - name: workDay_Intl(startDate, days, weekend, holidays) + uid: excel!Excel.Functions#workDay_Intl:member(1) + package: excel! + fullName: workDay_Intl(startDate, days, weekend, holidays) + summary: >- + Returns the serial number of the date before or after a specified number + of workdays with custom weekend parameters. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + workDay_Intl(startDate: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, days: number | string + | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, weekend?: number | string | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, holidays?: number | + string | Excel.Range | boolean | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: startDate + description: Is a serial date number that represents the start date. + type: >- + number | string | boolean | | + | <any> + - id: days + description: >- + Is the number of nonweekend and non-holiday days before or after + startDate. + type: >- + number | string | boolean | | + | <any> + - id: weekend + description: Is a number or string specifying when weekends occur. + type: >- + number | string | | | <any> + - id: holidays + description: >- + Is an optional array of one or more serial date numbers to exclude + from the working calendar, such as state and federal holidays and + floating holidays. + type: >- + number | string | | boolean | + | <any> + return: + type: <number> + description: '' + - name: workDay(startDate, days, holidays) + uid: excel!Excel.Functions#workDay:member(1) + package: excel! + fullName: workDay(startDate, days, holidays) + summary: >- + Returns the serial number of the date before or after a specified number + of workdays. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + workDay(startDate: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, days: number | string + | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, holidays?: number | string | Excel.Range | + boolean | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: startDate + description: Is a serial date number that represents the start date. + type: >- + number | string | boolean | | + | <any> + - id: days + description: >- + Is the number of nonweekend and non-holiday days before or after + startDate. + type: >- + number | string | boolean | | + | <any> + - id: holidays + description: >- + Is an optional array of one or more serial date numbers to exclude + from the working calendar, such as state and federal holidays and + floating holidays. + type: >- + number | string | | boolean | + | <any> + return: + type: <number> + description: '' + - name: xirr(values, dates, guess) + uid: excel!Excel.Functions#xirr:member(1) + package: excel! + fullName: xirr(values, dates, guess) + summary: Returns the internal rate of return for a schedule of cash flows. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + xirr(values: number | string | Excel.Range | boolean | + Excel.RangeReference | Excel.FunctionResult, dates: number | string + | Excel.Range | boolean | Excel.RangeReference | + Excel.FunctionResult, guess?: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: values + description: >- + Is a series of cash flows that correspond to a schedule of payments + in dates. + type: >- + number | string | | boolean | + | <any> + - id: dates + description: >- + Is a schedule of payment dates that corresponds to the cash flow + payments. + type: >- + number | string | | boolean | + | <any> + - id: guess + description: Is a number that you guess is close to the result of XIRR. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: xnpv(rate, values, dates) + uid: excel!Excel.Functions#xnpv:member(1) + package: excel! + fullName: xnpv(rate, values, dates) + summary: Returns the net present value for a schedule of cash flows. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + xnpv(rate: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, values: number | + string | Excel.Range | boolean | Excel.RangeReference | + Excel.FunctionResult, dates: number | string | Excel.Range | + boolean | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: rate + description: Is the discount rate to apply to the cash flows. + type: >- + number | string | boolean | | + | <any> + - id: values + description: >- + Is a series of cash flows that correspond to a schedule of payments + in dates. + type: >- + number | string | | boolean | + | <any> + - id: dates + description: >- + Is a schedule of payment dates that corresponds to the cash flow + payments. + type: >- + number | string | | boolean | + | <any> + return: + type: <number> + description: '' + - name: xor(values) + uid: excel!Excel.Functions#xor:member(1) + package: excel! + fullName: xor(values) + summary: Returns a logical 'Exclusive Or' of all arguments. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + xor(...values: Array>): FunctionResult; + parameters: + - id: values + description: >- + List of parameters, whose elements are 1 to 254 conditions you want + to test that can be either TRUE or FALSE and can be logical values, + arrays, or references. + type: >- + Array<boolean | | | <any>> + return: + type: <boolean> + description: '' + - name: year(serialNumber) + uid: excel!Excel.Functions#year:member(1) + package: excel! + fullName: year(serialNumber) + summary: Returns the year of a date, an integer in the range 1900 - 9999. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + year(serialNumber: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: serialNumber + description: Is a number in the date-time code used by Microsoft Excel. + type: >- + number | | | <any> + return: + type: <number> + description: '' + - name: yearFrac(startDate, endDate, basis) + uid: excel!Excel.Functions#yearFrac:member(1) + package: excel! + fullName: yearFrac(startDate, endDate, basis) + summary: >- + Returns the year fraction representing the number of whole days between + start\_date and end\_date. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + yearFrac(startDate: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, endDate: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, basis?: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: startDate + description: Is a serial date number that represents the start date. + type: >- + number | string | boolean | | + | <any> + - id: endDate + description: Is a serial date number that represents the end date. + type: >- + number | string | boolean | | + | <any> + - id: basis + description: Is the type of day count basis to use. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: yield(settlement, maturity, rate, pr, redemption, frequency, basis) + uid: excel!Excel.Functions#yield:member(1) + package: excel! + fullName: yield(settlement, maturity, rate, pr, redemption, frequency, basis) + summary: Returns the yield on a security that pays periodic interest. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + yield(settlement: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, maturity: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, rate: number | string | boolean | Excel.Range + | Excel.RangeReference | Excel.FunctionResult, pr: number | string + | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, redemption: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, + frequency: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, basis?: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: settlement + description: >- + Is the security's settlement date, expressed as a serial date + number. + type: >- + number | string | boolean | | + | <any> + - id: maturity + description: Is the security's maturity date, expressed as a serial date number. + type: >- + number | string | boolean | | + | <any> + - id: rate + description: Is the security's annual coupon rate. + type: >- + number | string | boolean | | + | <any> + - id: pr + description: Is the security's price per $100 face value. + type: >- + number | string | boolean | | + | <any> + - id: redemption + description: Is the security's redemption value per $100 face value. + type: >- + number | string | boolean | | + | <any> + - id: frequency + description: Is the number of coupon payments per year. + type: >- + number | string | boolean | | + | <any> + - id: basis + description: Is the type of day count basis to use. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: yieldDisc(settlement, maturity, pr, redemption, basis) + uid: excel!Excel.Functions#yieldDisc:member(1) + package: excel! + fullName: yieldDisc(settlement, maturity, pr, redemption, basis) + summary: >- + Returns the annual yield for a discounted security. For example, a + treasury bill. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + yieldDisc(settlement: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, maturity: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, pr: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, redemption: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, basis?: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: settlement + description: >- + Is the security's settlement date, expressed as a serial date + number. + type: >- + number | string | boolean | | + | <any> + - id: maturity + description: Is the security's maturity date, expressed as a serial date number. + type: >- + number | string | boolean | | + | <any> + - id: pr + description: Is the security's price per $100 face value. + type: >- + number | string | boolean | | + | <any> + - id: redemption + description: Is the security's redemption value per $100 face value. + type: >- + number | string | boolean | | + | <any> + - id: basis + description: Is the type of day count basis to use. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: yieldMat(settlement, maturity, issue, rate, pr, basis) + uid: excel!Excel.Functions#yieldMat:member(1) + package: excel! + fullName: yieldMat(settlement, maturity, issue, rate, pr, basis) + summary: Returns the annual yield of a security that pays interest at maturity. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + yieldMat(settlement: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, maturity: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, issue: number | string | boolean | + Excel.Range | Excel.RangeReference | Excel.FunctionResult, rate: + number | string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, pr: number | string | boolean | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, basis?: number | + string | boolean | Excel.Range | Excel.RangeReference | + Excel.FunctionResult): FunctionResult; + parameters: + - id: settlement + description: >- + Is the security's settlement date, expressed as a serial date + number. + type: >- + number | string | boolean | | + | <any> + - id: maturity + description: Is the security's maturity date, expressed as a serial date number. + type: >- + number | string | boolean | | + | <any> + - id: issue + description: Is the security's issue date, expressed as a serial date number. + type: >- + number | string | boolean | | + | <any> + - id: rate + description: Is the security's interest rate at date of issue. + type: >- + number | string | boolean | | + | <any> + - id: pr + description: Is the security's price per $100 face value. + type: >- + number | string | boolean | | + | <any> + - id: basis + description: Is the type of day count basis to use. + type: >- + number | string | boolean | | + | <any> + return: + type: <number> + description: '' + - name: z_Test(array, x, sigma) + uid: excel!Excel.Functions#z_Test:member(1) + package: excel! + fullName: z_Test(array, x, sigma) + summary: Returns the one-tailed P-value of a z-test. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + z_Test(array: number | Excel.Range | Excel.RangeReference | + Excel.FunctionResult, x: number | Excel.Range | + Excel.RangeReference | Excel.FunctionResult, sigma?: number | + Excel.Range | Excel.RangeReference | Excel.FunctionResult): + FunctionResult; + parameters: + - id: array + description: Is the array or range of data against which to test X. + type: >- + number | | | <any> + - id: x + description: Is the value to test. + type: >- + number | | | <any> + - id: sigma + description: >- + Is the population (known) standard deviation. If omitted, the sample + standard deviation is used. + type: >- + number | | | <any> + return: + type: <number> + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.geometricshape.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.geometricshape.yml new file mode 100644 index 0000000000..6292d4bc34 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.geometricshape.yml @@ -0,0 +1,164 @@ +### YamlMime:TSType +name: Excel.GeometricShape +uid: excel!Excel.GeometricShape:class +package: excel! +fullName: Excel.GeometricShape +summary: >- + Represents a geometric shape inside a worksheet. A geometric shape can be a + rectangle, block arrow, equation symbol, flowchart item, star, banner, + callout, or any other basic shape in Excel. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.GeometricShape#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: id + uid: excel!Excel.GeometricShape#id:member + package: excel! + fullName: id + summary: Returns the shape identifier. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly id: string;' + return: + type: string + - name: shape + uid: excel!Excel.GeometricShape#shape:member + package: excel! + fullName: shape + summary: Returns the `Shape` object for the geometric shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly shape: Excel.Shape;' + return: + type: +methods: + - name: load(options) + uid: excel!Excel.GeometricShape#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.GeometricShapeLoadOptions): + Excel.GeometricShape; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.GeometricShape#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.GeometricShape;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.GeometricShape#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.GeometricShape; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.GeometricShape#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.GeometricShape` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.GeometricShapeData`) that + contains shallow copies of any loaded child properties from the original + object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.GeometricShapeData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.geometricshapetype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.geometricshapetype.yml new file mode 100644 index 0000000000..eb3b46d177 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.geometricshapetype.yml @@ -0,0 +1,1274 @@ +### YamlMime:TSEnum +name: Excel.GeometricShapeType +uid: excel!Excel.GeometricShapeType:enum +package: excel! +fullName: Excel.GeometricShapeType +summary: Specifies the shape type for a `GeometricShape` object. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-create-and-delete.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Shapes"); + const shape = sheet.shapes.addGeometricShape(Excel.GeometricShapeType.hexagon); + shape.left = 5; + shape.top = 5; + shape.height = 175; + shape.width = 200; + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: accentBorderCallout1 + uid: excel!Excel.GeometricShapeType.accentBorderCallout1:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"AccentBorderCallout1"' + - name: accentBorderCallout2 + uid: excel!Excel.GeometricShapeType.accentBorderCallout2:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"AccentBorderCallout2"' + - name: accentBorderCallout3 + uid: excel!Excel.GeometricShapeType.accentBorderCallout3:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"AccentBorderCallout3"' + - name: accentCallout1 + uid: excel!Excel.GeometricShapeType.accentCallout1:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"AccentCallout1"' + - name: accentCallout2 + uid: excel!Excel.GeometricShapeType.accentCallout2:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"AccentCallout2"' + - name: accentCallout3 + uid: excel!Excel.GeometricShapeType.accentCallout3:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"AccentCallout3"' + - name: actionButtonBackPrevious + uid: excel!Excel.GeometricShapeType.actionButtonBackPrevious:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ActionButtonBackPrevious"' + - name: actionButtonBeginning + uid: excel!Excel.GeometricShapeType.actionButtonBeginning:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ActionButtonBeginning"' + - name: actionButtonBlank + uid: excel!Excel.GeometricShapeType.actionButtonBlank:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ActionButtonBlank"' + - name: actionButtonDocument + uid: excel!Excel.GeometricShapeType.actionButtonDocument:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ActionButtonDocument"' + - name: actionButtonEnd + uid: excel!Excel.GeometricShapeType.actionButtonEnd:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ActionButtonEnd"' + - name: actionButtonForwardNext + uid: excel!Excel.GeometricShapeType.actionButtonForwardNext:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ActionButtonForwardNext"' + - name: actionButtonHelp + uid: excel!Excel.GeometricShapeType.actionButtonHelp:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ActionButtonHelp"' + - name: actionButtonHome + uid: excel!Excel.GeometricShapeType.actionButtonHome:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ActionButtonHome"' + - name: actionButtonInformation + uid: excel!Excel.GeometricShapeType.actionButtonInformation:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ActionButtonInformation"' + - name: actionButtonMovie + uid: excel!Excel.GeometricShapeType.actionButtonMovie:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ActionButtonMovie"' + - name: actionButtonReturn + uid: excel!Excel.GeometricShapeType.actionButtonReturn:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ActionButtonReturn"' + - name: actionButtonSound + uid: excel!Excel.GeometricShapeType.actionButtonSound:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ActionButtonSound"' + - name: arc + uid: excel!Excel.GeometricShapeType.arc:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Arc"' + - name: bentArrow + uid: excel!Excel.GeometricShapeType.bentArrow:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"BentArrow"' + - name: bentUpArrow + uid: excel!Excel.GeometricShapeType.bentUpArrow:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"BentUpArrow"' + - name: bevel + uid: excel!Excel.GeometricShapeType.bevel:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Bevel"' + - name: blockArc + uid: excel!Excel.GeometricShapeType.blockArc:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"BlockArc"' + - name: borderCallout1 + uid: excel!Excel.GeometricShapeType.borderCallout1:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"BorderCallout1"' + - name: borderCallout2 + uid: excel!Excel.GeometricShapeType.borderCallout2:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"BorderCallout2"' + - name: borderCallout3 + uid: excel!Excel.GeometricShapeType.borderCallout3:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"BorderCallout3"' + - name: bracePair + uid: excel!Excel.GeometricShapeType.bracePair:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"BracePair"' + - name: bracketPair + uid: excel!Excel.GeometricShapeType.bracketPair:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"BracketPair"' + - name: callout1 + uid: excel!Excel.GeometricShapeType.callout1:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Callout1"' + - name: callout2 + uid: excel!Excel.GeometricShapeType.callout2:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Callout2"' + - name: callout3 + uid: excel!Excel.GeometricShapeType.callout3:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Callout3"' + - name: can + uid: excel!Excel.GeometricShapeType.can:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Can"' + - name: chartPlus + uid: excel!Excel.GeometricShapeType.chartPlus:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ChartPlus"' + - name: chartStar + uid: excel!Excel.GeometricShapeType.chartStar:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ChartStar"' + - name: chartX + uid: excel!Excel.GeometricShapeType.chartX:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ChartX"' + - name: chevron + uid: excel!Excel.GeometricShapeType.chevron:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Chevron"' + - name: chord + uid: excel!Excel.GeometricShapeType.chord:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Chord"' + - name: circularArrow + uid: excel!Excel.GeometricShapeType.circularArrow:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"CircularArrow"' + - name: cloud + uid: excel!Excel.GeometricShapeType.cloud:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Cloud"' + - name: cloudCallout + uid: excel!Excel.GeometricShapeType.cloudCallout:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"CloudCallout"' + - name: corner + uid: excel!Excel.GeometricShapeType.corner:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Corner"' + - name: cornerTabs + uid: excel!Excel.GeometricShapeType.cornerTabs:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"CornerTabs"' + - name: cube + uid: excel!Excel.GeometricShapeType.cube:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Cube"' + - name: curvedDownArrow + uid: excel!Excel.GeometricShapeType.curvedDownArrow:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"CurvedDownArrow"' + - name: curvedLeftArrow + uid: excel!Excel.GeometricShapeType.curvedLeftArrow:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"CurvedLeftArrow"' + - name: curvedRightArrow + uid: excel!Excel.GeometricShapeType.curvedRightArrow:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"CurvedRightArrow"' + - name: curvedUpArrow + uid: excel!Excel.GeometricShapeType.curvedUpArrow:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"CurvedUpArrow"' + - name: decagon + uid: excel!Excel.GeometricShapeType.decagon:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Decagon"' + - name: diagonalStripe + uid: excel!Excel.GeometricShapeType.diagonalStripe:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"DiagonalStripe"' + - name: diamond + uid: excel!Excel.GeometricShapeType.diamond:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Diamond"' + - name: dodecagon + uid: excel!Excel.GeometricShapeType.dodecagon:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Dodecagon"' + - name: donut + uid: excel!Excel.GeometricShapeType.donut:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Donut"' + - name: doubleWave + uid: excel!Excel.GeometricShapeType.doubleWave:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"DoubleWave"' + - name: downArrow + uid: excel!Excel.GeometricShapeType.downArrow:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"DownArrow"' + - name: downArrowCallout + uid: excel!Excel.GeometricShapeType.downArrowCallout:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"DownArrowCallout"' + - name: ellipse + uid: excel!Excel.GeometricShapeType.ellipse:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Ellipse"' + - name: ellipseRibbon + uid: excel!Excel.GeometricShapeType.ellipseRibbon:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"EllipseRibbon"' + - name: ellipseRibbon2 + uid: excel!Excel.GeometricShapeType.ellipseRibbon2:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"EllipseRibbon2"' + - name: flowChartAlternateProcess + uid: excel!Excel.GeometricShapeType.flowChartAlternateProcess:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FlowChartAlternateProcess"' + - name: flowChartCollate + uid: excel!Excel.GeometricShapeType.flowChartCollate:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FlowChartCollate"' + - name: flowChartConnector + uid: excel!Excel.GeometricShapeType.flowChartConnector:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FlowChartConnector"' + - name: flowChartDecision + uid: excel!Excel.GeometricShapeType.flowChartDecision:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FlowChartDecision"' + - name: flowChartDelay + uid: excel!Excel.GeometricShapeType.flowChartDelay:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FlowChartDelay"' + - name: flowChartDisplay + uid: excel!Excel.GeometricShapeType.flowChartDisplay:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FlowChartDisplay"' + - name: flowChartDocument + uid: excel!Excel.GeometricShapeType.flowChartDocument:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FlowChartDocument"' + - name: flowChartExtract + uid: excel!Excel.GeometricShapeType.flowChartExtract:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FlowChartExtract"' + - name: flowChartInputOutput + uid: excel!Excel.GeometricShapeType.flowChartInputOutput:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FlowChartInputOutput"' + - name: flowChartInternalStorage + uid: excel!Excel.GeometricShapeType.flowChartInternalStorage:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FlowChartInternalStorage"' + - name: flowChartMagneticDisk + uid: excel!Excel.GeometricShapeType.flowChartMagneticDisk:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FlowChartMagneticDisk"' + - name: flowChartMagneticDrum + uid: excel!Excel.GeometricShapeType.flowChartMagneticDrum:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FlowChartMagneticDrum"' + - name: flowChartMagneticTape + uid: excel!Excel.GeometricShapeType.flowChartMagneticTape:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FlowChartMagneticTape"' + - name: flowChartManualInput + uid: excel!Excel.GeometricShapeType.flowChartManualInput:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FlowChartManualInput"' + - name: flowChartManualOperation + uid: excel!Excel.GeometricShapeType.flowChartManualOperation:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FlowChartManualOperation"' + - name: flowChartMerge + uid: excel!Excel.GeometricShapeType.flowChartMerge:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FlowChartMerge"' + - name: flowChartMultidocument + uid: excel!Excel.GeometricShapeType.flowChartMultidocument:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FlowChartMultidocument"' + - name: flowChartOfflineStorage + uid: excel!Excel.GeometricShapeType.flowChartOfflineStorage:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FlowChartOfflineStorage"' + - name: flowChartOffpageConnector + uid: excel!Excel.GeometricShapeType.flowChartOffpageConnector:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FlowChartOffpageConnector"' + - name: flowChartOnlineStorage + uid: excel!Excel.GeometricShapeType.flowChartOnlineStorage:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FlowChartOnlineStorage"' + - name: flowChartOr + uid: excel!Excel.GeometricShapeType.flowChartOr:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FlowChartOr"' + - name: flowChartPredefinedProcess + uid: excel!Excel.GeometricShapeType.flowChartPredefinedProcess:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FlowChartPredefinedProcess"' + - name: flowChartPreparation + uid: excel!Excel.GeometricShapeType.flowChartPreparation:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FlowChartPreparation"' + - name: flowChartProcess + uid: excel!Excel.GeometricShapeType.flowChartProcess:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FlowChartProcess"' + - name: flowChartPunchedCard + uid: excel!Excel.GeometricShapeType.flowChartPunchedCard:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FlowChartPunchedCard"' + - name: flowChartPunchedTape + uid: excel!Excel.GeometricShapeType.flowChartPunchedTape:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FlowChartPunchedTape"' + - name: flowChartSort + uid: excel!Excel.GeometricShapeType.flowChartSort:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FlowChartSort"' + - name: flowChartSummingJunction + uid: excel!Excel.GeometricShapeType.flowChartSummingJunction:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FlowChartSummingJunction"' + - name: flowChartTerminator + uid: excel!Excel.GeometricShapeType.flowChartTerminator:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FlowChartTerminator"' + - name: foldedCorner + uid: excel!Excel.GeometricShapeType.foldedCorner:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FoldedCorner"' + - name: frame + uid: excel!Excel.GeometricShapeType.frame:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Frame"' + - name: funnel + uid: excel!Excel.GeometricShapeType.funnel:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Funnel"' + - name: gear6 + uid: excel!Excel.GeometricShapeType.gear6:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Gear6"' + - name: gear9 + uid: excel!Excel.GeometricShapeType.gear9:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Gear9"' + - name: halfFrame + uid: excel!Excel.GeometricShapeType.halfFrame:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"HalfFrame"' + - name: heart + uid: excel!Excel.GeometricShapeType.heart:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Heart"' + - name: heptagon + uid: excel!Excel.GeometricShapeType.heptagon:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Heptagon"' + - name: hexagon + uid: excel!Excel.GeometricShapeType.hexagon:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Hexagon"' + - name: homePlate + uid: excel!Excel.GeometricShapeType.homePlate:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"HomePlate"' + - name: horizontalScroll + uid: excel!Excel.GeometricShapeType.horizontalScroll:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"HorizontalScroll"' + - name: irregularSeal1 + uid: excel!Excel.GeometricShapeType.irregularSeal1:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"IrregularSeal1"' + - name: irregularSeal2 + uid: excel!Excel.GeometricShapeType.irregularSeal2:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"IrregularSeal2"' + - name: leftArrow + uid: excel!Excel.GeometricShapeType.leftArrow:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LeftArrow"' + - name: leftArrowCallout + uid: excel!Excel.GeometricShapeType.leftArrowCallout:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LeftArrowCallout"' + - name: leftBrace + uid: excel!Excel.GeometricShapeType.leftBrace:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LeftBrace"' + - name: leftBracket + uid: excel!Excel.GeometricShapeType.leftBracket:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LeftBracket"' + - name: leftCircularArrow + uid: excel!Excel.GeometricShapeType.leftCircularArrow:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LeftCircularArrow"' + - name: leftRightArrow + uid: excel!Excel.GeometricShapeType.leftRightArrow:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LeftRightArrow"' + - name: leftRightArrowCallout + uid: excel!Excel.GeometricShapeType.leftRightArrowCallout:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LeftRightArrowCallout"' + - name: leftRightCircularArrow + uid: excel!Excel.GeometricShapeType.leftRightCircularArrow:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LeftRightCircularArrow"' + - name: leftRightRibbon + uid: excel!Excel.GeometricShapeType.leftRightRibbon:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LeftRightRibbon"' + - name: leftRightUpArrow + uid: excel!Excel.GeometricShapeType.leftRightUpArrow:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LeftRightUpArrow"' + - name: leftUpArrow + uid: excel!Excel.GeometricShapeType.leftUpArrow:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LeftUpArrow"' + - name: lightningBolt + uid: excel!Excel.GeometricShapeType.lightningBolt:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LightningBolt"' + - name: lineInverse + uid: excel!Excel.GeometricShapeType.lineInverse:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LineInverse"' + - name: mathDivide + uid: excel!Excel.GeometricShapeType.mathDivide:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"MathDivide"' + - name: mathEqual + uid: excel!Excel.GeometricShapeType.mathEqual:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"MathEqual"' + - name: mathMinus + uid: excel!Excel.GeometricShapeType.mathMinus:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"MathMinus"' + - name: mathMultiply + uid: excel!Excel.GeometricShapeType.mathMultiply:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"MathMultiply"' + - name: mathNotEqual + uid: excel!Excel.GeometricShapeType.mathNotEqual:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"MathNotEqual"' + - name: mathPlus + uid: excel!Excel.GeometricShapeType.mathPlus:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"MathPlus"' + - name: moon + uid: excel!Excel.GeometricShapeType.moon:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Moon"' + - name: nonIsoscelesTrapezoid + uid: excel!Excel.GeometricShapeType.nonIsoscelesTrapezoid:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"NonIsoscelesTrapezoid"' + - name: noSmoking + uid: excel!Excel.GeometricShapeType.noSmoking:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"NoSmoking"' + - name: notchedRightArrow + uid: excel!Excel.GeometricShapeType.notchedRightArrow:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"NotchedRightArrow"' + - name: octagon + uid: excel!Excel.GeometricShapeType.octagon:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Octagon"' + - name: parallelogram + uid: excel!Excel.GeometricShapeType.parallelogram:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Parallelogram"' + - name: pentagon + uid: excel!Excel.GeometricShapeType.pentagon:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Pentagon"' + - name: pie + uid: excel!Excel.GeometricShapeType.pie:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Pie"' + - name: pieWedge + uid: excel!Excel.GeometricShapeType.pieWedge:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"PieWedge"' + - name: plaque + uid: excel!Excel.GeometricShapeType.plaque:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Plaque"' + - name: plaqueTabs + uid: excel!Excel.GeometricShapeType.plaqueTabs:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"PlaqueTabs"' + - name: plus + uid: excel!Excel.GeometricShapeType.plus:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Plus"' + - name: quadArrow + uid: excel!Excel.GeometricShapeType.quadArrow:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"QuadArrow"' + - name: quadArrowCallout + uid: excel!Excel.GeometricShapeType.quadArrowCallout:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"QuadArrowCallout"' + - name: rectangle + uid: excel!Excel.GeometricShapeType.rectangle:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Rectangle"' + - name: ribbon + uid: excel!Excel.GeometricShapeType.ribbon:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Ribbon"' + - name: ribbon2 + uid: excel!Excel.GeometricShapeType.ribbon2:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Ribbon2"' + - name: rightArrow + uid: excel!Excel.GeometricShapeType.rightArrow:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"RightArrow"' + - name: rightArrowCallout + uid: excel!Excel.GeometricShapeType.rightArrowCallout:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"RightArrowCallout"' + - name: rightBrace + uid: excel!Excel.GeometricShapeType.rightBrace:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"RightBrace"' + - name: rightBracket + uid: excel!Excel.GeometricShapeType.rightBracket:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"RightBracket"' + - name: rightTriangle + uid: excel!Excel.GeometricShapeType.rightTriangle:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"RightTriangle"' + - name: round1Rectangle + uid: excel!Excel.GeometricShapeType.round1Rectangle:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Round1Rectangle"' + - name: round2DiagonalRectangle + uid: excel!Excel.GeometricShapeType.round2DiagonalRectangle:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Round2DiagonalRectangle"' + - name: round2SameRectangle + uid: excel!Excel.GeometricShapeType.round2SameRectangle:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Round2SameRectangle"' + - name: roundRectangle + uid: excel!Excel.GeometricShapeType.roundRectangle:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"RoundRectangle"' + - name: smileyFace + uid: excel!Excel.GeometricShapeType.smileyFace:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"SmileyFace"' + - name: snip1Rectangle + uid: excel!Excel.GeometricShapeType.snip1Rectangle:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Snip1Rectangle"' + - name: snip2DiagonalRectangle + uid: excel!Excel.GeometricShapeType.snip2DiagonalRectangle:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Snip2DiagonalRectangle"' + - name: snip2SameRectangle + uid: excel!Excel.GeometricShapeType.snip2SameRectangle:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Snip2SameRectangle"' + - name: snipRoundRectangle + uid: excel!Excel.GeometricShapeType.snipRoundRectangle:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"SnipRoundRectangle"' + - name: squareTabs + uid: excel!Excel.GeometricShapeType.squareTabs:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"SquareTabs"' + - name: star10 + uid: excel!Excel.GeometricShapeType.star10:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Star10"' + - name: star12 + uid: excel!Excel.GeometricShapeType.star12:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Star12"' + - name: star16 + uid: excel!Excel.GeometricShapeType.star16:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Star16"' + - name: star24 + uid: excel!Excel.GeometricShapeType.star24:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Star24"' + - name: star32 + uid: excel!Excel.GeometricShapeType.star32:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Star32"' + - name: star4 + uid: excel!Excel.GeometricShapeType.star4:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Star4"' + - name: star5 + uid: excel!Excel.GeometricShapeType.star5:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Star5"' + - name: star6 + uid: excel!Excel.GeometricShapeType.star6:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Star6"' + - name: star7 + uid: excel!Excel.GeometricShapeType.star7:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Star7"' + - name: star8 + uid: excel!Excel.GeometricShapeType.star8:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Star8"' + - name: stripedRightArrow + uid: excel!Excel.GeometricShapeType.stripedRightArrow:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"StripedRightArrow"' + - name: sun + uid: excel!Excel.GeometricShapeType.sun:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Sun"' + - name: swooshArrow + uid: excel!Excel.GeometricShapeType.swooshArrow:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"SwooshArrow"' + - name: teardrop + uid: excel!Excel.GeometricShapeType.teardrop:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Teardrop"' + - name: trapezoid + uid: excel!Excel.GeometricShapeType.trapezoid:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Trapezoid"' + - name: triangle + uid: excel!Excel.GeometricShapeType.triangle:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Triangle"' + - name: upArrow + uid: excel!Excel.GeometricShapeType.upArrow:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"UpArrow"' + - name: upArrowCallout + uid: excel!Excel.GeometricShapeType.upArrowCallout:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"UpArrowCallout"' + - name: upDownArrow + uid: excel!Excel.GeometricShapeType.upDownArrow:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"UpDownArrow"' + - name: upDownArrowCallout + uid: excel!Excel.GeometricShapeType.upDownArrowCallout:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"UpDownArrowCallout"' + - name: uturnArrow + uid: excel!Excel.GeometricShapeType.uturnArrow:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"UturnArrow"' + - name: verticalScroll + uid: excel!Excel.GeometricShapeType.verticalScroll:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"VerticalScroll"' + - name: wave + uid: excel!Excel.GeometricShapeType.wave:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Wave"' + - name: wedgeEllipseCallout + uid: excel!Excel.GeometricShapeType.wedgeEllipseCallout:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"WedgeEllipseCallout"' + - name: wedgeRectCallout + uid: excel!Excel.GeometricShapeType.wedgeRectCallout:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"WedgeRectCallout"' + - name: wedgeRRectCallout + uid: excel!Excel.GeometricShapeType.wedgeRRectCallout:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"WedgeRRectCallout"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.gettingdataerrorcellvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.gettingdataerrorcellvalue.yml new file mode 100644 index 0000000000..cff16d4be1 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.gettingdataerrorcellvalue.yml @@ -0,0 +1,87 @@ +### YamlMime:TSType +name: Excel.GettingDataErrorCellValue +uid: excel!Excel.GettingDataErrorCellValue:interface +package: excel! +fullName: Excel.GettingDataErrorCellValue +summary: Represents the value of a cell containing a \#GETTING\_DATA error. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: basicType + uid: excel!Excel.GettingDataErrorCellValue#basicType:member + package: excel! + fullName: basicType + summary: >- + Represents the value that would be returned by `Range.valueTypes` for a + cell with this value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicType?: RangeValueType.error | "Error";' + return: + type: | "Error" + - name: basicValue + uid: excel!Excel.GettingDataErrorCellValue#basicValue:member + package: excel! + fullName: basicValue + summary: >- + Represents the value that would be returned by `Range.values` for a cell + with this value. When accessed through a `valuesAsJson` property, this + string value aligns with the en-US locale. When accessed through a + `valuesAsJsonLocal` property, this string value aligns with the user's + display locale. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicValue?: "#GETTING_DATA" | string;' + return: + type: '"#GETTING_DATA" | string' + - name: errorType + uid: excel!Excel.GettingDataErrorCellValue#errorType:member + package: excel! + fullName: errorType + summary: Represents the type of `ErrorCellValue`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'errorType?: ErrorCellValueType.gettingData | "GettingData";' + return: + type: >- + | + "GettingData" + - name: type + uid: excel!Excel.GettingDataErrorCellValue#type:member + package: excel! + fullName: type + summary: Represents the type of this cell value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: CellValueType.error | "Error";' + return: + type: | "Error" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.groupoption.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.groupoption.yml new file mode 100644 index 0000000000..e370bf8712 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.groupoption.yml @@ -0,0 +1,61 @@ +### YamlMime:TSEnum +name: Excel.GroupOption +uid: excel!Excel.GroupOption:enum +package: excel! +fullName: Excel.GroupOption +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/outline.yaml + + + Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Group the larger, main level. Note that the outline controls + // will be on row 10, meaning 4-9 will collapse and expand. + sheet.getRange("4:9").group(Excel.GroupOption.byRows); + + // Group the smaller, sublevels. Note that the outline controls + // will be on rows 6 and 9, meaning 4-5 and 7-8 will collapse and expand. + sheet.getRange("4:5").group(Excel.GroupOption.byRows); + sheet.getRange("7:8").group(Excel.GroupOption.byRows); + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: byColumns + uid: excel!Excel.GroupOption.byColumns:member + package: excel! + summary: >- + Group by columns. + + + * \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ByColumns"' + - name: byRows + uid: excel!Excel.GroupOption.byRows:member + package: excel! + summary: >- + Group by rows. + + + * \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ByRows"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.groupshapecollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.groupshapecollection.yml new file mode 100644 index 0000000000..5fb36a7447 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.groupshapecollection.yml @@ -0,0 +1,225 @@ +### YamlMime:TSType +name: Excel.GroupShapeCollection +uid: excel!Excel.GroupShapeCollection:class +package: excel! +fullName: Excel.GroupShapeCollection +summary: Represents the shape collection inside a shape group. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.GroupShapeCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: excel!Excel.GroupShapeCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.Shape[];' + return: + type: [] +methods: + - name: getCount() + uid: excel!Excel.GroupShapeCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Returns the number of shapes in the shape group. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getItem(key) + uid: excel!Excel.GroupShapeCollection#getItem:member(1) + package: excel! + fullName: getItem(key) + summary: Gets a shape using its name or ID. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItem(key: string): Excel.Shape;' + parameters: + - id: key + description: The name or ID of the shape to be retrieved. + type: string + return: + type: + description: '' + - name: getItemAt(index) + uid: excel!Excel.GroupShapeCollection#getItemAt:member(1) + package: excel! + fullName: getItemAt(index) + summary: Gets a shape based on its position in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemAt(index: number): Excel.Shape;' + parameters: + - id: index + description: The zero-based index value of the object to be retrieved. + type: number + return: + type: + description: '' + - name: getItemOrNullObject(key) + uid: excel!Excel.GroupShapeCollection#getItemOrNullObject:member(1) + package: excel! + fullName: getItemOrNullObject(key) + summary: >- + Gets a shape using its name or ID. If the shape object does not exist, + then this method returns an object with its `isNullObject` property set to + `true`. For further information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemOrNullObject(key: string): Excel.Shape;' + parameters: + - id: key + description: The name or ID of the shape to be retrieved. + type: string + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.GroupShapeCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.GroupShapeCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): Excel.GroupShapeCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.GroupShapeCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.GroupShapeCollection;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.GroupShapeCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.GroupShapeCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.GroupShapeCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.GroupShapeCollection` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.GroupShapeCollectionData`) that contains an + "items" array with shallow copies of any loaded properties from the + collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.GroupShapeCollectionData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.headerfooter.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.headerfooter.yml new file mode 100644 index 0000000000..c9cc7314ea --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.headerfooter.yml @@ -0,0 +1,292 @@ +### YamlMime:TSType +name: Excel.HeaderFooter +uid: excel!Excel.HeaderFooter:class +package: excel! +fullName: Excel.HeaderFooter +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: centerFooter + uid: excel!Excel.HeaderFooter#centerFooter:member + package: excel! + fullName: centerFooter + summary: >- + The center footer of the worksheet. To apply font formatting or insert a + variable value, use format codes specified here: + https://msdn.microsoft.com/library/bb225426.aspx. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'centerFooter: string;' + return: + type: string + - name: centerHeader + uid: excel!Excel.HeaderFooter#centerHeader:member + package: excel! + fullName: centerHeader + summary: >- + The center header of the worksheet. To apply font formatting or insert a + variable value, use format codes specified here: + https://msdn.microsoft.com/library/bb225426.aspx. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'centerHeader: string;' + return: + type: string + - name: context + uid: excel!Excel.HeaderFooter#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: leftFooter + uid: excel!Excel.HeaderFooter#leftFooter:member + package: excel! + fullName: leftFooter + summary: >- + The left footer of the worksheet. To apply font formatting or insert a + variable value, use format codes specified here: + https://msdn.microsoft.com/library/bb225426.aspx. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'leftFooter: string;' + return: + type: string + - name: leftHeader + uid: excel!Excel.HeaderFooter#leftHeader:member + package: excel! + fullName: leftHeader + summary: >- + The left header of the worksheet. To apply font formatting or insert a + variable value, use format codes specified here: + https://msdn.microsoft.com/library/bb225426.aspx. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'leftHeader: string;' + return: + type: string + - name: rightFooter + uid: excel!Excel.HeaderFooter#rightFooter:member + package: excel! + fullName: rightFooter + summary: >- + The right footer of the worksheet. To apply font formatting or insert a + variable value, use format codes specified here: + https://msdn.microsoft.com/library/bb225426.aspx. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rightFooter: string;' + return: + type: string + - name: rightHeader + uid: excel!Excel.HeaderFooter#rightHeader:member + package: excel! + fullName: rightHeader + summary: >- + The right header of the worksheet. To apply font formatting or insert a + variable value, use format codes specified here: + https://msdn.microsoft.com/library/bb225426.aspx. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rightHeader: string;' + return: + type: string +methods: + - name: load(options) + uid: excel!Excel.HeaderFooter#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.HeaderFooterLoadOptions): + Excel.HeaderFooter; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.HeaderFooter#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.HeaderFooter;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.HeaderFooter#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.HeaderFooter; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.HeaderFooter#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.HeaderFooterUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.HeaderFooter#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.HeaderFooter): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.HeaderFooter#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.HeaderFooter` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.HeaderFooterData`) that + contains shallow copies of any loaded child properties from the original + object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.HeaderFooterData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.headerfootergroup.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.headerfootergroup.yml new file mode 100644 index 0000000000..55b7001ced --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.headerfootergroup.yml @@ -0,0 +1,309 @@ +### YamlMime:TSType +name: Excel.HeaderFooterGroup +uid: excel!Excel.HeaderFooterGroup:class +package: excel! +fullName: Excel.HeaderFooterGroup +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.HeaderFooterGroup#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: defaultForAllPages + uid: excel!Excel.HeaderFooterGroup#defaultForAllPages:member + package: excel! + fullName: defaultForAllPages + summary: >- + The general header/footer, used for all pages unless even/odd or first + page is specified. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly defaultForAllPages: Excel.HeaderFooter;' + return: + type: + - name: evenPages + uid: excel!Excel.HeaderFooterGroup#evenPages:member + package: excel! + fullName: evenPages + summary: >- + The header/footer to use for even pages, odd header/footer needs to be + specified for odd pages. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly evenPages: Excel.HeaderFooter;' + return: + type: + - name: firstPage + uid: excel!Excel.HeaderFooterGroup#firstPage:member + package: excel! + fullName: firstPage + summary: >- + The first page header/footer, for all other pages general or even/odd is + used. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly firstPage: Excel.HeaderFooter;' + return: + type: + - name: oddPages + uid: excel!Excel.HeaderFooterGroup#oddPages:member + package: excel! + fullName: oddPages + summary: >- + The header/footer to use for odd pages, even header/footer needs to be + specified for even pages. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly oddPages: Excel.HeaderFooter;' + return: + type: + - name: state + uid: excel!Excel.HeaderFooterGroup#state:member + package: excel! + fullName: state + summary: >- + The state by which headers/footers are set. See `Excel.HeaderFooterState` + for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + state: Excel.HeaderFooterState | "Default" | "FirstAndDefault" | + "OddAndEven" | "FirstOddAndEven"; + return: + type: >- + | "Default" | + "FirstAndDefault" | "OddAndEven" | "FirstOddAndEven" + - name: useSheetMargins + uid: excel!Excel.HeaderFooterGroup#useSheetMargins:member + package: excel! + fullName: useSheetMargins + summary: >- + Gets or sets a flag indicating if headers/footers are aligned with the + page margins set in the page layout options for the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'useSheetMargins: boolean;' + return: + type: boolean + - name: useSheetScale + uid: excel!Excel.HeaderFooterGroup#useSheetScale:member + package: excel! + fullName: useSheetScale + summary: >- + Gets or sets a flag indicating if headers/footers should be scaled by the + page percentage scale set in the page layout options for the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'useSheetScale: boolean;' + return: + type: boolean +methods: + - name: load(options) + uid: excel!Excel.HeaderFooterGroup#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.HeaderFooterGroupLoadOptions): + Excel.HeaderFooterGroup; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.HeaderFooterGroup#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.HeaderFooterGroup;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.HeaderFooterGroup#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.HeaderFooterGroup; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.HeaderFooterGroup#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.HeaderFooterGroupUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.HeaderFooterGroup#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.HeaderFooterGroup): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.HeaderFooterGroup#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.HeaderFooterGroup` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.HeaderFooterGroupData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.HeaderFooterGroupData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.headerfooterstate.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.headerfooterstate.yml new file mode 100644 index 0000000000..baa21166ce --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.headerfooterstate.yml @@ -0,0 +1,55 @@ +### YamlMime:TSEnum +name: Excel.HeaderFooterState +uid: excel!Excel.HeaderFooterState:enum +package: excel! +fullName: Excel.HeaderFooterState +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: default + uid: excel!Excel.HeaderFooterState.default:member + package: excel! + summary: >- + Only one general header/footer is used for all pages printed. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Default"' + - name: firstAndDefault + uid: excel!Excel.HeaderFooterState.firstAndDefault:member + package: excel! + summary: >- + There is a separate first page header/footer, and a general header/footer + used for all other pages. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FirstAndDefault"' + - name: firstOddAndEven + uid: excel!Excel.HeaderFooterState.firstOddAndEven:member + package: excel! + summary: >- + There is a separate first page header/footer, then there is a separate + header/footer for odd and even pages. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FirstOddAndEven"' + - name: oddAndEven + uid: excel!Excel.HeaderFooterState.oddAndEven:member + package: excel! + summary: >- + There is a different header/footer for odd and even pages. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"OddAndEven"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.horizontalalignment.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.horizontalalignment.yml new file mode 100644 index 0000000000..6e1d9780cb --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.horizontalalignment.yml @@ -0,0 +1,96 @@ +### YamlMime:TSEnum +name: Excel.HorizontalAlignment +uid: excel!Excel.HorizontalAlignment:enum +package: excel! +fullName: Excel.HorizontalAlignment +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-merged-ranges.yaml + + + await Excel.run(async (context) => { + // Retrieve the worksheet and the table in that worksheet. + const sheet = context.workbook.worksheets.getActiveWorksheet(); + const tableRange = sheet.getRange("B2:E6"); + + // Create a merged range in the first row of the table. + const chartTitle = tableRange.getRow(0); + chartTitle.merge(true); + + // Format the merged range. + chartTitle.format.horizontalAlignment = "Center"; + + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: center + uid: excel!Excel.HorizontalAlignment.center:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Center"' + - name: centerAcrossSelection + uid: excel!Excel.HorizontalAlignment.centerAcrossSelection:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"CenterAcrossSelection"' + - name: distributed + uid: excel!Excel.HorizontalAlignment.distributed:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Distributed"' + - name: fill + uid: excel!Excel.HorizontalAlignment.fill:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Fill"' + - name: general + uid: excel!Excel.HorizontalAlignment.general:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"General"' + - name: justify + uid: excel!Excel.HorizontalAlignment.justify:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Justify"' + - name: left + uid: excel!Excel.HorizontalAlignment.left:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Left"' + - name: right + uid: excel!Excel.HorizontalAlignment.right:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Right"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.icon.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.icon.yml new file mode 100644 index 0000000000..c7a3f13d08 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.icon.yml @@ -0,0 +1,57 @@ +### YamlMime:TSType +name: Excel.Icon +uid: excel!Excel.Icon:interface +package: excel! +fullName: Excel.Icon +summary: Represents a cell icon. +remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: index + uid: excel!Excel.Icon#index:member + package: excel! + fullName: index + summary: Specifies the index of the icon in the given set. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'index: number;' + return: + type: number + - name: set + uid: excel!Excel.Icon#set:member + package: excel! + fullName: set + summary: Specifies the set that the icon is part of. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + set: Excel.IconSet | "Invalid" | "ThreeArrows" | "ThreeArrowsGray" | + "ThreeFlags" | "ThreeTrafficLights1" | "ThreeTrafficLights2" | + "ThreeSigns" | "ThreeSymbols" | "ThreeSymbols2" | "FourArrows" | + "FourArrowsGray" | "FourRedToBlack" | "FourRating" | "FourTrafficLights" + | "FiveArrows" | "FiveArrowsGray" | "FiveRating" | "FiveQuarters" | + "ThreeStars" | "ThreeTriangles" | "FiveBoxes"; + return: + type: >- + | "Invalid" | "ThreeArrows" | + "ThreeArrowsGray" | "ThreeFlags" | "ThreeTrafficLights1" | + "ThreeTrafficLights2" | "ThreeSigns" | "ThreeSymbols" | + "ThreeSymbols2" | "FourArrows" | "FourArrowsGray" | "FourRedToBlack" | + "FourRating" | "FourTrafficLights" | "FiveArrows" | "FiveArrowsGray" | + "FiveRating" | "FiveQuarters" | "ThreeStars" | "ThreeTriangles" | + "FiveBoxes" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.iconcollections.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.iconcollections.yml new file mode 100644 index 0000000000..c6c05db143 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.iconcollections.yml @@ -0,0 +1,274 @@ +### YamlMime:TSType +name: Excel.IconCollections +uid: excel!Excel.IconCollections:interface +package: excel! +fullName: Excel.IconCollections +summary: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: fiveArrows + uid: excel!Excel.IconCollections#fiveArrows:member + package: excel! + fullName: fiveArrows + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'fiveArrows: FiveArrowsSet;' + return: + type: + - name: fiveArrowsGray + uid: excel!Excel.IconCollections#fiveArrowsGray:member + package: excel! + fullName: fiveArrowsGray + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'fiveArrowsGray: FiveArrowsGraySet;' + return: + type: + - name: fiveBoxes + uid: excel!Excel.IconCollections#fiveBoxes:member + package: excel! + fullName: fiveBoxes + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'fiveBoxes: FiveBoxesSet;' + return: + type: + - name: fiveQuarters + uid: excel!Excel.IconCollections#fiveQuarters:member + package: excel! + fullName: fiveQuarters + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'fiveQuarters: FiveQuartersSet;' + return: + type: + - name: fiveRating + uid: excel!Excel.IconCollections#fiveRating:member + package: excel! + fullName: fiveRating + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'fiveRating: FiveRatingSet;' + return: + type: + - name: fourArrows + uid: excel!Excel.IconCollections#fourArrows:member + package: excel! + fullName: fourArrows + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'fourArrows: FourArrowsSet;' + return: + type: + - name: fourArrowsGray + uid: excel!Excel.IconCollections#fourArrowsGray:member + package: excel! + fullName: fourArrowsGray + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'fourArrowsGray: FourArrowsGraySet;' + return: + type: + - name: fourRating + uid: excel!Excel.IconCollections#fourRating:member + package: excel! + fullName: fourRating + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'fourRating: FourRatingSet;' + return: + type: + - name: fourRedToBlack + uid: excel!Excel.IconCollections#fourRedToBlack:member + package: excel! + fullName: fourRedToBlack + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'fourRedToBlack: FourRedToBlackSet;' + return: + type: + - name: fourTrafficLights + uid: excel!Excel.IconCollections#fourTrafficLights:member + package: excel! + fullName: fourTrafficLights + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'fourTrafficLights: FourTrafficLightsSet;' + return: + type: + - name: threeArrows + uid: excel!Excel.IconCollections#threeArrows:member + package: excel! + fullName: threeArrows + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'threeArrows: ThreeArrowsSet;' + return: + type: + - name: threeArrowsGray + uid: excel!Excel.IconCollections#threeArrowsGray:member + package: excel! + fullName: threeArrowsGray + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'threeArrowsGray: ThreeArrowsGraySet;' + return: + type: + - name: threeFlags + uid: excel!Excel.IconCollections#threeFlags:member + package: excel! + fullName: threeFlags + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'threeFlags: ThreeFlagsSet;' + return: + type: + - name: threeSigns + uid: excel!Excel.IconCollections#threeSigns:member + package: excel! + fullName: threeSigns + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'threeSigns: ThreeSignsSet;' + return: + type: + - name: threeStars + uid: excel!Excel.IconCollections#threeStars:member + package: excel! + fullName: threeStars + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'threeStars: ThreeStarsSet;' + return: + type: + - name: threeSymbols + uid: excel!Excel.IconCollections#threeSymbols:member + package: excel! + fullName: threeSymbols + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'threeSymbols: ThreeSymbolsSet;' + return: + type: + - name: threeSymbols2 + uid: excel!Excel.IconCollections#threeSymbols2:member + package: excel! + fullName: threeSymbols2 + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'threeSymbols2: ThreeSymbols2Set;' + return: + type: + - name: threeTrafficLights1 + uid: excel!Excel.IconCollections#threeTrafficLights1:member + package: excel! + fullName: threeTrafficLights1 + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'threeTrafficLights1: ThreeTrafficLights1Set;' + return: + type: + - name: threeTrafficLights2 + uid: excel!Excel.IconCollections#threeTrafficLights2:member + package: excel! + fullName: threeTrafficLights2 + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'threeTrafficLights2: ThreeTrafficLights2Set;' + return: + type: + - name: threeTriangles + uid: excel!Excel.IconCollections#threeTriangles:member + package: excel! + fullName: threeTriangles + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'threeTriangles: ThreeTrianglesSet;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.iconset.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.iconset.yml new file mode 100644 index 0000000000..f06c2459c8 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.iconset.yml @@ -0,0 +1,211 @@ +### YamlMime:TSEnum +name: Excel.IconSet +uid: excel!Excel.IconSet:enum +package: excel! +fullName: Excel.IconSet +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const range = sheet.getRange("B8:E13"); + const conditionalFormat = range.conditionalFormats + .add(Excel.ConditionalFormatType.iconSet); + const iconSetCF = conditionalFormat.iconSet; + iconSetCF.style = Excel.IconSet.threeTriangles; + + /* + The iconSetCF.criteria array is automatically prepopulated with + criterion elements whose properties have been given default settings. + You can't write to each property of a criterion directly. Instead, + replace the whole criteria object. + + With a "three*" icon set style, such as "threeTriangles", the third + element in the criteria array (criteria[2]) defines the "top" icon; + e.g., a green triangle. The second (criteria[1]) defines the "middle" + icon. The first (criteria[0]) defines the "low" icon, but it + can often be left empty as the following object shows, because every + cell that does not match the other two criteria always gets the low + icon. + */ + iconSetCF.criteria = [ + {} as any, + { + type: Excel.ConditionalFormatIconRuleType.number, + operator: Excel.ConditionalIconCriterionOperator.greaterThanOrEqual, + formula: "=700" + }, + { + type: Excel.ConditionalFormatIconRuleType.number, + operator: Excel.ConditionalIconCriterionOperator.greaterThanOrEqual, + formula: "=1000", + } + ]; + + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: fiveArrows + uid: excel!Excel.IconSet.fiveArrows:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FiveArrows"' + - name: fiveArrowsGray + uid: excel!Excel.IconSet.fiveArrowsGray:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FiveArrowsGray"' + - name: fiveBoxes + uid: excel!Excel.IconSet.fiveBoxes:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FiveBoxes"' + - name: fiveQuarters + uid: excel!Excel.IconSet.fiveQuarters:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FiveQuarters"' + - name: fiveRating + uid: excel!Excel.IconSet.fiveRating:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FiveRating"' + - name: fourArrows + uid: excel!Excel.IconSet.fourArrows:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FourArrows"' + - name: fourArrowsGray + uid: excel!Excel.IconSet.fourArrowsGray:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FourArrowsGray"' + - name: fourRating + uid: excel!Excel.IconSet.fourRating:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FourRating"' + - name: fourRedToBlack + uid: excel!Excel.IconSet.fourRedToBlack:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FourRedToBlack"' + - name: fourTrafficLights + uid: excel!Excel.IconSet.fourTrafficLights:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FourTrafficLights"' + - name: invalid + uid: excel!Excel.IconSet.invalid:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Invalid"' + - name: threeArrows + uid: excel!Excel.IconSet.threeArrows:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ThreeArrows"' + - name: threeArrowsGray + uid: excel!Excel.IconSet.threeArrowsGray:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ThreeArrowsGray"' + - name: threeFlags + uid: excel!Excel.IconSet.threeFlags:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ThreeFlags"' + - name: threeSigns + uid: excel!Excel.IconSet.threeSigns:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ThreeSigns"' + - name: threeStars + uid: excel!Excel.IconSet.threeStars:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ThreeStars"' + - name: threeSymbols + uid: excel!Excel.IconSet.threeSymbols:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ThreeSymbols"' + - name: threeSymbols2 + uid: excel!Excel.IconSet.threeSymbols2:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ThreeSymbols2"' + - name: threeTrafficLights1 + uid: excel!Excel.IconSet.threeTrafficLights1:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ThreeTrafficLights1"' + - name: threeTrafficLights2 + uid: excel!Excel.IconSet.threeTrafficLights2:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ThreeTrafficLights2"' + - name: threeTriangles + uid: excel!Excel.IconSet.threeTriangles:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ThreeTriangles"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.iconsetconditionalformat.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.iconsetconditionalformat.yml new file mode 100644 index 0000000000..1cecdf7814 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.iconsetconditionalformat.yml @@ -0,0 +1,369 @@ +### YamlMime:TSType +name: Excel.IconSetConditionalFormat +uid: excel!Excel.IconSetConditionalFormat:class +package: excel! +fullName: Excel.IconSetConditionalFormat +summary: Represents an icon set criteria for conditional formatting. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.IconSetConditionalFormat#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: criteria + uid: excel!Excel.IconSetConditionalFormat#criteria:member + package: excel! + fullName: criteria + summary: >- + An array of criteria and icon sets for the rules and potential custom + icons for conditional icons. Note that for the first criterion only the + custom icon can be modified, while type, formula, and operator will be + ignored when set. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const range = sheet.getRange("B8:E13"); + const conditionalFormat = range.conditionalFormats + .add(Excel.ConditionalFormatType.iconSet); + const iconSetCF = conditionalFormat.iconSet; + iconSetCF.style = Excel.IconSet.threeTriangles; + + /* + The iconSetCF.criteria array is automatically prepopulated with + criterion elements whose properties have been given default settings. + You can't write to each property of a criterion directly. Instead, + replace the whole criteria object. + + With a "three*" icon set style, such as "threeTriangles", the third + element in the criteria array (criteria[2]) defines the "top" icon; + e.g., a green triangle. The second (criteria[1]) defines the "middle" + icon. The first (criteria[0]) defines the "low" icon, but it + can often be left empty as the following object shows, because every + cell that does not match the other two criteria always gets the low + icon. + */ + iconSetCF.criteria = [ + {} as any, + { + type: Excel.ConditionalFormatIconRuleType.number, + operator: Excel.ConditionalIconCriterionOperator.greaterThanOrEqual, + formula: "=700" + }, + { + type: Excel.ConditionalFormatIconRuleType.number, + operator: Excel.ConditionalIconCriterionOperator.greaterThanOrEqual, + formula: "=1000", + } + ]; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'criteria: Excel.ConditionalIconCriterion[];' + return: + type: [] + - name: reverseIconOrder + uid: excel!Excel.IconSetConditionalFormat#reverseIconOrder:member + package: excel! + fullName: reverseIconOrder + summary: >- + If `true`, reverses the icon orders for the icon set. Note that + this cannot be set if custom icons are used. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'reverseIconOrder: boolean;' + return: + type: boolean + - name: showIconOnly + uid: excel!Excel.IconSetConditionalFormat#showIconOnly:member + package: excel! + fullName: showIconOnly + summary: If `true`, hides the values and only shows icons. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showIconOnly: boolean;' + return: + type: boolean + - name: style + uid: excel!Excel.IconSetConditionalFormat#style:member + package: excel! + fullName: style + summary: If set, displays the icon set option for the conditional format. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const range = sheet.getRange("B8:E13"); + const conditionalFormat = range.conditionalFormats + .add(Excel.ConditionalFormatType.iconSet); + const iconSetCF = conditionalFormat.iconSet; + iconSetCF.style = Excel.IconSet.threeTriangles; + + /* + The iconSetCF.criteria array is automatically prepopulated with + criterion elements whose properties have been given default settings. + You can't write to each property of a criterion directly. Instead, + replace the whole criteria object. + + With a "three*" icon set style, such as "threeTriangles", the third + element in the criteria array (criteria[2]) defines the "top" icon; + e.g., a green triangle. The second (criteria[1]) defines the "middle" + icon. The first (criteria[0]) defines the "low" icon, but it + can often be left empty as the following object shows, because every + cell that does not match the other two criteria always gets the low + icon. + */ + iconSetCF.criteria = [ + {} as any, + { + type: Excel.ConditionalFormatIconRuleType.number, + operator: Excel.ConditionalIconCriterionOperator.greaterThanOrEqual, + formula: "=700" + }, + { + type: Excel.ConditionalFormatIconRuleType.number, + operator: Excel.ConditionalIconCriterionOperator.greaterThanOrEqual, + formula: "=1000", + } + ]; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + style: Excel.IconSet | "Invalid" | "ThreeArrows" | "ThreeArrowsGray" | + "ThreeFlags" | "ThreeTrafficLights1" | "ThreeTrafficLights2" | + "ThreeSigns" | "ThreeSymbols" | "ThreeSymbols2" | "FourArrows" | + "FourArrowsGray" | "FourRedToBlack" | "FourRating" | "FourTrafficLights" + | "FiveArrows" | "FiveArrowsGray" | "FiveRating" | "FiveQuarters" | + "ThreeStars" | "ThreeTriangles" | "FiveBoxes"; + return: + type: >- + | "Invalid" | "ThreeArrows" | + "ThreeArrowsGray" | "ThreeFlags" | "ThreeTrafficLights1" | + "ThreeTrafficLights2" | "ThreeSigns" | "ThreeSymbols" | + "ThreeSymbols2" | "FourArrows" | "FourArrowsGray" | "FourRedToBlack" | + "FourRating" | "FourTrafficLights" | "FiveArrows" | "FiveArrowsGray" | + "FiveRating" | "FiveQuarters" | "ThreeStars" | "ThreeTriangles" | + "FiveBoxes" +methods: + - name: load(options) + uid: excel!Excel.IconSetConditionalFormat#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.IconSetConditionalFormatLoadOptions): + Excel.IconSetConditionalFormat; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.IconSetConditionalFormat#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.IconSetConditionalFormat;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.IconSetConditionalFormat#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.IconSetConditionalFormat; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.IconSetConditionalFormat#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.IconSetConditionalFormatUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.IconSetConditionalFormat#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.IconSetConditionalFormat): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.IconSetConditionalFormat#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.IconSetConditionalFormat` object is an API object, the `toJSON` + method returns a plain JavaScript object (typed as + `Excel.Interfaces.IconSetConditionalFormatData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.IconSetConditionalFormatData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.image.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.image.yml new file mode 100644 index 0000000000..c65b482d0d --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.image.yml @@ -0,0 +1,199 @@ +### YamlMime:TSType +name: Excel.Image +uid: excel!Excel.Image:class +package: excel! +fullName: Excel.Image +summary: >- + Represents an image in the worksheet. To get the corresponding `Shape` object, + use `Image.shape`. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.Image#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: format + uid: excel!Excel.Image#format:member + package: excel! + fullName: format + summary: Returns the format of the image. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-images.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Shapes"); + const image = sheet.shapes.getItem("Image").image; + image.load("format"); + await context.sync(); + + console.log("The image's format is: " + image.format); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly format: Excel.PictureFormat | "UNKNOWN" | "BMP" | "JPEG" | + "GIF" | "PNG" | "SVG"; + return: + type: >- + | "UNKNOWN" | "BMP" | + "JPEG" | "GIF" | "PNG" | "SVG" + - name: id + uid: excel!Excel.Image#id:member + package: excel! + fullName: id + summary: Specifies the shape identifier for the image object. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly id: string;' + return: + type: string + - name: shape + uid: excel!Excel.Image#shape:member + package: excel! + fullName: shape + summary: Returns the `Shape` object associated with the image. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly shape: Excel.Shape;' + return: + type: +methods: + - name: load(options) + uid: excel!Excel.Image#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(options?: Excel.Interfaces.ImageLoadOptions): Excel.Image;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.Image#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.Image;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.Image#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.Image; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.Image#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.Image` object is + an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Excel.Interfaces.ImageData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ImageData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.imagefittingmode.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.imagefittingmode.yml new file mode 100644 index 0000000000..2535700e86 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.imagefittingmode.yml @@ -0,0 +1,34 @@ +### YamlMime:TSEnum +name: Excel.ImageFittingMode +uid: excel!Excel.ImageFittingMode:enum +package: excel! +fullName: Excel.ImageFittingMode +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: fill + uid: excel!Excel.ImageFittingMode.fill:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Fill"' + - name: fit + uid: excel!Excel.ImageFittingMode.fit:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Fit"' + - name: fitAndCenter + uid: excel!Excel.ImageFittingMode.fitAndCenter:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FitAndCenter"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.insertshiftdirection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.insertshiftdirection.yml new file mode 100644 index 0000000000..d163cbf01f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.insertshiftdirection.yml @@ -0,0 +1,50 @@ +### YamlMime:TSEnum +name: Excel.InsertShiftDirection +uid: excel!Excel.InsertShiftDirection:enum +package: excel! +fullName: Excel.InsertShiftDirection +summary: >- + Determines the direction in which existing cells will be shifted to + accommodate what is being inserted. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/insert-delete-clear-range.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const range = sheet.getRange("B4:E4"); + + range.insert(Excel.InsertShiftDirection.down); + + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: down + uid: excel!Excel.InsertShiftDirection.down:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Down"' + - name: right + uid: excel!Excel.InsertShiftDirection.right:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Right"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.insertworksheetoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.insertworksheetoptions.yml new file mode 100644 index 0000000000..bee2a2a853 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.insertworksheetoptions.yml @@ -0,0 +1,76 @@ +### YamlMime:TSType +name: Excel.InsertWorksheetOptions +uid: excel!Excel.InsertWorksheetOptions:interface +package: excel! +fullName: Excel.InsertWorksheetOptions +summary: >- + The options that define which worksheets to insert and where in the workbook + the new worksheets will be inserted. +remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: positionType + uid: excel!Excel.InsertWorksheetOptions#positionType:member + package: excel! + fullName: positionType + summary: >- + The insert position, in the current workbook, of the new worksheets. See + `Excel.WorksheetPositionType` for details. The default position is "End". + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + positionType?: Excel.WorksheetPositionType | "None" | "Before" | "After" + | "Beginning" | "End"; + return: + type: >- + | "None" | + "Before" | "After" | "Beginning" | "End" + - name: relativeTo + uid: excel!Excel.InsertWorksheetOptions#relativeTo:member + package: excel! + fullName: relativeTo + summary: >- + The worksheet in the current workbook that is referenced for the + `WorksheetPositionType` parameter. The default is `null`. If the + `relativeTo` parameter is not set, worksheets will be inserted based on + `positionType`, at the start or end of the current workbook. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'relativeTo?: Worksheet | string;' + return: + type: | string + - name: sheetNamesToInsert + uid: excel!Excel.InsertWorksheetOptions#sheetNamesToInsert:member + package: excel! + fullName: sheetNamesToInsert + summary: >- + The names of individual worksheets to insert. By default, all the + worksheets from the source workbook are inserted. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'sheetNamesToInsert?: string[];' + return: + type: string[] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.alloweditrangecollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.alloweditrangecollectiondata.yml new file mode 100644 index 0000000000..274fbc4015 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.alloweditrangecollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.AllowEditRangeCollectionData +uid: excel!Excel.Interfaces.AllowEditRangeCollectionData:interface +package: excel! +fullName: Excel.Interfaces.AllowEditRangeCollectionData +summary: >- + An interface describing the data returned by calling + `allowEditRangeCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.AllowEditRangeCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.AllowEditRangeData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.alloweditrangecollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.alloweditrangecollectionupdatedata.yml new file mode 100644 index 0000000000..563ea5dd70 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.alloweditrangecollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.AllowEditRangeCollectionUpdateData +uid: excel!Excel.Interfaces.AllowEditRangeCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.AllowEditRangeCollectionUpdateData +summary: >- + An interface for updating data on the `AllowEditRangeCollection` object, for + use in `allowEditRangeCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.AllowEditRangeCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.AllowEditRangeData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.alloweditrangedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.alloweditrangedata.yml new file mode 100644 index 0000000000..89d0e66aea --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.alloweditrangedata.yml @@ -0,0 +1,13 @@ +### YamlMime:TSType +name: Excel.Interfaces.AllowEditRangeData +uid: excel!Excel.Interfaces.AllowEditRangeData:interface +package: excel! +fullName: Excel.Interfaces.AllowEditRangeData +summary: >- + An interface describing the data returned by calling + `allowEditRange.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.alloweditrangeupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.alloweditrangeupdatedata.yml new file mode 100644 index 0000000000..5a1bd87bb9 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.alloweditrangeupdatedata.yml @@ -0,0 +1,13 @@ +### YamlMime:TSType +name: Excel.Interfaces.AllowEditRangeUpdateData +uid: excel!Excel.Interfaces.AllowEditRangeUpdateData:interface +package: excel! +fullName: Excel.Interfaces.AllowEditRangeUpdateData +summary: >- + An interface for updating data on the `AllowEditRange` object, for use in + `allowEditRange.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.applicationdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.applicationdata.yml new file mode 100644 index 0000000000..a180d4d741 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.applicationdata.yml @@ -0,0 +1,170 @@ +### YamlMime:TSType +name: Excel.Interfaces.ApplicationData +uid: excel!Excel.Interfaces.ApplicationData:interface +package: excel! +fullName: Excel.Interfaces.ApplicationData +summary: >- + An interface describing the data returned by calling + `application.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: calculationEngineVersion + uid: excel!Excel.Interfaces.ApplicationData#calculationEngineVersion:member + package: excel! + fullName: calculationEngineVersion + summary: >- + Returns the Excel calculation engine version used for the last full + recalculation. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'calculationEngineVersion?: number;' + return: + type: number + - name: calculationMode + uid: excel!Excel.Interfaces.ApplicationData#calculationMode:member + package: excel! + fullName: calculationMode + summary: >- + Returns the calculation mode used in the workbook, as defined by the + constants in `Excel.CalculationMode`. Possible values are: + `Automatic`, where Excel controls recalculation; + `AutomaticExceptTables`, where Excel controls recalculation but + ignores changes in tables; `Manual`, where calculation is done + when the user requests it. + remarks: >- + \[ [API set: ExcelApi 1.1 for get, 1.8 for + set](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + calculationMode?: Excel.CalculationMode | "Automatic" | + "AutomaticExceptTables" | "Manual"; + return: + type: >- + | "Automatic" | + "AutomaticExceptTables" | "Manual" + - name: calculationState + uid: excel!Excel.Interfaces.ApplicationData#calculationState:member + package: excel! + fullName: calculationState + summary: >- + Returns the calculation state of the application. See + `Excel.CalculationState` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + calculationState?: Excel.CalculationState | "Done" | "Calculating" | + "Pending"; + return: + type: >- + | "Done" | + "Calculating" | "Pending" + - name: cultureInfo + uid: excel!Excel.Interfaces.ApplicationData#cultureInfo:member + package: excel! + fullName: cultureInfo + summary: >- + Provides information based on current system culture settings. This + includes the culture names, number formatting, and other culturally + dependent settings. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'cultureInfo?: Excel.Interfaces.CultureInfoData;' + return: + type: + - name: decimalSeparator + uid: excel!Excel.Interfaces.ApplicationData#decimalSeparator:member + package: excel! + fullName: decimalSeparator + summary: >- + Gets the string used as the decimal separator for numeric values. This is + based on the local Excel settings. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'decimalSeparator?: string;' + return: + type: string + - name: iterativeCalculation + uid: excel!Excel.Interfaces.ApplicationData#iterativeCalculation:member + package: excel! + fullName: iterativeCalculation + summary: >- + Returns the iterative calculation settings. In Excel on Windows and Mac, + the settings will apply to the Excel Application. In Excel on the web and + other platforms, the settings will apply to the active workbook. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'iterativeCalculation?: Excel.Interfaces.IterativeCalculationData;' + return: + type: >- + + - name: thousandsSeparator + uid: excel!Excel.Interfaces.ApplicationData#thousandsSeparator:member + package: excel! + fullName: thousandsSeparator + summary: >- + Gets the string used to separate groups of digits to the left of the + decimal for numeric values. This is based on the local Excel settings. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'thousandsSeparator?: string;' + return: + type: string + - name: useSystemSeparators + uid: excel!Excel.Interfaces.ApplicationData#useSystemSeparators:member + package: excel! + fullName: useSystemSeparators + summary: >- + Specifies if the system separators of Excel are enabled. System separators + include the decimal separator and thousands separator. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'useSystemSeparators?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.applicationloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.applicationloadoptions.yml new file mode 100644 index 0000000000..342a1538a1 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.applicationloadoptions.yml @@ -0,0 +1,180 @@ +### YamlMime:TSType +name: Excel.Interfaces.ApplicationLoadOptions +uid: excel!Excel.Interfaces.ApplicationLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ApplicationLoadOptions +summary: Represents the Excel application that manages the workbook. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ApplicationLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: calculationEngineVersion + uid: >- + excel!Excel.Interfaces.ApplicationLoadOptions#calculationEngineVersion:member + package: excel! + fullName: calculationEngineVersion + summary: >- + Returns the Excel calculation engine version used for the last full + recalculation. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'calculationEngineVersion?: boolean;' + return: + type: boolean + - name: calculationMode + uid: excel!Excel.Interfaces.ApplicationLoadOptions#calculationMode:member + package: excel! + fullName: calculationMode + summary: >- + Returns the calculation mode used in the workbook, as defined by the + constants in `Excel.CalculationMode`. Possible values are: + `Automatic`, where Excel controls recalculation; + `AutomaticExceptTables`, where Excel controls recalculation but + ignores changes in tables; `Manual`, where calculation is done + when the user requests it. + remarks: >- + \[ [API set: ExcelApi 1.1 for get, 1.8 for + set](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'calculationMode?: boolean;' + return: + type: boolean + - name: calculationState + uid: excel!Excel.Interfaces.ApplicationLoadOptions#calculationState:member + package: excel! + fullName: calculationState + summary: >- + Returns the calculation state of the application. See + `Excel.CalculationState` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'calculationState?: boolean;' + return: + type: boolean + - name: cultureInfo + uid: excel!Excel.Interfaces.ApplicationLoadOptions#cultureInfo:member + package: excel! + fullName: cultureInfo + summary: >- + Provides information based on current system culture settings. This + includes the culture names, number formatting, and other culturally + dependent settings. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'cultureInfo?: Excel.Interfaces.CultureInfoLoadOptions;' + return: + type: + - name: decimalSeparator + uid: excel!Excel.Interfaces.ApplicationLoadOptions#decimalSeparator:member + package: excel! + fullName: decimalSeparator + summary: >- + Gets the string used as the decimal separator for numeric values. This is + based on the local Excel settings. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'decimalSeparator?: boolean;' + return: + type: boolean + - name: iterativeCalculation + uid: excel!Excel.Interfaces.ApplicationLoadOptions#iterativeCalculation:member + package: excel! + fullName: iterativeCalculation + summary: >- + Returns the iterative calculation settings. In Excel on Windows and Mac, + the settings will apply to the Excel Application. In Excel on the web and + other platforms, the settings will apply to the active workbook. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'iterativeCalculation?: Excel.Interfaces.IterativeCalculationLoadOptions;' + return: + type: >- + + - name: thousandsSeparator + uid: excel!Excel.Interfaces.ApplicationLoadOptions#thousandsSeparator:member + package: excel! + fullName: thousandsSeparator + summary: >- + Gets the string used to separate groups of digits to the left of the + decimal for numeric values. This is based on the local Excel settings. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'thousandsSeparator?: boolean;' + return: + type: boolean + - name: useSystemSeparators + uid: excel!Excel.Interfaces.ApplicationLoadOptions#useSystemSeparators:member + package: excel! + fullName: useSystemSeparators + summary: >- + Specifies if the system separators of Excel are enabled. System separators + include the decimal separator and thousands separator. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'useSystemSeparators?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.applicationupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.applicationupdatedata.yml new file mode 100644 index 0000000000..31ab982a11 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.applicationupdatedata.yml @@ -0,0 +1,60 @@ +### YamlMime:TSType +name: Excel.Interfaces.ApplicationUpdateData +uid: excel!Excel.Interfaces.ApplicationUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ApplicationUpdateData +summary: >- + An interface for updating data on the `Application` object, for use in + `application.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: calculationMode + uid: excel!Excel.Interfaces.ApplicationUpdateData#calculationMode:member + package: excel! + fullName: calculationMode + summary: >- + Returns the calculation mode used in the workbook, as defined by the + constants in `Excel.CalculationMode`. Possible values are: + `Automatic`, where Excel controls recalculation; + `AutomaticExceptTables`, where Excel controls recalculation but + ignores changes in tables; `Manual`, where calculation is done + when the user requests it. + remarks: >- + \[ [API set: ExcelApi 1.1 for get, 1.8 for + set](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + calculationMode?: Excel.CalculationMode | "Automatic" | + "AutomaticExceptTables" | "Manual"; + return: + type: >- + | "Automatic" | + "AutomaticExceptTables" | "Manual" + - name: iterativeCalculation + uid: excel!Excel.Interfaces.ApplicationUpdateData#iterativeCalculation:member + package: excel! + fullName: iterativeCalculation + summary: >- + Returns the iterative calculation settings. In Excel on Windows and Mac, + the settings will apply to the Excel Application. In Excel on the web and + other platforms, the settings will apply to the active workbook. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'iterativeCalculation?: Excel.Interfaces.IterativeCalculationUpdateData;' + return: + type: >- + diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.autofilterdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.autofilterdata.yml new file mode 100644 index 0000000000..d17fb034c0 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.autofilterdata.yml @@ -0,0 +1,59 @@ +### YamlMime:TSType +name: Excel.Interfaces.AutoFilterData +uid: excel!Excel.Interfaces.AutoFilterData:interface +package: excel! +fullName: Excel.Interfaces.AutoFilterData +summary: >- + An interface describing the data returned by calling `autoFilter.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: criteria + uid: excel!Excel.Interfaces.AutoFilterData#criteria:member + package: excel! + fullName: criteria + summary: An array that holds all the filter criteria in the autofiltered range. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'criteria?: Excel.FilterCriteria[];' + return: + type: [] + - name: enabled + uid: excel!Excel.Interfaces.AutoFilterData#enabled:member + package: excel! + fullName: enabled + summary: Specifies if the AutoFilter is enabled. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'enabled?: boolean;' + return: + type: boolean + - name: isDataFiltered + uid: excel!Excel.Interfaces.AutoFilterData#isDataFiltered:member + package: excel! + fullName: isDataFiltered + summary: Specifies if the AutoFilter has filter criteria. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'isDataFiltered?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.autofilterloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.autofilterloadoptions.yml new file mode 100644 index 0000000000..38362e3dfd --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.autofilterloadoptions.yml @@ -0,0 +1,77 @@ +### YamlMime:TSType +name: Excel.Interfaces.AutoFilterLoadOptions +uid: excel!Excel.Interfaces.AutoFilterLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.AutoFilterLoadOptions +summary: >- + Represents the `AutoFilter` object. AutoFilter turns the values in Excel + column into specific filters based on the cell contents. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.AutoFilterLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: criteria + uid: excel!Excel.Interfaces.AutoFilterLoadOptions#criteria:member + package: excel! + fullName: criteria + summary: An array that holds all the filter criteria in the autofiltered range. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'criteria?: boolean;' + return: + type: boolean + - name: enabled + uid: excel!Excel.Interfaces.AutoFilterLoadOptions#enabled:member + package: excel! + fullName: enabled + summary: Specifies if the AutoFilter is enabled. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'enabled?: boolean;' + return: + type: boolean + - name: isDataFiltered + uid: excel!Excel.Interfaces.AutoFilterLoadOptions#isDataFiltered:member + package: excel! + fullName: isDataFiltered + summary: Specifies if the AutoFilter has filter criteria. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'isDataFiltered?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.bindingcollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.bindingcollectiondata.yml new file mode 100644 index 0000000000..c00a2b61fb --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.bindingcollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.BindingCollectionData +uid: excel!Excel.Interfaces.BindingCollectionData:interface +package: excel! +fullName: Excel.Interfaces.BindingCollectionData +summary: >- + An interface describing the data returned by calling + `bindingCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.BindingCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.BindingData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.bindingcollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.bindingcollectionloadoptions.yml new file mode 100644 index 0000000000..f7b2b6c9f0 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.bindingcollectionloadoptions.yml @@ -0,0 +1,64 @@ +### YamlMime:TSType +name: Excel.Interfaces.BindingCollectionLoadOptions +uid: excel!Excel.Interfaces.BindingCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.BindingCollectionLoadOptions +summary: >- + Represents the collection of all the binding objects that are part of the + workbook. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.BindingCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.BindingCollectionLoadOptions#id:member + package: excel! + fullName: id + summary: 'For EACH ITEM in the collection: Represents the binding identifier.' + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: type + uid: excel!Excel.Interfaces.BindingCollectionLoadOptions#type:member + package: excel! + fullName: type + summary: >- + For EACH ITEM in the collection: Returns the type of the binding. See + `Excel.BindingType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.bindingcollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.bindingcollectionupdatedata.yml new file mode 100644 index 0000000000..481b64a9fd --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.bindingcollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.BindingCollectionUpdateData +uid: excel!Excel.Interfaces.BindingCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.BindingCollectionUpdateData +summary: >- + An interface for updating data on the `BindingCollection` object, for use in + `bindingCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.BindingCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.BindingData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.bindingdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.bindingdata.yml new file mode 100644 index 0000000000..8b28f8ab83 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.bindingdata.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: Excel.Interfaces.BindingData +uid: excel!Excel.Interfaces.BindingData:interface +package: excel! +fullName: Excel.Interfaces.BindingData +summary: >- + An interface describing the data returned by calling `binding.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: id + uid: excel!Excel.Interfaces.BindingData#id:member + package: excel! + fullName: id + summary: Represents the binding identifier. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: string;' + return: + type: string + - name: type + uid: excel!Excel.Interfaces.BindingData#type:member + package: excel! + fullName: type + summary: Returns the type of the binding. See `Excel.BindingType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type?: Excel.BindingType | "Range" | "Table" | "Text";' + return: + type: >- + | "Range" | "Table" | + "Text" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.bindingloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.bindingloadoptions.yml new file mode 100644 index 0000000000..6ecce4ff08 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.bindingloadoptions.yml @@ -0,0 +1,60 @@ +### YamlMime:TSType +name: Excel.Interfaces.BindingLoadOptions +uid: excel!Excel.Interfaces.BindingLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.BindingLoadOptions +summary: Represents an Office.js binding that is defined in the workbook. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.BindingLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.BindingLoadOptions#id:member + package: excel! + fullName: id + summary: Represents the binding identifier. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: type + uid: excel!Excel.Interfaces.BindingLoadOptions#type:member + package: excel! + fullName: type + summary: Returns the type of the binding. See `Excel.BindingType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.cellvalueconditionalformatdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.cellvalueconditionalformatdata.yml new file mode 100644 index 0000000000..867499c6bf --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.cellvalueconditionalformatdata.yml @@ -0,0 +1,48 @@ +### YamlMime:TSType +name: Excel.Interfaces.CellValueConditionalFormatData +uid: excel!Excel.Interfaces.CellValueConditionalFormatData:interface +package: excel! +fullName: Excel.Interfaces.CellValueConditionalFormatData +summary: >- + An interface describing the data returned by calling + `cellValueConditionalFormat.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: format + uid: excel!Excel.Interfaces.CellValueConditionalFormatData#format:member + package: excel! + fullName: format + summary: >- + Returns a format object, encapsulating the conditional formats font, fill, + borders, and other properties. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ConditionalRangeFormatData;' + return: + type: >- + + - name: rule + uid: excel!Excel.Interfaces.CellValueConditionalFormatData#rule:member + package: excel! + fullName: rule + summary: Specifies the rule object on this conditional format. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rule?: Excel.ConditionalCellValueRule;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.cellvalueconditionalformatloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.cellvalueconditionalformatloadoptions.yml new file mode 100644 index 0000000000..8e227ae8fe --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.cellvalueconditionalformatloadoptions.yml @@ -0,0 +1,65 @@ +### YamlMime:TSType +name: Excel.Interfaces.CellValueConditionalFormatLoadOptions +uid: excel!Excel.Interfaces.CellValueConditionalFormatLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.CellValueConditionalFormatLoadOptions +summary: Represents a cell value conditional format. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.CellValueConditionalFormatLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: format + uid: excel!Excel.Interfaces.CellValueConditionalFormatLoadOptions#format:member + package: excel! + fullName: format + summary: >- + Returns a format object, encapsulating the conditional formats font, fill, + borders, and other properties. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ConditionalRangeFormatLoadOptions;' + return: + type: >- + + - name: rule + uid: excel!Excel.Interfaces.CellValueConditionalFormatLoadOptions#rule:member + package: excel! + fullName: rule + summary: Specifies the rule object on this conditional format. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rule?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.cellvalueconditionalformatupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.cellvalueconditionalformatupdatedata.yml new file mode 100644 index 0000000000..6ef570c3f6 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.cellvalueconditionalformatupdatedata.yml @@ -0,0 +1,49 @@ +### YamlMime:TSType +name: Excel.Interfaces.CellValueConditionalFormatUpdateData +uid: excel!Excel.Interfaces.CellValueConditionalFormatUpdateData:interface +package: excel! +fullName: Excel.Interfaces.CellValueConditionalFormatUpdateData +summary: >- + An interface for updating data on the `CellValueConditionalFormat` object, for + use in `cellValueConditionalFormat.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: format + uid: excel!Excel.Interfaces.CellValueConditionalFormatUpdateData#format:member + package: excel! + fullName: format + summary: >- + Returns a format object, encapsulating the conditional formats font, fill, + borders, and other properties. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ConditionalRangeFormatUpdateData;' + return: + type: >- + + - name: rule + uid: excel!Excel.Interfaces.CellValueConditionalFormatUpdateData#rule:member + package: excel! + fullName: rule + summary: Specifies the rule object on this conditional format. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rule?: Excel.ConditionalCellValueRule;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartareaformatdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartareaformatdata.yml new file mode 100644 index 0000000000..8ff9f9dfca --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartareaformatdata.yml @@ -0,0 +1,96 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartAreaFormatData +uid: excel!Excel.Interfaces.ChartAreaFormatData:interface +package: excel! +fullName: Excel.Interfaces.ChartAreaFormatData +summary: >- + An interface describing the data returned by calling + `chartAreaFormat.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: border + uid: excel!Excel.Interfaces.ChartAreaFormatData#border:member + package: excel! + fullName: border + summary: >- + Represents the border format of chart area, which includes color, + linestyle, and weight. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'border?: Excel.Interfaces.ChartBorderData;' + return: + type: + - name: colorScheme + uid: excel!Excel.Interfaces.ChartAreaFormatData#colorScheme:member + package: excel! + fullName: colorScheme + summary: Specifies the color scheme of the chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + colorScheme?: Excel.ChartColorScheme | "ColorfulPalette1" | + "ColorfulPalette2" | "ColorfulPalette3" | "ColorfulPalette4" | + "MonochromaticPalette1" | "MonochromaticPalette2" | + "MonochromaticPalette3" | "MonochromaticPalette4" | + "MonochromaticPalette5" | "MonochromaticPalette6" | + "MonochromaticPalette7" | "MonochromaticPalette8" | + "MonochromaticPalette9" | "MonochromaticPalette10" | + "MonochromaticPalette11" | "MonochromaticPalette12" | + "MonochromaticPalette13"; + return: + type: >- + | "ColorfulPalette1" + | "ColorfulPalette2" | "ColorfulPalette3" | "ColorfulPalette4" | + "MonochromaticPalette1" | "MonochromaticPalette2" | + "MonochromaticPalette3" | "MonochromaticPalette4" | + "MonochromaticPalette5" | "MonochromaticPalette6" | + "MonochromaticPalette7" | "MonochromaticPalette8" | + "MonochromaticPalette9" | "MonochromaticPalette10" | + "MonochromaticPalette11" | "MonochromaticPalette12" | + "MonochromaticPalette13" + - name: font + uid: excel!Excel.Interfaces.ChartAreaFormatData#font:member + package: excel! + fullName: font + summary: >- + Represents the font attributes (font name, font size, color, etc.) for the + current object. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.Interfaces.ChartFontData;' + return: + type: + - name: roundedCorners + uid: excel!Excel.Interfaces.ChartAreaFormatData#roundedCorners:member + package: excel! + fullName: roundedCorners + summary: Specifies if the chart area of the chart has rounded corners. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'roundedCorners?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartareaformatloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartareaformatloadoptions.yml new file mode 100644 index 0000000000..507f825269 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartareaformatloadoptions.yml @@ -0,0 +1,94 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartAreaFormatLoadOptions +uid: excel!Excel.Interfaces.ChartAreaFormatLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartAreaFormatLoadOptions +summary: Encapsulates the format properties for the overall chart area. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartAreaFormatLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: border + uid: excel!Excel.Interfaces.ChartAreaFormatLoadOptions#border:member + package: excel! + fullName: border + summary: >- + Represents the border format of chart area, which includes color, + linestyle, and weight. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'border?: Excel.Interfaces.ChartBorderLoadOptions;' + return: + type: + - name: colorScheme + uid: excel!Excel.Interfaces.ChartAreaFormatLoadOptions#colorScheme:member + package: excel! + fullName: colorScheme + summary: Specifies the color scheme of the chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'colorScheme?: boolean;' + return: + type: boolean + - name: font + uid: excel!Excel.Interfaces.ChartAreaFormatLoadOptions#font:member + package: excel! + fullName: font + summary: >- + Represents the font attributes (font name, font size, color, etc.) for the + current object. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.Interfaces.ChartFontLoadOptions;' + return: + type: + - name: roundedCorners + uid: excel!Excel.Interfaces.ChartAreaFormatLoadOptions#roundedCorners:member + package: excel! + fullName: roundedCorners + summary: Specifies if the chart area of the chart has rounded corners. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'roundedCorners?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartareaformatupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartareaformatupdatedata.yml new file mode 100644 index 0000000000..6de4787ec8 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartareaformatupdatedata.yml @@ -0,0 +1,96 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartAreaFormatUpdateData +uid: excel!Excel.Interfaces.ChartAreaFormatUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartAreaFormatUpdateData +summary: >- + An interface for updating data on the `ChartAreaFormat` object, for use in + `chartAreaFormat.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: border + uid: excel!Excel.Interfaces.ChartAreaFormatUpdateData#border:member + package: excel! + fullName: border + summary: >- + Represents the border format of chart area, which includes color, + linestyle, and weight. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'border?: Excel.Interfaces.ChartBorderUpdateData;' + return: + type: + - name: colorScheme + uid: excel!Excel.Interfaces.ChartAreaFormatUpdateData#colorScheme:member + package: excel! + fullName: colorScheme + summary: Specifies the color scheme of the chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + colorScheme?: Excel.ChartColorScheme | "ColorfulPalette1" | + "ColorfulPalette2" | "ColorfulPalette3" | "ColorfulPalette4" | + "MonochromaticPalette1" | "MonochromaticPalette2" | + "MonochromaticPalette3" | "MonochromaticPalette4" | + "MonochromaticPalette5" | "MonochromaticPalette6" | + "MonochromaticPalette7" | "MonochromaticPalette8" | + "MonochromaticPalette9" | "MonochromaticPalette10" | + "MonochromaticPalette11" | "MonochromaticPalette12" | + "MonochromaticPalette13"; + return: + type: >- + | "ColorfulPalette1" + | "ColorfulPalette2" | "ColorfulPalette3" | "ColorfulPalette4" | + "MonochromaticPalette1" | "MonochromaticPalette2" | + "MonochromaticPalette3" | "MonochromaticPalette4" | + "MonochromaticPalette5" | "MonochromaticPalette6" | + "MonochromaticPalette7" | "MonochromaticPalette8" | + "MonochromaticPalette9" | "MonochromaticPalette10" | + "MonochromaticPalette11" | "MonochromaticPalette12" | + "MonochromaticPalette13" + - name: font + uid: excel!Excel.Interfaces.ChartAreaFormatUpdateData#font:member + package: excel! + fullName: font + summary: >- + Represents the font attributes (font name, font size, color, etc.) for the + current object. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.Interfaces.ChartFontUpdateData;' + return: + type: + - name: roundedCorners + uid: excel!Excel.Interfaces.ChartAreaFormatUpdateData#roundedCorners:member + package: excel! + fullName: roundedCorners + summary: Specifies if the chart area of the chart has rounded corners. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'roundedCorners?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxesdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxesdata.yml new file mode 100644 index 0000000000..49147f4023 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxesdata.yml @@ -0,0 +1,59 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartAxesData +uid: excel!Excel.Interfaces.ChartAxesData:interface +package: excel! +fullName: Excel.Interfaces.ChartAxesData +summary: >- + An interface describing the data returned by calling `chartAxes.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: categoryAxis + uid: excel!Excel.Interfaces.ChartAxesData#categoryAxis:member + package: excel! + fullName: categoryAxis + summary: Represents the category axis in a chart. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'categoryAxis?: Excel.Interfaces.ChartAxisData;' + return: + type: + - name: seriesAxis + uid: excel!Excel.Interfaces.ChartAxesData#seriesAxis:member + package: excel! + fullName: seriesAxis + summary: Represents the series axis of a 3-D chart. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'seriesAxis?: Excel.Interfaces.ChartAxisData;' + return: + type: + - name: valueAxis + uid: excel!Excel.Interfaces.ChartAxesData#valueAxis:member + package: excel! + fullName: valueAxis + summary: Represents the value axis in an axis. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valueAxis?: Excel.Interfaces.ChartAxisData;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxesloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxesloadoptions.yml new file mode 100644 index 0000000000..055c7add06 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxesloadoptions.yml @@ -0,0 +1,75 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartAxesLoadOptions +uid: excel!Excel.Interfaces.ChartAxesLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartAxesLoadOptions +summary: Represents the chart axes. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartAxesLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: categoryAxis + uid: excel!Excel.Interfaces.ChartAxesLoadOptions#categoryAxis:member + package: excel! + fullName: categoryAxis + summary: Represents the category axis in a chart. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'categoryAxis?: Excel.Interfaces.ChartAxisLoadOptions;' + return: + type: + - name: seriesAxis + uid: excel!Excel.Interfaces.ChartAxesLoadOptions#seriesAxis:member + package: excel! + fullName: seriesAxis + summary: Represents the series axis of a 3-D chart. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'seriesAxis?: Excel.Interfaces.ChartAxisLoadOptions;' + return: + type: + - name: valueAxis + uid: excel!Excel.Interfaces.ChartAxesLoadOptions#valueAxis:member + package: excel! + fullName: valueAxis + summary: Represents the value axis in an axis. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valueAxis?: Excel.Interfaces.ChartAxisLoadOptions;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxesupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxesupdatedata.yml new file mode 100644 index 0000000000..6461b76f25 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxesupdatedata.yml @@ -0,0 +1,59 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartAxesUpdateData +uid: excel!Excel.Interfaces.ChartAxesUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartAxesUpdateData +summary: >- + An interface for updating data on the `ChartAxes` object, for use in + `chartAxes.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: categoryAxis + uid: excel!Excel.Interfaces.ChartAxesUpdateData#categoryAxis:member + package: excel! + fullName: categoryAxis + summary: Represents the category axis in a chart. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'categoryAxis?: Excel.Interfaces.ChartAxisUpdateData;' + return: + type: + - name: seriesAxis + uid: excel!Excel.Interfaces.ChartAxesUpdateData#seriesAxis:member + package: excel! + fullName: seriesAxis + summary: Represents the series axis of a 3-D chart. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'seriesAxis?: Excel.Interfaces.ChartAxisUpdateData;' + return: + type: + - name: valueAxis + uid: excel!Excel.Interfaces.ChartAxesUpdateData#valueAxis:member + package: excel! + fullName: valueAxis + summary: Represents the value axis in an axis. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valueAxis?: Excel.Interfaces.ChartAxisUpdateData;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxisdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxisdata.yml new file mode 100644 index 0000000000..9801202f32 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxisdata.yml @@ -0,0 +1,706 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartAxisData +uid: excel!Excel.Interfaces.ChartAxisData:interface +package: excel! +fullName: Excel.Interfaces.ChartAxisData +summary: >- + An interface describing the data returned by calling `chartAxis.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: alignment + uid: excel!Excel.Interfaces.ChartAxisData#alignment:member + package: excel! + fullName: alignment + summary: >- + Specifies the alignment for the specified axis tick label. See + `Excel.ChartTextHorizontalAlignment` for detail. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'alignment?: Excel.ChartTickLabelAlignment | "Center" | "Left" | "Right";' + return: + type: >- + | "Center" | + "Left" | "Right" + - name: axisGroup + uid: excel!Excel.Interfaces.ChartAxisData#axisGroup:member + package: excel! + fullName: axisGroup + summary: >- + Specifies the group for the specified axis. See `Excel.ChartAxisGroup` for + details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'axisGroup?: Excel.ChartAxisGroup | "Primary" | "Secondary";' + return: + type: >- + | "Primary" | + "Secondary" + - name: baseTimeUnit + uid: excel!Excel.Interfaces.ChartAxisData#baseTimeUnit:member + package: excel! + fullName: baseTimeUnit + summary: Specifies the base unit for the specified category axis. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'baseTimeUnit?: Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years";' + return: + type: >- + | "Days" | "Months" + | "Years" + - name: categoryType + uid: excel!Excel.Interfaces.ChartAxisData#categoryType:member + package: excel! + fullName: categoryType + summary: Specifies the category axis type. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + categoryType?: Excel.ChartAxisCategoryType | "Automatic" | "TextAxis" | + "DateAxis"; + return: + type: >- + | "Automatic" | + "TextAxis" | "DateAxis" + - name: customDisplayUnit + uid: excel!Excel.Interfaces.ChartAxisData#customDisplayUnit:member + package: excel! + fullName: customDisplayUnit + summary: >- + Specifies the custom axis display unit value. To set this property, please + use the `SetCustomDisplayUnit(double)` method. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'customDisplayUnit?: number;' + return: + type: number + - name: displayUnit + uid: excel!Excel.Interfaces.ChartAxisData#displayUnit:member + package: excel! + fullName: displayUnit + summary: >- + Represents the axis display unit. See `Excel.ChartAxisDisplayUnit` for + details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + displayUnit?: Excel.ChartAxisDisplayUnit | "None" | "Hundreds" | + "Thousands" | "TenThousands" | "HundredThousands" | "Millions" | + "TenMillions" | "HundredMillions" | "Billions" | "Trillions" | "Custom"; + return: + type: >- + | "None" | + "Hundreds" | "Thousands" | "TenThousands" | "HundredThousands" | + "Millions" | "TenMillions" | "HundredMillions" | "Billions" | + "Trillions" | "Custom" + - name: format + uid: excel!Excel.Interfaces.ChartAxisData#format:member + package: excel! + fullName: format + summary: >- + Represents the formatting of a chart object, which includes line and font + formatting. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartAxisFormatData;' + return: + type: + - name: height + uid: excel!Excel.Interfaces.ChartAxisData#height:member + package: excel! + fullName: height + summary: >- + Specifies the height, in points, of the chart axis. Returns `null` if the + axis is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height?: number;' + return: + type: number + - name: isBetweenCategories + uid: excel!Excel.Interfaces.ChartAxisData#isBetweenCategories:member + package: excel! + fullName: isBetweenCategories + summary: Specifies if the value axis crosses the category axis between categories. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'isBetweenCategories?: boolean;' + return: + type: boolean + - name: left + uid: excel!Excel.Interfaces.ChartAxisData#left:member + package: excel! + fullName: left + summary: >- + Specifies the distance, in points, from the left edge of the axis to the + left of chart area. Returns `null` if the axis is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: number;' + return: + type: number + - name: linkNumberFormat + uid: excel!Excel.Interfaces.ChartAxisData#linkNumberFormat:member + package: excel! + fullName: linkNumberFormat + summary: >- + Specifies if the number format is linked to the cells. If `true`, + the number format will change in the labels when it changes in the cells. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'linkNumberFormat?: boolean;' + return: + type: boolean + - name: logBase + uid: excel!Excel.Interfaces.ChartAxisData#logBase:member + package: excel! + fullName: logBase + summary: Specifies the base of the logarithm when using logarithmic scales. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'logBase?: number;' + return: + type: number + - name: majorGridlines + uid: excel!Excel.Interfaces.ChartAxisData#majorGridlines:member + package: excel! + fullName: majorGridlines + summary: >- + Returns an object that represents the major gridlines for the specified + axis. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'majorGridlines?: Excel.Interfaces.ChartGridlinesData;' + return: + type: + - name: majorTickMark + uid: excel!Excel.Interfaces.ChartAxisData#majorTickMark:member + package: excel! + fullName: majorTickMark + summary: >- + Specifies the type of major tick mark for the specified axis. See + `Excel.ChartAxisTickMark` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + majorTickMark?: Excel.ChartAxisTickMark | "None" | "Cross" | "Inside" | + "Outside"; + return: + type: >- + | "None" | "Cross" | + "Inside" | "Outside" + - name: majorTimeUnitScale + uid: excel!Excel.Interfaces.ChartAxisData#majorTimeUnitScale:member + package: excel! + fullName: majorTimeUnitScale + summary: >- + Specifies the major unit scale value for the category axis when the + `categoryType` property is set to `dateAxis`. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + majorTimeUnitScale?: Excel.ChartAxisTimeUnit | "Days" | "Months" | + "Years"; + return: + type: >- + | "Days" | "Months" + | "Years" + - name: majorUnit + uid: excel!Excel.Interfaces.ChartAxisData#majorUnit:member + package: excel! + fullName: majorUnit + summary: >- + Represents the interval between two major tick marks. Can be set to a + numeric value or an empty string. The returned value is always a number. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'majorUnit?: any;' + return: + type: any + - name: maximum + uid: excel!Excel.Interfaces.ChartAxisData#maximum:member + package: excel! + fullName: maximum + summary: >- + Represents the maximum value on the value axis. Can be set to a numeric + value or an empty string (for automatic axis values). The returned value + is always a number. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'maximum?: any;' + return: + type: any + - name: minimum + uid: excel!Excel.Interfaces.ChartAxisData#minimum:member + package: excel! + fullName: minimum + summary: >- + Represents the minimum value on the value axis. Can be set to a numeric + value or an empty string (for automatic axis values). The returned value + is always a number. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'minimum?: any;' + return: + type: any + - name: minorGridlines + uid: excel!Excel.Interfaces.ChartAxisData#minorGridlines:member + package: excel! + fullName: minorGridlines + summary: >- + Returns an object that represents the minor gridlines for the specified + axis. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'minorGridlines?: Excel.Interfaces.ChartGridlinesData;' + return: + type: + - name: minorTickMark + uid: excel!Excel.Interfaces.ChartAxisData#minorTickMark:member + package: excel! + fullName: minorTickMark + summary: >- + Specifies the type of minor tick mark for the specified axis. See + `Excel.ChartAxisTickMark` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + minorTickMark?: Excel.ChartAxisTickMark | "None" | "Cross" | "Inside" | + "Outside"; + return: + type: >- + | "None" | "Cross" | + "Inside" | "Outside" + - name: minorTimeUnitScale + uid: excel!Excel.Interfaces.ChartAxisData#minorTimeUnitScale:member + package: excel! + fullName: minorTimeUnitScale + summary: >- + Specifies the minor unit scale value for the category axis when the + `categoryType` property is set to `dateAxis`. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + minorTimeUnitScale?: Excel.ChartAxisTimeUnit | "Days" | "Months" | + "Years"; + return: + type: >- + | "Days" | "Months" + | "Years" + - name: minorUnit + uid: excel!Excel.Interfaces.ChartAxisData#minorUnit:member + package: excel! + fullName: minorUnit + summary: >- + Represents the interval between two minor tick marks. Can be set to a + numeric value or an empty string (for automatic axis values). The returned + value is always a number. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'minorUnit?: any;' + return: + type: any + - name: multiLevel + uid: excel!Excel.Interfaces.ChartAxisData#multiLevel:member + package: excel! + fullName: multiLevel + summary: Specifies if an axis is multilevel. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'multiLevel?: boolean;' + return: + type: boolean + - name: numberFormat + uid: excel!Excel.Interfaces.ChartAxisData#numberFormat:member + package: excel! + fullName: numberFormat + summary: Specifies the format code for the axis tick label. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat?: string;' + return: + type: string + - name: offset + uid: excel!Excel.Interfaces.ChartAxisData#offset:member + package: excel! + fullName: offset + summary: >- + Specifies the distance between the levels of labels, and the distance + between the first level and the axis line. The value should be an integer + from 0 to 1000. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'offset?: number;' + return: + type: number + - name: position + uid: excel!Excel.Interfaces.ChartAxisData#position:member + package: excel! + fullName: position + summary: >- + Specifies the specified axis position where the other axis crosses. See + `Excel.ChartAxisPosition` for details. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + position?: Excel.ChartAxisPosition | "Automatic" | "Maximum" | "Minimum" + | "Custom"; + return: + type: >- + | "Automatic" | + "Maximum" | "Minimum" | "Custom" + - name: positionAt + uid: excel!Excel.Interfaces.ChartAxisData#positionAt:member + package: excel! + fullName: positionAt + summary: >- + Specifies the axis position where the other axis crosses. You should use + the `SetPositionAt(double)` method to set this property. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'positionAt?: number;' + return: + type: number + - name: reversePlotOrder + uid: excel!Excel.Interfaces.ChartAxisData#reversePlotOrder:member + package: excel! + fullName: reversePlotOrder + summary: Specifies if Excel plots data points from last to first. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'reversePlotOrder?: boolean;' + return: + type: boolean + - name: scaleType + uid: excel!Excel.Interfaces.ChartAxisData#scaleType:member + package: excel! + fullName: scaleType + summary: >- + Specifies the value axis scale type. See `Excel.ChartAxisScaleType` for + details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'scaleType?: Excel.ChartAxisScaleType | "Linear" | "Logarithmic";' + return: + type: >- + | "Linear" | + "Logarithmic" + - name: showDisplayUnitLabel + uid: excel!Excel.Interfaces.ChartAxisData#showDisplayUnitLabel:member + package: excel! + fullName: showDisplayUnitLabel + summary: Specifies if the axis display unit label is visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showDisplayUnitLabel?: boolean;' + return: + type: boolean + - name: textOrientation + uid: excel!Excel.Interfaces.ChartAxisData#textOrientation:member + package: excel! + fullName: textOrientation + summary: >- + Specifies the angle to which the text is oriented for the chart axis tick + label. The value should either be an integer from -90 to 90 or the integer + 180 for vertically-oriented text. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textOrientation?: any;' + return: + type: any + - name: tickLabelPosition + uid: excel!Excel.Interfaces.ChartAxisData#tickLabelPosition:member + package: excel! + fullName: tickLabelPosition + summary: >- + Specifies the position of tick-mark labels on the specified axis. See + `Excel.ChartAxisTickLabelPosition` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + tickLabelPosition?: Excel.ChartAxisTickLabelPosition | "NextToAxis" | + "High" | "Low" | "None"; + return: + type: >- + | + "NextToAxis" | "High" | "Low" | "None" + - name: tickLabelSpacing + uid: excel!Excel.Interfaces.ChartAxisData#tickLabelSpacing:member + package: excel! + fullName: tickLabelSpacing + summary: >- + Specifies the number of categories or series between tick-mark labels. Can + be a value from 1 through 31999 or an empty string for automatic setting. + The returned value is always a number. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tickLabelSpacing?: any;' + return: + type: any + - name: tickMarkSpacing + uid: excel!Excel.Interfaces.ChartAxisData#tickMarkSpacing:member + package: excel! + fullName: tickMarkSpacing + summary: Specifies the number of categories or series between tick marks. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tickMarkSpacing?: number;' + return: + type: number + - name: title + uid: excel!Excel.Interfaces.ChartAxisData#title:member + package: excel! + fullName: title + summary: Represents the axis title. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'title?: Excel.Interfaces.ChartAxisTitleData;' + return: + type: + - name: top + uid: excel!Excel.Interfaces.ChartAxisData#top:member + package: excel! + fullName: top + summary: >- + Specifies the distance, in points, from the top edge of the axis to the + top of chart area. Returns `null` if the axis is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: number;' + return: + type: number + - name: type + uid: excel!Excel.Interfaces.ChartAxisData#type:member + package: excel! + fullName: type + summary: Specifies the axis type. See `Excel.ChartAxisType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + type?: Excel.ChartAxisType | "Invalid" | "Category" | "Value" | + "Series"; + return: + type: >- + | "Invalid" | "Category" + | "Value" | "Series" + - name: visible + uid: excel!Excel.Interfaces.ChartAxisData#visible:member + package: excel! + fullName: visible + summary: Specifies if the axis is visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean + - name: width + uid: excel!Excel.Interfaces.ChartAxisData#width:member + package: excel! + fullName: width + summary: >- + Specifies the width, in points, of the chart axis. Returns `null` if the + axis is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxisformatdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxisformatdata.yml new file mode 100644 index 0000000000..eb6cfdbf66 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxisformatdata.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartAxisFormatData +uid: excel!Excel.Interfaces.ChartAxisFormatData:interface +package: excel! +fullName: Excel.Interfaces.ChartAxisFormatData +summary: >- + An interface describing the data returned by calling + `chartAxisFormat.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: font + uid: excel!Excel.Interfaces.ChartAxisFormatData#font:member + package: excel! + fullName: font + summary: >- + Specifies the font attributes (font name, font size, color, etc.) for a + chart axis element. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.Interfaces.ChartFontData;' + return: + type: + - name: line + uid: excel!Excel.Interfaces.ChartAxisFormatData#line:member + package: excel! + fullName: line + summary: Specifies chart line formatting. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'line?: Excel.Interfaces.ChartLineFormatData;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxisformatloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxisformatloadoptions.yml new file mode 100644 index 0000000000..31c6d92251 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxisformatloadoptions.yml @@ -0,0 +1,64 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartAxisFormatLoadOptions +uid: excel!Excel.Interfaces.ChartAxisFormatLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartAxisFormatLoadOptions +summary: Encapsulates the format properties for the chart axis. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartAxisFormatLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: font + uid: excel!Excel.Interfaces.ChartAxisFormatLoadOptions#font:member + package: excel! + fullName: font + summary: >- + Specifies the font attributes (font name, font size, color, etc.) for a + chart axis element. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.Interfaces.ChartFontLoadOptions;' + return: + type: + - name: line + uid: excel!Excel.Interfaces.ChartAxisFormatLoadOptions#line:member + package: excel! + fullName: line + summary: Specifies chart line formatting. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'line?: Excel.Interfaces.ChartLineFormatLoadOptions;' + return: + type: >- + diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxisformatupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxisformatupdatedata.yml new file mode 100644 index 0000000000..046acedfdc --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxisformatupdatedata.yml @@ -0,0 +1,48 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartAxisFormatUpdateData +uid: excel!Excel.Interfaces.ChartAxisFormatUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartAxisFormatUpdateData +summary: >- + An interface for updating data on the `ChartAxisFormat` object, for use in + `chartAxisFormat.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: font + uid: excel!Excel.Interfaces.ChartAxisFormatUpdateData#font:member + package: excel! + fullName: font + summary: >- + Specifies the font attributes (font name, font size, color, etc.) for a + chart axis element. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.Interfaces.ChartFontUpdateData;' + return: + type: + - name: line + uid: excel!Excel.Interfaces.ChartAxisFormatUpdateData#line:member + package: excel! + fullName: line + summary: Specifies chart line formatting. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'line?: Excel.Interfaces.ChartLineFormatUpdateData;' + return: + type: >- + diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxisloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxisloadoptions.yml new file mode 100644 index 0000000000..c7ac7c141f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxisloadoptions.yml @@ -0,0 +1,683 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartAxisLoadOptions +uid: excel!Excel.Interfaces.ChartAxisLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartAxisLoadOptions +summary: Represents a single axis in a chart. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartAxisLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: alignment + uid: excel!Excel.Interfaces.ChartAxisLoadOptions#alignment:member + package: excel! + fullName: alignment + summary: >- + Specifies the alignment for the specified axis tick label. See + `Excel.ChartTextHorizontalAlignment` for detail. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'alignment?: boolean;' + return: + type: boolean + - name: axisGroup + uid: excel!Excel.Interfaces.ChartAxisLoadOptions#axisGroup:member + package: excel! + fullName: axisGroup + summary: >- + Specifies the group for the specified axis. See `Excel.ChartAxisGroup` for + details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'axisGroup?: boolean;' + return: + type: boolean + - name: baseTimeUnit + uid: excel!Excel.Interfaces.ChartAxisLoadOptions#baseTimeUnit:member + package: excel! + fullName: baseTimeUnit + summary: Specifies the base unit for the specified category axis. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'baseTimeUnit?: boolean;' + return: + type: boolean + - name: categoryType + uid: excel!Excel.Interfaces.ChartAxisLoadOptions#categoryType:member + package: excel! + fullName: categoryType + summary: Specifies the category axis type. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'categoryType?: boolean;' + return: + type: boolean + - name: customDisplayUnit + uid: excel!Excel.Interfaces.ChartAxisLoadOptions#customDisplayUnit:member + package: excel! + fullName: customDisplayUnit + summary: >- + Specifies the custom axis display unit value. To set this property, please + use the `SetCustomDisplayUnit(double)` method. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'customDisplayUnit?: boolean;' + return: + type: boolean + - name: displayUnit + uid: excel!Excel.Interfaces.ChartAxisLoadOptions#displayUnit:member + package: excel! + fullName: displayUnit + summary: >- + Represents the axis display unit. See `Excel.ChartAxisDisplayUnit` for + details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'displayUnit?: boolean;' + return: + type: boolean + - name: format + uid: excel!Excel.Interfaces.ChartAxisLoadOptions#format:member + package: excel! + fullName: format + summary: >- + Represents the formatting of a chart object, which includes line and font + formatting. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartAxisFormatLoadOptions;' + return: + type: >- + + - name: height + uid: excel!Excel.Interfaces.ChartAxisLoadOptions#height:member + package: excel! + fullName: height + summary: >- + Specifies the height, in points, of the chart axis. Returns `null` if the + axis is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height?: boolean;' + return: + type: boolean + - name: isBetweenCategories + uid: excel!Excel.Interfaces.ChartAxisLoadOptions#isBetweenCategories:member + package: excel! + fullName: isBetweenCategories + summary: Specifies if the value axis crosses the category axis between categories. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'isBetweenCategories?: boolean;' + return: + type: boolean + - name: left + uid: excel!Excel.Interfaces.ChartAxisLoadOptions#left:member + package: excel! + fullName: left + summary: >- + Specifies the distance, in points, from the left edge of the axis to the + left of chart area. Returns `null` if the axis is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: boolean;' + return: + type: boolean + - name: linkNumberFormat + uid: excel!Excel.Interfaces.ChartAxisLoadOptions#linkNumberFormat:member + package: excel! + fullName: linkNumberFormat + summary: >- + Specifies if the number format is linked to the cells. If `true`, + the number format will change in the labels when it changes in the cells. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'linkNumberFormat?: boolean;' + return: + type: boolean + - name: logBase + uid: excel!Excel.Interfaces.ChartAxisLoadOptions#logBase:member + package: excel! + fullName: logBase + summary: Specifies the base of the logarithm when using logarithmic scales. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'logBase?: boolean;' + return: + type: boolean + - name: majorGridlines + uid: excel!Excel.Interfaces.ChartAxisLoadOptions#majorGridlines:member + package: excel! + fullName: majorGridlines + summary: >- + Returns an object that represents the major gridlines for the specified + axis. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'majorGridlines?: Excel.Interfaces.ChartGridlinesLoadOptions;' + return: + type: >- + + - name: majorTickMark + uid: excel!Excel.Interfaces.ChartAxisLoadOptions#majorTickMark:member + package: excel! + fullName: majorTickMark + summary: >- + Specifies the type of major tick mark for the specified axis. See + `Excel.ChartAxisTickMark` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'majorTickMark?: boolean;' + return: + type: boolean + - name: majorTimeUnitScale + uid: excel!Excel.Interfaces.ChartAxisLoadOptions#majorTimeUnitScale:member + package: excel! + fullName: majorTimeUnitScale + summary: >- + Specifies the major unit scale value for the category axis when the + `categoryType` property is set to `dateAxis`. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'majorTimeUnitScale?: boolean;' + return: + type: boolean + - name: majorUnit + uid: excel!Excel.Interfaces.ChartAxisLoadOptions#majorUnit:member + package: excel! + fullName: majorUnit + summary: >- + Represents the interval between two major tick marks. Can be set to a + numeric value or an empty string. The returned value is always a number. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'majorUnit?: boolean;' + return: + type: boolean + - name: maximum + uid: excel!Excel.Interfaces.ChartAxisLoadOptions#maximum:member + package: excel! + fullName: maximum + summary: >- + Represents the maximum value on the value axis. Can be set to a numeric + value or an empty string (for automatic axis values). The returned value + is always a number. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'maximum?: boolean;' + return: + type: boolean + - name: minimum + uid: excel!Excel.Interfaces.ChartAxisLoadOptions#minimum:member + package: excel! + fullName: minimum + summary: >- + Represents the minimum value on the value axis. Can be set to a numeric + value or an empty string (for automatic axis values). The returned value + is always a number. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'minimum?: boolean;' + return: + type: boolean + - name: minorGridlines + uid: excel!Excel.Interfaces.ChartAxisLoadOptions#minorGridlines:member + package: excel! + fullName: minorGridlines + summary: >- + Returns an object that represents the minor gridlines for the specified + axis. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'minorGridlines?: Excel.Interfaces.ChartGridlinesLoadOptions;' + return: + type: >- + + - name: minorTickMark + uid: excel!Excel.Interfaces.ChartAxisLoadOptions#minorTickMark:member + package: excel! + fullName: minorTickMark + summary: >- + Specifies the type of minor tick mark for the specified axis. See + `Excel.ChartAxisTickMark` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'minorTickMark?: boolean;' + return: + type: boolean + - name: minorTimeUnitScale + uid: excel!Excel.Interfaces.ChartAxisLoadOptions#minorTimeUnitScale:member + package: excel! + fullName: minorTimeUnitScale + summary: >- + Specifies the minor unit scale value for the category axis when the + `categoryType` property is set to `dateAxis`. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'minorTimeUnitScale?: boolean;' + return: + type: boolean + - name: minorUnit + uid: excel!Excel.Interfaces.ChartAxisLoadOptions#minorUnit:member + package: excel! + fullName: minorUnit + summary: >- + Represents the interval between two minor tick marks. Can be set to a + numeric value or an empty string (for automatic axis values). The returned + value is always a number. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'minorUnit?: boolean;' + return: + type: boolean + - name: multiLevel + uid: excel!Excel.Interfaces.ChartAxisLoadOptions#multiLevel:member + package: excel! + fullName: multiLevel + summary: Specifies if an axis is multilevel. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'multiLevel?: boolean;' + return: + type: boolean + - name: numberFormat + uid: excel!Excel.Interfaces.ChartAxisLoadOptions#numberFormat:member + package: excel! + fullName: numberFormat + summary: Specifies the format code for the axis tick label. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat?: boolean;' + return: + type: boolean + - name: offset + uid: excel!Excel.Interfaces.ChartAxisLoadOptions#offset:member + package: excel! + fullName: offset + summary: >- + Specifies the distance between the levels of labels, and the distance + between the first level and the axis line. The value should be an integer + from 0 to 1000. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'offset?: boolean;' + return: + type: boolean + - name: position + uid: excel!Excel.Interfaces.ChartAxisLoadOptions#position:member + package: excel! + fullName: position + summary: >- + Specifies the specified axis position where the other axis crosses. See + `Excel.ChartAxisPosition` for details. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'position?: boolean;' + return: + type: boolean + - name: positionAt + uid: excel!Excel.Interfaces.ChartAxisLoadOptions#positionAt:member + package: excel! + fullName: positionAt + summary: >- + Specifies the axis position where the other axis crosses. You should use + the `SetPositionAt(double)` method to set this property. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'positionAt?: boolean;' + return: + type: boolean + - name: reversePlotOrder + uid: excel!Excel.Interfaces.ChartAxisLoadOptions#reversePlotOrder:member + package: excel! + fullName: reversePlotOrder + summary: Specifies if Excel plots data points from last to first. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'reversePlotOrder?: boolean;' + return: + type: boolean + - name: scaleType + uid: excel!Excel.Interfaces.ChartAxisLoadOptions#scaleType:member + package: excel! + fullName: scaleType + summary: >- + Specifies the value axis scale type. See `Excel.ChartAxisScaleType` for + details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'scaleType?: boolean;' + return: + type: boolean + - name: showDisplayUnitLabel + uid: excel!Excel.Interfaces.ChartAxisLoadOptions#showDisplayUnitLabel:member + package: excel! + fullName: showDisplayUnitLabel + summary: Specifies if the axis display unit label is visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showDisplayUnitLabel?: boolean;' + return: + type: boolean + - name: textOrientation + uid: excel!Excel.Interfaces.ChartAxisLoadOptions#textOrientation:member + package: excel! + fullName: textOrientation + summary: >- + Specifies the angle to which the text is oriented for the chart axis tick + label. The value should either be an integer from -90 to 90 or the integer + 180 for vertically-oriented text. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textOrientation?: boolean;' + return: + type: boolean + - name: tickLabelPosition + uid: excel!Excel.Interfaces.ChartAxisLoadOptions#tickLabelPosition:member + package: excel! + fullName: tickLabelPosition + summary: >- + Specifies the position of tick-mark labels on the specified axis. See + `Excel.ChartAxisTickLabelPosition` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tickLabelPosition?: boolean;' + return: + type: boolean + - name: tickLabelSpacing + uid: excel!Excel.Interfaces.ChartAxisLoadOptions#tickLabelSpacing:member + package: excel! + fullName: tickLabelSpacing + summary: >- + Specifies the number of categories or series between tick-mark labels. Can + be a value from 1 through 31999 or an empty string for automatic setting. + The returned value is always a number. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tickLabelSpacing?: boolean;' + return: + type: boolean + - name: tickMarkSpacing + uid: excel!Excel.Interfaces.ChartAxisLoadOptions#tickMarkSpacing:member + package: excel! + fullName: tickMarkSpacing + summary: Specifies the number of categories or series between tick marks. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tickMarkSpacing?: boolean;' + return: + type: boolean + - name: title + uid: excel!Excel.Interfaces.ChartAxisLoadOptions#title:member + package: excel! + fullName: title + summary: Represents the axis title. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'title?: Excel.Interfaces.ChartAxisTitleLoadOptions;' + return: + type: >- + + - name: top + uid: excel!Excel.Interfaces.ChartAxisLoadOptions#top:member + package: excel! + fullName: top + summary: >- + Specifies the distance, in points, from the top edge of the axis to the + top of chart area. Returns `null` if the axis is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: boolean;' + return: + type: boolean + - name: type + uid: excel!Excel.Interfaces.ChartAxisLoadOptions#type:member + package: excel! + fullName: type + summary: Specifies the axis type. See `Excel.ChartAxisType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type?: boolean;' + return: + type: boolean + - name: visible + uid: excel!Excel.Interfaces.ChartAxisLoadOptions#visible:member + package: excel! + fullName: visible + summary: Specifies if the axis is visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean + - name: width + uid: excel!Excel.Interfaces.ChartAxisLoadOptions#width:member + package: excel! + fullName: width + summary: >- + Specifies the width, in points, of the chart axis. Returns `null` if the + axis is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxistitledata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxistitledata.yml new file mode 100644 index 0000000000..3a498a9c5d --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxistitledata.yml @@ -0,0 +1,80 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartAxisTitleData +uid: excel!Excel.Interfaces.ChartAxisTitleData:interface +package: excel! +fullName: Excel.Interfaces.ChartAxisTitleData +summary: >- + An interface describing the data returned by calling + `chartAxisTitle.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: format + uid: excel!Excel.Interfaces.ChartAxisTitleData#format:member + package: excel! + fullName: format + summary: Specifies the formatting of the chart axis title. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartAxisTitleFormatData;' + return: + type: >- + + - name: text + uid: excel!Excel.Interfaces.ChartAxisTitleData#text:member + package: excel! + fullName: text + summary: Specifies the axis title. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'text?: string;' + return: + type: string + - name: textOrientation + uid: excel!Excel.Interfaces.ChartAxisTitleData#textOrientation:member + package: excel! + fullName: textOrientation + summary: >- + Specifies the angle to which the text is oriented for the chart axis + title. The value should either be an integer from -90 to 90 or the integer + 180 for vertically-oriented text. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textOrientation?: number;' + return: + type: number + - name: visible + uid: excel!Excel.Interfaces.ChartAxisTitleData#visible:member + package: excel! + fullName: visible + summary: Specifies if the axis title is visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxistitleformatdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxistitleformatdata.yml new file mode 100644 index 0000000000..3ff27f5e19 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxistitleformatdata.yml @@ -0,0 +1,48 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartAxisTitleFormatData +uid: excel!Excel.Interfaces.ChartAxisTitleFormatData:interface +package: excel! +fullName: Excel.Interfaces.ChartAxisTitleFormatData +summary: >- + An interface describing the data returned by calling + `chartAxisTitleFormat.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: border + uid: excel!Excel.Interfaces.ChartAxisTitleFormatData#border:member + package: excel! + fullName: border + summary: >- + Specifies the chart axis title's border format, which includes color, + linestyle, and weight. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'border?: Excel.Interfaces.ChartBorderData;' + return: + type: + - name: font + uid: excel!Excel.Interfaces.ChartAxisTitleFormatData#font:member + package: excel! + fullName: font + summary: >- + Specifies the chart axis title's font attributes, such as font name, font + size, or color, of the chart axis title object. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.Interfaces.ChartFontData;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxistitleformatloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxistitleformatloadoptions.yml new file mode 100644 index 0000000000..dce1a3be9e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxistitleformatloadoptions.yml @@ -0,0 +1,64 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartAxisTitleFormatLoadOptions +uid: excel!Excel.Interfaces.ChartAxisTitleFormatLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartAxisTitleFormatLoadOptions +summary: Represents the chart axis title formatting. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartAxisTitleFormatLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: border + uid: excel!Excel.Interfaces.ChartAxisTitleFormatLoadOptions#border:member + package: excel! + fullName: border + summary: >- + Specifies the chart axis title's border format, which includes color, + linestyle, and weight. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'border?: Excel.Interfaces.ChartBorderLoadOptions;' + return: + type: + - name: font + uid: excel!Excel.Interfaces.ChartAxisTitleFormatLoadOptions#font:member + package: excel! + fullName: font + summary: >- + Specifies the chart axis title's font attributes, such as font name, font + size, or color, of the chart axis title object. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.Interfaces.ChartFontLoadOptions;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxistitleformatupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxistitleformatupdatedata.yml new file mode 100644 index 0000000000..2f7e952749 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxistitleformatupdatedata.yml @@ -0,0 +1,48 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartAxisTitleFormatUpdateData +uid: excel!Excel.Interfaces.ChartAxisTitleFormatUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartAxisTitleFormatUpdateData +summary: >- + An interface for updating data on the `ChartAxisTitleFormat` object, for use + in `chartAxisTitleFormat.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: border + uid: excel!Excel.Interfaces.ChartAxisTitleFormatUpdateData#border:member + package: excel! + fullName: border + summary: >- + Specifies the chart axis title's border format, which includes color, + linestyle, and weight. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'border?: Excel.Interfaces.ChartBorderUpdateData;' + return: + type: + - name: font + uid: excel!Excel.Interfaces.ChartAxisTitleFormatUpdateData#font:member + package: excel! + fullName: font + summary: >- + Specifies the chart axis title's font attributes, such as font name, font + size, or color, of the chart axis title object. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.Interfaces.ChartFontUpdateData;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxistitleloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxistitleloadoptions.yml new file mode 100644 index 0000000000..8375474b5c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxistitleloadoptions.yml @@ -0,0 +1,97 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartAxisTitleLoadOptions +uid: excel!Excel.Interfaces.ChartAxisTitleLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartAxisTitleLoadOptions +summary: Represents the title of a chart axis. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartAxisTitleLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: format + uid: excel!Excel.Interfaces.ChartAxisTitleLoadOptions#format:member + package: excel! + fullName: format + summary: Specifies the formatting of the chart axis title. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartAxisTitleFormatLoadOptions;' + return: + type: >- + + - name: text + uid: excel!Excel.Interfaces.ChartAxisTitleLoadOptions#text:member + package: excel! + fullName: text + summary: Specifies the axis title. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'text?: boolean;' + return: + type: boolean + - name: textOrientation + uid: excel!Excel.Interfaces.ChartAxisTitleLoadOptions#textOrientation:member + package: excel! + fullName: textOrientation + summary: >- + Specifies the angle to which the text is oriented for the chart axis + title. The value should either be an integer from -90 to 90 or the integer + 180 for vertically-oriented text. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textOrientation?: boolean;' + return: + type: boolean + - name: visible + uid: excel!Excel.Interfaces.ChartAxisTitleLoadOptions#visible:member + package: excel! + fullName: visible + summary: Specifies if the axis title is visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxistitleupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxistitleupdatedata.yml new file mode 100644 index 0000000000..c82ef21fa8 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxistitleupdatedata.yml @@ -0,0 +1,81 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartAxisTitleUpdateData +uid: excel!Excel.Interfaces.ChartAxisTitleUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartAxisTitleUpdateData +summary: >- + An interface for updating data on the `ChartAxisTitle` object, for use in + `chartAxisTitle.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: format + uid: excel!Excel.Interfaces.ChartAxisTitleUpdateData#format:member + package: excel! + fullName: format + summary: Specifies the formatting of the chart axis title. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartAxisTitleFormatUpdateData;' + return: + type: >- + + - name: text + uid: excel!Excel.Interfaces.ChartAxisTitleUpdateData#text:member + package: excel! + fullName: text + summary: Specifies the axis title. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'text?: string;' + return: + type: string + - name: textOrientation + uid: excel!Excel.Interfaces.ChartAxisTitleUpdateData#textOrientation:member + package: excel! + fullName: textOrientation + summary: >- + Specifies the angle to which the text is oriented for the chart axis + title. The value should either be an integer from -90 to 90 or the integer + 180 for vertically-oriented text. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textOrientation?: number;' + return: + type: number + - name: visible + uid: excel!Excel.Interfaces.ChartAxisTitleUpdateData#visible:member + package: excel! + fullName: visible + summary: Specifies if the axis title is visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxisupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxisupdatedata.yml new file mode 100644 index 0000000000..649003d4c1 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartaxisupdatedata.yml @@ -0,0 +1,574 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartAxisUpdateData +uid: excel!Excel.Interfaces.ChartAxisUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartAxisUpdateData +summary: >- + An interface for updating data on the `ChartAxis` object, for use in + `chartAxis.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: alignment + uid: excel!Excel.Interfaces.ChartAxisUpdateData#alignment:member + package: excel! + fullName: alignment + summary: >- + Specifies the alignment for the specified axis tick label. See + `Excel.ChartTextHorizontalAlignment` for detail. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'alignment?: Excel.ChartTickLabelAlignment | "Center" | "Left" | "Right";' + return: + type: >- + | "Center" | + "Left" | "Right" + - name: baseTimeUnit + uid: excel!Excel.Interfaces.ChartAxisUpdateData#baseTimeUnit:member + package: excel! + fullName: baseTimeUnit + summary: Specifies the base unit for the specified category axis. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'baseTimeUnit?: Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years";' + return: + type: >- + | "Days" | "Months" + | "Years" + - name: categoryType + uid: excel!Excel.Interfaces.ChartAxisUpdateData#categoryType:member + package: excel! + fullName: categoryType + summary: Specifies the category axis type. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + categoryType?: Excel.ChartAxisCategoryType | "Automatic" | "TextAxis" | + "DateAxis"; + return: + type: >- + | "Automatic" | + "TextAxis" | "DateAxis" + - name: displayUnit + uid: excel!Excel.Interfaces.ChartAxisUpdateData#displayUnit:member + package: excel! + fullName: displayUnit + summary: >- + Represents the axis display unit. See `Excel.ChartAxisDisplayUnit` for + details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + displayUnit?: Excel.ChartAxisDisplayUnit | "None" | "Hundreds" | + "Thousands" | "TenThousands" | "HundredThousands" | "Millions" | + "TenMillions" | "HundredMillions" | "Billions" | "Trillions" | "Custom"; + return: + type: >- + | "None" | + "Hundreds" | "Thousands" | "TenThousands" | "HundredThousands" | + "Millions" | "TenMillions" | "HundredMillions" | "Billions" | + "Trillions" | "Custom" + - name: format + uid: excel!Excel.Interfaces.ChartAxisUpdateData#format:member + package: excel! + fullName: format + summary: >- + Represents the formatting of a chart object, which includes line and font + formatting. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartAxisFormatUpdateData;' + return: + type: >- + + - name: isBetweenCategories + uid: excel!Excel.Interfaces.ChartAxisUpdateData#isBetweenCategories:member + package: excel! + fullName: isBetweenCategories + summary: Specifies if the value axis crosses the category axis between categories. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'isBetweenCategories?: boolean;' + return: + type: boolean + - name: linkNumberFormat + uid: excel!Excel.Interfaces.ChartAxisUpdateData#linkNumberFormat:member + package: excel! + fullName: linkNumberFormat + summary: >- + Specifies if the number format is linked to the cells. If `true`, + the number format will change in the labels when it changes in the cells. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'linkNumberFormat?: boolean;' + return: + type: boolean + - name: logBase + uid: excel!Excel.Interfaces.ChartAxisUpdateData#logBase:member + package: excel! + fullName: logBase + summary: Specifies the base of the logarithm when using logarithmic scales. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'logBase?: number;' + return: + type: number + - name: majorGridlines + uid: excel!Excel.Interfaces.ChartAxisUpdateData#majorGridlines:member + package: excel! + fullName: majorGridlines + summary: >- + Returns an object that represents the major gridlines for the specified + axis. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'majorGridlines?: Excel.Interfaces.ChartGridlinesUpdateData;' + return: + type: >- + + - name: majorTickMark + uid: excel!Excel.Interfaces.ChartAxisUpdateData#majorTickMark:member + package: excel! + fullName: majorTickMark + summary: >- + Specifies the type of major tick mark for the specified axis. See + `Excel.ChartAxisTickMark` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + majorTickMark?: Excel.ChartAxisTickMark | "None" | "Cross" | "Inside" | + "Outside"; + return: + type: >- + | "None" | "Cross" | + "Inside" | "Outside" + - name: majorTimeUnitScale + uid: excel!Excel.Interfaces.ChartAxisUpdateData#majorTimeUnitScale:member + package: excel! + fullName: majorTimeUnitScale + summary: >- + Specifies the major unit scale value for the category axis when the + `categoryType` property is set to `dateAxis`. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + majorTimeUnitScale?: Excel.ChartAxisTimeUnit | "Days" | "Months" | + "Years"; + return: + type: >- + | "Days" | "Months" + | "Years" + - name: majorUnit + uid: excel!Excel.Interfaces.ChartAxisUpdateData#majorUnit:member + package: excel! + fullName: majorUnit + summary: >- + Represents the interval between two major tick marks. Can be set to a + numeric value or an empty string. The returned value is always a number. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'majorUnit?: any;' + return: + type: any + - name: maximum + uid: excel!Excel.Interfaces.ChartAxisUpdateData#maximum:member + package: excel! + fullName: maximum + summary: >- + Represents the maximum value on the value axis. Can be set to a numeric + value or an empty string (for automatic axis values). The returned value + is always a number. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'maximum?: any;' + return: + type: any + - name: minimum + uid: excel!Excel.Interfaces.ChartAxisUpdateData#minimum:member + package: excel! + fullName: minimum + summary: >- + Represents the minimum value on the value axis. Can be set to a numeric + value or an empty string (for automatic axis values). The returned value + is always a number. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'minimum?: any;' + return: + type: any + - name: minorGridlines + uid: excel!Excel.Interfaces.ChartAxisUpdateData#minorGridlines:member + package: excel! + fullName: minorGridlines + summary: >- + Returns an object that represents the minor gridlines for the specified + axis. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'minorGridlines?: Excel.Interfaces.ChartGridlinesUpdateData;' + return: + type: >- + + - name: minorTickMark + uid: excel!Excel.Interfaces.ChartAxisUpdateData#minorTickMark:member + package: excel! + fullName: minorTickMark + summary: >- + Specifies the type of minor tick mark for the specified axis. See + `Excel.ChartAxisTickMark` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + minorTickMark?: Excel.ChartAxisTickMark | "None" | "Cross" | "Inside" | + "Outside"; + return: + type: >- + | "None" | "Cross" | + "Inside" | "Outside" + - name: minorTimeUnitScale + uid: excel!Excel.Interfaces.ChartAxisUpdateData#minorTimeUnitScale:member + package: excel! + fullName: minorTimeUnitScale + summary: >- + Specifies the minor unit scale value for the category axis when the + `categoryType` property is set to `dateAxis`. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + minorTimeUnitScale?: Excel.ChartAxisTimeUnit | "Days" | "Months" | + "Years"; + return: + type: >- + | "Days" | "Months" + | "Years" + - name: minorUnit + uid: excel!Excel.Interfaces.ChartAxisUpdateData#minorUnit:member + package: excel! + fullName: minorUnit + summary: >- + Represents the interval between two minor tick marks. Can be set to a + numeric value or an empty string (for automatic axis values). The returned + value is always a number. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'minorUnit?: any;' + return: + type: any + - name: multiLevel + uid: excel!Excel.Interfaces.ChartAxisUpdateData#multiLevel:member + package: excel! + fullName: multiLevel + summary: Specifies if an axis is multilevel. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'multiLevel?: boolean;' + return: + type: boolean + - name: numberFormat + uid: excel!Excel.Interfaces.ChartAxisUpdateData#numberFormat:member + package: excel! + fullName: numberFormat + summary: Specifies the format code for the axis tick label. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat?: string;' + return: + type: string + - name: offset + uid: excel!Excel.Interfaces.ChartAxisUpdateData#offset:member + package: excel! + fullName: offset + summary: >- + Specifies the distance between the levels of labels, and the distance + between the first level and the axis line. The value should be an integer + from 0 to 1000. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'offset?: number;' + return: + type: number + - name: position + uid: excel!Excel.Interfaces.ChartAxisUpdateData#position:member + package: excel! + fullName: position + summary: >- + Specifies the specified axis position where the other axis crosses. See + `Excel.ChartAxisPosition` for details. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + position?: Excel.ChartAxisPosition | "Automatic" | "Maximum" | "Minimum" + | "Custom"; + return: + type: >- + | "Automatic" | + "Maximum" | "Minimum" | "Custom" + - name: reversePlotOrder + uid: excel!Excel.Interfaces.ChartAxisUpdateData#reversePlotOrder:member + package: excel! + fullName: reversePlotOrder + summary: Specifies if Excel plots data points from last to first. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'reversePlotOrder?: boolean;' + return: + type: boolean + - name: scaleType + uid: excel!Excel.Interfaces.ChartAxisUpdateData#scaleType:member + package: excel! + fullName: scaleType + summary: >- + Specifies the value axis scale type. See `Excel.ChartAxisScaleType` for + details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'scaleType?: Excel.ChartAxisScaleType | "Linear" | "Logarithmic";' + return: + type: >- + | "Linear" | + "Logarithmic" + - name: showDisplayUnitLabel + uid: excel!Excel.Interfaces.ChartAxisUpdateData#showDisplayUnitLabel:member + package: excel! + fullName: showDisplayUnitLabel + summary: Specifies if the axis display unit label is visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showDisplayUnitLabel?: boolean;' + return: + type: boolean + - name: textOrientation + uid: excel!Excel.Interfaces.ChartAxisUpdateData#textOrientation:member + package: excel! + fullName: textOrientation + summary: >- + Specifies the angle to which the text is oriented for the chart axis tick + label. The value should either be an integer from -90 to 90 or the integer + 180 for vertically-oriented text. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textOrientation?: any;' + return: + type: any + - name: tickLabelPosition + uid: excel!Excel.Interfaces.ChartAxisUpdateData#tickLabelPosition:member + package: excel! + fullName: tickLabelPosition + summary: >- + Specifies the position of tick-mark labels on the specified axis. See + `Excel.ChartAxisTickLabelPosition` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + tickLabelPosition?: Excel.ChartAxisTickLabelPosition | "NextToAxis" | + "High" | "Low" | "None"; + return: + type: >- + | + "NextToAxis" | "High" | "Low" | "None" + - name: tickLabelSpacing + uid: excel!Excel.Interfaces.ChartAxisUpdateData#tickLabelSpacing:member + package: excel! + fullName: tickLabelSpacing + summary: >- + Specifies the number of categories or series between tick-mark labels. Can + be a value from 1 through 31999 or an empty string for automatic setting. + The returned value is always a number. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tickLabelSpacing?: any;' + return: + type: any + - name: tickMarkSpacing + uid: excel!Excel.Interfaces.ChartAxisUpdateData#tickMarkSpacing:member + package: excel! + fullName: tickMarkSpacing + summary: Specifies the number of categories or series between tick marks. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tickMarkSpacing?: number;' + return: + type: number + - name: title + uid: excel!Excel.Interfaces.ChartAxisUpdateData#title:member + package: excel! + fullName: title + summary: Represents the axis title. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'title?: Excel.Interfaces.ChartAxisTitleUpdateData;' + return: + type: >- + + - name: visible + uid: excel!Excel.Interfaces.ChartAxisUpdateData#visible:member + package: excel! + fullName: visible + summary: Specifies if the axis is visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartbinoptionsdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartbinoptionsdata.yml new file mode 100644 index 0000000000..ee923c3cfc --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartbinoptionsdata.yml @@ -0,0 +1,125 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartBinOptionsData +uid: excel!Excel.Interfaces.ChartBinOptionsData:interface +package: excel! +fullName: Excel.Interfaces.ChartBinOptionsData +summary: >- + An interface describing the data returned by calling + `chartBinOptions.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: allowOverflow + uid: excel!Excel.Interfaces.ChartBinOptionsData#allowOverflow:member + package: excel! + fullName: allowOverflow + summary: Specifies if bin overflow is enabled in a histogram chart or pareto chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'allowOverflow?: boolean;' + return: + type: boolean + - name: allowUnderflow + uid: excel!Excel.Interfaces.ChartBinOptionsData#allowUnderflow:member + package: excel! + fullName: allowUnderflow + summary: >- + Specifies if bin underflow is enabled in a histogram chart or pareto + chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'allowUnderflow?: boolean;' + return: + type: boolean + - name: count + uid: excel!Excel.Interfaces.ChartBinOptionsData#count:member + package: excel! + fullName: count + summary: Specifies the bin count of a histogram chart or pareto chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'count?: number;' + return: + type: number + - name: overflowValue + uid: excel!Excel.Interfaces.ChartBinOptionsData#overflowValue:member + package: excel! + fullName: overflowValue + summary: Specifies the bin overflow value of a histogram chart or pareto chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'overflowValue?: number;' + return: + type: number + - name: type + uid: excel!Excel.Interfaces.ChartBinOptionsData#type:member + package: excel! + fullName: type + summary: Specifies the bin's type for a histogram chart or pareto chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + type?: Excel.ChartBinType | "Category" | "Auto" | "BinWidth" | + "BinCount"; + return: + type: >- + | "Category" | "Auto" | + "BinWidth" | "BinCount" + - name: underflowValue + uid: excel!Excel.Interfaces.ChartBinOptionsData#underflowValue:member + package: excel! + fullName: underflowValue + summary: Specifies the bin underflow value of a histogram chart or pareto chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'underflowValue?: number;' + return: + type: number + - name: width + uid: excel!Excel.Interfaces.ChartBinOptionsData#width:member + package: excel! + fullName: width + summary: Specifies the bin width value of a histogram chart or pareto chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartbinoptionsloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartbinoptionsloadoptions.yml new file mode 100644 index 0000000000..0a067d1b2c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartbinoptionsloadoptions.yml @@ -0,0 +1,137 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartBinOptionsLoadOptions +uid: excel!Excel.Interfaces.ChartBinOptionsLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartBinOptionsLoadOptions +summary: Encapsulates the bin options for histogram charts and pareto charts. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartBinOptionsLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: allowOverflow + uid: excel!Excel.Interfaces.ChartBinOptionsLoadOptions#allowOverflow:member + package: excel! + fullName: allowOverflow + summary: Specifies if bin overflow is enabled in a histogram chart or pareto chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'allowOverflow?: boolean;' + return: + type: boolean + - name: allowUnderflow + uid: excel!Excel.Interfaces.ChartBinOptionsLoadOptions#allowUnderflow:member + package: excel! + fullName: allowUnderflow + summary: >- + Specifies if bin underflow is enabled in a histogram chart or pareto + chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'allowUnderflow?: boolean;' + return: + type: boolean + - name: count + uid: excel!Excel.Interfaces.ChartBinOptionsLoadOptions#count:member + package: excel! + fullName: count + summary: Specifies the bin count of a histogram chart or pareto chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'count?: boolean;' + return: + type: boolean + - name: overflowValue + uid: excel!Excel.Interfaces.ChartBinOptionsLoadOptions#overflowValue:member + package: excel! + fullName: overflowValue + summary: Specifies the bin overflow value of a histogram chart or pareto chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'overflowValue?: boolean;' + return: + type: boolean + - name: type + uid: excel!Excel.Interfaces.ChartBinOptionsLoadOptions#type:member + package: excel! + fullName: type + summary: Specifies the bin's type for a histogram chart or pareto chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type?: boolean;' + return: + type: boolean + - name: underflowValue + uid: excel!Excel.Interfaces.ChartBinOptionsLoadOptions#underflowValue:member + package: excel! + fullName: underflowValue + summary: Specifies the bin underflow value of a histogram chart or pareto chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'underflowValue?: boolean;' + return: + type: boolean + - name: width + uid: excel!Excel.Interfaces.ChartBinOptionsLoadOptions#width:member + package: excel! + fullName: width + summary: Specifies the bin width value of a histogram chart or pareto chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartbinoptionsupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartbinoptionsupdatedata.yml new file mode 100644 index 0000000000..22502a44cc --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartbinoptionsupdatedata.yml @@ -0,0 +1,125 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartBinOptionsUpdateData +uid: excel!Excel.Interfaces.ChartBinOptionsUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartBinOptionsUpdateData +summary: >- + An interface for updating data on the `ChartBinOptions` object, for use in + `chartBinOptions.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: allowOverflow + uid: excel!Excel.Interfaces.ChartBinOptionsUpdateData#allowOverflow:member + package: excel! + fullName: allowOverflow + summary: Specifies if bin overflow is enabled in a histogram chart or pareto chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'allowOverflow?: boolean;' + return: + type: boolean + - name: allowUnderflow + uid: excel!Excel.Interfaces.ChartBinOptionsUpdateData#allowUnderflow:member + package: excel! + fullName: allowUnderflow + summary: >- + Specifies if bin underflow is enabled in a histogram chart or pareto + chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'allowUnderflow?: boolean;' + return: + type: boolean + - name: count + uid: excel!Excel.Interfaces.ChartBinOptionsUpdateData#count:member + package: excel! + fullName: count + summary: Specifies the bin count of a histogram chart or pareto chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'count?: number;' + return: + type: number + - name: overflowValue + uid: excel!Excel.Interfaces.ChartBinOptionsUpdateData#overflowValue:member + package: excel! + fullName: overflowValue + summary: Specifies the bin overflow value of a histogram chart or pareto chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'overflowValue?: number;' + return: + type: number + - name: type + uid: excel!Excel.Interfaces.ChartBinOptionsUpdateData#type:member + package: excel! + fullName: type + summary: Specifies the bin's type for a histogram chart or pareto chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + type?: Excel.ChartBinType | "Category" | "Auto" | "BinWidth" | + "BinCount"; + return: + type: >- + | "Category" | "Auto" | + "BinWidth" | "BinCount" + - name: underflowValue + uid: excel!Excel.Interfaces.ChartBinOptionsUpdateData#underflowValue:member + package: excel! + fullName: underflowValue + summary: Specifies the bin underflow value of a histogram chart or pareto chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'underflowValue?: number;' + return: + type: number + - name: width + uid: excel!Excel.Interfaces.ChartBinOptionsUpdateData#width:member + package: excel! + fullName: width + summary: Specifies the bin width value of a histogram chart or pareto chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartborderdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartborderdata.yml new file mode 100644 index 0000000000..6dcade12f9 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartborderdata.yml @@ -0,0 +1,67 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartBorderData +uid: excel!Excel.Interfaces.ChartBorderData:interface +package: excel! +fullName: Excel.Interfaces.ChartBorderData +summary: >- + An interface describing the data returned by calling + `chartBorder.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: color + uid: excel!Excel.Interfaces.ChartBorderData#color:member + package: excel! + fullName: color + summary: HTML color code representing the color of borders in the chart. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: string;' + return: + type: string + - name: lineStyle + uid: excel!Excel.Interfaces.ChartBorderData#lineStyle:member + package: excel! + fullName: lineStyle + summary: >- + Represents the line style of the border. See `Excel.ChartLineStyle` for + details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + lineStyle?: Excel.ChartLineStyle | "None" | "Continuous" | "Dash" | + "DashDot" | "DashDotDot" | "Dot" | "Grey25" | "Grey50" | "Grey75" | + "Automatic" | "RoundDot"; + return: + type: >- + | "None" | "Continuous" + | "Dash" | "DashDot" | "DashDotDot" | "Dot" | "Grey25" | "Grey50" | + "Grey75" | "Automatic" | "RoundDot" + - name: weight + uid: excel!Excel.Interfaces.ChartBorderData#weight:member + package: excel! + fullName: weight + summary: Represents weight of the border, in points. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'weight?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartborderloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartborderloadoptions.yml new file mode 100644 index 0000000000..40f6e483ba --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartborderloadoptions.yml @@ -0,0 +1,77 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartBorderLoadOptions +uid: excel!Excel.Interfaces.ChartBorderLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartBorderLoadOptions +summary: Represents the border formatting of a chart element. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartBorderLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: color + uid: excel!Excel.Interfaces.ChartBorderLoadOptions#color:member + package: excel! + fullName: color + summary: HTML color code representing the color of borders in the chart. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: boolean;' + return: + type: boolean + - name: lineStyle + uid: excel!Excel.Interfaces.ChartBorderLoadOptions#lineStyle:member + package: excel! + fullName: lineStyle + summary: >- + Represents the line style of the border. See `Excel.ChartLineStyle` for + details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'lineStyle?: boolean;' + return: + type: boolean + - name: weight + uid: excel!Excel.Interfaces.ChartBorderLoadOptions#weight:member + package: excel! + fullName: weight + summary: Represents weight of the border, in points. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'weight?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartborderupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartborderupdatedata.yml new file mode 100644 index 0000000000..d8d707d846 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartborderupdatedata.yml @@ -0,0 +1,67 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartBorderUpdateData +uid: excel!Excel.Interfaces.ChartBorderUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartBorderUpdateData +summary: >- + An interface for updating data on the `ChartBorder` object, for use in + `chartBorder.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: color + uid: excel!Excel.Interfaces.ChartBorderUpdateData#color:member + package: excel! + fullName: color + summary: HTML color code representing the color of borders in the chart. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: string;' + return: + type: string + - name: lineStyle + uid: excel!Excel.Interfaces.ChartBorderUpdateData#lineStyle:member + package: excel! + fullName: lineStyle + summary: >- + Represents the line style of the border. See `Excel.ChartLineStyle` for + details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + lineStyle?: Excel.ChartLineStyle | "None" | "Continuous" | "Dash" | + "DashDot" | "DashDotDot" | "Dot" | "Grey25" | "Grey50" | "Grey75" | + "Automatic" | "RoundDot"; + return: + type: >- + | "None" | "Continuous" + | "Dash" | "DashDot" | "DashDotDot" | "Dot" | "Grey25" | "Grey50" | + "Grey75" | "Automatic" | "RoundDot" + - name: weight + uid: excel!Excel.Interfaces.ChartBorderUpdateData#weight:member + package: excel! + fullName: weight + summary: Represents weight of the border, in points. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'weight?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartboxwhiskeroptionsdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartboxwhiskeroptionsdata.yml new file mode 100644 index 0000000000..63706d1c43 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartboxwhiskeroptionsdata.yml @@ -0,0 +1,94 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartBoxwhiskerOptionsData +uid: excel!Excel.Interfaces.ChartBoxwhiskerOptionsData:interface +package: excel! +fullName: Excel.Interfaces.ChartBoxwhiskerOptionsData +summary: >- + An interface describing the data returned by calling + `chartBoxwhiskerOptions.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: quartileCalculation + uid: >- + excel!Excel.Interfaces.ChartBoxwhiskerOptionsData#quartileCalculation:member + package: excel! + fullName: quartileCalculation + summary: Specifies if the quartile calculation type of a box and whisker chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + quartileCalculation?: Excel.ChartBoxQuartileCalculation | "Inclusive" | + "Exclusive"; + return: + type: >- + | + "Inclusive" | "Exclusive" + - name: showInnerPoints + uid: excel!Excel.Interfaces.ChartBoxwhiskerOptionsData#showInnerPoints:member + package: excel! + fullName: showInnerPoints + summary: Specifies if inner points are shown in a box and whisker chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showInnerPoints?: boolean;' + return: + type: boolean + - name: showMeanLine + uid: excel!Excel.Interfaces.ChartBoxwhiskerOptionsData#showMeanLine:member + package: excel! + fullName: showMeanLine + summary: Specifies if the mean line is shown in a box and whisker chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showMeanLine?: boolean;' + return: + type: boolean + - name: showMeanMarker + uid: excel!Excel.Interfaces.ChartBoxwhiskerOptionsData#showMeanMarker:member + package: excel! + fullName: showMeanMarker + summary: Specifies if the mean marker is shown in a box and whisker chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showMeanMarker?: boolean;' + return: + type: boolean + - name: showOutlierPoints + uid: excel!Excel.Interfaces.ChartBoxwhiskerOptionsData#showOutlierPoints:member + package: excel! + fullName: showOutlierPoints + summary: Specifies if outlier points are shown in a box and whisker chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showOutlierPoints?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartboxwhiskeroptionsloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartboxwhiskeroptionsloadoptions.yml new file mode 100644 index 0000000000..b888d76b16 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartboxwhiskeroptionsloadoptions.yml @@ -0,0 +1,110 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartBoxwhiskerOptionsLoadOptions +uid: excel!Excel.Interfaces.ChartBoxwhiskerOptionsLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartBoxwhiskerOptionsLoadOptions +summary: Represents the properties of a box and whisker chart. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartBoxwhiskerOptionsLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: quartileCalculation + uid: >- + excel!Excel.Interfaces.ChartBoxwhiskerOptionsLoadOptions#quartileCalculation:member + package: excel! + fullName: quartileCalculation + summary: Specifies if the quartile calculation type of a box and whisker chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'quartileCalculation?: boolean;' + return: + type: boolean + - name: showInnerPoints + uid: >- + excel!Excel.Interfaces.ChartBoxwhiskerOptionsLoadOptions#showInnerPoints:member + package: excel! + fullName: showInnerPoints + summary: Specifies if inner points are shown in a box and whisker chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showInnerPoints?: boolean;' + return: + type: boolean + - name: showMeanLine + uid: >- + excel!Excel.Interfaces.ChartBoxwhiskerOptionsLoadOptions#showMeanLine:member + package: excel! + fullName: showMeanLine + summary: Specifies if the mean line is shown in a box and whisker chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showMeanLine?: boolean;' + return: + type: boolean + - name: showMeanMarker + uid: >- + excel!Excel.Interfaces.ChartBoxwhiskerOptionsLoadOptions#showMeanMarker:member + package: excel! + fullName: showMeanMarker + summary: Specifies if the mean marker is shown in a box and whisker chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showMeanMarker?: boolean;' + return: + type: boolean + - name: showOutlierPoints + uid: >- + excel!Excel.Interfaces.ChartBoxwhiskerOptionsLoadOptions#showOutlierPoints:member + package: excel! + fullName: showOutlierPoints + summary: Specifies if outlier points are shown in a box and whisker chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showOutlierPoints?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartboxwhiskeroptionsupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartboxwhiskeroptionsupdatedata.yml new file mode 100644 index 0000000000..63ac6135d2 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartboxwhiskeroptionsupdatedata.yml @@ -0,0 +1,98 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartBoxwhiskerOptionsUpdateData +uid: excel!Excel.Interfaces.ChartBoxwhiskerOptionsUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartBoxwhiskerOptionsUpdateData +summary: >- + An interface for updating data on the `ChartBoxwhiskerOptions` object, for use + in `chartBoxwhiskerOptions.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: quartileCalculation + uid: >- + excel!Excel.Interfaces.ChartBoxwhiskerOptionsUpdateData#quartileCalculation:member + package: excel! + fullName: quartileCalculation + summary: Specifies if the quartile calculation type of a box and whisker chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + quartileCalculation?: Excel.ChartBoxQuartileCalculation | "Inclusive" | + "Exclusive"; + return: + type: >- + | + "Inclusive" | "Exclusive" + - name: showInnerPoints + uid: >- + excel!Excel.Interfaces.ChartBoxwhiskerOptionsUpdateData#showInnerPoints:member + package: excel! + fullName: showInnerPoints + summary: Specifies if inner points are shown in a box and whisker chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showInnerPoints?: boolean;' + return: + type: boolean + - name: showMeanLine + uid: >- + excel!Excel.Interfaces.ChartBoxwhiskerOptionsUpdateData#showMeanLine:member + package: excel! + fullName: showMeanLine + summary: Specifies if the mean line is shown in a box and whisker chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showMeanLine?: boolean;' + return: + type: boolean + - name: showMeanMarker + uid: >- + excel!Excel.Interfaces.ChartBoxwhiskerOptionsUpdateData#showMeanMarker:member + package: excel! + fullName: showMeanMarker + summary: Specifies if the mean marker is shown in a box and whisker chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showMeanMarker?: boolean;' + return: + type: boolean + - name: showOutlierPoints + uid: >- + excel!Excel.Interfaces.ChartBoxwhiskerOptionsUpdateData#showOutlierPoints:member + package: excel! + fullName: showOutlierPoints + summary: Specifies if outlier points are shown in a box and whisker chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showOutlierPoints?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartcollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartcollectiondata.yml new file mode 100644 index 0000000000..d94bd85b0f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartcollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartCollectionData +uid: excel!Excel.Interfaces.ChartCollectionData:interface +package: excel! +fullName: Excel.Interfaces.ChartCollectionData +summary: >- + An interface describing the data returned by calling + `chartCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.ChartCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.ChartData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartcollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartcollectionloadoptions.yml new file mode 100644 index 0000000000..7907874a37 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartcollectionloadoptions.yml @@ -0,0 +1,444 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartCollectionLoadOptions +uid: excel!Excel.Interfaces.ChartCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartCollectionLoadOptions +summary: A collection of all the chart objects on a worksheet. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: axes + uid: excel!Excel.Interfaces.ChartCollectionLoadOptions#axes:member + package: excel! + fullName: axes + summary: 'For EACH ITEM in the collection: Represents chart axes.' + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'axes?: Excel.Interfaces.ChartAxesLoadOptions;' + return: + type: + - name: categoryLabelLevel + uid: >- + excel!Excel.Interfaces.ChartCollectionLoadOptions#categoryLabelLevel:member + package: excel! + fullName: categoryLabelLevel + summary: >- + For EACH ITEM in the collection: Specifies a chart category label level + enumeration constant, referring to the level of the source category + labels. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'categoryLabelLevel?: boolean;' + return: + type: boolean + - name: chartType + uid: excel!Excel.Interfaces.ChartCollectionLoadOptions#chartType:member + package: excel! + fullName: chartType + summary: >- + For EACH ITEM in the collection: Specifies the type of the chart. See + `Excel.ChartType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'chartType?: boolean;' + return: + type: boolean + - name: dataLabels + uid: excel!Excel.Interfaces.ChartCollectionLoadOptions#dataLabels:member + package: excel! + fullName: dataLabels + summary: 'For EACH ITEM in the collection: Represents the data labels on the chart.' + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'dataLabels?: Excel.Interfaces.ChartDataLabelsLoadOptions;' + return: + type: >- + + - name: displayBlanksAs + uid: excel!Excel.Interfaces.ChartCollectionLoadOptions#displayBlanksAs:member + package: excel! + fullName: displayBlanksAs + summary: >- + For EACH ITEM in the collection: Specifies the way that blank cells are + plotted on a chart. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'displayBlanksAs?: boolean;' + return: + type: boolean + - name: format + uid: excel!Excel.Interfaces.ChartCollectionLoadOptions#format:member + package: excel! + fullName: format + summary: >- + For EACH ITEM in the collection: Encapsulates the format properties for + the chart area. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartAreaFormatLoadOptions;' + return: + type: >- + + - name: height + uid: excel!Excel.Interfaces.ChartCollectionLoadOptions#height:member + package: excel! + fullName: height + summary: >- + For EACH ITEM in the collection: Specifies the height, in points, of the + chart object. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.ChartCollectionLoadOptions#id:member + package: excel! + fullName: id + summary: 'For EACH ITEM in the collection: The unique ID of chart.' + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: left + uid: excel!Excel.Interfaces.ChartCollectionLoadOptions#left:member + package: excel! + fullName: left + summary: >- + For EACH ITEM in the collection: The distance, in points, from the left + side of the chart to the worksheet origin. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: boolean;' + return: + type: boolean + - name: legend + uid: excel!Excel.Interfaces.ChartCollectionLoadOptions#legend:member + package: excel! + fullName: legend + summary: 'For EACH ITEM in the collection: Represents the legend for the chart.' + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'legend?: Excel.Interfaces.ChartLegendLoadOptions;' + return: + type: + - name: name + uid: excel!Excel.Interfaces.ChartCollectionLoadOptions#name:member + package: excel! + fullName: name + summary: 'For EACH ITEM in the collection: Specifies the name of a chart object.' + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: pivotOptions + uid: excel!Excel.Interfaces.ChartCollectionLoadOptions#pivotOptions:member + package: excel! + fullName: pivotOptions + summary: >- + For EACH ITEM in the collection: Encapsulates the options for a pivot + chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'pivotOptions?: Excel.Interfaces.ChartPivotOptionsLoadOptions;' + return: + type: >- + + - name: plotArea + uid: excel!Excel.Interfaces.ChartCollectionLoadOptions#plotArea:member + package: excel! + fullName: plotArea + summary: 'For EACH ITEM in the collection: Represents the plot area for the chart.' + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'plotArea?: Excel.Interfaces.ChartPlotAreaLoadOptions;' + return: + type: >- + + - name: plotBy + uid: excel!Excel.Interfaces.ChartCollectionLoadOptions#plotBy:member + package: excel! + fullName: plotBy + summary: >- + For EACH ITEM in the collection: Specifies the way columns or rows are + used as data series on the chart. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'plotBy?: boolean;' + return: + type: boolean + - name: plotVisibleOnly + uid: excel!Excel.Interfaces.ChartCollectionLoadOptions#plotVisibleOnly:member + package: excel! + fullName: plotVisibleOnly + summary: >- + For EACH ITEM in the collection: True if only visible cells are plotted. + False if both visible and hidden cells are plotted. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'plotVisibleOnly?: boolean;' + return: + type: boolean + - name: series + uid: excel!Excel.Interfaces.ChartCollectionLoadOptions#series:member + package: excel! + fullName: series + summary: >- + For EACH ITEM in the collection: Represents either a single series or + collection of series in the chart. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'series?: Excel.Interfaces.ChartSeriesCollectionLoadOptions;' + return: + type: >- + + - name: seriesNameLevel + uid: excel!Excel.Interfaces.ChartCollectionLoadOptions#seriesNameLevel:member + package: excel! + fullName: seriesNameLevel + summary: >- + For EACH ITEM in the collection: Specifies a chart series name level + enumeration constant, referring to the level of the source series names. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'seriesNameLevel?: boolean;' + return: + type: boolean + - name: showAllFieldButtons + uid: >- + excel!Excel.Interfaces.ChartCollectionLoadOptions#showAllFieldButtons:member + package: excel! + fullName: showAllFieldButtons + summary: >- + For EACH ITEM in the collection: Specifies whether to display all field + buttons on a PivotChart. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showAllFieldButtons?: boolean;' + return: + type: boolean + - name: showDataLabelsOverMaximum + uid: >- + excel!Excel.Interfaces.ChartCollectionLoadOptions#showDataLabelsOverMaximum:member + package: excel! + fullName: showDataLabelsOverMaximum + summary: >- + For EACH ITEM in the collection: Specifies whether to show the data labels + when the value is greater than the maximum value on the value axis. If the + value axis becomes smaller than the size of the data points, you can use + this property to set whether to show the data labels. This property + applies to 2-D charts only. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showDataLabelsOverMaximum?: boolean;' + return: + type: boolean + - name: style + uid: excel!Excel.Interfaces.ChartCollectionLoadOptions#style:member + package: excel! + fullName: style + summary: 'For EACH ITEM in the collection: Specifies the chart style for the chart.' + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'style?: boolean;' + return: + type: boolean + - name: title + uid: excel!Excel.Interfaces.ChartCollectionLoadOptions#title:member + package: excel! + fullName: title + summary: >- + For EACH ITEM in the collection: Represents the title of the specified + chart, including the text, visibility, position, and formatting of the + title. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'title?: Excel.Interfaces.ChartTitleLoadOptions;' + return: + type: + - name: top + uid: excel!Excel.Interfaces.ChartCollectionLoadOptions#top:member + package: excel! + fullName: top + summary: >- + For EACH ITEM in the collection: Specifies the distance, in points, from + the top edge of the object to the top of row 1 (on a worksheet) or the top + of the chart area (on a chart). + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: boolean;' + return: + type: boolean + - name: width + uid: excel!Excel.Interfaces.ChartCollectionLoadOptions#width:member + package: excel! + fullName: width + summary: >- + For EACH ITEM in the collection: Specifies the width, in points, of the + chart object. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width?: boolean;' + return: + type: boolean + - name: worksheet + uid: excel!Excel.Interfaces.ChartCollectionLoadOptions#worksheet:member + package: excel! + fullName: worksheet + summary: >- + For EACH ITEM in the collection: The worksheet containing the current + chart. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheet?: Excel.Interfaces.WorksheetLoadOptions;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartcollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartcollectionupdatedata.yml new file mode 100644 index 0000000000..1fa377fb27 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartcollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartCollectionUpdateData +uid: excel!Excel.Interfaces.ChartCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartCollectionUpdateData +summary: >- + An interface for updating data on the `ChartCollection` object, for use in + `chartCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.ChartCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.ChartData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdata.yml new file mode 100644 index 0000000000..64e05c83a2 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdata.yml @@ -0,0 +1,425 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartData +uid: excel!Excel.Interfaces.ChartData:interface +package: excel! +fullName: Excel.Interfaces.ChartData +summary: An interface describing the data returned by calling `chart.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: axes + uid: excel!Excel.Interfaces.ChartData#axes:member + package: excel! + fullName: axes + summary: Represents chart axes. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'axes?: Excel.Interfaces.ChartAxesData;' + return: + type: + - name: categoryLabelLevel + uid: excel!Excel.Interfaces.ChartData#categoryLabelLevel:member + package: excel! + fullName: categoryLabelLevel + summary: >- + Specifies a chart category label level enumeration constant, referring to + the level of the source category labels. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'categoryLabelLevel?: number;' + return: + type: number + - name: chartType + uid: excel!Excel.Interfaces.ChartData#chartType:member + package: excel! + fullName: chartType + summary: Specifies the type of the chart. See `Excel.ChartType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + chartType?: Excel.ChartType | "Invalid" | "ColumnClustered" | + "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | + "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" + | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | + "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | + "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | + "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | + "XYScatterSmoothNoMarkers" | "XYScatterLines" | + "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | + "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | + "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | + "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | + "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" + | "CylinderColClustered" | "CylinderColStacked" | + "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" + | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | + "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | + "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | + "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | + "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | + "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | + "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | + "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | + "Sunburst" | "Funnel"; + return: + type: >- + | "Invalid" | + "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | + "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | + "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | + "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" + | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | + "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | + "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | + "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | + "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | + "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | + "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | + "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | + "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | + "CylinderColStacked100" | "CylinderBarClustered" | + "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | + "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | + "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | + "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | + "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | + "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" + | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | + "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | + "Treemap" | "Waterfall" | "Sunburst" | "Funnel" + - name: dataLabels + uid: excel!Excel.Interfaces.ChartData#dataLabels:member + package: excel! + fullName: dataLabels + summary: Represents the data labels on the chart. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'dataLabels?: Excel.Interfaces.ChartDataLabelsData;' + return: + type: + - name: displayBlanksAs + uid: excel!Excel.Interfaces.ChartData#displayBlanksAs:member + package: excel! + fullName: displayBlanksAs + summary: Specifies the way that blank cells are plotted on a chart. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + displayBlanksAs?: Excel.ChartDisplayBlanksAs | "NotPlotted" | "Zero" | + "Interplotted"; + return: + type: >- + | "NotPlotted" | + "Zero" | "Interplotted" + - name: format + uid: excel!Excel.Interfaces.ChartData#format:member + package: excel! + fullName: format + summary: Encapsulates the format properties for the chart area. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartAreaFormatData;' + return: + type: + - name: height + uid: excel!Excel.Interfaces.ChartData#height:member + package: excel! + fullName: height + summary: Specifies the height, in points, of the chart object. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height?: number;' + return: + type: number + - name: id + uid: excel!Excel.Interfaces.ChartData#id:member + package: excel! + fullName: id + summary: The unique ID of chart. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: string;' + return: + type: string + - name: left + uid: excel!Excel.Interfaces.ChartData#left:member + package: excel! + fullName: left + summary: >- + The distance, in points, from the left side of the chart to the worksheet + origin. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: number;' + return: + type: number + - name: legend + uid: excel!Excel.Interfaces.ChartData#legend:member + package: excel! + fullName: legend + summary: Represents the legend for the chart. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'legend?: Excel.Interfaces.ChartLegendData;' + return: + type: + - name: name + uid: excel!Excel.Interfaces.ChartData#name:member + package: excel! + fullName: name + summary: Specifies the name of a chart object. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: pivotOptions + uid: excel!Excel.Interfaces.ChartData#pivotOptions:member + package: excel! + fullName: pivotOptions + summary: Encapsulates the options for a pivot chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'pivotOptions?: Excel.Interfaces.ChartPivotOptionsData;' + return: + type: + - name: plotArea + uid: excel!Excel.Interfaces.ChartData#plotArea:member + package: excel! + fullName: plotArea + summary: Represents the plot area for the chart. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'plotArea?: Excel.Interfaces.ChartPlotAreaData;' + return: + type: + - name: plotBy + uid: excel!Excel.Interfaces.ChartData#plotBy:member + package: excel! + fullName: plotBy + summary: Specifies the way columns or rows are used as data series on the chart. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'plotBy?: Excel.ChartPlotBy | "Rows" | "Columns";' + return: + type: | "Rows" | "Columns" + - name: plotVisibleOnly + uid: excel!Excel.Interfaces.ChartData#plotVisibleOnly:member + package: excel! + fullName: plotVisibleOnly + summary: >- + True if only visible cells are plotted. False if both visible and hidden + cells are plotted. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'plotVisibleOnly?: boolean;' + return: + type: boolean + - name: series + uid: excel!Excel.Interfaces.ChartData#series:member + package: excel! + fullName: series + summary: Represents either a single series or collection of series in the chart. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'series?: Excel.Interfaces.ChartSeriesData[];' + return: + type: [] + - name: seriesNameLevel + uid: excel!Excel.Interfaces.ChartData#seriesNameLevel:member + package: excel! + fullName: seriesNameLevel + summary: >- + Specifies a chart series name level enumeration constant, referring to the + level of the source series names. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'seriesNameLevel?: number;' + return: + type: number + - name: showAllFieldButtons + uid: excel!Excel.Interfaces.ChartData#showAllFieldButtons:member + package: excel! + fullName: showAllFieldButtons + summary: Specifies whether to display all field buttons on a PivotChart. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showAllFieldButtons?: boolean;' + return: + type: boolean + - name: showDataLabelsOverMaximum + uid: excel!Excel.Interfaces.ChartData#showDataLabelsOverMaximum:member + package: excel! + fullName: showDataLabelsOverMaximum + summary: >- + Specifies whether to show the data labels when the value is greater than + the maximum value on the value axis. If the value axis becomes smaller + than the size of the data points, you can use this property to set whether + to show the data labels. This property applies to 2-D charts only. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showDataLabelsOverMaximum?: boolean;' + return: + type: boolean + - name: style + uid: excel!Excel.Interfaces.ChartData#style:member + package: excel! + fullName: style + summary: Specifies the chart style for the chart. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'style?: number;' + return: + type: number + - name: title + uid: excel!Excel.Interfaces.ChartData#title:member + package: excel! + fullName: title + summary: >- + Represents the title of the specified chart, including the text, + visibility, position, and formatting of the title. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'title?: Excel.Interfaces.ChartTitleData;' + return: + type: + - name: top + uid: excel!Excel.Interfaces.ChartData#top:member + package: excel! + fullName: top + summary: >- + Specifies the distance, in points, from the top edge of the object to the + top of row 1 (on a worksheet) or the top of the chart area (on a chart). + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: number;' + return: + type: number + - name: width + uid: excel!Excel.Interfaces.ChartData#width:member + package: excel! + fullName: width + summary: Specifies the width, in points, of the chart object. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatalabelanchordata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatalabelanchordata.yml new file mode 100644 index 0000000000..79f5e4c026 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatalabelanchordata.yml @@ -0,0 +1,52 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartDataLabelAnchorData +uid: excel!Excel.Interfaces.ChartDataLabelAnchorData:interface +package: excel! +fullName: Excel.Interfaces.ChartDataLabelAnchorData +summary: >- + An interface describing the data returned by calling + `chartDataLabelAnchor.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: left + uid: excel!Excel.Interfaces.ChartDataLabelAnchorData#left:member + package: excel! + fullName: left + summary: >- + Specifies the distance, in points, from the anchor to the left edge of the + chart data label. Note that when getting the value, it may differ slightly + from the set value. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: number;' + return: + type: number + - name: top + uid: excel!Excel.Interfaces.ChartDataLabelAnchorData#top:member + package: excel! + fullName: top + summary: >- + Specifies the distance, in points, from the anchor to the top edge of the + chart data label. Note that when getting the value, it may differ slightly + from the set value. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatalabelanchorloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatalabelanchorloadoptions.yml new file mode 100644 index 0000000000..63e5919a24 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatalabelanchorloadoptions.yml @@ -0,0 +1,68 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartDataLabelAnchorLoadOptions +uid: excel!Excel.Interfaces.ChartDataLabelAnchorLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartDataLabelAnchorLoadOptions +summary: Represents the chart data label anchor. +remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartDataLabelAnchorLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: left + uid: excel!Excel.Interfaces.ChartDataLabelAnchorLoadOptions#left:member + package: excel! + fullName: left + summary: >- + Specifies the distance, in points, from the anchor to the left edge of the + chart data label. Note that when getting the value, it may differ slightly + from the set value. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: boolean;' + return: + type: boolean + - name: top + uid: excel!Excel.Interfaces.ChartDataLabelAnchorLoadOptions#top:member + package: excel! + fullName: top + summary: >- + Specifies the distance, in points, from the anchor to the top edge of the + chart data label. Note that when getting the value, it may differ slightly + from the set value. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatalabelanchorupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatalabelanchorupdatedata.yml new file mode 100644 index 0000000000..d38c8fef05 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatalabelanchorupdatedata.yml @@ -0,0 +1,52 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartDataLabelAnchorUpdateData +uid: excel!Excel.Interfaces.ChartDataLabelAnchorUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartDataLabelAnchorUpdateData +summary: >- + An interface for updating data on the `ChartDataLabelAnchor` object, for use + in `chartDataLabelAnchor.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: left + uid: excel!Excel.Interfaces.ChartDataLabelAnchorUpdateData#left:member + package: excel! + fullName: left + summary: >- + Specifies the distance, in points, from the anchor to the left edge of the + chart data label. Note that when getting the value, it may differ slightly + from the set value. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: number;' + return: + type: number + - name: top + uid: excel!Excel.Interfaces.ChartDataLabelAnchorUpdateData#top:member + package: excel! + fullName: top + summary: >- + Specifies the distance, in points, from the anchor to the top edge of the + chart data label. Note that when getting the value, it may differ slightly + from the set value. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatalabeldata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatalabeldata.yml new file mode 100644 index 0000000000..3a0b7ae439 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatalabeldata.yml @@ -0,0 +1,516 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartDataLabelData +uid: excel!Excel.Interfaces.ChartDataLabelData:interface +package: excel! +fullName: Excel.Interfaces.ChartDataLabelData +summary: >- + An interface describing the data returned by calling + `chartDataLabel.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: autoText + uid: excel!Excel.Interfaces.ChartDataLabelData#autoText:member + package: excel! + fullName: autoText + summary: >- + Specifies if the data label automatically generates appropriate text based + on context. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'autoText?: boolean;' + return: + type: boolean + - name: format + uid: excel!Excel.Interfaces.ChartDataLabelData#format:member + package: excel! + fullName: format + summary: Represents the format of chart data label. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartDataLabelFormatData;' + return: + type: >- + + - name: formula + uid: excel!Excel.Interfaces.ChartDataLabelData#formula:member + package: excel! + fullName: formula + summary: >- + String value that represents the formula of chart data label using + A1-style notation. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formula?: string;' + return: + type: string + - name: geometricShapeType + uid: excel!Excel.Interfaces.ChartDataLabelData#geometricShapeType:member + package: excel! + fullName: geometricShapeType + summary: >- + Specifies the geometric shape type of the data label. See + `Excel.GeometricShapeType` for more details. Value is `null` if the data + label is not a geometric shape. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + geometricShapeType?: Excel.GeometricShapeType | "LineInverse" | + "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" + | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | + "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | + "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" + | "Star32" | "RoundRectangle" | "Round1Rectangle" | + "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" + | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | + "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" + | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | + "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | + "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | + "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | + "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | + "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | + "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | + "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | + "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | + "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | + "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" + | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | + "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | + "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | + "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | + "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | + "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" + | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | + "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | + "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | + "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" + | "FlowChartDecision" | "FlowChartInputOutput" | + "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | + "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | + "FlowChartPreparation" | "FlowChartManualInput" | + "FlowChartManualOperation" | "FlowChartConnector" | + "FlowChartPunchedCard" | "FlowChartPunchedTape" | + "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | + "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | + "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | + "FlowChartMagneticTape" | "FlowChartMagneticDisk" | + "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | + "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | + "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | + "ActionButtonInformation" | "ActionButtonForwardNext" | + "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" + | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | + "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | + "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | + "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | + "ChartStar" | "ChartPlus"; + return: + type: >- + | "LineInverse" | + "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | + "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | + "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" + | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | + "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" + | "Round2SameRectangle" | "Round2DiagonalRectangle" | + "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | + "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | + "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | + "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | + "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | + "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" + | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | + "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | + "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" + | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | + "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | + "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | + "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | + "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | + "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | + "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | + "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" + | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | + "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | + "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | + "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" + | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | + "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | + "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | + "FlowChartInputOutput" | "FlowChartPredefinedProcess" | + "FlowChartInternalStorage" | "FlowChartDocument" | + "FlowChartMultidocument" | "FlowChartTerminator" | + "FlowChartPreparation" | "FlowChartManualInput" | + "FlowChartManualOperation" | "FlowChartConnector" | + "FlowChartPunchedCard" | "FlowChartPunchedTape" | + "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | + "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | + "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | + "FlowChartMagneticTape" | "FlowChartMagneticDisk" | + "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | + "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | + "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | + "ActionButtonInformation" | "ActionButtonForwardNext" | + "ActionButtonBackPrevious" | "ActionButtonEnd" | + "ActionButtonBeginning" | "ActionButtonReturn" | + "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | + "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | + "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | + "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | + "ChartPlus" + - name: height + uid: excel!Excel.Interfaces.ChartDataLabelData#height:member + package: excel! + fullName: height + summary: >- + Returns the height, in points, of the chart data label. Value is `null` if + the chart data label is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height?: number;' + return: + type: number + - name: horizontalAlignment + uid: excel!Excel.Interfaces.ChartDataLabelData#horizontalAlignment:member + package: excel! + fullName: horizontalAlignment + summary: >- + Represents the horizontal alignment for chart data label. See + `Excel.ChartTextHorizontalAlignment` for details. This property is valid + only when `TextOrientation` of data label is -90, 90, or 180. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + horizontalAlignment?: Excel.ChartTextHorizontalAlignment | "Center" | + "Left" | "Right" | "Justify" | "Distributed"; + return: + type: >- + | + "Center" | "Left" | "Right" | "Justify" | "Distributed" + - name: left + uid: excel!Excel.Interfaces.ChartDataLabelData#left:member + package: excel! + fullName: left + summary: >- + Represents the distance, in points, from the left edge of chart data label + to the left edge of chart area. Value is `null` if the chart data label is + not visible. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: number;' + return: + type: number + - name: linkNumberFormat + uid: excel!Excel.Interfaces.ChartDataLabelData#linkNumberFormat:member + package: excel! + fullName: linkNumberFormat + summary: >- + Specifies if the number format is linked to the cells (so that the number + format changes in the labels when it changes in the cells). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'linkNumberFormat?: boolean;' + return: + type: boolean + - name: numberFormat + uid: excel!Excel.Interfaces.ChartDataLabelData#numberFormat:member + package: excel! + fullName: numberFormat + summary: Specifies the format code for data label. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat?: string;' + return: + type: string + - name: position + uid: excel!Excel.Interfaces.ChartDataLabelData#position:member + package: excel! + fullName: position + summary: >- + Value that represents the position of the data label. See + `Excel.ChartDataLabelPosition` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + position?: Excel.ChartDataLabelPosition | "Invalid" | "None" | "Center" + | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" | "Right" | "Top" | + "Bottom" | "BestFit" | "Callout"; + return: + type: >- + | "Invalid" | + "None" | "Center" | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" + | "Right" | "Top" | "Bottom" | "BestFit" | "Callout" + - name: separator + uid: excel!Excel.Interfaces.ChartDataLabelData#separator:member + package: excel! + fullName: separator + summary: String representing the separator used for the data label on a chart. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'separator?: string;' + return: + type: string + - name: showAsStickyCallout + uid: excel!Excel.Interfaces.ChartDataLabelData#showAsStickyCallout:member + package: excel! + fullName: showAsStickyCallout + summary: >- + Specifies if the data label is shown as a callout with the tail anchor + attached to the data point. If `true`, the callout is one of the + following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", + "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or + "WedgeEllipseCallout". See + [GeometricShapeType](xref:excel!Excel.GeometricShapeType:enum) for more + details. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showAsStickyCallout?: boolean;' + return: + type: boolean + - name: showBubbleSize + uid: excel!Excel.Interfaces.ChartDataLabelData#showBubbleSize:member + package: excel! + fullName: showBubbleSize + summary: Specifies if the data label bubble size is visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showBubbleSize?: boolean;' + return: + type: boolean + - name: showCategoryName + uid: excel!Excel.Interfaces.ChartDataLabelData#showCategoryName:member + package: excel! + fullName: showCategoryName + summary: Specifies if the data label category name is visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showCategoryName?: boolean;' + return: + type: boolean + - name: showLegendKey + uid: excel!Excel.Interfaces.ChartDataLabelData#showLegendKey:member + package: excel! + fullName: showLegendKey + summary: Specifies if the data label legend key is visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showLegendKey?: boolean;' + return: + type: boolean + - name: showPercentage + uid: excel!Excel.Interfaces.ChartDataLabelData#showPercentage:member + package: excel! + fullName: showPercentage + summary: Specifies if the data label percentage is visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showPercentage?: boolean;' + return: + type: boolean + - name: showSeriesName + uid: excel!Excel.Interfaces.ChartDataLabelData#showSeriesName:member + package: excel! + fullName: showSeriesName + summary: Specifies if the data label series name is visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showSeriesName?: boolean;' + return: + type: boolean + - name: showValue + uid: excel!Excel.Interfaces.ChartDataLabelData#showValue:member + package: excel! + fullName: showValue + summary: Specifies if the data label value is visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showValue?: boolean;' + return: + type: boolean + - name: text + uid: excel!Excel.Interfaces.ChartDataLabelData#text:member + package: excel! + fullName: text + summary: String representing the text of the data label on a chart. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'text?: string;' + return: + type: string + - name: textOrientation + uid: excel!Excel.Interfaces.ChartDataLabelData#textOrientation:member + package: excel! + fullName: textOrientation + summary: >- + Represents the angle to which the text is oriented for the chart data + label. The value should either be an integer from -90 to 90 or the integer + 180 for vertically-oriented text. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textOrientation?: number;' + return: + type: number + - name: top + uid: excel!Excel.Interfaces.ChartDataLabelData#top:member + package: excel! + fullName: top + summary: >- + Represents the distance, in points, from the top edge of chart data label + to the top of chart area. Value is `null` if the chart data label is not + visible. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: number;' + return: + type: number + - name: verticalAlignment + uid: excel!Excel.Interfaces.ChartDataLabelData#verticalAlignment:member + package: excel! + fullName: verticalAlignment + summary: >- + Represents the vertical alignment of chart data label. See + `Excel.ChartTextVerticalAlignment` for details. This property is valid + only when `TextOrientation` of data label is 0. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + verticalAlignment?: Excel.ChartTextVerticalAlignment | "Center" | + "Bottom" | "Top" | "Justify" | "Distributed"; + return: + type: >- + | "Center" + | "Bottom" | "Top" | "Justify" | "Distributed" + - name: width + uid: excel!Excel.Interfaces.ChartDataLabelData#width:member + package: excel! + fullName: width + summary: >- + Returns the width, in points, of the chart data label. Value is `null` if + the chart data label is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatalabelformatdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatalabelformatdata.yml new file mode 100644 index 0000000000..21c686ad04 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatalabelformatdata.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartDataLabelFormatData +uid: excel!Excel.Interfaces.ChartDataLabelFormatData:interface +package: excel! +fullName: Excel.Interfaces.ChartDataLabelFormatData +summary: >- + An interface describing the data returned by calling + `chartDataLabelFormat.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: border + uid: excel!Excel.Interfaces.ChartDataLabelFormatData#border:member + package: excel! + fullName: border + summary: Represents the border format, which includes color, linestyle, and weight. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'border?: Excel.Interfaces.ChartBorderData;' + return: + type: + - name: font + uid: excel!Excel.Interfaces.ChartDataLabelFormatData#font:member + package: excel! + fullName: font + summary: >- + Represents the font attributes (such as font name, font size, and color) + for a chart data label. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.Interfaces.ChartFontData;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatalabelformatloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatalabelformatloadoptions.yml new file mode 100644 index 0000000000..1fb71be52f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatalabelformatloadoptions.yml @@ -0,0 +1,62 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartDataLabelFormatLoadOptions +uid: excel!Excel.Interfaces.ChartDataLabelFormatLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartDataLabelFormatLoadOptions +summary: Encapsulates the format properties for the chart data labels. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartDataLabelFormatLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: border + uid: excel!Excel.Interfaces.ChartDataLabelFormatLoadOptions#border:member + package: excel! + fullName: border + summary: Represents the border format, which includes color, linestyle, and weight. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'border?: Excel.Interfaces.ChartBorderLoadOptions;' + return: + type: + - name: font + uid: excel!Excel.Interfaces.ChartDataLabelFormatLoadOptions#font:member + package: excel! + fullName: font + summary: >- + Represents the font attributes (such as font name, font size, and color) + for a chart data label. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.Interfaces.ChartFontLoadOptions;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatalabelformatupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatalabelformatupdatedata.yml new file mode 100644 index 0000000000..baff422335 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatalabelformatupdatedata.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartDataLabelFormatUpdateData +uid: excel!Excel.Interfaces.ChartDataLabelFormatUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartDataLabelFormatUpdateData +summary: >- + An interface for updating data on the `ChartDataLabelFormat` object, for use + in `chartDataLabelFormat.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: border + uid: excel!Excel.Interfaces.ChartDataLabelFormatUpdateData#border:member + package: excel! + fullName: border + summary: Represents the border format, which includes color, linestyle, and weight. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'border?: Excel.Interfaces.ChartBorderUpdateData;' + return: + type: + - name: font + uid: excel!Excel.Interfaces.ChartDataLabelFormatUpdateData#font:member + package: excel! + fullName: font + summary: >- + Represents the font attributes (such as font name, font size, and color) + for a chart data label. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.Interfaces.ChartFontUpdateData;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatalabelloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatalabelloadoptions.yml new file mode 100644 index 0000000000..511f109cca --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatalabelloadoptions.yml @@ -0,0 +1,419 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartDataLabelLoadOptions +uid: excel!Excel.Interfaces.ChartDataLabelLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartDataLabelLoadOptions +summary: Represents the data label of a chart point. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartDataLabelLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: autoText + uid: excel!Excel.Interfaces.ChartDataLabelLoadOptions#autoText:member + package: excel! + fullName: autoText + summary: >- + Specifies if the data label automatically generates appropriate text based + on context. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'autoText?: boolean;' + return: + type: boolean + - name: format + uid: excel!Excel.Interfaces.ChartDataLabelLoadOptions#format:member + package: excel! + fullName: format + summary: Represents the format of chart data label. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartDataLabelFormatLoadOptions;' + return: + type: >- + + - name: formula + uid: excel!Excel.Interfaces.ChartDataLabelLoadOptions#formula:member + package: excel! + fullName: formula + summary: >- + String value that represents the formula of chart data label using + A1-style notation. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formula?: boolean;' + return: + type: boolean + - name: geometricShapeType + uid: excel!Excel.Interfaces.ChartDataLabelLoadOptions#geometricShapeType:member + package: excel! + fullName: geometricShapeType + summary: >- + Specifies the geometric shape type of the data label. See + `Excel.GeometricShapeType` for more details. Value is `null` if the data + label is not a geometric shape. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'geometricShapeType?: boolean;' + return: + type: boolean + - name: height + uid: excel!Excel.Interfaces.ChartDataLabelLoadOptions#height:member + package: excel! + fullName: height + summary: >- + Returns the height, in points, of the chart data label. Value is `null` if + the chart data label is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height?: boolean;' + return: + type: boolean + - name: horizontalAlignment + uid: >- + excel!Excel.Interfaces.ChartDataLabelLoadOptions#horizontalAlignment:member + package: excel! + fullName: horizontalAlignment + summary: >- + Represents the horizontal alignment for chart data label. See + `Excel.ChartTextHorizontalAlignment` for details. This property is valid + only when `TextOrientation` of data label is -90, 90, or 180. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'horizontalAlignment?: boolean;' + return: + type: boolean + - name: left + uid: excel!Excel.Interfaces.ChartDataLabelLoadOptions#left:member + package: excel! + fullName: left + summary: >- + Represents the distance, in points, from the left edge of chart data label + to the left edge of chart area. Value is `null` if the chart data label is + not visible. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: boolean;' + return: + type: boolean + - name: linkNumberFormat + uid: excel!Excel.Interfaces.ChartDataLabelLoadOptions#linkNumberFormat:member + package: excel! + fullName: linkNumberFormat + summary: >- + Specifies if the number format is linked to the cells (so that the number + format changes in the labels when it changes in the cells). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'linkNumberFormat?: boolean;' + return: + type: boolean + - name: numberFormat + uid: excel!Excel.Interfaces.ChartDataLabelLoadOptions#numberFormat:member + package: excel! + fullName: numberFormat + summary: Specifies the format code for data label. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat?: boolean;' + return: + type: boolean + - name: position + uid: excel!Excel.Interfaces.ChartDataLabelLoadOptions#position:member + package: excel! + fullName: position + summary: >- + Value that represents the position of the data label. See + `Excel.ChartDataLabelPosition` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'position?: boolean;' + return: + type: boolean + - name: separator + uid: excel!Excel.Interfaces.ChartDataLabelLoadOptions#separator:member + package: excel! + fullName: separator + summary: String representing the separator used for the data label on a chart. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'separator?: boolean;' + return: + type: boolean + - name: showAsStickyCallout + uid: >- + excel!Excel.Interfaces.ChartDataLabelLoadOptions#showAsStickyCallout:member + package: excel! + fullName: showAsStickyCallout + summary: >- + Specifies if the data label is shown as a callout with the tail anchor + attached to the data point. If `true`, the callout is one of the + following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", + "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or + "WedgeEllipseCallout". See + [GeometricShapeType](xref:excel!Excel.GeometricShapeType:enum) for more + details. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showAsStickyCallout?: boolean;' + return: + type: boolean + - name: showBubbleSize + uid: excel!Excel.Interfaces.ChartDataLabelLoadOptions#showBubbleSize:member + package: excel! + fullName: showBubbleSize + summary: Specifies if the data label bubble size is visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showBubbleSize?: boolean;' + return: + type: boolean + - name: showCategoryName + uid: excel!Excel.Interfaces.ChartDataLabelLoadOptions#showCategoryName:member + package: excel! + fullName: showCategoryName + summary: Specifies if the data label category name is visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showCategoryName?: boolean;' + return: + type: boolean + - name: showLegendKey + uid: excel!Excel.Interfaces.ChartDataLabelLoadOptions#showLegendKey:member + package: excel! + fullName: showLegendKey + summary: Specifies if the data label legend key is visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showLegendKey?: boolean;' + return: + type: boolean + - name: showPercentage + uid: excel!Excel.Interfaces.ChartDataLabelLoadOptions#showPercentage:member + package: excel! + fullName: showPercentage + summary: Specifies if the data label percentage is visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showPercentage?: boolean;' + return: + type: boolean + - name: showSeriesName + uid: excel!Excel.Interfaces.ChartDataLabelLoadOptions#showSeriesName:member + package: excel! + fullName: showSeriesName + summary: Specifies if the data label series name is visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showSeriesName?: boolean;' + return: + type: boolean + - name: showValue + uid: excel!Excel.Interfaces.ChartDataLabelLoadOptions#showValue:member + package: excel! + fullName: showValue + summary: Specifies if the data label value is visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showValue?: boolean;' + return: + type: boolean + - name: text + uid: excel!Excel.Interfaces.ChartDataLabelLoadOptions#text:member + package: excel! + fullName: text + summary: String representing the text of the data label on a chart. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'text?: boolean;' + return: + type: boolean + - name: textOrientation + uid: excel!Excel.Interfaces.ChartDataLabelLoadOptions#textOrientation:member + package: excel! + fullName: textOrientation + summary: >- + Represents the angle to which the text is oriented for the chart data + label. The value should either be an integer from -90 to 90 or the integer + 180 for vertically-oriented text. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textOrientation?: boolean;' + return: + type: boolean + - name: top + uid: excel!Excel.Interfaces.ChartDataLabelLoadOptions#top:member + package: excel! + fullName: top + summary: >- + Represents the distance, in points, from the top edge of chart data label + to the top of chart area. Value is `null` if the chart data label is not + visible. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: boolean;' + return: + type: boolean + - name: verticalAlignment + uid: excel!Excel.Interfaces.ChartDataLabelLoadOptions#verticalAlignment:member + package: excel! + fullName: verticalAlignment + summary: >- + Represents the vertical alignment of chart data label. See + `Excel.ChartTextVerticalAlignment` for details. This property is valid + only when `TextOrientation` of data label is 0. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'verticalAlignment?: boolean;' + return: + type: boolean + - name: width + uid: excel!Excel.Interfaces.ChartDataLabelLoadOptions#width:member + package: excel! + fullName: width + summary: >- + Returns the width, in points, of the chart data label. Value is `null` if + the chart data label is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatalabelsdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatalabelsdata.yml new file mode 100644 index 0000000000..552e859aa8 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatalabelsdata.yml @@ -0,0 +1,450 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartDataLabelsData +uid: excel!Excel.Interfaces.ChartDataLabelsData:interface +package: excel! +fullName: Excel.Interfaces.ChartDataLabelsData +summary: >- + An interface describing the data returned by calling + `chartDataLabels.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: autoText + uid: excel!Excel.Interfaces.ChartDataLabelsData#autoText:member + package: excel! + fullName: autoText + summary: >- + Specifies if data labels automatically generate appropriate text based on + context. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'autoText?: boolean;' + return: + type: boolean + - name: format + uid: excel!Excel.Interfaces.ChartDataLabelsData#format:member + package: excel! + fullName: format + summary: >- + Specifies the format of chart data labels, which includes fill and font + formatting. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartDataLabelFormatData;' + return: + type: >- + + - name: geometricShapeType + uid: excel!Excel.Interfaces.ChartDataLabelsData#geometricShapeType:member + package: excel! + fullName: geometricShapeType + summary: >- + Specifies the geometric shape type of the data labels. See + `Excel.GeometricShapeType` for more details. Value is `null` if the data + labels are not geometric shapes. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + geometricShapeType?: Excel.GeometricShapeType | "LineInverse" | + "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" + | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | + "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | + "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" + | "Star32" | "RoundRectangle" | "Round1Rectangle" | + "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" + | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | + "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" + | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | + "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | + "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | + "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | + "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | + "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | + "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | + "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | + "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | + "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | + "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" + | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | + "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | + "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | + "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | + "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | + "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" + | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | + "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | + "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | + "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" + | "FlowChartDecision" | "FlowChartInputOutput" | + "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | + "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | + "FlowChartPreparation" | "FlowChartManualInput" | + "FlowChartManualOperation" | "FlowChartConnector" | + "FlowChartPunchedCard" | "FlowChartPunchedTape" | + "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | + "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | + "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | + "FlowChartMagneticTape" | "FlowChartMagneticDisk" | + "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | + "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | + "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | + "ActionButtonInformation" | "ActionButtonForwardNext" | + "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" + | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | + "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | + "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | + "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | + "ChartStar" | "ChartPlus"; + return: + type: >- + | "LineInverse" | + "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | + "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | + "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" + | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | + "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" + | "Round2SameRectangle" | "Round2DiagonalRectangle" | + "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | + "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | + "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | + "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | + "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | + "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" + | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | + "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | + "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" + | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | + "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | + "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | + "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | + "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | + "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | + "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | + "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" + | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | + "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | + "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | + "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" + | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | + "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | + "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | + "FlowChartInputOutput" | "FlowChartPredefinedProcess" | + "FlowChartInternalStorage" | "FlowChartDocument" | + "FlowChartMultidocument" | "FlowChartTerminator" | + "FlowChartPreparation" | "FlowChartManualInput" | + "FlowChartManualOperation" | "FlowChartConnector" | + "FlowChartPunchedCard" | "FlowChartPunchedTape" | + "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | + "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | + "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | + "FlowChartMagneticTape" | "FlowChartMagneticDisk" | + "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | + "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | + "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | + "ActionButtonInformation" | "ActionButtonForwardNext" | + "ActionButtonBackPrevious" | "ActionButtonEnd" | + "ActionButtonBeginning" | "ActionButtonReturn" | + "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | + "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | + "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | + "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | + "ChartPlus" + - name: horizontalAlignment + uid: excel!Excel.Interfaces.ChartDataLabelsData#horizontalAlignment:member + package: excel! + fullName: horizontalAlignment + summary: >- + Specifies the horizontal alignment for chart data label. See + `Excel.ChartTextHorizontalAlignment` for details. This property is valid + only when the `TextOrientation` of data label is 0. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + horizontalAlignment?: Excel.ChartTextHorizontalAlignment | "Center" | + "Left" | "Right" | "Justify" | "Distributed"; + return: + type: >- + | + "Center" | "Left" | "Right" | "Justify" | "Distributed" + - name: leaderLines + uid: excel!Excel.Interfaces.ChartDataLabelsData#leaderLines:member + package: excel! + fullName: leaderLines + summary: Gets an object that represents the leader lines of the data labels. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'leaderLines?: Excel.Interfaces.ChartLeaderLinesData;' + return: + type: + - name: linkNumberFormat + uid: excel!Excel.Interfaces.ChartDataLabelsData#linkNumberFormat:member + package: excel! + fullName: linkNumberFormat + summary: >- + Specifies if the number format is linked to the cells. If `true`, + the number format will change in the labels when it changes in the cells. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'linkNumberFormat?: boolean;' + return: + type: boolean + - name: numberFormat + uid: excel!Excel.Interfaces.ChartDataLabelsData#numberFormat:member + package: excel! + fullName: numberFormat + summary: Specifies the format code for data labels. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat?: string;' + return: + type: string + - name: position + uid: excel!Excel.Interfaces.ChartDataLabelsData#position:member + package: excel! + fullName: position + summary: >- + Value that represents the position of the data label. See + `Excel.ChartDataLabelPosition` for details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + position?: Excel.ChartDataLabelPosition | "Invalid" | "None" | "Center" + | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" | "Right" | "Top" | + "Bottom" | "BestFit" | "Callout"; + return: + type: >- + | "Invalid" | + "None" | "Center" | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" + | "Right" | "Top" | "Bottom" | "BestFit" | "Callout" + - name: separator + uid: excel!Excel.Interfaces.ChartDataLabelsData#separator:member + package: excel! + fullName: separator + summary: String representing the separator used for the data labels on a chart. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'separator?: string;' + return: + type: string + - name: showAsStickyCallout + uid: excel!Excel.Interfaces.ChartDataLabelsData#showAsStickyCallout:member + package: excel! + fullName: showAsStickyCallout + summary: >- + Specifies if the data labels are shown as a callout with the tail anchor + attached to the data point. If `true`, the callout is one of the + following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", + "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or + "WedgeEllipseCallout". See + [GeometricShapeType](xref:excel!Excel.GeometricShapeType:enum) for more + details. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showAsStickyCallout?: boolean;' + return: + type: boolean + - name: showBubbleSize + uid: excel!Excel.Interfaces.ChartDataLabelsData#showBubbleSize:member + package: excel! + fullName: showBubbleSize + summary: Specifies if the data label bubble size is visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showBubbleSize?: boolean;' + return: + type: boolean + - name: showCategoryName + uid: excel!Excel.Interfaces.ChartDataLabelsData#showCategoryName:member + package: excel! + fullName: showCategoryName + summary: Specifies if the data label category name is visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showCategoryName?: boolean;' + return: + type: boolean + - name: showLeaderLines + uid: excel!Excel.Interfaces.ChartDataLabelsData#showLeaderLines:member + package: excel! + fullName: showLeaderLines + summary: >- + Specifies if leader lines are displayed for the data labels. `true` if + leader lines are shown; otherwise, `false`. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showLeaderLines?: boolean;' + return: + type: boolean + - name: showLegendKey + uid: excel!Excel.Interfaces.ChartDataLabelsData#showLegendKey:member + package: excel! + fullName: showLegendKey + summary: Specifies if the data label legend key is visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showLegendKey?: boolean;' + return: + type: boolean + - name: showPercentage + uid: excel!Excel.Interfaces.ChartDataLabelsData#showPercentage:member + package: excel! + fullName: showPercentage + summary: Specifies if the data label percentage is visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showPercentage?: boolean;' + return: + type: boolean + - name: showSeriesName + uid: excel!Excel.Interfaces.ChartDataLabelsData#showSeriesName:member + package: excel! + fullName: showSeriesName + summary: Specifies if the data label series name is visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showSeriesName?: boolean;' + return: + type: boolean + - name: showValue + uid: excel!Excel.Interfaces.ChartDataLabelsData#showValue:member + package: excel! + fullName: showValue + summary: Specifies if the data label value is visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showValue?: boolean;' + return: + type: boolean + - name: textOrientation + uid: excel!Excel.Interfaces.ChartDataLabelsData#textOrientation:member + package: excel! + fullName: textOrientation + summary: >- + Represents the angle to which the text is oriented for data labels. The + value should either be an integer from -90 to 90 or the integer 180 for + vertically-oriented text. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textOrientation?: number;' + return: + type: number + - name: verticalAlignment + uid: excel!Excel.Interfaces.ChartDataLabelsData#verticalAlignment:member + package: excel! + fullName: verticalAlignment + summary: >- + Represents the vertical alignment of chart data label. See + `Excel.ChartTextVerticalAlignment` for details. This property is valid + only when `TextOrientation` of the data label is -90, 90, or 180. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + verticalAlignment?: Excel.ChartTextVerticalAlignment | "Center" | + "Bottom" | "Top" | "Justify" | "Distributed"; + return: + type: >- + | "Center" + | "Bottom" | "Top" | "Justify" | "Distributed" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatalabelsloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatalabelsloadoptions.yml new file mode 100644 index 0000000000..4ac3e1bfdd --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatalabelsloadoptions.yml @@ -0,0 +1,356 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartDataLabelsLoadOptions +uid: excel!Excel.Interfaces.ChartDataLabelsLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartDataLabelsLoadOptions +summary: Represents a collection of all the data labels on a chart point. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartDataLabelsLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: autoText + uid: excel!Excel.Interfaces.ChartDataLabelsLoadOptions#autoText:member + package: excel! + fullName: autoText + summary: >- + Specifies if data labels automatically generate appropriate text based on + context. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'autoText?: boolean;' + return: + type: boolean + - name: format + uid: excel!Excel.Interfaces.ChartDataLabelsLoadOptions#format:member + package: excel! + fullName: format + summary: >- + Specifies the format of chart data labels, which includes fill and font + formatting. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartDataLabelFormatLoadOptions;' + return: + type: >- + + - name: geometricShapeType + uid: >- + excel!Excel.Interfaces.ChartDataLabelsLoadOptions#geometricShapeType:member + package: excel! + fullName: geometricShapeType + summary: >- + Specifies the geometric shape type of the data labels. See + `Excel.GeometricShapeType` for more details. Value is `null` if the data + labels are not geometric shapes. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'geometricShapeType?: boolean;' + return: + type: boolean + - name: horizontalAlignment + uid: >- + excel!Excel.Interfaces.ChartDataLabelsLoadOptions#horizontalAlignment:member + package: excel! + fullName: horizontalAlignment + summary: >- + Specifies the horizontal alignment for chart data label. See + `Excel.ChartTextHorizontalAlignment` for details. This property is valid + only when the `TextOrientation` of data label is 0. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'horizontalAlignment?: boolean;' + return: + type: boolean + - name: leaderLines + uid: excel!Excel.Interfaces.ChartDataLabelsLoadOptions#leaderLines:member + package: excel! + fullName: leaderLines + summary: Gets an object that represents the leader lines of the data labels. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'leaderLines?: Excel.Interfaces.ChartLeaderLinesLoadOptions;' + return: + type: >- + + - name: linkNumberFormat + uid: excel!Excel.Interfaces.ChartDataLabelsLoadOptions#linkNumberFormat:member + package: excel! + fullName: linkNumberFormat + summary: >- + Specifies if the number format is linked to the cells. If `true`, + the number format will change in the labels when it changes in the cells. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'linkNumberFormat?: boolean;' + return: + type: boolean + - name: numberFormat + uid: excel!Excel.Interfaces.ChartDataLabelsLoadOptions#numberFormat:member + package: excel! + fullName: numberFormat + summary: Specifies the format code for data labels. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat?: boolean;' + return: + type: boolean + - name: position + uid: excel!Excel.Interfaces.ChartDataLabelsLoadOptions#position:member + package: excel! + fullName: position + summary: >- + Value that represents the position of the data label. See + `Excel.ChartDataLabelPosition` for details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'position?: boolean;' + return: + type: boolean + - name: separator + uid: excel!Excel.Interfaces.ChartDataLabelsLoadOptions#separator:member + package: excel! + fullName: separator + summary: String representing the separator used for the data labels on a chart. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'separator?: boolean;' + return: + type: boolean + - name: showAsStickyCallout + uid: >- + excel!Excel.Interfaces.ChartDataLabelsLoadOptions#showAsStickyCallout:member + package: excel! + fullName: showAsStickyCallout + summary: >- + Specifies if the data labels are shown as a callout with the tail anchor + attached to the data point. If `true`, the callout is one of the + following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", + "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or + "WedgeEllipseCallout". See + [GeometricShapeType](xref:excel!Excel.GeometricShapeType:enum) for more + details. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showAsStickyCallout?: boolean;' + return: + type: boolean + - name: showBubbleSize + uid: excel!Excel.Interfaces.ChartDataLabelsLoadOptions#showBubbleSize:member + package: excel! + fullName: showBubbleSize + summary: Specifies if the data label bubble size is visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showBubbleSize?: boolean;' + return: + type: boolean + - name: showCategoryName + uid: excel!Excel.Interfaces.ChartDataLabelsLoadOptions#showCategoryName:member + package: excel! + fullName: showCategoryName + summary: Specifies if the data label category name is visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showCategoryName?: boolean;' + return: + type: boolean + - name: showLeaderLines + uid: excel!Excel.Interfaces.ChartDataLabelsLoadOptions#showLeaderLines:member + package: excel! + fullName: showLeaderLines + summary: >- + Specifies if leader lines are displayed for the data labels. `true` if + leader lines are shown; otherwise, `false`. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showLeaderLines?: boolean;' + return: + type: boolean + - name: showLegendKey + uid: excel!Excel.Interfaces.ChartDataLabelsLoadOptions#showLegendKey:member + package: excel! + fullName: showLegendKey + summary: Specifies if the data label legend key is visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showLegendKey?: boolean;' + return: + type: boolean + - name: showPercentage + uid: excel!Excel.Interfaces.ChartDataLabelsLoadOptions#showPercentage:member + package: excel! + fullName: showPercentage + summary: Specifies if the data label percentage is visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showPercentage?: boolean;' + return: + type: boolean + - name: showSeriesName + uid: excel!Excel.Interfaces.ChartDataLabelsLoadOptions#showSeriesName:member + package: excel! + fullName: showSeriesName + summary: Specifies if the data label series name is visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showSeriesName?: boolean;' + return: + type: boolean + - name: showValue + uid: excel!Excel.Interfaces.ChartDataLabelsLoadOptions#showValue:member + package: excel! + fullName: showValue + summary: Specifies if the data label value is visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showValue?: boolean;' + return: + type: boolean + - name: textOrientation + uid: excel!Excel.Interfaces.ChartDataLabelsLoadOptions#textOrientation:member + package: excel! + fullName: textOrientation + summary: >- + Represents the angle to which the text is oriented for data labels. The + value should either be an integer from -90 to 90 or the integer 180 for + vertically-oriented text. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textOrientation?: boolean;' + return: + type: boolean + - name: verticalAlignment + uid: excel!Excel.Interfaces.ChartDataLabelsLoadOptions#verticalAlignment:member + package: excel! + fullName: verticalAlignment + summary: >- + Represents the vertical alignment of chart data label. See + `Excel.ChartTextVerticalAlignment` for details. This property is valid + only when `TextOrientation` of the data label is -90, 90, or 180. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'verticalAlignment?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatalabelsupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatalabelsupdatedata.yml new file mode 100644 index 0000000000..2935e628da --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatalabelsupdatedata.yml @@ -0,0 +1,431 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartDataLabelsUpdateData +uid: excel!Excel.Interfaces.ChartDataLabelsUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartDataLabelsUpdateData +summary: >- + An interface for updating data on the `ChartDataLabels` object, for use in + `chartDataLabels.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: autoText + uid: excel!Excel.Interfaces.ChartDataLabelsUpdateData#autoText:member + package: excel! + fullName: autoText + summary: >- + Specifies if data labels automatically generate appropriate text based on + context. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'autoText?: boolean;' + return: + type: boolean + - name: format + uid: excel!Excel.Interfaces.ChartDataLabelsUpdateData#format:member + package: excel! + fullName: format + summary: >- + Specifies the format of chart data labels, which includes fill and font + formatting. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartDataLabelFormatUpdateData;' + return: + type: >- + + - name: geometricShapeType + uid: excel!Excel.Interfaces.ChartDataLabelsUpdateData#geometricShapeType:member + package: excel! + fullName: geometricShapeType + summary: >- + Specifies the geometric shape type of the data labels. See + `Excel.GeometricShapeType` for more details. Value is `null` if the data + labels are not geometric shapes. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + geometricShapeType?: Excel.GeometricShapeType | "LineInverse" | + "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" + | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | + "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | + "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" + | "Star32" | "RoundRectangle" | "Round1Rectangle" | + "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" + | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | + "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" + | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | + "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | + "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | + "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | + "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | + "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | + "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | + "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | + "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | + "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | + "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" + | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | + "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | + "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | + "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | + "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | + "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" + | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | + "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | + "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | + "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" + | "FlowChartDecision" | "FlowChartInputOutput" | + "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | + "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | + "FlowChartPreparation" | "FlowChartManualInput" | + "FlowChartManualOperation" | "FlowChartConnector" | + "FlowChartPunchedCard" | "FlowChartPunchedTape" | + "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | + "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | + "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | + "FlowChartMagneticTape" | "FlowChartMagneticDisk" | + "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | + "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | + "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | + "ActionButtonInformation" | "ActionButtonForwardNext" | + "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" + | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | + "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | + "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | + "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | + "ChartStar" | "ChartPlus"; + return: + type: >- + | "LineInverse" | + "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | + "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | + "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" + | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | + "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" + | "Round2SameRectangle" | "Round2DiagonalRectangle" | + "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | + "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | + "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | + "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | + "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | + "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" + | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | + "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | + "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" + | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | + "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | + "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | + "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | + "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | + "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | + "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | + "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" + | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | + "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | + "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | + "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" + | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | + "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | + "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | + "FlowChartInputOutput" | "FlowChartPredefinedProcess" | + "FlowChartInternalStorage" | "FlowChartDocument" | + "FlowChartMultidocument" | "FlowChartTerminator" | + "FlowChartPreparation" | "FlowChartManualInput" | + "FlowChartManualOperation" | "FlowChartConnector" | + "FlowChartPunchedCard" | "FlowChartPunchedTape" | + "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | + "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | + "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | + "FlowChartMagneticTape" | "FlowChartMagneticDisk" | + "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | + "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | + "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | + "ActionButtonInformation" | "ActionButtonForwardNext" | + "ActionButtonBackPrevious" | "ActionButtonEnd" | + "ActionButtonBeginning" | "ActionButtonReturn" | + "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | + "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | + "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | + "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | + "ChartPlus" + - name: horizontalAlignment + uid: >- + excel!Excel.Interfaces.ChartDataLabelsUpdateData#horizontalAlignment:member + package: excel! + fullName: horizontalAlignment + summary: >- + Specifies the horizontal alignment for chart data label. See + `Excel.ChartTextHorizontalAlignment` for details. This property is valid + only when the `TextOrientation` of data label is 0. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + horizontalAlignment?: Excel.ChartTextHorizontalAlignment | "Center" | + "Left" | "Right" | "Justify" | "Distributed"; + return: + type: >- + | + "Center" | "Left" | "Right" | "Justify" | "Distributed" + - name: leaderLines + uid: excel!Excel.Interfaces.ChartDataLabelsUpdateData#leaderLines:member + package: excel! + fullName: leaderLines + summary: Gets an object that represents the leader lines of the data labels. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'leaderLines?: Excel.Interfaces.ChartLeaderLinesUpdateData;' + return: + type: >- + + - name: linkNumberFormat + uid: excel!Excel.Interfaces.ChartDataLabelsUpdateData#linkNumberFormat:member + package: excel! + fullName: linkNumberFormat + summary: >- + Specifies if the number format is linked to the cells. If `true`, + the number format will change in the labels when it changes in the cells. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'linkNumberFormat?: boolean;' + return: + type: boolean + - name: numberFormat + uid: excel!Excel.Interfaces.ChartDataLabelsUpdateData#numberFormat:member + package: excel! + fullName: numberFormat + summary: Specifies the format code for data labels. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat?: string;' + return: + type: string + - name: position + uid: excel!Excel.Interfaces.ChartDataLabelsUpdateData#position:member + package: excel! + fullName: position + summary: >- + Value that represents the position of the data label. See + `Excel.ChartDataLabelPosition` for details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + position?: Excel.ChartDataLabelPosition | "Invalid" | "None" | "Center" + | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" | "Right" | "Top" | + "Bottom" | "BestFit" | "Callout"; + return: + type: >- + | "Invalid" | + "None" | "Center" | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" + | "Right" | "Top" | "Bottom" | "BestFit" | "Callout" + - name: separator + uid: excel!Excel.Interfaces.ChartDataLabelsUpdateData#separator:member + package: excel! + fullName: separator + summary: String representing the separator used for the data labels on a chart. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'separator?: string;' + return: + type: string + - name: showBubbleSize + uid: excel!Excel.Interfaces.ChartDataLabelsUpdateData#showBubbleSize:member + package: excel! + fullName: showBubbleSize + summary: Specifies if the data label bubble size is visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showBubbleSize?: boolean;' + return: + type: boolean + - name: showCategoryName + uid: excel!Excel.Interfaces.ChartDataLabelsUpdateData#showCategoryName:member + package: excel! + fullName: showCategoryName + summary: Specifies if the data label category name is visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showCategoryName?: boolean;' + return: + type: boolean + - name: showLeaderLines + uid: excel!Excel.Interfaces.ChartDataLabelsUpdateData#showLeaderLines:member + package: excel! + fullName: showLeaderLines + summary: >- + Specifies if leader lines are displayed for the data labels. `true` if + leader lines are shown; otherwise, `false`. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showLeaderLines?: boolean;' + return: + type: boolean + - name: showLegendKey + uid: excel!Excel.Interfaces.ChartDataLabelsUpdateData#showLegendKey:member + package: excel! + fullName: showLegendKey + summary: Specifies if the data label legend key is visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showLegendKey?: boolean;' + return: + type: boolean + - name: showPercentage + uid: excel!Excel.Interfaces.ChartDataLabelsUpdateData#showPercentage:member + package: excel! + fullName: showPercentage + summary: Specifies if the data label percentage is visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showPercentage?: boolean;' + return: + type: boolean + - name: showSeriesName + uid: excel!Excel.Interfaces.ChartDataLabelsUpdateData#showSeriesName:member + package: excel! + fullName: showSeriesName + summary: Specifies if the data label series name is visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showSeriesName?: boolean;' + return: + type: boolean + - name: showValue + uid: excel!Excel.Interfaces.ChartDataLabelsUpdateData#showValue:member + package: excel! + fullName: showValue + summary: Specifies if the data label value is visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showValue?: boolean;' + return: + type: boolean + - name: textOrientation + uid: excel!Excel.Interfaces.ChartDataLabelsUpdateData#textOrientation:member + package: excel! + fullName: textOrientation + summary: >- + Represents the angle to which the text is oriented for data labels. The + value should either be an integer from -90 to 90 or the integer 180 for + vertically-oriented text. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textOrientation?: number;' + return: + type: number + - name: verticalAlignment + uid: excel!Excel.Interfaces.ChartDataLabelsUpdateData#verticalAlignment:member + package: excel! + fullName: verticalAlignment + summary: >- + Represents the vertical alignment of chart data label. See + `Excel.ChartTextVerticalAlignment` for details. This property is valid + only when `TextOrientation` of the data label is -90, 90, or 180. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + verticalAlignment?: Excel.ChartTextVerticalAlignment | "Center" | + "Bottom" | "Top" | "Justify" | "Distributed"; + return: + type: >- + | "Center" + | "Bottom" | "Top" | "Justify" | "Distributed" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatalabelupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatalabelupdatedata.yml new file mode 100644 index 0000000000..4b56406a81 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatalabelupdatedata.yml @@ -0,0 +1,460 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartDataLabelUpdateData +uid: excel!Excel.Interfaces.ChartDataLabelUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartDataLabelUpdateData +summary: >- + An interface for updating data on the `ChartDataLabel` object, for use in + `chartDataLabel.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: autoText + uid: excel!Excel.Interfaces.ChartDataLabelUpdateData#autoText:member + package: excel! + fullName: autoText + summary: >- + Specifies if the data label automatically generates appropriate text based + on context. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'autoText?: boolean;' + return: + type: boolean + - name: format + uid: excel!Excel.Interfaces.ChartDataLabelUpdateData#format:member + package: excel! + fullName: format + summary: Represents the format of chart data label. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartDataLabelFormatUpdateData;' + return: + type: >- + + - name: formula + uid: excel!Excel.Interfaces.ChartDataLabelUpdateData#formula:member + package: excel! + fullName: formula + summary: >- + String value that represents the formula of chart data label using + A1-style notation. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formula?: string;' + return: + type: string + - name: geometricShapeType + uid: excel!Excel.Interfaces.ChartDataLabelUpdateData#geometricShapeType:member + package: excel! + fullName: geometricShapeType + summary: >- + Specifies the geometric shape type of the data label. See + `Excel.GeometricShapeType` for more details. Value is `null` if the data + label is not a geometric shape. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + geometricShapeType?: Excel.GeometricShapeType | "LineInverse" | + "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" + | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | + "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | + "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" + | "Star32" | "RoundRectangle" | "Round1Rectangle" | + "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" + | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | + "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" + | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | + "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | + "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | + "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | + "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | + "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | + "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | + "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | + "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | + "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | + "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" + | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | + "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | + "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | + "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | + "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | + "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" + | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | + "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | + "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | + "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" + | "FlowChartDecision" | "FlowChartInputOutput" | + "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | + "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | + "FlowChartPreparation" | "FlowChartManualInput" | + "FlowChartManualOperation" | "FlowChartConnector" | + "FlowChartPunchedCard" | "FlowChartPunchedTape" | + "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | + "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | + "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | + "FlowChartMagneticTape" | "FlowChartMagneticDisk" | + "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | + "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | + "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | + "ActionButtonInformation" | "ActionButtonForwardNext" | + "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" + | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | + "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | + "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | + "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | + "ChartStar" | "ChartPlus"; + return: + type: >- + | "LineInverse" | + "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | + "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | + "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" + | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | + "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" + | "Round2SameRectangle" | "Round2DiagonalRectangle" | + "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | + "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | + "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | + "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | + "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | + "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" + | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | + "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | + "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" + | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | + "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | + "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | + "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | + "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | + "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | + "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | + "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" + | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | + "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | + "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | + "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" + | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | + "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | + "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | + "FlowChartInputOutput" | "FlowChartPredefinedProcess" | + "FlowChartInternalStorage" | "FlowChartDocument" | + "FlowChartMultidocument" | "FlowChartTerminator" | + "FlowChartPreparation" | "FlowChartManualInput" | + "FlowChartManualOperation" | "FlowChartConnector" | + "FlowChartPunchedCard" | "FlowChartPunchedTape" | + "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | + "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | + "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | + "FlowChartMagneticTape" | "FlowChartMagneticDisk" | + "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | + "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | + "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | + "ActionButtonInformation" | "ActionButtonForwardNext" | + "ActionButtonBackPrevious" | "ActionButtonEnd" | + "ActionButtonBeginning" | "ActionButtonReturn" | + "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | + "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | + "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | + "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | + "ChartPlus" + - name: horizontalAlignment + uid: excel!Excel.Interfaces.ChartDataLabelUpdateData#horizontalAlignment:member + package: excel! + fullName: horizontalAlignment + summary: >- + Represents the horizontal alignment for chart data label. See + `Excel.ChartTextHorizontalAlignment` for details. This property is valid + only when `TextOrientation` of data label is -90, 90, or 180. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + horizontalAlignment?: Excel.ChartTextHorizontalAlignment | "Center" | + "Left" | "Right" | "Justify" | "Distributed"; + return: + type: >- + | + "Center" | "Left" | "Right" | "Justify" | "Distributed" + - name: left + uid: excel!Excel.Interfaces.ChartDataLabelUpdateData#left:member + package: excel! + fullName: left + summary: >- + Represents the distance, in points, from the left edge of chart data label + to the left edge of chart area. Value is `null` if the chart data label is + not visible. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: number;' + return: + type: number + - name: linkNumberFormat + uid: excel!Excel.Interfaces.ChartDataLabelUpdateData#linkNumberFormat:member + package: excel! + fullName: linkNumberFormat + summary: >- + Specifies if the number format is linked to the cells (so that the number + format changes in the labels when it changes in the cells). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'linkNumberFormat?: boolean;' + return: + type: boolean + - name: numberFormat + uid: excel!Excel.Interfaces.ChartDataLabelUpdateData#numberFormat:member + package: excel! + fullName: numberFormat + summary: Specifies the format code for data label. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat?: string;' + return: + type: string + - name: position + uid: excel!Excel.Interfaces.ChartDataLabelUpdateData#position:member + package: excel! + fullName: position + summary: >- + Value that represents the position of the data label. See + `Excel.ChartDataLabelPosition` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + position?: Excel.ChartDataLabelPosition | "Invalid" | "None" | "Center" + | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" | "Right" | "Top" | + "Bottom" | "BestFit" | "Callout"; + return: + type: >- + | "Invalid" | + "None" | "Center" | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" + | "Right" | "Top" | "Bottom" | "BestFit" | "Callout" + - name: separator + uid: excel!Excel.Interfaces.ChartDataLabelUpdateData#separator:member + package: excel! + fullName: separator + summary: String representing the separator used for the data label on a chart. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'separator?: string;' + return: + type: string + - name: showBubbleSize + uid: excel!Excel.Interfaces.ChartDataLabelUpdateData#showBubbleSize:member + package: excel! + fullName: showBubbleSize + summary: Specifies if the data label bubble size is visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showBubbleSize?: boolean;' + return: + type: boolean + - name: showCategoryName + uid: excel!Excel.Interfaces.ChartDataLabelUpdateData#showCategoryName:member + package: excel! + fullName: showCategoryName + summary: Specifies if the data label category name is visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showCategoryName?: boolean;' + return: + type: boolean + - name: showLegendKey + uid: excel!Excel.Interfaces.ChartDataLabelUpdateData#showLegendKey:member + package: excel! + fullName: showLegendKey + summary: Specifies if the data label legend key is visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showLegendKey?: boolean;' + return: + type: boolean + - name: showPercentage + uid: excel!Excel.Interfaces.ChartDataLabelUpdateData#showPercentage:member + package: excel! + fullName: showPercentage + summary: Specifies if the data label percentage is visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showPercentage?: boolean;' + return: + type: boolean + - name: showSeriesName + uid: excel!Excel.Interfaces.ChartDataLabelUpdateData#showSeriesName:member + package: excel! + fullName: showSeriesName + summary: Specifies if the data label series name is visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showSeriesName?: boolean;' + return: + type: boolean + - name: showValue + uid: excel!Excel.Interfaces.ChartDataLabelUpdateData#showValue:member + package: excel! + fullName: showValue + summary: Specifies if the data label value is visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showValue?: boolean;' + return: + type: boolean + - name: text + uid: excel!Excel.Interfaces.ChartDataLabelUpdateData#text:member + package: excel! + fullName: text + summary: String representing the text of the data label on a chart. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'text?: string;' + return: + type: string + - name: textOrientation + uid: excel!Excel.Interfaces.ChartDataLabelUpdateData#textOrientation:member + package: excel! + fullName: textOrientation + summary: >- + Represents the angle to which the text is oriented for the chart data + label. The value should either be an integer from -90 to 90 or the integer + 180 for vertically-oriented text. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textOrientation?: number;' + return: + type: number + - name: top + uid: excel!Excel.Interfaces.ChartDataLabelUpdateData#top:member + package: excel! + fullName: top + summary: >- + Represents the distance, in points, from the top edge of chart data label + to the top of chart area. Value is `null` if the chart data label is not + visible. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: number;' + return: + type: number + - name: verticalAlignment + uid: excel!Excel.Interfaces.ChartDataLabelUpdateData#verticalAlignment:member + package: excel! + fullName: verticalAlignment + summary: >- + Represents the vertical alignment of chart data label. See + `Excel.ChartTextVerticalAlignment` for details. This property is valid + only when `TextOrientation` of data label is 0. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + verticalAlignment?: Excel.ChartTextVerticalAlignment | "Center" | + "Bottom" | "Top" | "Justify" | "Distributed"; + return: + type: >- + | "Center" + | "Bottom" | "Top" | "Justify" | "Distributed" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatatabledata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatatabledata.yml new file mode 100644 index 0000000000..610b0e2df9 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatatabledata.yml @@ -0,0 +1,114 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartDataTableData +uid: excel!Excel.Interfaces.ChartDataTableData:interface +package: excel! +fullName: Excel.Interfaces.ChartDataTableData +summary: >- + An interface describing the data returned by calling + `chartDataTable.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: format + uid: excel!Excel.Interfaces.ChartDataTableData#format:member + package: excel! + fullName: format + summary: >- + Represents the format of a chart data table, which includes fill, font, + and border format. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartDataTableFormatData;' + return: + type: >- + + - name: showHorizontalBorder + uid: excel!Excel.Interfaces.ChartDataTableData#showHorizontalBorder:member + package: excel! + fullName: showHorizontalBorder + summary: Specifies whether to display the horizontal border of the data table. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showHorizontalBorder?: boolean;' + return: + type: boolean + - name: showLegendKey + uid: excel!Excel.Interfaces.ChartDataTableData#showLegendKey:member + package: excel! + fullName: showLegendKey + summary: Specifies whether to show the legend key of the data table. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showLegendKey?: boolean;' + return: + type: boolean + - name: showOutlineBorder + uid: excel!Excel.Interfaces.ChartDataTableData#showOutlineBorder:member + package: excel! + fullName: showOutlineBorder + summary: Specifies whether to display the outline border of the data table. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showOutlineBorder?: boolean;' + return: + type: boolean + - name: showVerticalBorder + uid: excel!Excel.Interfaces.ChartDataTableData#showVerticalBorder:member + package: excel! + fullName: showVerticalBorder + summary: Specifies whether to display the vertical border of the data table. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showVerticalBorder?: boolean;' + return: + type: boolean + - name: visible + uid: excel!Excel.Interfaces.ChartDataTableData#visible:member + package: excel! + fullName: visible + summary: Specifies whether to show the data table of the chart. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatatableformatdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatatableformatdata.yml new file mode 100644 index 0000000000..2b8f0492fb --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatatableformatdata.yml @@ -0,0 +1,50 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartDataTableFormatData +uid: excel!Excel.Interfaces.ChartDataTableFormatData:interface +package: excel! +fullName: Excel.Interfaces.ChartDataTableFormatData +summary: >- + An interface describing the data returned by calling + `chartDataTableFormat.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: border + uid: excel!Excel.Interfaces.ChartDataTableFormatData#border:member + package: excel! + fullName: border + summary: >- + Represents the border format of chart data table, which includes color, + line style, and weight. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'border?: Excel.Interfaces.ChartBorderData;' + return: + type: + - name: font + uid: excel!Excel.Interfaces.ChartDataTableFormatData#font:member + package: excel! + fullName: font + summary: >- + Represents the font attributes (such as font name, font size, and color) + for the current object. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.Interfaces.ChartFontData;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatatableformatloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatatableformatloadoptions.yml new file mode 100644 index 0000000000..cb194e69b8 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatatableformatloadoptions.yml @@ -0,0 +1,66 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartDataTableFormatLoadOptions +uid: excel!Excel.Interfaces.ChartDataTableFormatLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartDataTableFormatLoadOptions +summary: Represents the format of a chart data table. +remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartDataTableFormatLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: border + uid: excel!Excel.Interfaces.ChartDataTableFormatLoadOptions#border:member + package: excel! + fullName: border + summary: >- + Represents the border format of chart data table, which includes color, + line style, and weight. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'border?: Excel.Interfaces.ChartBorderLoadOptions;' + return: + type: + - name: font + uid: excel!Excel.Interfaces.ChartDataTableFormatLoadOptions#font:member + package: excel! + fullName: font + summary: >- + Represents the font attributes (such as font name, font size, and color) + for the current object. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.Interfaces.ChartFontLoadOptions;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatatableformatupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatatableformatupdatedata.yml new file mode 100644 index 0000000000..c883f4ed4c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatatableformatupdatedata.yml @@ -0,0 +1,50 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartDataTableFormatUpdateData +uid: excel!Excel.Interfaces.ChartDataTableFormatUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartDataTableFormatUpdateData +summary: >- + An interface for updating data on the `ChartDataTableFormat` object, for use + in `chartDataTableFormat.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: border + uid: excel!Excel.Interfaces.ChartDataTableFormatUpdateData#border:member + package: excel! + fullName: border + summary: >- + Represents the border format of chart data table, which includes color, + line style, and weight. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'border?: Excel.Interfaces.ChartBorderUpdateData;' + return: + type: + - name: font + uid: excel!Excel.Interfaces.ChartDataTableFormatUpdateData#font:member + package: excel! + fullName: font + summary: >- + Represents the font attributes (such as font name, font size, and color) + for the current object. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.Interfaces.ChartFontUpdateData;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatatableloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatatableloadoptions.yml new file mode 100644 index 0000000000..1182a97073 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatatableloadoptions.yml @@ -0,0 +1,132 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartDataTableLoadOptions +uid: excel!Excel.Interfaces.ChartDataTableLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartDataTableLoadOptions +summary: Represents the data table object of a chart. +remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartDataTableLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: format + uid: excel!Excel.Interfaces.ChartDataTableLoadOptions#format:member + package: excel! + fullName: format + summary: >- + Represents the format of a chart data table, which includes fill, font, + and border format. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartDataTableFormatLoadOptions;' + return: + type: >- + + - name: showHorizontalBorder + uid: >- + excel!Excel.Interfaces.ChartDataTableLoadOptions#showHorizontalBorder:member + package: excel! + fullName: showHorizontalBorder + summary: Specifies whether to display the horizontal border of the data table. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showHorizontalBorder?: boolean;' + return: + type: boolean + - name: showLegendKey + uid: excel!Excel.Interfaces.ChartDataTableLoadOptions#showLegendKey:member + package: excel! + fullName: showLegendKey + summary: Specifies whether to show the legend key of the data table. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showLegendKey?: boolean;' + return: + type: boolean + - name: showOutlineBorder + uid: excel!Excel.Interfaces.ChartDataTableLoadOptions#showOutlineBorder:member + package: excel! + fullName: showOutlineBorder + summary: Specifies whether to display the outline border of the data table. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showOutlineBorder?: boolean;' + return: + type: boolean + - name: showVerticalBorder + uid: excel!Excel.Interfaces.ChartDataTableLoadOptions#showVerticalBorder:member + package: excel! + fullName: showVerticalBorder + summary: Specifies whether to display the vertical border of the data table. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showVerticalBorder?: boolean;' + return: + type: boolean + - name: visible + uid: excel!Excel.Interfaces.ChartDataTableLoadOptions#visible:member + package: excel! + fullName: visible + summary: Specifies whether to show the data table of the chart. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatatableupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatatableupdatedata.yml new file mode 100644 index 0000000000..5877d679df --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartdatatableupdatedata.yml @@ -0,0 +1,116 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartDataTableUpdateData +uid: excel!Excel.Interfaces.ChartDataTableUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartDataTableUpdateData +summary: >- + An interface for updating data on the `ChartDataTable` object, for use in + `chartDataTable.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: format + uid: excel!Excel.Interfaces.ChartDataTableUpdateData#format:member + package: excel! + fullName: format + summary: >- + Represents the format of a chart data table, which includes fill, font, + and border format. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartDataTableFormatUpdateData;' + return: + type: >- + + - name: showHorizontalBorder + uid: >- + excel!Excel.Interfaces.ChartDataTableUpdateData#showHorizontalBorder:member + package: excel! + fullName: showHorizontalBorder + summary: Specifies whether to display the horizontal border of the data table. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showHorizontalBorder?: boolean;' + return: + type: boolean + - name: showLegendKey + uid: excel!Excel.Interfaces.ChartDataTableUpdateData#showLegendKey:member + package: excel! + fullName: showLegendKey + summary: Specifies whether to show the legend key of the data table. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showLegendKey?: boolean;' + return: + type: boolean + - name: showOutlineBorder + uid: excel!Excel.Interfaces.ChartDataTableUpdateData#showOutlineBorder:member + package: excel! + fullName: showOutlineBorder + summary: Specifies whether to display the outline border of the data table. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showOutlineBorder?: boolean;' + return: + type: boolean + - name: showVerticalBorder + uid: excel!Excel.Interfaces.ChartDataTableUpdateData#showVerticalBorder:member + package: excel! + fullName: showVerticalBorder + summary: Specifies whether to display the vertical border of the data table. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showVerticalBorder?: boolean;' + return: + type: boolean + - name: visible + uid: excel!Excel.Interfaces.ChartDataTableUpdateData#visible:member + package: excel! + fullName: visible + summary: Specifies whether to show the data table of the chart. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charterrorbarsdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charterrorbarsdata.yml new file mode 100644 index 0000000000..0e9fa25723 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charterrorbarsdata.yml @@ -0,0 +1,99 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartErrorBarsData +uid: excel!Excel.Interfaces.ChartErrorBarsData:interface +package: excel! +fullName: Excel.Interfaces.ChartErrorBarsData +summary: >- + An interface describing the data returned by calling + `chartErrorBars.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: endStyleCap + uid: excel!Excel.Interfaces.ChartErrorBarsData#endStyleCap:member + package: excel! + fullName: endStyleCap + summary: Specifies if error bars have an end style cap. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'endStyleCap?: boolean;' + return: + type: boolean + - name: format + uid: excel!Excel.Interfaces.ChartErrorBarsData#format:member + package: excel! + fullName: format + summary: Specifies the formatting type of the error bars. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartErrorBarsFormatData;' + return: + type: >- + + - name: include + uid: excel!Excel.Interfaces.ChartErrorBarsData#include:member + package: excel! + fullName: include + summary: Specifies which parts of the error bars to include. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + include?: Excel.ChartErrorBarsInclude | "Both" | "MinusValues" | + "PlusValues"; + return: + type: >- + | "Both" | + "MinusValues" | "PlusValues" + - name: type + uid: excel!Excel.Interfaces.ChartErrorBarsData#type:member + package: excel! + fullName: type + summary: The type of range marked by the error bars. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + type?: Excel.ChartErrorBarsType | "FixedValue" | "Percent" | "StDev" | + "StError" | "Custom"; + return: + type: >- + | "FixedValue" | + "Percent" | "StDev" | "StError" | "Custom" + - name: visible + uid: excel!Excel.Interfaces.ChartErrorBarsData#visible:member + package: excel! + fullName: visible + summary: Specifies whether the error bars are displayed. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charterrorbarsformatdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charterrorbarsformatdata.yml new file mode 100644 index 0000000000..f16372e760 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charterrorbarsformatdata.yml @@ -0,0 +1,29 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartErrorBarsFormatData +uid: excel!Excel.Interfaces.ChartErrorBarsFormatData:interface +package: excel! +fullName: Excel.Interfaces.ChartErrorBarsFormatData +summary: >- + An interface describing the data returned by calling + `chartErrorBarsFormat.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: line + uid: excel!Excel.Interfaces.ChartErrorBarsFormatData#line:member + package: excel! + fullName: line + summary: Represents the chart line formatting. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'line?: Excel.Interfaces.ChartLineFormatData;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charterrorbarsformatloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charterrorbarsformatloadoptions.yml new file mode 100644 index 0000000000..d9528da89f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charterrorbarsformatloadoptions.yml @@ -0,0 +1,47 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartErrorBarsFormatLoadOptions +uid: excel!Excel.Interfaces.ChartErrorBarsFormatLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartErrorBarsFormatLoadOptions +summary: Encapsulates the format properties for chart error bars. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartErrorBarsFormatLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: line + uid: excel!Excel.Interfaces.ChartErrorBarsFormatLoadOptions#line:member + package: excel! + fullName: line + summary: Represents the chart line formatting. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'line?: Excel.Interfaces.ChartLineFormatLoadOptions;' + return: + type: >- + diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charterrorbarsformatupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charterrorbarsformatupdatedata.yml new file mode 100644 index 0000000000..7a8a3f9d2f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charterrorbarsformatupdatedata.yml @@ -0,0 +1,31 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartErrorBarsFormatUpdateData +uid: excel!Excel.Interfaces.ChartErrorBarsFormatUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartErrorBarsFormatUpdateData +summary: >- + An interface for updating data on the `ChartErrorBarsFormat` object, for use + in `chartErrorBarsFormat.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: line + uid: excel!Excel.Interfaces.ChartErrorBarsFormatUpdateData#line:member + package: excel! + fullName: line + summary: Represents the chart line formatting. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'line?: Excel.Interfaces.ChartLineFormatUpdateData;' + return: + type: >- + diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charterrorbarsloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charterrorbarsloadoptions.yml new file mode 100644 index 0000000000..ae842959f6 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charterrorbarsloadoptions.yml @@ -0,0 +1,108 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartErrorBarsLoadOptions +uid: excel!Excel.Interfaces.ChartErrorBarsLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartErrorBarsLoadOptions +summary: This object represents the attributes for a chart's error bars. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartErrorBarsLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: endStyleCap + uid: excel!Excel.Interfaces.ChartErrorBarsLoadOptions#endStyleCap:member + package: excel! + fullName: endStyleCap + summary: Specifies if error bars have an end style cap. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'endStyleCap?: boolean;' + return: + type: boolean + - name: format + uid: excel!Excel.Interfaces.ChartErrorBarsLoadOptions#format:member + package: excel! + fullName: format + summary: Specifies the formatting type of the error bars. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartErrorBarsFormatLoadOptions;' + return: + type: >- + + - name: include + uid: excel!Excel.Interfaces.ChartErrorBarsLoadOptions#include:member + package: excel! + fullName: include + summary: Specifies which parts of the error bars to include. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'include?: boolean;' + return: + type: boolean + - name: type + uid: excel!Excel.Interfaces.ChartErrorBarsLoadOptions#type:member + package: excel! + fullName: type + summary: The type of range marked by the error bars. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type?: boolean;' + return: + type: boolean + - name: visible + uid: excel!Excel.Interfaces.ChartErrorBarsLoadOptions#visible:member + package: excel! + fullName: visible + summary: Specifies whether the error bars are displayed. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charterrorbarsupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charterrorbarsupdatedata.yml new file mode 100644 index 0000000000..c4b687f580 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charterrorbarsupdatedata.yml @@ -0,0 +1,100 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartErrorBarsUpdateData +uid: excel!Excel.Interfaces.ChartErrorBarsUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartErrorBarsUpdateData +summary: >- + An interface for updating data on the `ChartErrorBars` object, for use in + `chartErrorBars.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: endStyleCap + uid: excel!Excel.Interfaces.ChartErrorBarsUpdateData#endStyleCap:member + package: excel! + fullName: endStyleCap + summary: Specifies if error bars have an end style cap. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'endStyleCap?: boolean;' + return: + type: boolean + - name: format + uid: excel!Excel.Interfaces.ChartErrorBarsUpdateData#format:member + package: excel! + fullName: format + summary: Specifies the formatting type of the error bars. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartErrorBarsFormatUpdateData;' + return: + type: >- + + - name: include + uid: excel!Excel.Interfaces.ChartErrorBarsUpdateData#include:member + package: excel! + fullName: include + summary: Specifies which parts of the error bars to include. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + include?: Excel.ChartErrorBarsInclude | "Both" | "MinusValues" | + "PlusValues"; + return: + type: >- + | "Both" | + "MinusValues" | "PlusValues" + - name: type + uid: excel!Excel.Interfaces.ChartErrorBarsUpdateData#type:member + package: excel! + fullName: type + summary: The type of range marked by the error bars. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + type?: Excel.ChartErrorBarsType | "FixedValue" | "Percent" | "StDev" | + "StError" | "Custom"; + return: + type: >- + | "FixedValue" | + "Percent" | "StDev" | "StError" | "Custom" + - name: visible + uid: excel!Excel.Interfaces.ChartErrorBarsUpdateData#visible:member + package: excel! + fullName: visible + summary: Specifies whether the error bars are displayed. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartfontdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartfontdata.yml new file mode 100644 index 0000000000..e4cf20fc4a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartfontdata.yml @@ -0,0 +1,110 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartFontData +uid: excel!Excel.Interfaces.ChartFontData:interface +package: excel! +fullName: Excel.Interfaces.ChartFontData +summary: >- + An interface describing the data returned by calling `chartFont.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: bold + uid: excel!Excel.Interfaces.ChartFontData#bold:member + package: excel! + fullName: bold + summary: Represents the bold status of font. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'bold?: boolean;' + return: + type: boolean + - name: color + uid: excel!Excel.Interfaces.ChartFontData#color:member + package: excel! + fullName: color + summary: >- + HTML color code representation of the text color (e.g., \#FF0000 + represents Red). + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: string;' + return: + type: string + - name: italic + uid: excel!Excel.Interfaces.ChartFontData#italic:member + package: excel! + fullName: italic + summary: Represents the italic status of the font. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'italic?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.ChartFontData#name:member + package: excel! + fullName: name + summary: Font name (e.g., "Calibri") + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: size + uid: excel!Excel.Interfaces.ChartFontData#size:member + package: excel! + fullName: size + summary: Size of the font (e.g., 11) + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'size?: number;' + return: + type: number + - name: underline + uid: excel!Excel.Interfaces.ChartFontData#underline:member + package: excel! + fullName: underline + summary: >- + Type of underline applied to the font. See `Excel.ChartUnderlineStyle` for + details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'underline?: Excel.ChartUnderlineStyle | "None" | "Single";' + return: + type: >- + | "None" | + "Single" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartfontloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartfontloadoptions.yml new file mode 100644 index 0000000000..dbb0d3a986 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartfontloadoptions.yml @@ -0,0 +1,126 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartFontLoadOptions +uid: excel!Excel.Interfaces.ChartFontLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartFontLoadOptions +summary: >- + This object represents the font attributes (such as font name, font size, and + color) for a chart object. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartFontLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: bold + uid: excel!Excel.Interfaces.ChartFontLoadOptions#bold:member + package: excel! + fullName: bold + summary: Represents the bold status of font. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'bold?: boolean;' + return: + type: boolean + - name: color + uid: excel!Excel.Interfaces.ChartFontLoadOptions#color:member + package: excel! + fullName: color + summary: >- + HTML color code representation of the text color (e.g., \#FF0000 + represents Red). + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: boolean;' + return: + type: boolean + - name: italic + uid: excel!Excel.Interfaces.ChartFontLoadOptions#italic:member + package: excel! + fullName: italic + summary: Represents the italic status of the font. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'italic?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.ChartFontLoadOptions#name:member + package: excel! + fullName: name + summary: Font name (e.g., "Calibri") + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: size + uid: excel!Excel.Interfaces.ChartFontLoadOptions#size:member + package: excel! + fullName: size + summary: Size of the font (e.g., 11) + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'size?: boolean;' + return: + type: boolean + - name: underline + uid: excel!Excel.Interfaces.ChartFontLoadOptions#underline:member + package: excel! + fullName: underline + summary: >- + Type of underline applied to the font. See `Excel.ChartUnderlineStyle` for + details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'underline?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartfontupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartfontupdatedata.yml new file mode 100644 index 0000000000..143ce7769c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartfontupdatedata.yml @@ -0,0 +1,110 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartFontUpdateData +uid: excel!Excel.Interfaces.ChartFontUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartFontUpdateData +summary: >- + An interface for updating data on the `ChartFont` object, for use in + `chartFont.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: bold + uid: excel!Excel.Interfaces.ChartFontUpdateData#bold:member + package: excel! + fullName: bold + summary: Represents the bold status of font. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'bold?: boolean;' + return: + type: boolean + - name: color + uid: excel!Excel.Interfaces.ChartFontUpdateData#color:member + package: excel! + fullName: color + summary: >- + HTML color code representation of the text color (e.g., \#FF0000 + represents Red). + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: string;' + return: + type: string + - name: italic + uid: excel!Excel.Interfaces.ChartFontUpdateData#italic:member + package: excel! + fullName: italic + summary: Represents the italic status of the font. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'italic?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.ChartFontUpdateData#name:member + package: excel! + fullName: name + summary: Font name (e.g., "Calibri") + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: size + uid: excel!Excel.Interfaces.ChartFontUpdateData#size:member + package: excel! + fullName: size + summary: Size of the font (e.g., 11) + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'size?: number;' + return: + type: number + - name: underline + uid: excel!Excel.Interfaces.ChartFontUpdateData#underline:member + package: excel! + fullName: underline + summary: >- + Type of underline applied to the font. See `Excel.ChartUnderlineStyle` for + details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'underline?: Excel.ChartUnderlineStyle | "None" | "Single";' + return: + type: >- + | "None" | + "Single" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartformatstringdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartformatstringdata.yml new file mode 100644 index 0000000000..57b2e2100c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartformatstringdata.yml @@ -0,0 +1,31 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartFormatStringData +uid: excel!Excel.Interfaces.ChartFormatStringData:interface +package: excel! +fullName: Excel.Interfaces.ChartFormatStringData +summary: >- + An interface describing the data returned by calling + `chartFormatString.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: font + uid: excel!Excel.Interfaces.ChartFormatStringData#font:member + package: excel! + fullName: font + summary: >- + Represents the font attributes, such as font name, font size, and color of + a chart characters object. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.Interfaces.ChartFontData;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartformatstringloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartformatstringloadoptions.yml new file mode 100644 index 0000000000..59834ab3bd --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartformatstringloadoptions.yml @@ -0,0 +1,49 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartFormatStringLoadOptions +uid: excel!Excel.Interfaces.ChartFormatStringLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartFormatStringLoadOptions +summary: >- + Represents the substring in chart related objects that contain text, like a + `ChartTitle` object or `ChartAxisTitle` object. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartFormatStringLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: font + uid: excel!Excel.Interfaces.ChartFormatStringLoadOptions#font:member + package: excel! + fullName: font + summary: >- + Represents the font attributes, such as font name, font size, and color of + a chart characters object. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.Interfaces.ChartFontLoadOptions;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartformatstringupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartformatstringupdatedata.yml new file mode 100644 index 0000000000..9ce8fe528e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartformatstringupdatedata.yml @@ -0,0 +1,31 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartFormatStringUpdateData +uid: excel!Excel.Interfaces.ChartFormatStringUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartFormatStringUpdateData +summary: >- + An interface for updating data on the `ChartFormatString` object, for use in + `chartFormatString.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: font + uid: excel!Excel.Interfaces.ChartFormatStringUpdateData#font:member + package: excel! + fullName: font + summary: >- + Represents the font attributes, such as font name, font size, and color of + a chart characters object. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.Interfaces.ChartFontUpdateData;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartgridlinesdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartgridlinesdata.yml new file mode 100644 index 0000000000..03bfb0ca5f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartgridlinesdata.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartGridlinesData +uid: excel!Excel.Interfaces.ChartGridlinesData:interface +package: excel! +fullName: Excel.Interfaces.ChartGridlinesData +summary: >- + An interface describing the data returned by calling + `chartGridlines.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: format + uid: excel!Excel.Interfaces.ChartGridlinesData#format:member + package: excel! + fullName: format + summary: Represents the formatting of chart gridlines. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartGridlinesFormatData;' + return: + type: >- + + - name: visible + uid: excel!Excel.Interfaces.ChartGridlinesData#visible:member + package: excel! + fullName: visible + summary: Specifies if the axis gridlines are visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartgridlinesformatdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartgridlinesformatdata.yml new file mode 100644 index 0000000000..0b1f2a0ddf --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartgridlinesformatdata.yml @@ -0,0 +1,29 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartGridlinesFormatData +uid: excel!Excel.Interfaces.ChartGridlinesFormatData:interface +package: excel! +fullName: Excel.Interfaces.ChartGridlinesFormatData +summary: >- + An interface describing the data returned by calling + `chartGridlinesFormat.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: line + uid: excel!Excel.Interfaces.ChartGridlinesFormatData#line:member + package: excel! + fullName: line + summary: Represents chart line formatting. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'line?: Excel.Interfaces.ChartLineFormatData;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartgridlinesformatloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartgridlinesformatloadoptions.yml new file mode 100644 index 0000000000..03e6296da2 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartgridlinesformatloadoptions.yml @@ -0,0 +1,47 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartGridlinesFormatLoadOptions +uid: excel!Excel.Interfaces.ChartGridlinesFormatLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartGridlinesFormatLoadOptions +summary: Encapsulates the format properties for chart gridlines. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartGridlinesFormatLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: line + uid: excel!Excel.Interfaces.ChartGridlinesFormatLoadOptions#line:member + package: excel! + fullName: line + summary: Represents chart line formatting. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'line?: Excel.Interfaces.ChartLineFormatLoadOptions;' + return: + type: >- + diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartgridlinesformatupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartgridlinesformatupdatedata.yml new file mode 100644 index 0000000000..aa63107069 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartgridlinesformatupdatedata.yml @@ -0,0 +1,31 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartGridlinesFormatUpdateData +uid: excel!Excel.Interfaces.ChartGridlinesFormatUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartGridlinesFormatUpdateData +summary: >- + An interface for updating data on the `ChartGridlinesFormat` object, for use + in `chartGridlinesFormat.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: line + uid: excel!Excel.Interfaces.ChartGridlinesFormatUpdateData#line:member + package: excel! + fullName: line + summary: Represents chart line formatting. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'line?: Excel.Interfaces.ChartLineFormatUpdateData;' + return: + type: >- + diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartgridlinesloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartgridlinesloadoptions.yml new file mode 100644 index 0000000000..0ba3acf8a2 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartgridlinesloadoptions.yml @@ -0,0 +1,63 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartGridlinesLoadOptions +uid: excel!Excel.Interfaces.ChartGridlinesLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartGridlinesLoadOptions +summary: Represents major or minor gridlines on a chart axis. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartGridlinesLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: format + uid: excel!Excel.Interfaces.ChartGridlinesLoadOptions#format:member + package: excel! + fullName: format + summary: Represents the formatting of chart gridlines. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartGridlinesFormatLoadOptions;' + return: + type: >- + + - name: visible + uid: excel!Excel.Interfaces.ChartGridlinesLoadOptions#visible:member + package: excel! + fullName: visible + summary: Specifies if the axis gridlines are visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartgridlinesupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartgridlinesupdatedata.yml new file mode 100644 index 0000000000..864c62a8f7 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartgridlinesupdatedata.yml @@ -0,0 +1,47 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartGridlinesUpdateData +uid: excel!Excel.Interfaces.ChartGridlinesUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartGridlinesUpdateData +summary: >- + An interface for updating data on the `ChartGridlines` object, for use in + `chartGridlines.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: format + uid: excel!Excel.Interfaces.ChartGridlinesUpdateData#format:member + package: excel! + fullName: format + summary: Represents the formatting of chart gridlines. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartGridlinesFormatUpdateData;' + return: + type: >- + + - name: visible + uid: excel!Excel.Interfaces.ChartGridlinesUpdateData#visible:member + package: excel! + fullName: visible + summary: Specifies if the axis gridlines are visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartleaderlinesdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartleaderlinesdata.yml new file mode 100644 index 0000000000..edcfd125a3 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartleaderlinesdata.yml @@ -0,0 +1,32 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartLeaderLinesData +uid: excel!Excel.Interfaces.ChartLeaderLinesData:interface +package: excel! +fullName: Excel.Interfaces.ChartLeaderLinesData +summary: >- + An interface describing the data returned by calling + `chartLeaderLines.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: format + uid: excel!Excel.Interfaces.ChartLeaderLinesData#format:member + package: excel! + fullName: format + summary: Represents the formatting of leader lines of data labels in a series. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartLeaderLinesFormatData;' + return: + type: >- + diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartleaderlinesformatdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartleaderlinesformatdata.yml new file mode 100644 index 0000000000..fe056de18f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartleaderlinesformatdata.yml @@ -0,0 +1,30 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartLeaderLinesFormatData +uid: excel!Excel.Interfaces.ChartLeaderLinesFormatData:interface +package: excel! +fullName: Excel.Interfaces.ChartLeaderLinesFormatData +summary: >- + An interface describing the data returned by calling + `chartLeaderLinesFormat.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: line + uid: excel!Excel.Interfaces.ChartLeaderLinesFormatData#line:member + package: excel! + fullName: line + summary: Gets an object that represents the line formatting of chart leader lines. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'line?: Excel.Interfaces.ChartLineFormatData;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartleaderlinesformatloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartleaderlinesformatloadoptions.yml new file mode 100644 index 0000000000..bd11a85e38 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartleaderlinesformatloadoptions.yml @@ -0,0 +1,48 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartLeaderLinesFormatLoadOptions +uid: excel!Excel.Interfaces.ChartLeaderLinesFormatLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartLeaderLinesFormatLoadOptions +summary: Encapsulates the format properties for leader lines. +remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartLeaderLinesFormatLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: line + uid: excel!Excel.Interfaces.ChartLeaderLinesFormatLoadOptions#line:member + package: excel! + fullName: line + summary: Gets an object that represents the line formatting of chart leader lines. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'line?: Excel.Interfaces.ChartLineFormatLoadOptions;' + return: + type: >- + diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartleaderlinesformatupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartleaderlinesformatupdatedata.yml new file mode 100644 index 0000000000..6e83a01298 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartleaderlinesformatupdatedata.yml @@ -0,0 +1,32 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartLeaderLinesFormatUpdateData +uid: excel!Excel.Interfaces.ChartLeaderLinesFormatUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartLeaderLinesFormatUpdateData +summary: >- + An interface for updating data on the `ChartLeaderLinesFormat` object, for use + in `chartLeaderLinesFormat.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: line + uid: excel!Excel.Interfaces.ChartLeaderLinesFormatUpdateData#line:member + package: excel! + fullName: line + summary: Gets an object that represents the line formatting of chart leader lines. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'line?: Excel.Interfaces.ChartLineFormatUpdateData;' + return: + type: >- + diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartleaderlinesloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartleaderlinesloadoptions.yml new file mode 100644 index 0000000000..03e6007da6 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartleaderlinesloadoptions.yml @@ -0,0 +1,49 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartLeaderLinesLoadOptions +uid: excel!Excel.Interfaces.ChartLeaderLinesLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartLeaderLinesLoadOptions +summary: Gets an object that represents the formatting of chart leader lines. +remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartLeaderLinesLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: format + uid: excel!Excel.Interfaces.ChartLeaderLinesLoadOptions#format:member + package: excel! + fullName: format + summary: Represents the formatting of leader lines of data labels in a series. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartLeaderLinesFormatLoadOptions;' + return: + type: >- + diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartleaderlinesupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartleaderlinesupdatedata.yml new file mode 100644 index 0000000000..e809a9edca --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartleaderlinesupdatedata.yml @@ -0,0 +1,33 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartLeaderLinesUpdateData +uid: excel!Excel.Interfaces.ChartLeaderLinesUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartLeaderLinesUpdateData +summary: >- + An interface for updating data on the `ChartLeaderLines` object, for use in + `chartLeaderLines.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: format + uid: excel!Excel.Interfaces.ChartLeaderLinesUpdateData#format:member + package: excel! + fullName: format + summary: Represents the formatting of leader lines of data labels in a series. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartLeaderLinesFormatUpdateData;' + return: + type: >- + diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlegenddata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlegenddata.yml new file mode 100644 index 0000000000..5dddb61a10 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlegenddata.yml @@ -0,0 +1,180 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartLegendData +uid: excel!Excel.Interfaces.ChartLegendData:interface +package: excel! +fullName: Excel.Interfaces.ChartLegendData +summary: >- + An interface describing the data returned by calling + `chartLegend.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: format + uid: excel!Excel.Interfaces.ChartLegendData#format:member + package: excel! + fullName: format + summary: >- + Represents the formatting of a chart legend, which includes fill and font + formatting. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartLegendFormatData;' + return: + type: + - name: height + uid: excel!Excel.Interfaces.ChartLegendData#height:member + package: excel! + fullName: height + summary: >- + Specifies the height, in points, of the legend on the chart. Value is + `null` if the legend is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height?: number;' + return: + type: number + - name: left + uid: excel!Excel.Interfaces.ChartLegendData#left:member + package: excel! + fullName: left + summary: >- + Specifies the left value, in points, of the legend on the chart. Value is + `null` if the legend is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: number;' + return: + type: number + - name: legendEntries + uid: excel!Excel.Interfaces.ChartLegendData#legendEntries:member + package: excel! + fullName: legendEntries + summary: Represents a collection of legendEntries in the legend. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'legendEntries?: Excel.Interfaces.ChartLegendEntryData[];' + return: + type: [] + - name: overlay + uid: excel!Excel.Interfaces.ChartLegendData#overlay:member + package: excel! + fullName: overlay + summary: >- + Specifies if the chart legend should overlap with the main body of the + chart. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'overlay?: boolean;' + return: + type: boolean + - name: position + uid: excel!Excel.Interfaces.ChartLegendData#position:member + package: excel! + fullName: position + summary: >- + Specifies the position of the legend on the chart. See + `Excel.ChartLegendPosition` for details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + position?: Excel.ChartLegendPosition | "Invalid" | "Top" | "Bottom" | + "Left" | "Right" | "Corner" | "Custom"; + return: + type: >- + | "Invalid" | + "Top" | "Bottom" | "Left" | "Right" | "Corner" | "Custom" + - name: showShadow + uid: excel!Excel.Interfaces.ChartLegendData#showShadow:member + package: excel! + fullName: showShadow + summary: Specifies if the legend has a shadow on the chart. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showShadow?: boolean;' + return: + type: boolean + - name: top + uid: excel!Excel.Interfaces.ChartLegendData#top:member + package: excel! + fullName: top + summary: Specifies the top of a chart legend. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: number;' + return: + type: number + - name: visible + uid: excel!Excel.Interfaces.ChartLegendData#visible:member + package: excel! + fullName: visible + summary: Specifies if the chart legend is visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean + - name: width + uid: excel!Excel.Interfaces.ChartLegendData#width:member + package: excel! + fullName: width + summary: >- + Specifies the width, in points, of the legend on the chart. Value is + `null` if the legend is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlegendentrycollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlegendentrycollectiondata.yml new file mode 100644 index 0000000000..512478d55d --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlegendentrycollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartLegendEntryCollectionData +uid: excel!Excel.Interfaces.ChartLegendEntryCollectionData:interface +package: excel! +fullName: Excel.Interfaces.ChartLegendEntryCollectionData +summary: >- + An interface describing the data returned by calling + `chartLegendEntryCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.ChartLegendEntryCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.ChartLegendEntryData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlegendentrycollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlegendentrycollectionloadoptions.yml new file mode 100644 index 0000000000..77e8d57191 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlegendentrycollectionloadoptions.yml @@ -0,0 +1,133 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartLegendEntryCollectionLoadOptions +uid: excel!Excel.Interfaces.ChartLegendEntryCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartLegendEntryCollectionLoadOptions +summary: Represents a collection of legend entries. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartLegendEntryCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: height + uid: excel!Excel.Interfaces.ChartLegendEntryCollectionLoadOptions#height:member + package: excel! + fullName: height + summary: >- + For EACH ITEM in the collection: Specifies the height of the legend entry + on the chart legend. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height?: boolean;' + return: + type: boolean + - name: index + uid: excel!Excel.Interfaces.ChartLegendEntryCollectionLoadOptions#index:member + package: excel! + fullName: index + summary: >- + For EACH ITEM in the collection: Specifies the index of the legend entry + in the chart legend. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'index?: boolean;' + return: + type: boolean + - name: left + uid: excel!Excel.Interfaces.ChartLegendEntryCollectionLoadOptions#left:member + package: excel! + fullName: left + summary: >- + For EACH ITEM in the collection: Specifies the left value of a chart + legend entry. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: boolean;' + return: + type: boolean + - name: top + uid: excel!Excel.Interfaces.ChartLegendEntryCollectionLoadOptions#top:member + package: excel! + fullName: top + summary: >- + For EACH ITEM in the collection: Specifies the top of a chart legend + entry. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: boolean;' + return: + type: boolean + - name: visible + uid: >- + excel!Excel.Interfaces.ChartLegendEntryCollectionLoadOptions#visible:member + package: excel! + fullName: visible + summary: >- + For EACH ITEM in the collection: Represents the visibility of a chart + legend entry. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean + - name: width + uid: excel!Excel.Interfaces.ChartLegendEntryCollectionLoadOptions#width:member + package: excel! + fullName: width + summary: >- + For EACH ITEM in the collection: Represents the width of the legend entry + on the chart Legend. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlegendentrycollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlegendentrycollectionupdatedata.yml new file mode 100644 index 0000000000..3c115878b2 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlegendentrycollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartLegendEntryCollectionUpdateData +uid: excel!Excel.Interfaces.ChartLegendEntryCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartLegendEntryCollectionUpdateData +summary: >- + An interface for updating data on the `ChartLegendEntryCollection` object, for + use in `chartLegendEntryCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.ChartLegendEntryCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.ChartLegendEntryData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlegendentrydata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlegendentrydata.yml new file mode 100644 index 0000000000..6f9b4d1454 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlegendentrydata.yml @@ -0,0 +1,104 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartLegendEntryData +uid: excel!Excel.Interfaces.ChartLegendEntryData:interface +package: excel! +fullName: Excel.Interfaces.ChartLegendEntryData +summary: >- + An interface describing the data returned by calling + `chartLegendEntry.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: height + uid: excel!Excel.Interfaces.ChartLegendEntryData#height:member + package: excel! + fullName: height + summary: Specifies the height of the legend entry on the chart legend. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height?: number;' + return: + type: number + - name: index + uid: excel!Excel.Interfaces.ChartLegendEntryData#index:member + package: excel! + fullName: index + summary: Specifies the index of the legend entry in the chart legend. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'index?: number;' + return: + type: number + - name: left + uid: excel!Excel.Interfaces.ChartLegendEntryData#left:member + package: excel! + fullName: left + summary: Specifies the left value of a chart legend entry. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: number;' + return: + type: number + - name: top + uid: excel!Excel.Interfaces.ChartLegendEntryData#top:member + package: excel! + fullName: top + summary: Specifies the top of a chart legend entry. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: number;' + return: + type: number + - name: visible + uid: excel!Excel.Interfaces.ChartLegendEntryData#visible:member + package: excel! + fullName: visible + summary: Represents the visibility of a chart legend entry. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean + - name: width + uid: excel!Excel.Interfaces.ChartLegendEntryData#width:member + package: excel! + fullName: width + summary: Represents the width of the legend entry on the chart Legend. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlegendentryloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlegendentryloadoptions.yml new file mode 100644 index 0000000000..f8ada3a70a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlegendentryloadoptions.yml @@ -0,0 +1,120 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartLegendEntryLoadOptions +uid: excel!Excel.Interfaces.ChartLegendEntryLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartLegendEntryLoadOptions +summary: Represents the legend entry in `legendEntryCollection`. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartLegendEntryLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: height + uid: excel!Excel.Interfaces.ChartLegendEntryLoadOptions#height:member + package: excel! + fullName: height + summary: Specifies the height of the legend entry on the chart legend. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height?: boolean;' + return: + type: boolean + - name: index + uid: excel!Excel.Interfaces.ChartLegendEntryLoadOptions#index:member + package: excel! + fullName: index + summary: Specifies the index of the legend entry in the chart legend. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'index?: boolean;' + return: + type: boolean + - name: left + uid: excel!Excel.Interfaces.ChartLegendEntryLoadOptions#left:member + package: excel! + fullName: left + summary: Specifies the left value of a chart legend entry. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: boolean;' + return: + type: boolean + - name: top + uid: excel!Excel.Interfaces.ChartLegendEntryLoadOptions#top:member + package: excel! + fullName: top + summary: Specifies the top of a chart legend entry. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: boolean;' + return: + type: boolean + - name: visible + uid: excel!Excel.Interfaces.ChartLegendEntryLoadOptions#visible:member + package: excel! + fullName: visible + summary: Represents the visibility of a chart legend entry. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean + - name: width + uid: excel!Excel.Interfaces.ChartLegendEntryLoadOptions#width:member + package: excel! + fullName: width + summary: Represents the width of the legend entry on the chart Legend. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlegendentryupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlegendentryupdatedata.yml new file mode 100644 index 0000000000..136f57a44f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlegendentryupdatedata.yml @@ -0,0 +1,29 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartLegendEntryUpdateData +uid: excel!Excel.Interfaces.ChartLegendEntryUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartLegendEntryUpdateData +summary: >- + An interface for updating data on the `ChartLegendEntry` object, for use in + `chartLegendEntry.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: visible + uid: excel!Excel.Interfaces.ChartLegendEntryUpdateData#visible:member + package: excel! + fullName: visible + summary: Represents the visibility of a chart legend entry. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlegendformatdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlegendformatdata.yml new file mode 100644 index 0000000000..70822f6cee --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlegendformatdata.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartLegendFormatData +uid: excel!Excel.Interfaces.ChartLegendFormatData:interface +package: excel! +fullName: Excel.Interfaces.ChartLegendFormatData +summary: >- + An interface describing the data returned by calling + `chartLegendFormat.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: border + uid: excel!Excel.Interfaces.ChartLegendFormatData#border:member + package: excel! + fullName: border + summary: Represents the border format, which includes color, linestyle, and weight. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'border?: Excel.Interfaces.ChartBorderData;' + return: + type: + - name: font + uid: excel!Excel.Interfaces.ChartLegendFormatData#font:member + package: excel! + fullName: font + summary: >- + Represents the font attributes such as font name, font size, and color of + a chart legend. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.Interfaces.ChartFontData;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlegendformatloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlegendformatloadoptions.yml new file mode 100644 index 0000000000..13a72cdae8 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlegendformatloadoptions.yml @@ -0,0 +1,62 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartLegendFormatLoadOptions +uid: excel!Excel.Interfaces.ChartLegendFormatLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartLegendFormatLoadOptions +summary: Encapsulates the format properties of a chart legend. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartLegendFormatLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: border + uid: excel!Excel.Interfaces.ChartLegendFormatLoadOptions#border:member + package: excel! + fullName: border + summary: Represents the border format, which includes color, linestyle, and weight. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'border?: Excel.Interfaces.ChartBorderLoadOptions;' + return: + type: + - name: font + uid: excel!Excel.Interfaces.ChartLegendFormatLoadOptions#font:member + package: excel! + fullName: font + summary: >- + Represents the font attributes such as font name, font size, and color of + a chart legend. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.Interfaces.ChartFontLoadOptions;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlegendformatupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlegendformatupdatedata.yml new file mode 100644 index 0000000000..1115e05491 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlegendformatupdatedata.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartLegendFormatUpdateData +uid: excel!Excel.Interfaces.ChartLegendFormatUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartLegendFormatUpdateData +summary: >- + An interface for updating data on the `ChartLegendFormat` object, for use in + `chartLegendFormat.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: border + uid: excel!Excel.Interfaces.ChartLegendFormatUpdateData#border:member + package: excel! + fullName: border + summary: Represents the border format, which includes color, linestyle, and weight. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'border?: Excel.Interfaces.ChartBorderUpdateData;' + return: + type: + - name: font + uid: excel!Excel.Interfaces.ChartLegendFormatUpdateData#font:member + package: excel! + fullName: font + summary: >- + Represents the font attributes such as font name, font size, and color of + a chart legend. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.Interfaces.ChartFontUpdateData;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlegendloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlegendloadoptions.yml new file mode 100644 index 0000000000..a155f6a81d --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlegendloadoptions.yml @@ -0,0 +1,179 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartLegendLoadOptions +uid: excel!Excel.Interfaces.ChartLegendLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartLegendLoadOptions +summary: Represents the legend in a chart. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartLegendLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: format + uid: excel!Excel.Interfaces.ChartLegendLoadOptions#format:member + package: excel! + fullName: format + summary: >- + Represents the formatting of a chart legend, which includes fill and font + formatting. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartLegendFormatLoadOptions;' + return: + type: >- + + - name: height + uid: excel!Excel.Interfaces.ChartLegendLoadOptions#height:member + package: excel! + fullName: height + summary: >- + Specifies the height, in points, of the legend on the chart. Value is + `null` if the legend is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height?: boolean;' + return: + type: boolean + - name: left + uid: excel!Excel.Interfaces.ChartLegendLoadOptions#left:member + package: excel! + fullName: left + summary: >- + Specifies the left value, in points, of the legend on the chart. Value is + `null` if the legend is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: boolean;' + return: + type: boolean + - name: overlay + uid: excel!Excel.Interfaces.ChartLegendLoadOptions#overlay:member + package: excel! + fullName: overlay + summary: >- + Specifies if the chart legend should overlap with the main body of the + chart. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'overlay?: boolean;' + return: + type: boolean + - name: position + uid: excel!Excel.Interfaces.ChartLegendLoadOptions#position:member + package: excel! + fullName: position + summary: >- + Specifies the position of the legend on the chart. See + `Excel.ChartLegendPosition` for details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'position?: boolean;' + return: + type: boolean + - name: showShadow + uid: excel!Excel.Interfaces.ChartLegendLoadOptions#showShadow:member + package: excel! + fullName: showShadow + summary: Specifies if the legend has a shadow on the chart. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showShadow?: boolean;' + return: + type: boolean + - name: top + uid: excel!Excel.Interfaces.ChartLegendLoadOptions#top:member + package: excel! + fullName: top + summary: Specifies the top of a chart legend. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: boolean;' + return: + type: boolean + - name: visible + uid: excel!Excel.Interfaces.ChartLegendLoadOptions#visible:member + package: excel! + fullName: visible + summary: Specifies if the chart legend is visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean + - name: width + uid: excel!Excel.Interfaces.ChartLegendLoadOptions#width:member + package: excel! + fullName: width + summary: >- + Specifies the width, in points, of the legend on the chart. Value is + `null` if the legend is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlegendupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlegendupdatedata.yml new file mode 100644 index 0000000000..475bfe5786 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlegendupdatedata.yml @@ -0,0 +1,167 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartLegendUpdateData +uid: excel!Excel.Interfaces.ChartLegendUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartLegendUpdateData +summary: >- + An interface for updating data on the `ChartLegend` object, for use in + `chartLegend.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: format + uid: excel!Excel.Interfaces.ChartLegendUpdateData#format:member + package: excel! + fullName: format + summary: >- + Represents the formatting of a chart legend, which includes fill and font + formatting. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartLegendFormatUpdateData;' + return: + type: >- + + - name: height + uid: excel!Excel.Interfaces.ChartLegendUpdateData#height:member + package: excel! + fullName: height + summary: >- + Specifies the height, in points, of the legend on the chart. Value is + `null` if the legend is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height?: number;' + return: + type: number + - name: left + uid: excel!Excel.Interfaces.ChartLegendUpdateData#left:member + package: excel! + fullName: left + summary: >- + Specifies the left value, in points, of the legend on the chart. Value is + `null` if the legend is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: number;' + return: + type: number + - name: overlay + uid: excel!Excel.Interfaces.ChartLegendUpdateData#overlay:member + package: excel! + fullName: overlay + summary: >- + Specifies if the chart legend should overlap with the main body of the + chart. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'overlay?: boolean;' + return: + type: boolean + - name: position + uid: excel!Excel.Interfaces.ChartLegendUpdateData#position:member + package: excel! + fullName: position + summary: >- + Specifies the position of the legend on the chart. See + `Excel.ChartLegendPosition` for details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + position?: Excel.ChartLegendPosition | "Invalid" | "Top" | "Bottom" | + "Left" | "Right" | "Corner" | "Custom"; + return: + type: >- + | "Invalid" | + "Top" | "Bottom" | "Left" | "Right" | "Corner" | "Custom" + - name: showShadow + uid: excel!Excel.Interfaces.ChartLegendUpdateData#showShadow:member + package: excel! + fullName: showShadow + summary: Specifies if the legend has a shadow on the chart. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showShadow?: boolean;' + return: + type: boolean + - name: top + uid: excel!Excel.Interfaces.ChartLegendUpdateData#top:member + package: excel! + fullName: top + summary: Specifies the top of a chart legend. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: number;' + return: + type: number + - name: visible + uid: excel!Excel.Interfaces.ChartLegendUpdateData#visible:member + package: excel! + fullName: visible + summary: Specifies if the chart legend is visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean + - name: width + uid: excel!Excel.Interfaces.ChartLegendUpdateData#width:member + package: excel! + fullName: width + summary: >- + Specifies the width, in points, of the legend on the chart. Value is + `null` if the legend is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlineformatdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlineformatdata.yml new file mode 100644 index 0000000000..4bffd3417c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlineformatdata.yml @@ -0,0 +1,65 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartLineFormatData +uid: excel!Excel.Interfaces.ChartLineFormatData:interface +package: excel! +fullName: Excel.Interfaces.ChartLineFormatData +summary: >- + An interface describing the data returned by calling + `chartLineFormat.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: color + uid: excel!Excel.Interfaces.ChartLineFormatData#color:member + package: excel! + fullName: color + summary: HTML color code representing the color of lines in the chart. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: string;' + return: + type: string + - name: lineStyle + uid: excel!Excel.Interfaces.ChartLineFormatData#lineStyle:member + package: excel! + fullName: lineStyle + summary: Represents the line style. See `Excel.ChartLineStyle` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + lineStyle?: Excel.ChartLineStyle | "None" | "Continuous" | "Dash" | + "DashDot" | "DashDotDot" | "Dot" | "Grey25" | "Grey50" | "Grey75" | + "Automatic" | "RoundDot"; + return: + type: >- + | "None" | "Continuous" + | "Dash" | "DashDot" | "DashDotDot" | "Dot" | "Grey25" | "Grey50" | + "Grey75" | "Automatic" | "RoundDot" + - name: weight + uid: excel!Excel.Interfaces.ChartLineFormatData#weight:member + package: excel! + fullName: weight + summary: Represents weight of the line, in points. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'weight?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlineformatloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlineformatloadoptions.yml new file mode 100644 index 0000000000..3a4799bacd --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlineformatloadoptions.yml @@ -0,0 +1,75 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartLineFormatLoadOptions +uid: excel!Excel.Interfaces.ChartLineFormatLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartLineFormatLoadOptions +summary: Encapsulates the formatting options for line elements. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartLineFormatLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: color + uid: excel!Excel.Interfaces.ChartLineFormatLoadOptions#color:member + package: excel! + fullName: color + summary: HTML color code representing the color of lines in the chart. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: boolean;' + return: + type: boolean + - name: lineStyle + uid: excel!Excel.Interfaces.ChartLineFormatLoadOptions#lineStyle:member + package: excel! + fullName: lineStyle + summary: Represents the line style. See `Excel.ChartLineStyle` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'lineStyle?: boolean;' + return: + type: boolean + - name: weight + uid: excel!Excel.Interfaces.ChartLineFormatLoadOptions#weight:member + package: excel! + fullName: weight + summary: Represents weight of the line, in points. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'weight?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlineformatupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlineformatupdatedata.yml new file mode 100644 index 0000000000..a79c904095 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartlineformatupdatedata.yml @@ -0,0 +1,65 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartLineFormatUpdateData +uid: excel!Excel.Interfaces.ChartLineFormatUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartLineFormatUpdateData +summary: >- + An interface for updating data on the `ChartLineFormat` object, for use in + `chartLineFormat.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: color + uid: excel!Excel.Interfaces.ChartLineFormatUpdateData#color:member + package: excel! + fullName: color + summary: HTML color code representing the color of lines in the chart. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: string;' + return: + type: string + - name: lineStyle + uid: excel!Excel.Interfaces.ChartLineFormatUpdateData#lineStyle:member + package: excel! + fullName: lineStyle + summary: Represents the line style. See `Excel.ChartLineStyle` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + lineStyle?: Excel.ChartLineStyle | "None" | "Continuous" | "Dash" | + "DashDot" | "DashDotDot" | "Dot" | "Grey25" | "Grey50" | "Grey75" | + "Automatic" | "RoundDot"; + return: + type: >- + | "None" | "Continuous" + | "Dash" | "DashDot" | "DashDotDot" | "Dot" | "Grey25" | "Grey50" | + "Grey75" | "Automatic" | "RoundDot" + - name: weight + uid: excel!Excel.Interfaces.ChartLineFormatUpdateData#weight:member + package: excel! + fullName: weight + summary: Represents weight of the line, in points. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'weight?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartloadoptions.yml new file mode 100644 index 0000000000..1e75110c5c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartloadoptions.yml @@ -0,0 +1,421 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartLoadOptions +uid: excel!Excel.Interfaces.ChartLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartLoadOptions +summary: >- + Represents a chart object in a workbook. To learn more about the chart object + model, see [Work with charts using the Excel JavaScript + API](https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-charts). +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: axes + uid: excel!Excel.Interfaces.ChartLoadOptions#axes:member + package: excel! + fullName: axes + summary: Represents chart axes. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'axes?: Excel.Interfaces.ChartAxesLoadOptions;' + return: + type: + - name: categoryLabelLevel + uid: excel!Excel.Interfaces.ChartLoadOptions#categoryLabelLevel:member + package: excel! + fullName: categoryLabelLevel + summary: >- + Specifies a chart category label level enumeration constant, referring to + the level of the source category labels. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'categoryLabelLevel?: boolean;' + return: + type: boolean + - name: chartType + uid: excel!Excel.Interfaces.ChartLoadOptions#chartType:member + package: excel! + fullName: chartType + summary: Specifies the type of the chart. See `Excel.ChartType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'chartType?: boolean;' + return: + type: boolean + - name: dataLabels + uid: excel!Excel.Interfaces.ChartLoadOptions#dataLabels:member + package: excel! + fullName: dataLabels + summary: Represents the data labels on the chart. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'dataLabels?: Excel.Interfaces.ChartDataLabelsLoadOptions;' + return: + type: >- + + - name: displayBlanksAs + uid: excel!Excel.Interfaces.ChartLoadOptions#displayBlanksAs:member + package: excel! + fullName: displayBlanksAs + summary: Specifies the way that blank cells are plotted on a chart. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'displayBlanksAs?: boolean;' + return: + type: boolean + - name: format + uid: excel!Excel.Interfaces.ChartLoadOptions#format:member + package: excel! + fullName: format + summary: Encapsulates the format properties for the chart area. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartAreaFormatLoadOptions;' + return: + type: >- + + - name: height + uid: excel!Excel.Interfaces.ChartLoadOptions#height:member + package: excel! + fullName: height + summary: Specifies the height, in points, of the chart object. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.ChartLoadOptions#id:member + package: excel! + fullName: id + summary: The unique ID of chart. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: left + uid: excel!Excel.Interfaces.ChartLoadOptions#left:member + package: excel! + fullName: left + summary: >- + The distance, in points, from the left side of the chart to the worksheet + origin. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: boolean;' + return: + type: boolean + - name: legend + uid: excel!Excel.Interfaces.ChartLoadOptions#legend:member + package: excel! + fullName: legend + summary: Represents the legend for the chart. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'legend?: Excel.Interfaces.ChartLegendLoadOptions;' + return: + type: + - name: name + uid: excel!Excel.Interfaces.ChartLoadOptions#name:member + package: excel! + fullName: name + summary: Specifies the name of a chart object. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: pivotOptions + uid: excel!Excel.Interfaces.ChartLoadOptions#pivotOptions:member + package: excel! + fullName: pivotOptions + summary: Encapsulates the options for a pivot chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'pivotOptions?: Excel.Interfaces.ChartPivotOptionsLoadOptions;' + return: + type: >- + + - name: plotArea + uid: excel!Excel.Interfaces.ChartLoadOptions#plotArea:member + package: excel! + fullName: plotArea + summary: Represents the plot area for the chart. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'plotArea?: Excel.Interfaces.ChartPlotAreaLoadOptions;' + return: + type: >- + + - name: plotBy + uid: excel!Excel.Interfaces.ChartLoadOptions#plotBy:member + package: excel! + fullName: plotBy + summary: Specifies the way columns or rows are used as data series on the chart. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'plotBy?: boolean;' + return: + type: boolean + - name: plotVisibleOnly + uid: excel!Excel.Interfaces.ChartLoadOptions#plotVisibleOnly:member + package: excel! + fullName: plotVisibleOnly + summary: >- + True if only visible cells are plotted. False if both visible and hidden + cells are plotted. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'plotVisibleOnly?: boolean;' + return: + type: boolean + - name: series + uid: excel!Excel.Interfaces.ChartLoadOptions#series:member + package: excel! + fullName: series + summary: Represents either a single series or collection of series in the chart. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'series?: Excel.Interfaces.ChartSeriesCollectionLoadOptions;' + return: + type: >- + + - name: seriesNameLevel + uid: excel!Excel.Interfaces.ChartLoadOptions#seriesNameLevel:member + package: excel! + fullName: seriesNameLevel + summary: >- + Specifies a chart series name level enumeration constant, referring to the + level of the source series names. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'seriesNameLevel?: boolean;' + return: + type: boolean + - name: showAllFieldButtons + uid: excel!Excel.Interfaces.ChartLoadOptions#showAllFieldButtons:member + package: excel! + fullName: showAllFieldButtons + summary: Specifies whether to display all field buttons on a PivotChart. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showAllFieldButtons?: boolean;' + return: + type: boolean + - name: showDataLabelsOverMaximum + uid: excel!Excel.Interfaces.ChartLoadOptions#showDataLabelsOverMaximum:member + package: excel! + fullName: showDataLabelsOverMaximum + summary: >- + Specifies whether to show the data labels when the value is greater than + the maximum value on the value axis. If the value axis becomes smaller + than the size of the data points, you can use this property to set whether + to show the data labels. This property applies to 2-D charts only. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showDataLabelsOverMaximum?: boolean;' + return: + type: boolean + - name: style + uid: excel!Excel.Interfaces.ChartLoadOptions#style:member + package: excel! + fullName: style + summary: Specifies the chart style for the chart. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'style?: boolean;' + return: + type: boolean + - name: title + uid: excel!Excel.Interfaces.ChartLoadOptions#title:member + package: excel! + fullName: title + summary: >- + Represents the title of the specified chart, including the text, + visibility, position, and formatting of the title. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'title?: Excel.Interfaces.ChartTitleLoadOptions;' + return: + type: + - name: top + uid: excel!Excel.Interfaces.ChartLoadOptions#top:member + package: excel! + fullName: top + summary: >- + Specifies the distance, in points, from the top edge of the object to the + top of row 1 (on a worksheet) or the top of the chart area (on a chart). + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: boolean;' + return: + type: boolean + - name: width + uid: excel!Excel.Interfaces.ChartLoadOptions#width:member + package: excel! + fullName: width + summary: Specifies the width, in points, of the chart object. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width?: boolean;' + return: + type: boolean + - name: worksheet + uid: excel!Excel.Interfaces.ChartLoadOptions#worksheet:member + package: excel! + fullName: worksheet + summary: The worksheet containing the current chart. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheet?: Excel.Interfaces.WorksheetLoadOptions;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartmapoptionsdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartmapoptionsdata.yml new file mode 100644 index 0000000000..6ee35c0d1d --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartmapoptionsdata.yml @@ -0,0 +1,72 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartMapOptionsData +uid: excel!Excel.Interfaces.ChartMapOptionsData:interface +package: excel! +fullName: Excel.Interfaces.ChartMapOptionsData +summary: >- + An interface describing the data returned by calling + `chartMapOptions.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: labelStrategy + uid: excel!Excel.Interfaces.ChartMapOptionsData#labelStrategy:member + package: excel! + fullName: labelStrategy + summary: Specifies the series map labels strategy of a region map chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + labelStrategy?: Excel.ChartMapLabelStrategy | "None" | "BestFit" | + "ShowAll"; + return: + type: >- + | "None" | + "BestFit" | "ShowAll" + - name: level + uid: excel!Excel.Interfaces.ChartMapOptionsData#level:member + package: excel! + fullName: level + summary: Specifies the series mapping level of a region map chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + level?: Excel.ChartMapAreaLevel | "Automatic" | "DataOnly" | "City" | + "County" | "State" | "Country" | "Continent" | "World"; + return: + type: >- + | "Automatic" | + "DataOnly" | "City" | "County" | "State" | "Country" | "Continent" | + "World" + - name: projectionType + uid: excel!Excel.Interfaces.ChartMapOptionsData#projectionType:member + package: excel! + fullName: projectionType + summary: Specifies the series projection type of a region map chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + projectionType?: Excel.ChartMapProjectionType | "Automatic" | "Mercator" + | "Miller" | "Robinson" | "Albers"; + return: + type: >- + | "Automatic" | + "Mercator" | "Miller" | "Robinson" | "Albers" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartmapoptionsloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartmapoptionsloadoptions.yml new file mode 100644 index 0000000000..2202ddc12c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartmapoptionsloadoptions.yml @@ -0,0 +1,75 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartMapOptionsLoadOptions +uid: excel!Excel.Interfaces.ChartMapOptionsLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartMapOptionsLoadOptions +summary: Encapsulates the properties for a region map chart. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartMapOptionsLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: labelStrategy + uid: excel!Excel.Interfaces.ChartMapOptionsLoadOptions#labelStrategy:member + package: excel! + fullName: labelStrategy + summary: Specifies the series map labels strategy of a region map chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'labelStrategy?: boolean;' + return: + type: boolean + - name: level + uid: excel!Excel.Interfaces.ChartMapOptionsLoadOptions#level:member + package: excel! + fullName: level + summary: Specifies the series mapping level of a region map chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'level?: boolean;' + return: + type: boolean + - name: projectionType + uid: excel!Excel.Interfaces.ChartMapOptionsLoadOptions#projectionType:member + package: excel! + fullName: projectionType + summary: Specifies the series projection type of a region map chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'projectionType?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartmapoptionsupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartmapoptionsupdatedata.yml new file mode 100644 index 0000000000..937b02c2f6 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartmapoptionsupdatedata.yml @@ -0,0 +1,72 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartMapOptionsUpdateData +uid: excel!Excel.Interfaces.ChartMapOptionsUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartMapOptionsUpdateData +summary: >- + An interface for updating data on the `ChartMapOptions` object, for use in + `chartMapOptions.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: labelStrategy + uid: excel!Excel.Interfaces.ChartMapOptionsUpdateData#labelStrategy:member + package: excel! + fullName: labelStrategy + summary: Specifies the series map labels strategy of a region map chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + labelStrategy?: Excel.ChartMapLabelStrategy | "None" | "BestFit" | + "ShowAll"; + return: + type: >- + | "None" | + "BestFit" | "ShowAll" + - name: level + uid: excel!Excel.Interfaces.ChartMapOptionsUpdateData#level:member + package: excel! + fullName: level + summary: Specifies the series mapping level of a region map chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + level?: Excel.ChartMapAreaLevel | "Automatic" | "DataOnly" | "City" | + "County" | "State" | "Country" | "Continent" | "World"; + return: + type: >- + | "Automatic" | + "DataOnly" | "City" | "County" | "State" | "Country" | "Continent" | + "World" + - name: projectionType + uid: excel!Excel.Interfaces.ChartMapOptionsUpdateData#projectionType:member + package: excel! + fullName: projectionType + summary: Specifies the series projection type of a region map chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + projectionType?: Excel.ChartMapProjectionType | "Automatic" | "Mercator" + | "Miller" | "Robinson" | "Albers"; + return: + type: >- + | "Automatic" | + "Mercator" | "Miller" | "Robinson" | "Albers" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartpivotoptionsdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartpivotoptionsdata.yml new file mode 100644 index 0000000000..ab948b62df --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartpivotoptionsdata.yml @@ -0,0 +1,81 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartPivotOptionsData +uid: excel!Excel.Interfaces.ChartPivotOptionsData:interface +package: excel! +fullName: Excel.Interfaces.ChartPivotOptionsData +summary: >- + An interface describing the data returned by calling + `chartPivotOptions.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: showAxisFieldButtons + uid: excel!Excel.Interfaces.ChartPivotOptionsData#showAxisFieldButtons:member + package: excel! + fullName: showAxisFieldButtons + summary: >- + Specifies whether to display the axis field buttons on a PivotChart. The + `showAxisFieldButtons` property corresponds to the "Show Axis Field + Buttons" command on the "Field Buttons" drop-down list of the "Analyze" + tab, which is available when a PivotChart is selected. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showAxisFieldButtons?: boolean;' + return: + type: boolean + - name: showLegendFieldButtons + uid: excel!Excel.Interfaces.ChartPivotOptionsData#showLegendFieldButtons:member + package: excel! + fullName: showLegendFieldButtons + summary: Specifies whether to display the legend field buttons on a PivotChart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showLegendFieldButtons?: boolean;' + return: + type: boolean + - name: showReportFilterFieldButtons + uid: >- + excel!Excel.Interfaces.ChartPivotOptionsData#showReportFilterFieldButtons:member + package: excel! + fullName: showReportFilterFieldButtons + summary: >- + Specifies whether to display the report filter field buttons on a + PivotChart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showReportFilterFieldButtons?: boolean;' + return: + type: boolean + - name: showValueFieldButtons + uid: excel!Excel.Interfaces.ChartPivotOptionsData#showValueFieldButtons:member + package: excel! + fullName: showValueFieldButtons + summary: Specifies whether to display the show value field buttons on a PivotChart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showValueFieldButtons?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartpivotoptionsloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartpivotoptionsloadoptions.yml new file mode 100644 index 0000000000..67aedcaf50 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartpivotoptionsloadoptions.yml @@ -0,0 +1,100 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartPivotOptionsLoadOptions +uid: excel!Excel.Interfaces.ChartPivotOptionsLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartPivotOptionsLoadOptions +summary: Encapsulates the options for the pivot chart. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartPivotOptionsLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: showAxisFieldButtons + uid: >- + excel!Excel.Interfaces.ChartPivotOptionsLoadOptions#showAxisFieldButtons:member + package: excel! + fullName: showAxisFieldButtons + summary: >- + Specifies whether to display the axis field buttons on a PivotChart. The + `showAxisFieldButtons` property corresponds to the "Show Axis Field + Buttons" command on the "Field Buttons" drop-down list of the "Analyze" + tab, which is available when a PivotChart is selected. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showAxisFieldButtons?: boolean;' + return: + type: boolean + - name: showLegendFieldButtons + uid: >- + excel!Excel.Interfaces.ChartPivotOptionsLoadOptions#showLegendFieldButtons:member + package: excel! + fullName: showLegendFieldButtons + summary: Specifies whether to display the legend field buttons on a PivotChart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showLegendFieldButtons?: boolean;' + return: + type: boolean + - name: showReportFilterFieldButtons + uid: >- + excel!Excel.Interfaces.ChartPivotOptionsLoadOptions#showReportFilterFieldButtons:member + package: excel! + fullName: showReportFilterFieldButtons + summary: >- + Specifies whether to display the report filter field buttons on a + PivotChart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showReportFilterFieldButtons?: boolean;' + return: + type: boolean + - name: showValueFieldButtons + uid: >- + excel!Excel.Interfaces.ChartPivotOptionsLoadOptions#showValueFieldButtons:member + package: excel! + fullName: showValueFieldButtons + summary: Specifies whether to display the show value field buttons on a PivotChart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showValueFieldButtons?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartpivotoptionsupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartpivotoptionsupdatedata.yml new file mode 100644 index 0000000000..efa1536f90 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartpivotoptionsupdatedata.yml @@ -0,0 +1,84 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartPivotOptionsUpdateData +uid: excel!Excel.Interfaces.ChartPivotOptionsUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartPivotOptionsUpdateData +summary: >- + An interface for updating data on the `ChartPivotOptions` object, for use in + `chartPivotOptions.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: showAxisFieldButtons + uid: >- + excel!Excel.Interfaces.ChartPivotOptionsUpdateData#showAxisFieldButtons:member + package: excel! + fullName: showAxisFieldButtons + summary: >- + Specifies whether to display the axis field buttons on a PivotChart. The + `showAxisFieldButtons` property corresponds to the "Show Axis Field + Buttons" command on the "Field Buttons" drop-down list of the "Analyze" + tab, which is available when a PivotChart is selected. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showAxisFieldButtons?: boolean;' + return: + type: boolean + - name: showLegendFieldButtons + uid: >- + excel!Excel.Interfaces.ChartPivotOptionsUpdateData#showLegendFieldButtons:member + package: excel! + fullName: showLegendFieldButtons + summary: Specifies whether to display the legend field buttons on a PivotChart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showLegendFieldButtons?: boolean;' + return: + type: boolean + - name: showReportFilterFieldButtons + uid: >- + excel!Excel.Interfaces.ChartPivotOptionsUpdateData#showReportFilterFieldButtons:member + package: excel! + fullName: showReportFilterFieldButtons + summary: >- + Specifies whether to display the report filter field buttons on a + PivotChart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showReportFilterFieldButtons?: boolean;' + return: + type: boolean + - name: showValueFieldButtons + uid: >- + excel!Excel.Interfaces.ChartPivotOptionsUpdateData#showValueFieldButtons:member + package: excel! + fullName: showValueFieldButtons + summary: Specifies whether to display the show value field buttons on a PivotChart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showValueFieldButtons?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartplotareadata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartplotareadata.yml new file mode 100644 index 0000000000..3ea6b86c82 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartplotareadata.yml @@ -0,0 +1,168 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartPlotAreaData +uid: excel!Excel.Interfaces.ChartPlotAreaData:interface +package: excel! +fullName: Excel.Interfaces.ChartPlotAreaData +summary: >- + An interface describing the data returned by calling + `chartPlotArea.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: format + uid: excel!Excel.Interfaces.ChartPlotAreaData#format:member + package: excel! + fullName: format + summary: Specifies the formatting of a chart plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartPlotAreaFormatData;' + return: + type: >- + + - name: height + uid: excel!Excel.Interfaces.ChartPlotAreaData#height:member + package: excel! + fullName: height + summary: Specifies the height value of a plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height?: number;' + return: + type: number + - name: insideHeight + uid: excel!Excel.Interfaces.ChartPlotAreaData#insideHeight:member + package: excel! + fullName: insideHeight + summary: Specifies the inside height value of a plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'insideHeight?: number;' + return: + type: number + - name: insideLeft + uid: excel!Excel.Interfaces.ChartPlotAreaData#insideLeft:member + package: excel! + fullName: insideLeft + summary: Specifies the inside left value of a plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'insideLeft?: number;' + return: + type: number + - name: insideTop + uid: excel!Excel.Interfaces.ChartPlotAreaData#insideTop:member + package: excel! + fullName: insideTop + summary: Specifies the inside top value of a plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'insideTop?: number;' + return: + type: number + - name: insideWidth + uid: excel!Excel.Interfaces.ChartPlotAreaData#insideWidth:member + package: excel! + fullName: insideWidth + summary: Specifies the inside width value of a plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'insideWidth?: number;' + return: + type: number + - name: left + uid: excel!Excel.Interfaces.ChartPlotAreaData#left:member + package: excel! + fullName: left + summary: Specifies the left value of a plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: number;' + return: + type: number + - name: position + uid: excel!Excel.Interfaces.ChartPlotAreaData#position:member + package: excel! + fullName: position + summary: Specifies the position of a plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'position?: Excel.ChartPlotAreaPosition | "Automatic" | "Custom";' + return: + type: >- + | "Automatic" | + "Custom" + - name: top + uid: excel!Excel.Interfaces.ChartPlotAreaData#top:member + package: excel! + fullName: top + summary: Specifies the top value of a plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: number;' + return: + type: number + - name: width + uid: excel!Excel.Interfaces.ChartPlotAreaData#width:member + package: excel! + fullName: width + summary: Specifies the width value of a plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartplotareaformatdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartplotareaformatdata.yml new file mode 100644 index 0000000000..f5215722ad --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartplotareaformatdata.yml @@ -0,0 +1,29 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartPlotAreaFormatData +uid: excel!Excel.Interfaces.ChartPlotAreaFormatData:interface +package: excel! +fullName: Excel.Interfaces.ChartPlotAreaFormatData +summary: >- + An interface describing the data returned by calling + `chartPlotAreaFormat.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: border + uid: excel!Excel.Interfaces.ChartPlotAreaFormatData#border:member + package: excel! + fullName: border + summary: Specifies the border attributes of a chart plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'border?: Excel.Interfaces.ChartBorderData;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartplotareaformatloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartplotareaformatloadoptions.yml new file mode 100644 index 0000000000..daa4e8e10c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartplotareaformatloadoptions.yml @@ -0,0 +1,45 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartPlotAreaFormatLoadOptions +uid: excel!Excel.Interfaces.ChartPlotAreaFormatLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartPlotAreaFormatLoadOptions +summary: Represents the format properties for a chart plot area. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartPlotAreaFormatLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: border + uid: excel!Excel.Interfaces.ChartPlotAreaFormatLoadOptions#border:member + package: excel! + fullName: border + summary: Specifies the border attributes of a chart plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'border?: Excel.Interfaces.ChartBorderLoadOptions;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartplotareaformatupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartplotareaformatupdatedata.yml new file mode 100644 index 0000000000..81433be5ee --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartplotareaformatupdatedata.yml @@ -0,0 +1,29 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartPlotAreaFormatUpdateData +uid: excel!Excel.Interfaces.ChartPlotAreaFormatUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartPlotAreaFormatUpdateData +summary: >- + An interface for updating data on the `ChartPlotAreaFormat` object, for use in + `chartPlotAreaFormat.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: border + uid: excel!Excel.Interfaces.ChartPlotAreaFormatUpdateData#border:member + package: excel! + fullName: border + summary: Specifies the border attributes of a chart plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'border?: Excel.Interfaces.ChartBorderUpdateData;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartplotarealoadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartplotarealoadoptions.yml new file mode 100644 index 0000000000..b6b788c655 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartplotarealoadoptions.yml @@ -0,0 +1,183 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartPlotAreaLoadOptions +uid: excel!Excel.Interfaces.ChartPlotAreaLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartPlotAreaLoadOptions +summary: This object represents the attributes for a chart plot area. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartPlotAreaLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: format + uid: excel!Excel.Interfaces.ChartPlotAreaLoadOptions#format:member + package: excel! + fullName: format + summary: Specifies the formatting of a chart plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartPlotAreaFormatLoadOptions;' + return: + type: >- + + - name: height + uid: excel!Excel.Interfaces.ChartPlotAreaLoadOptions#height:member + package: excel! + fullName: height + summary: Specifies the height value of a plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height?: boolean;' + return: + type: boolean + - name: insideHeight + uid: excel!Excel.Interfaces.ChartPlotAreaLoadOptions#insideHeight:member + package: excel! + fullName: insideHeight + summary: Specifies the inside height value of a plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'insideHeight?: boolean;' + return: + type: boolean + - name: insideLeft + uid: excel!Excel.Interfaces.ChartPlotAreaLoadOptions#insideLeft:member + package: excel! + fullName: insideLeft + summary: Specifies the inside left value of a plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'insideLeft?: boolean;' + return: + type: boolean + - name: insideTop + uid: excel!Excel.Interfaces.ChartPlotAreaLoadOptions#insideTop:member + package: excel! + fullName: insideTop + summary: Specifies the inside top value of a plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'insideTop?: boolean;' + return: + type: boolean + - name: insideWidth + uid: excel!Excel.Interfaces.ChartPlotAreaLoadOptions#insideWidth:member + package: excel! + fullName: insideWidth + summary: Specifies the inside width value of a plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'insideWidth?: boolean;' + return: + type: boolean + - name: left + uid: excel!Excel.Interfaces.ChartPlotAreaLoadOptions#left:member + package: excel! + fullName: left + summary: Specifies the left value of a plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: boolean;' + return: + type: boolean + - name: position + uid: excel!Excel.Interfaces.ChartPlotAreaLoadOptions#position:member + package: excel! + fullName: position + summary: Specifies the position of a plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'position?: boolean;' + return: + type: boolean + - name: top + uid: excel!Excel.Interfaces.ChartPlotAreaLoadOptions#top:member + package: excel! + fullName: top + summary: Specifies the top value of a plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: boolean;' + return: + type: boolean + - name: width + uid: excel!Excel.Interfaces.ChartPlotAreaLoadOptions#width:member + package: excel! + fullName: width + summary: Specifies the width value of a plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartplotareaupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartplotareaupdatedata.yml new file mode 100644 index 0000000000..d73184a2f6 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartplotareaupdatedata.yml @@ -0,0 +1,169 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartPlotAreaUpdateData +uid: excel!Excel.Interfaces.ChartPlotAreaUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartPlotAreaUpdateData +summary: >- + An interface for updating data on the `ChartPlotArea` object, for use in + `chartPlotArea.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: format + uid: excel!Excel.Interfaces.ChartPlotAreaUpdateData#format:member + package: excel! + fullName: format + summary: Specifies the formatting of a chart plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartPlotAreaFormatUpdateData;' + return: + type: >- + + - name: height + uid: excel!Excel.Interfaces.ChartPlotAreaUpdateData#height:member + package: excel! + fullName: height + summary: Specifies the height value of a plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height?: number;' + return: + type: number + - name: insideHeight + uid: excel!Excel.Interfaces.ChartPlotAreaUpdateData#insideHeight:member + package: excel! + fullName: insideHeight + summary: Specifies the inside height value of a plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'insideHeight?: number;' + return: + type: number + - name: insideLeft + uid: excel!Excel.Interfaces.ChartPlotAreaUpdateData#insideLeft:member + package: excel! + fullName: insideLeft + summary: Specifies the inside left value of a plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'insideLeft?: number;' + return: + type: number + - name: insideTop + uid: excel!Excel.Interfaces.ChartPlotAreaUpdateData#insideTop:member + package: excel! + fullName: insideTop + summary: Specifies the inside top value of a plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'insideTop?: number;' + return: + type: number + - name: insideWidth + uid: excel!Excel.Interfaces.ChartPlotAreaUpdateData#insideWidth:member + package: excel! + fullName: insideWidth + summary: Specifies the inside width value of a plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'insideWidth?: number;' + return: + type: number + - name: left + uid: excel!Excel.Interfaces.ChartPlotAreaUpdateData#left:member + package: excel! + fullName: left + summary: Specifies the left value of a plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: number;' + return: + type: number + - name: position + uid: excel!Excel.Interfaces.ChartPlotAreaUpdateData#position:member + package: excel! + fullName: position + summary: Specifies the position of a plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'position?: Excel.ChartPlotAreaPosition | "Automatic" | "Custom";' + return: + type: >- + | "Automatic" | + "Custom" + - name: top + uid: excel!Excel.Interfaces.ChartPlotAreaUpdateData#top:member + package: excel! + fullName: top + summary: Specifies the top value of a plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: number;' + return: + type: number + - name: width + uid: excel!Excel.Interfaces.ChartPlotAreaUpdateData#width:member + package: excel! + fullName: width + summary: Specifies the width value of a plot area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartpointdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartpointdata.yml new file mode 100644 index 0000000000..fe31b72aa6 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartpointdata.yml @@ -0,0 +1,151 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartPointData +uid: excel!Excel.Interfaces.ChartPointData:interface +package: excel! +fullName: Excel.Interfaces.ChartPointData +summary: >- + An interface describing the data returned by calling `chartPoint.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: dataLabel + uid: excel!Excel.Interfaces.ChartPointData#dataLabel:member + package: excel! + fullName: dataLabel + summary: Returns the data label of a chart point. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'dataLabel?: Excel.Interfaces.ChartDataLabelData;' + return: + type: + - name: format + uid: excel!Excel.Interfaces.ChartPointData#format:member + package: excel! + fullName: format + summary: Encapsulates the format properties chart point. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartPointFormatData;' + return: + type: + - name: hasDataLabel + uid: excel!Excel.Interfaces.ChartPointData#hasDataLabel:member + package: excel! + fullName: hasDataLabel + summary: >- + Represents whether a data point has a data label. Not applicable for + surface charts. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'hasDataLabel?: boolean;' + return: + type: boolean + - name: markerBackgroundColor + uid: excel!Excel.Interfaces.ChartPointData#markerBackgroundColor:member + package: excel! + fullName: markerBackgroundColor + summary: >- + HTML color code representation of the marker background color of a data + point (e.g., \#FF0000 represents Red). + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'markerBackgroundColor?: string;' + return: + type: string + - name: markerForegroundColor + uid: excel!Excel.Interfaces.ChartPointData#markerForegroundColor:member + package: excel! + fullName: markerForegroundColor + summary: >- + HTML color code representation of the marker foreground color of a data + point (e.g., \#FF0000 represents Red). + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'markerForegroundColor?: string;' + return: + type: string + - name: markerSize + uid: excel!Excel.Interfaces.ChartPointData#markerSize:member + package: excel! + fullName: markerSize + summary: >- + Represents marker size of a data point. The supported size range is 2 to + 72. This method returns an InvalidArgument error if it's set with a size + outside of the supported range. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'markerSize?: number;' + return: + type: number + - name: markerStyle + uid: excel!Excel.Interfaces.ChartPointData#markerStyle:member + package: excel! + fullName: markerStyle + summary: >- + Represents marker style of a chart data point. See + `Excel.ChartMarkerStyle` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + markerStyle?: Excel.ChartMarkerStyle | "Invalid" | "Automatic" | "None" + | "Square" | "Diamond" | "Triangle" | "X" | "Star" | "Dot" | "Dash" | + "Circle" | "Plus" | "Picture"; + return: + type: >- + | "Invalid" | + "Automatic" | "None" | "Square" | "Diamond" | "Triangle" | "X" | + "Star" | "Dot" | "Dash" | "Circle" | "Plus" | "Picture" + - name: value + uid: excel!Excel.Interfaces.ChartPointData#value:member + package: excel! + fullName: value + summary: Returns the value of a chart point. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'value?: any;' + return: + type: any diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartpointformatdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartpointformatdata.yml new file mode 100644 index 0000000000..8ed8603dcb --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartpointformatdata.yml @@ -0,0 +1,31 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartPointFormatData +uid: excel!Excel.Interfaces.ChartPointFormatData:interface +package: excel! +fullName: Excel.Interfaces.ChartPointFormatData +summary: >- + An interface describing the data returned by calling + `chartPointFormat.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: border + uid: excel!Excel.Interfaces.ChartPointFormatData#border:member + package: excel! + fullName: border + summary: >- + Represents the border format of a chart data point, which includes color, + style, and weight information. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'border?: Excel.Interfaces.ChartBorderData;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartpointformatloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartpointformatloadoptions.yml new file mode 100644 index 0000000000..4f44ee05dd --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartpointformatloadoptions.yml @@ -0,0 +1,47 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartPointFormatLoadOptions +uid: excel!Excel.Interfaces.ChartPointFormatLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartPointFormatLoadOptions +summary: Represents the formatting object for chart points. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartPointFormatLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: border + uid: excel!Excel.Interfaces.ChartPointFormatLoadOptions#border:member + package: excel! + fullName: border + summary: >- + Represents the border format of a chart data point, which includes color, + style, and weight information. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'border?: Excel.Interfaces.ChartBorderLoadOptions;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartpointformatupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartpointformatupdatedata.yml new file mode 100644 index 0000000000..ffbdee6abf --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartpointformatupdatedata.yml @@ -0,0 +1,31 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartPointFormatUpdateData +uid: excel!Excel.Interfaces.ChartPointFormatUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartPointFormatUpdateData +summary: >- + An interface for updating data on the `ChartPointFormat` object, for use in + `chartPointFormat.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: border + uid: excel!Excel.Interfaces.ChartPointFormatUpdateData#border:member + package: excel! + fullName: border + summary: >- + Represents the border format of a chart data point, which includes color, + style, and weight information. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'border?: Excel.Interfaces.ChartBorderUpdateData;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartpointloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartpointloadoptions.yml new file mode 100644 index 0000000000..e4b6a0e2d5 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartpointloadoptions.yml @@ -0,0 +1,165 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartPointLoadOptions +uid: excel!Excel.Interfaces.ChartPointLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartPointLoadOptions +summary: Represents a point of a series in a chart. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartPointLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: dataLabel + uid: excel!Excel.Interfaces.ChartPointLoadOptions#dataLabel:member + package: excel! + fullName: dataLabel + summary: Returns the data label of a chart point. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'dataLabel?: Excel.Interfaces.ChartDataLabelLoadOptions;' + return: + type: >- + + - name: format + uid: excel!Excel.Interfaces.ChartPointLoadOptions#format:member + package: excel! + fullName: format + summary: Encapsulates the format properties chart point. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartPointFormatLoadOptions;' + return: + type: >- + + - name: hasDataLabel + uid: excel!Excel.Interfaces.ChartPointLoadOptions#hasDataLabel:member + package: excel! + fullName: hasDataLabel + summary: >- + Represents whether a data point has a data label. Not applicable for + surface charts. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'hasDataLabel?: boolean;' + return: + type: boolean + - name: markerBackgroundColor + uid: excel!Excel.Interfaces.ChartPointLoadOptions#markerBackgroundColor:member + package: excel! + fullName: markerBackgroundColor + summary: >- + HTML color code representation of the marker background color of a data + point (e.g., \#FF0000 represents Red). + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'markerBackgroundColor?: boolean;' + return: + type: boolean + - name: markerForegroundColor + uid: excel!Excel.Interfaces.ChartPointLoadOptions#markerForegroundColor:member + package: excel! + fullName: markerForegroundColor + summary: >- + HTML color code representation of the marker foreground color of a data + point (e.g., \#FF0000 represents Red). + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'markerForegroundColor?: boolean;' + return: + type: boolean + - name: markerSize + uid: excel!Excel.Interfaces.ChartPointLoadOptions#markerSize:member + package: excel! + fullName: markerSize + summary: >- + Represents marker size of a data point. The supported size range is 2 to + 72. This method returns an InvalidArgument error if it's set with a size + outside of the supported range. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'markerSize?: boolean;' + return: + type: boolean + - name: markerStyle + uid: excel!Excel.Interfaces.ChartPointLoadOptions#markerStyle:member + package: excel! + fullName: markerStyle + summary: >- + Represents marker style of a chart data point. See + `Excel.ChartMarkerStyle` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'markerStyle?: boolean;' + return: + type: boolean + - name: value + uid: excel!Excel.Interfaces.ChartPointLoadOptions#value:member + package: excel! + fullName: value + summary: Returns the value of a chart point. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'value?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartpointscollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartpointscollectiondata.yml new file mode 100644 index 0000000000..52f7f638ca --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartpointscollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartPointsCollectionData +uid: excel!Excel.Interfaces.ChartPointsCollectionData:interface +package: excel! +fullName: Excel.Interfaces.ChartPointsCollectionData +summary: >- + An interface describing the data returned by calling + `chartPointsCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.ChartPointsCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.ChartPointData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartpointscollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartpointscollectionloadoptions.yml new file mode 100644 index 0000000000..ce0cbb34af --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartpointscollectionloadoptions.yml @@ -0,0 +1,171 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartPointsCollectionLoadOptions +uid: excel!Excel.Interfaces.ChartPointsCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartPointsCollectionLoadOptions +summary: A collection of all the chart points within a series inside a chart. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartPointsCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: dataLabel + uid: excel!Excel.Interfaces.ChartPointsCollectionLoadOptions#dataLabel:member + package: excel! + fullName: dataLabel + summary: 'For EACH ITEM in the collection: Returns the data label of a chart point.' + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'dataLabel?: Excel.Interfaces.ChartDataLabelLoadOptions;' + return: + type: >- + + - name: format + uid: excel!Excel.Interfaces.ChartPointsCollectionLoadOptions#format:member + package: excel! + fullName: format + summary: >- + For EACH ITEM in the collection: Encapsulates the format properties chart + point. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartPointFormatLoadOptions;' + return: + type: >- + + - name: hasDataLabel + uid: >- + excel!Excel.Interfaces.ChartPointsCollectionLoadOptions#hasDataLabel:member + package: excel! + fullName: hasDataLabel + summary: >- + For EACH ITEM in the collection: Represents whether a data point has a + data label. Not applicable for surface charts. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'hasDataLabel?: boolean;' + return: + type: boolean + - name: markerBackgroundColor + uid: >- + excel!Excel.Interfaces.ChartPointsCollectionLoadOptions#markerBackgroundColor:member + package: excel! + fullName: markerBackgroundColor + summary: >- + For EACH ITEM in the collection: HTML color code representation of the + marker background color of a data point (e.g., \#FF0000 represents Red). + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'markerBackgroundColor?: boolean;' + return: + type: boolean + - name: markerForegroundColor + uid: >- + excel!Excel.Interfaces.ChartPointsCollectionLoadOptions#markerForegroundColor:member + package: excel! + fullName: markerForegroundColor + summary: >- + For EACH ITEM in the collection: HTML color code representation of the + marker foreground color of a data point (e.g., \#FF0000 represents Red). + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'markerForegroundColor?: boolean;' + return: + type: boolean + - name: markerSize + uid: excel!Excel.Interfaces.ChartPointsCollectionLoadOptions#markerSize:member + package: excel! + fullName: markerSize + summary: >- + For EACH ITEM in the collection: Represents marker size of a data point. + The supported size range is 2 to 72. This method returns an + InvalidArgument error if it's set with a size outside of the supported + range. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'markerSize?: boolean;' + return: + type: boolean + - name: markerStyle + uid: excel!Excel.Interfaces.ChartPointsCollectionLoadOptions#markerStyle:member + package: excel! + fullName: markerStyle + summary: >- + For EACH ITEM in the collection: Represents marker style of a chart data + point. See `Excel.ChartMarkerStyle` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'markerStyle?: boolean;' + return: + type: boolean + - name: value + uid: excel!Excel.Interfaces.ChartPointsCollectionLoadOptions#value:member + package: excel! + fullName: value + summary: 'For EACH ITEM in the collection: Returns the value of a chart point.' + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'value?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartpointscollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartpointscollectionupdatedata.yml new file mode 100644 index 0000000000..770b4e51fd --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartpointscollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartPointsCollectionUpdateData +uid: excel!Excel.Interfaces.ChartPointsCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartPointsCollectionUpdateData +summary: >- + An interface for updating data on the `ChartPointsCollection` object, for use + in `chartPointsCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.ChartPointsCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.ChartPointData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartpointupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartpointupdatedata.yml new file mode 100644 index 0000000000..8e83d8ac47 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartpointupdatedata.yml @@ -0,0 +1,140 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartPointUpdateData +uid: excel!Excel.Interfaces.ChartPointUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartPointUpdateData +summary: >- + An interface for updating data on the `ChartPoint` object, for use in + `chartPoint.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: dataLabel + uid: excel!Excel.Interfaces.ChartPointUpdateData#dataLabel:member + package: excel! + fullName: dataLabel + summary: Returns the data label of a chart point. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'dataLabel?: Excel.Interfaces.ChartDataLabelUpdateData;' + return: + type: >- + + - name: format + uid: excel!Excel.Interfaces.ChartPointUpdateData#format:member + package: excel! + fullName: format + summary: Encapsulates the format properties chart point. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartPointFormatUpdateData;' + return: + type: >- + + - name: hasDataLabel + uid: excel!Excel.Interfaces.ChartPointUpdateData#hasDataLabel:member + package: excel! + fullName: hasDataLabel + summary: >- + Represents whether a data point has a data label. Not applicable for + surface charts. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'hasDataLabel?: boolean;' + return: + type: boolean + - name: markerBackgroundColor + uid: excel!Excel.Interfaces.ChartPointUpdateData#markerBackgroundColor:member + package: excel! + fullName: markerBackgroundColor + summary: >- + HTML color code representation of the marker background color of a data + point (e.g., \#FF0000 represents Red). + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'markerBackgroundColor?: string;' + return: + type: string + - name: markerForegroundColor + uid: excel!Excel.Interfaces.ChartPointUpdateData#markerForegroundColor:member + package: excel! + fullName: markerForegroundColor + summary: >- + HTML color code representation of the marker foreground color of a data + point (e.g., \#FF0000 represents Red). + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'markerForegroundColor?: string;' + return: + type: string + - name: markerSize + uid: excel!Excel.Interfaces.ChartPointUpdateData#markerSize:member + package: excel! + fullName: markerSize + summary: >- + Represents marker size of a data point. The supported size range is 2 to + 72. This method returns an InvalidArgument error if it's set with a size + outside of the supported range. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'markerSize?: number;' + return: + type: number + - name: markerStyle + uid: excel!Excel.Interfaces.ChartPointUpdateData#markerStyle:member + package: excel! + fullName: markerStyle + summary: >- + Represents marker style of a chart data point. See + `Excel.ChartMarkerStyle` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + markerStyle?: Excel.ChartMarkerStyle | "Invalid" | "Automatic" | "None" + | "Square" | "Diamond" | "Triangle" | "X" | "Star" | "Dot" | "Dash" | + "Circle" | "Plus" | "Picture"; + return: + type: >- + | "Invalid" | + "Automatic" | "None" | "Square" | "Diamond" | "Triangle" | "X" | + "Star" | "Dot" | "Dash" | "Circle" | "Plus" | "Picture" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartseriescollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartseriescollectiondata.yml new file mode 100644 index 0000000000..8f2140d4fc --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartseriescollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartSeriesCollectionData +uid: excel!Excel.Interfaces.ChartSeriesCollectionData:interface +package: excel! +fullName: Excel.Interfaces.ChartSeriesCollectionData +summary: >- + An interface describing the data returned by calling + `chartSeriesCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.ChartSeriesCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.ChartSeriesData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartseriescollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartseriescollectionloadoptions.yml new file mode 100644 index 0000000000..b20c4a605b --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartseriescollectionloadoptions.yml @@ -0,0 +1,842 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartSeriesCollectionLoadOptions +uid: excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartSeriesCollectionLoadOptions +summary: Represents a collection of chart series. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: axisGroup + uid: excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#axisGroup:member + package: excel! + fullName: axisGroup + summary: >- + For EACH ITEM in the collection: Specifies the group for the specified + series. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'axisGroup?: boolean;' + return: + type: boolean + - name: binOptions + uid: excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#binOptions:member + package: excel! + fullName: binOptions + summary: >- + For EACH ITEM in the collection: Encapsulates the bin options for + histogram charts and pareto charts. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'binOptions?: Excel.Interfaces.ChartBinOptionsLoadOptions;' + return: + type: >- + + - name: boxwhiskerOptions + uid: >- + excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#boxwhiskerOptions:member + package: excel! + fullName: boxwhiskerOptions + summary: >- + For EACH ITEM in the collection: Encapsulates the options for the box and + whisker charts. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'boxwhiskerOptions?: Excel.Interfaces.ChartBoxwhiskerOptionsLoadOptions;' + return: + type: >- + + - name: bubbleScale + uid: excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#bubbleScale:member + package: excel! + fullName: bubbleScale + summary: >- + For EACH ITEM in the collection: This can be an integer value from 0 + (zero) to 300, representing the percentage of the default size. This + property only applies to bubble charts. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'bubbleScale?: boolean;' + return: + type: boolean + - name: chartType + uid: excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#chartType:member + package: excel! + fullName: chartType + summary: >- + For EACH ITEM in the collection: Represents the chart type of a series. + See `Excel.ChartType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'chartType?: boolean;' + return: + type: boolean + - name: dataLabels + uid: excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#dataLabels:member + package: excel! + fullName: dataLabels + summary: >- + For EACH ITEM in the collection: Represents a collection of all data + labels in the series. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'dataLabels?: Excel.Interfaces.ChartDataLabelsLoadOptions;' + return: + type: >- + + - name: doughnutHoleSize + uid: >- + excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#doughnutHoleSize:member + package: excel! + fullName: doughnutHoleSize + summary: >- + For EACH ITEM in the collection: Represents the doughnut hole size of a + chart series. Only valid on doughnut and doughnut exploded charts. Throws + an `InvalidArgument` error on invalid charts. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'doughnutHoleSize?: boolean;' + return: + type: boolean + - name: explosion + uid: excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#explosion:member + package: excel! + fullName: explosion + summary: >- + For EACH ITEM in the collection: Specifies the explosion value for a + pie-chart or doughnut-chart slice. Returns 0 (zero) if there's no + explosion (the tip of the slice is in the center of the pie). + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'explosion?: boolean;' + return: + type: boolean + - name: filtered + uid: excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#filtered:member + package: excel! + fullName: filtered + summary: >- + For EACH ITEM in the collection: Specifies if the series is filtered. Not + applicable for surface charts. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'filtered?: boolean;' + return: + type: boolean + - name: firstSliceAngle + uid: >- + excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#firstSliceAngle:member + package: excel! + fullName: firstSliceAngle + summary: >- + For EACH ITEM in the collection: Specifies the angle of the first + pie-chart or doughnut-chart slice, in degrees (clockwise from vertical). + Applies only to pie, 3-D pie, and doughnut charts. Can be a value from 0 + through 360. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'firstSliceAngle?: boolean;' + return: + type: boolean + - name: format + uid: excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#format:member + package: excel! + fullName: format + summary: >- + For EACH ITEM in the collection: Represents the formatting of a chart + series, which includes fill and line formatting. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartSeriesFormatLoadOptions;' + return: + type: >- + + - name: gapWidth + uid: excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#gapWidth:member + package: excel! + fullName: gapWidth + summary: >- + For EACH ITEM in the collection: Represents the gap width of a chart + series. Only valid on bar and column charts, as well as specific classes + of line and pie charts. Throws an invalid argument exception on invalid + charts. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gapWidth?: boolean;' + return: + type: boolean + - name: gradientMaximumColor + uid: >- + excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#gradientMaximumColor:member + package: excel! + fullName: gradientMaximumColor + summary: >- + For EACH ITEM in the collection: Specifies the color for maximum value of + a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientMaximumColor?: boolean;' + return: + type: boolean + - name: gradientMaximumType + uid: >- + excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#gradientMaximumType:member + package: excel! + fullName: gradientMaximumType + summary: >- + For EACH ITEM in the collection: Specifies the type for maximum value of a + region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientMaximumType?: boolean;' + return: + type: boolean + - name: gradientMaximumValue + uid: >- + excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#gradientMaximumValue:member + package: excel! + fullName: gradientMaximumValue + summary: >- + For EACH ITEM in the collection: Specifies the maximum value of a region + map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientMaximumValue?: boolean;' + return: + type: boolean + - name: gradientMidpointColor + uid: >- + excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#gradientMidpointColor:member + package: excel! + fullName: gradientMidpointColor + summary: >- + For EACH ITEM in the collection: Specifies the color for the midpoint + value of a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientMidpointColor?: boolean;' + return: + type: boolean + - name: gradientMidpointType + uid: >- + excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#gradientMidpointType:member + package: excel! + fullName: gradientMidpointType + summary: >- + For EACH ITEM in the collection: Specifies the type for the midpoint value + of a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientMidpointType?: boolean;' + return: + type: boolean + - name: gradientMidpointValue + uid: >- + excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#gradientMidpointValue:member + package: excel! + fullName: gradientMidpointValue + summary: >- + For EACH ITEM in the collection: Specifies the midpoint value of a region + map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientMidpointValue?: boolean;' + return: + type: boolean + - name: gradientMinimumColor + uid: >- + excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#gradientMinimumColor:member + package: excel! + fullName: gradientMinimumColor + summary: >- + For EACH ITEM in the collection: Specifies the color for the minimum value + of a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientMinimumColor?: boolean;' + return: + type: boolean + - name: gradientMinimumType + uid: >- + excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#gradientMinimumType:member + package: excel! + fullName: gradientMinimumType + summary: >- + For EACH ITEM in the collection: Specifies the type for the minimum value + of a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientMinimumType?: boolean;' + return: + type: boolean + - name: gradientMinimumValue + uid: >- + excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#gradientMinimumValue:member + package: excel! + fullName: gradientMinimumValue + summary: >- + For EACH ITEM in the collection: Specifies the minimum value of a region + map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientMinimumValue?: boolean;' + return: + type: boolean + - name: gradientStyle + uid: >- + excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#gradientStyle:member + package: excel! + fullName: gradientStyle + summary: >- + For EACH ITEM in the collection: Specifies the series gradient style of a + region map chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientStyle?: boolean;' + return: + type: boolean + - name: hasDataLabels + uid: >- + excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#hasDataLabels:member + package: excel! + fullName: hasDataLabels + summary: 'For EACH ITEM in the collection: Specifies if the series has data labels.' + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'hasDataLabels?: boolean;' + return: + type: boolean + - name: invertColor + uid: excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#invertColor:member + package: excel! + fullName: invertColor + summary: >- + For EACH ITEM in the collection: Specifies the fill color for negative + data points in a series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'invertColor?: boolean;' + return: + type: boolean + - name: invertIfNegative + uid: >- + excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#invertIfNegative:member + package: excel! + fullName: invertIfNegative + summary: >- + For EACH ITEM in the collection: True if Excel inverts the pattern in the + item when it corresponds to a negative number. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'invertIfNegative?: boolean;' + return: + type: boolean + - name: mapOptions + uid: excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#mapOptions:member + package: excel! + fullName: mapOptions + summary: >- + For EACH ITEM in the collection: Encapsulates the options for a region map + chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'mapOptions?: Excel.Interfaces.ChartMapOptionsLoadOptions;' + return: + type: >- + + - name: markerBackgroundColor + uid: >- + excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#markerBackgroundColor:member + package: excel! + fullName: markerBackgroundColor + summary: >- + For EACH ITEM in the collection: Specifies the marker background color of + a chart series. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'markerBackgroundColor?: boolean;' + return: + type: boolean + - name: markerForegroundColor + uid: >- + excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#markerForegroundColor:member + package: excel! + fullName: markerForegroundColor + summary: >- + For EACH ITEM in the collection: Specifies the marker foreground color of + a chart series. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'markerForegroundColor?: boolean;' + return: + type: boolean + - name: markerSize + uid: excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#markerSize:member + package: excel! + fullName: markerSize + summary: >- + For EACH ITEM in the collection: Specifies the marker size of a chart + series. The supported size range is 2 to 72. This method returns an + InvalidArgument error if it's set with a size outside of the supported + range. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'markerSize?: boolean;' + return: + type: boolean + - name: markerStyle + uid: excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#markerStyle:member + package: excel! + fullName: markerStyle + summary: >- + For EACH ITEM in the collection: Specifies the marker style of a chart + series. See `Excel.ChartMarkerStyle` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'markerStyle?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#name:member + package: excel! + fullName: name + summary: >- + For EACH ITEM in the collection: Specifies the name of a series in a + chart. The name's length should not be greater than 255 characters. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: overlap + uid: excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#overlap:member + package: excel! + fullName: overlap + summary: >- + For EACH ITEM in the collection: Specifies how bars and columns are + positioned. Can be a value between -100 and 100. Applies only to 2-D bar + and 2-D column charts. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'overlap?: boolean;' + return: + type: boolean + - name: parentLabelStrategy + uid: >- + excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#parentLabelStrategy:member + package: excel! + fullName: parentLabelStrategy + summary: >- + For EACH ITEM in the collection: Specifies the series parent label + strategy area for a treemap chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'parentLabelStrategy?: boolean;' + return: + type: boolean + - name: plotOrder + uid: excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#plotOrder:member + package: excel! + fullName: plotOrder + summary: >- + For EACH ITEM in the collection: Specifies the plot order of a chart + series within the chart group. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'plotOrder?: boolean;' + return: + type: boolean + - name: points + uid: excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#points:member + package: excel! + fullName: points + summary: >- + For EACH ITEM in the collection: Returns a collection of all points in the + series. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'points?: Excel.Interfaces.ChartPointsCollectionLoadOptions;' + return: + type: >- + + - name: secondPlotSize + uid: >- + excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#secondPlotSize:member + package: excel! + fullName: secondPlotSize + summary: >- + For EACH ITEM in the collection: Specifies the size of the secondary + section of either a pie-of-pie chart or a bar-of-pie chart, as a + percentage of the size of the primary pie. Can be a value from 5 to 200. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'secondPlotSize?: boolean;' + return: + type: boolean + - name: showConnectorLines + uid: >- + excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#showConnectorLines:member + package: excel! + fullName: showConnectorLines + summary: >- + For EACH ITEM in the collection: Specifies whether connector lines are + shown in waterfall charts. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showConnectorLines?: boolean;' + return: + type: boolean + - name: showLeaderLines + uid: >- + excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#showLeaderLines:member + package: excel! + fullName: showLeaderLines + summary: >- + For EACH ITEM in the collection: Specifies whether leader lines are + displayed for each data label in the series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showLeaderLines?: boolean;' + return: + type: boolean + - name: showShadow + uid: excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#showShadow:member + package: excel! + fullName: showShadow + summary: 'For EACH ITEM in the collection: Specifies if the series has a shadow.' + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showShadow?: boolean;' + return: + type: boolean + - name: smooth + uid: excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#smooth:member + package: excel! + fullName: smooth + summary: >- + For EACH ITEM in the collection: Specifies if the series is smooth. Only + applicable to line and scatter charts. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'smooth?: boolean;' + return: + type: boolean + - name: splitType + uid: excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#splitType:member + package: excel! + fullName: splitType + summary: >- + For EACH ITEM in the collection: Specifies the way the two sections of + either a pie-of-pie chart or a bar-of-pie chart are split. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'splitType?: boolean;' + return: + type: boolean + - name: splitValue + uid: excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#splitValue:member + package: excel! + fullName: splitValue + summary: >- + For EACH ITEM in the collection: Specifies the threshold value that + separates two sections of either a pie-of-pie chart or a bar-of-pie chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'splitValue?: boolean;' + return: + type: boolean + - name: varyByCategories + uid: >- + excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#varyByCategories:member + package: excel! + fullName: varyByCategories + summary: >- + For EACH ITEM in the collection: True if Excel assigns a different color + or pattern to each data marker. The chart must contain only one series. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'varyByCategories?: boolean;' + return: + type: boolean + - name: xErrorBars + uid: excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#xErrorBars:member + package: excel! + fullName: xErrorBars + summary: >- + For EACH ITEM in the collection: Represents the error bar object of a + chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'xErrorBars?: Excel.Interfaces.ChartErrorBarsLoadOptions;' + return: + type: >- + + - name: yErrorBars + uid: excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions#yErrorBars:member + package: excel! + fullName: yErrorBars + summary: >- + For EACH ITEM in the collection: Represents the error bar object of a + chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'yErrorBars?: Excel.Interfaces.ChartErrorBarsLoadOptions;' + return: + type: >- + diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartseriescollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartseriescollectionupdatedata.yml new file mode 100644 index 0000000000..30426fcc57 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartseriescollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartSeriesCollectionUpdateData +uid: excel!Excel.Interfaces.ChartSeriesCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartSeriesCollectionUpdateData +summary: >- + An interface for updating data on the `ChartSeriesCollection` object, for use + in `chartSeriesCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.ChartSeriesCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.ChartSeriesData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartseriesdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartseriesdata.yml new file mode 100644 index 0000000000..34f82f4906 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartseriesdata.yml @@ -0,0 +1,827 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartSeriesData +uid: excel!Excel.Interfaces.ChartSeriesData:interface +package: excel! +fullName: Excel.Interfaces.ChartSeriesData +summary: >- + An interface describing the data returned by calling + `chartSeries.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: axisGroup + uid: excel!Excel.Interfaces.ChartSeriesData#axisGroup:member + package: excel! + fullName: axisGroup + summary: Specifies the group for the specified series. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'axisGroup?: Excel.ChartAxisGroup | "Primary" | "Secondary";' + return: + type: >- + | "Primary" | + "Secondary" + - name: binOptions + uid: excel!Excel.Interfaces.ChartSeriesData#binOptions:member + package: excel! + fullName: binOptions + summary: Encapsulates the bin options for histogram charts and pareto charts. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'binOptions?: Excel.Interfaces.ChartBinOptionsData;' + return: + type: + - name: boxwhiskerOptions + uid: excel!Excel.Interfaces.ChartSeriesData#boxwhiskerOptions:member + package: excel! + fullName: boxwhiskerOptions + summary: Encapsulates the options for the box and whisker charts. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'boxwhiskerOptions?: Excel.Interfaces.ChartBoxwhiskerOptionsData;' + return: + type: >- + + - name: bubbleScale + uid: excel!Excel.Interfaces.ChartSeriesData#bubbleScale:member + package: excel! + fullName: bubbleScale + summary: >- + This can be an integer value from 0 (zero) to 300, representing the + percentage of the default size. This property only applies to bubble + charts. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'bubbleScale?: number;' + return: + type: number + - name: chartType + uid: excel!Excel.Interfaces.ChartSeriesData#chartType:member + package: excel! + fullName: chartType + summary: Represents the chart type of a series. See `Excel.ChartType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + chartType?: Excel.ChartType | "Invalid" | "ColumnClustered" | + "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | + "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" + | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | + "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | + "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | + "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | + "XYScatterSmoothNoMarkers" | "XYScatterLines" | + "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | + "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | + "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | + "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | + "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" + | "CylinderColClustered" | "CylinderColStacked" | + "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" + | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | + "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | + "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | + "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | + "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | + "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | + "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | + "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | + "Sunburst" | "Funnel"; + return: + type: >- + | "Invalid" | + "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | + "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | + "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | + "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" + | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | + "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | + "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | + "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | + "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | + "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | + "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | + "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | + "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | + "CylinderColStacked100" | "CylinderBarClustered" | + "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | + "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | + "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | + "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | + "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | + "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" + | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | + "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | + "Treemap" | "Waterfall" | "Sunburst" | "Funnel" + - name: dataLabels + uid: excel!Excel.Interfaces.ChartSeriesData#dataLabels:member + package: excel! + fullName: dataLabels + summary: Represents a collection of all data labels in the series. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'dataLabels?: Excel.Interfaces.ChartDataLabelsData;' + return: + type: + - name: doughnutHoleSize + uid: excel!Excel.Interfaces.ChartSeriesData#doughnutHoleSize:member + package: excel! + fullName: doughnutHoleSize + summary: >- + Represents the doughnut hole size of a chart series. Only valid on + doughnut and doughnut exploded charts. Throws an `InvalidArgument` error + on invalid charts. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'doughnutHoleSize?: number;' + return: + type: number + - name: explosion + uid: excel!Excel.Interfaces.ChartSeriesData#explosion:member + package: excel! + fullName: explosion + summary: >- + Specifies the explosion value for a pie-chart or doughnut-chart slice. + Returns 0 (zero) if there's no explosion (the tip of the slice is in the + center of the pie). + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'explosion?: number;' + return: + type: number + - name: filtered + uid: excel!Excel.Interfaces.ChartSeriesData#filtered:member + package: excel! + fullName: filtered + summary: Specifies if the series is filtered. Not applicable for surface charts. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'filtered?: boolean;' + return: + type: boolean + - name: firstSliceAngle + uid: excel!Excel.Interfaces.ChartSeriesData#firstSliceAngle:member + package: excel! + fullName: firstSliceAngle + summary: >- + Specifies the angle of the first pie-chart or doughnut-chart slice, in + degrees (clockwise from vertical). Applies only to pie, 3-D pie, and + doughnut charts. Can be a value from 0 through 360. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'firstSliceAngle?: number;' + return: + type: number + - name: format + uid: excel!Excel.Interfaces.ChartSeriesData#format:member + package: excel! + fullName: format + summary: >- + Represents the formatting of a chart series, which includes fill and line + formatting. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartSeriesFormatData;' + return: + type: + - name: gapWidth + uid: excel!Excel.Interfaces.ChartSeriesData#gapWidth:member + package: excel! + fullName: gapWidth + summary: >- + Represents the gap width of a chart series. Only valid on bar and column + charts, as well as specific classes of line and pie charts. Throws an + invalid argument exception on invalid charts. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gapWidth?: number;' + return: + type: number + - name: gradientMaximumColor + uid: excel!Excel.Interfaces.ChartSeriesData#gradientMaximumColor:member + package: excel! + fullName: gradientMaximumColor + summary: Specifies the color for maximum value of a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientMaximumColor?: string;' + return: + type: string + - name: gradientMaximumType + uid: excel!Excel.Interfaces.ChartSeriesData#gradientMaximumType:member + package: excel! + fullName: gradientMaximumType + summary: Specifies the type for maximum value of a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + gradientMaximumType?: Excel.ChartGradientStyleType | "ExtremeValue" | + "Number" | "Percent"; + return: + type: >- + | + "ExtremeValue" | "Number" | "Percent" + - name: gradientMaximumValue + uid: excel!Excel.Interfaces.ChartSeriesData#gradientMaximumValue:member + package: excel! + fullName: gradientMaximumValue + summary: Specifies the maximum value of a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientMaximumValue?: number;' + return: + type: number + - name: gradientMidpointColor + uid: excel!Excel.Interfaces.ChartSeriesData#gradientMidpointColor:member + package: excel! + fullName: gradientMidpointColor + summary: Specifies the color for the midpoint value of a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientMidpointColor?: string;' + return: + type: string + - name: gradientMidpointType + uid: excel!Excel.Interfaces.ChartSeriesData#gradientMidpointType:member + package: excel! + fullName: gradientMidpointType + summary: Specifies the type for the midpoint value of a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + gradientMidpointType?: Excel.ChartGradientStyleType | "ExtremeValue" | + "Number" | "Percent"; + return: + type: >- + | + "ExtremeValue" | "Number" | "Percent" + - name: gradientMidpointValue + uid: excel!Excel.Interfaces.ChartSeriesData#gradientMidpointValue:member + package: excel! + fullName: gradientMidpointValue + summary: Specifies the midpoint value of a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientMidpointValue?: number;' + return: + type: number + - name: gradientMinimumColor + uid: excel!Excel.Interfaces.ChartSeriesData#gradientMinimumColor:member + package: excel! + fullName: gradientMinimumColor + summary: Specifies the color for the minimum value of a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientMinimumColor?: string;' + return: + type: string + - name: gradientMinimumType + uid: excel!Excel.Interfaces.ChartSeriesData#gradientMinimumType:member + package: excel! + fullName: gradientMinimumType + summary: Specifies the type for the minimum value of a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + gradientMinimumType?: Excel.ChartGradientStyleType | "ExtremeValue" | + "Number" | "Percent"; + return: + type: >- + | + "ExtremeValue" | "Number" | "Percent" + - name: gradientMinimumValue + uid: excel!Excel.Interfaces.ChartSeriesData#gradientMinimumValue:member + package: excel! + fullName: gradientMinimumValue + summary: Specifies the minimum value of a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientMinimumValue?: number;' + return: + type: number + - name: gradientStyle + uid: excel!Excel.Interfaces.ChartSeriesData#gradientStyle:member + package: excel! + fullName: gradientStyle + summary: Specifies the series gradient style of a region map chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + gradientStyle?: Excel.ChartGradientStyle | "TwoPhaseColor" | + "ThreePhaseColor"; + return: + type: >- + | "TwoPhaseColor" | + "ThreePhaseColor" + - name: hasDataLabels + uid: excel!Excel.Interfaces.ChartSeriesData#hasDataLabels:member + package: excel! + fullName: hasDataLabels + summary: Specifies if the series has data labels. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'hasDataLabels?: boolean;' + return: + type: boolean + - name: invertColor + uid: excel!Excel.Interfaces.ChartSeriesData#invertColor:member + package: excel! + fullName: invertColor + summary: Specifies the fill color for negative data points in a series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'invertColor?: string;' + return: + type: string + - name: invertIfNegative + uid: excel!Excel.Interfaces.ChartSeriesData#invertIfNegative:member + package: excel! + fullName: invertIfNegative + summary: >- + True if Excel inverts the pattern in the item when it corresponds to a + negative number. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'invertIfNegative?: boolean;' + return: + type: boolean + - name: mapOptions + uid: excel!Excel.Interfaces.ChartSeriesData#mapOptions:member + package: excel! + fullName: mapOptions + summary: Encapsulates the options for a region map chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'mapOptions?: Excel.Interfaces.ChartMapOptionsData;' + return: + type: + - name: markerBackgroundColor + uid: excel!Excel.Interfaces.ChartSeriesData#markerBackgroundColor:member + package: excel! + fullName: markerBackgroundColor + summary: Specifies the marker background color of a chart series. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'markerBackgroundColor?: string;' + return: + type: string + - name: markerForegroundColor + uid: excel!Excel.Interfaces.ChartSeriesData#markerForegroundColor:member + package: excel! + fullName: markerForegroundColor + summary: Specifies the marker foreground color of a chart series. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'markerForegroundColor?: string;' + return: + type: string + - name: markerSize + uid: excel!Excel.Interfaces.ChartSeriesData#markerSize:member + package: excel! + fullName: markerSize + summary: >- + Specifies the marker size of a chart series. The supported size range is 2 + to 72. This method returns an InvalidArgument error if it's set with a + size outside of the supported range. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'markerSize?: number;' + return: + type: number + - name: markerStyle + uid: excel!Excel.Interfaces.ChartSeriesData#markerStyle:member + package: excel! + fullName: markerStyle + summary: >- + Specifies the marker style of a chart series. See `Excel.ChartMarkerStyle` + for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + markerStyle?: Excel.ChartMarkerStyle | "Invalid" | "Automatic" | "None" + | "Square" | "Diamond" | "Triangle" | "X" | "Star" | "Dot" | "Dash" | + "Circle" | "Plus" | "Picture"; + return: + type: >- + | "Invalid" | + "Automatic" | "None" | "Square" | "Diamond" | "Triangle" | "X" | + "Star" | "Dot" | "Dash" | "Circle" | "Plus" | "Picture" + - name: name + uid: excel!Excel.Interfaces.ChartSeriesData#name:member + package: excel! + fullName: name + summary: >- + Specifies the name of a series in a chart. The name's length should not be + greater than 255 characters. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: overlap + uid: excel!Excel.Interfaces.ChartSeriesData#overlap:member + package: excel! + fullName: overlap + summary: >- + Specifies how bars and columns are positioned. Can be a value between -100 + and 100. Applies only to 2-D bar and 2-D column charts. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'overlap?: number;' + return: + type: number + - name: parentLabelStrategy + uid: excel!Excel.Interfaces.ChartSeriesData#parentLabelStrategy:member + package: excel! + fullName: parentLabelStrategy + summary: Specifies the series parent label strategy area for a treemap chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + parentLabelStrategy?: Excel.ChartParentLabelStrategy | "None" | "Banner" + | "Overlapping"; + return: + type: >- + | "None" | + "Banner" | "Overlapping" + - name: plotOrder + uid: excel!Excel.Interfaces.ChartSeriesData#plotOrder:member + package: excel! + fullName: plotOrder + summary: Specifies the plot order of a chart series within the chart group. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'plotOrder?: number;' + return: + type: number + - name: points + uid: excel!Excel.Interfaces.ChartSeriesData#points:member + package: excel! + fullName: points + summary: Returns a collection of all points in the series. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'points?: Excel.Interfaces.ChartPointData[];' + return: + type: [] + - name: secondPlotSize + uid: excel!Excel.Interfaces.ChartSeriesData#secondPlotSize:member + package: excel! + fullName: secondPlotSize + summary: >- + Specifies the size of the secondary section of either a pie-of-pie chart + or a bar-of-pie chart, as a percentage of the size of the primary pie. Can + be a value from 5 to 200. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'secondPlotSize?: number;' + return: + type: number + - name: showConnectorLines + uid: excel!Excel.Interfaces.ChartSeriesData#showConnectorLines:member + package: excel! + fullName: showConnectorLines + summary: Specifies whether connector lines are shown in waterfall charts. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showConnectorLines?: boolean;' + return: + type: boolean + - name: showLeaderLines + uid: excel!Excel.Interfaces.ChartSeriesData#showLeaderLines:member + package: excel! + fullName: showLeaderLines + summary: >- + Specifies whether leader lines are displayed for each data label in the + series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showLeaderLines?: boolean;' + return: + type: boolean + - name: showShadow + uid: excel!Excel.Interfaces.ChartSeriesData#showShadow:member + package: excel! + fullName: showShadow + summary: Specifies if the series has a shadow. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showShadow?: boolean;' + return: + type: boolean + - name: smooth + uid: excel!Excel.Interfaces.ChartSeriesData#smooth:member + package: excel! + fullName: smooth + summary: >- + Specifies if the series is smooth. Only applicable to line and scatter + charts. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'smooth?: boolean;' + return: + type: boolean + - name: splitType + uid: excel!Excel.Interfaces.ChartSeriesData#splitType:member + package: excel! + fullName: splitType + summary: >- + Specifies the way the two sections of either a pie-of-pie chart or a + bar-of-pie chart are split. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + splitType?: Excel.ChartSplitType | "SplitByPosition" | "SplitByValue" | + "SplitByPercentValue" | "SplitByCustomSplit"; + return: + type: >- + | "SplitByPosition" | + "SplitByValue" | "SplitByPercentValue" | "SplitByCustomSplit" + - name: splitValue + uid: excel!Excel.Interfaces.ChartSeriesData#splitValue:member + package: excel! + fullName: splitValue + summary: >- + Specifies the threshold value that separates two sections of either a + pie-of-pie chart or a bar-of-pie chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'splitValue?: number;' + return: + type: number + - name: trendlines + uid: excel!Excel.Interfaces.ChartSeriesData#trendlines:member + package: excel! + fullName: trendlines + summary: The collection of trendlines in the series. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'trendlines?: Excel.Interfaces.ChartTrendlineData[];' + return: + type: [] + - name: varyByCategories + uid: excel!Excel.Interfaces.ChartSeriesData#varyByCategories:member + package: excel! + fullName: varyByCategories + summary: >- + True if Excel assigns a different color or pattern to each data marker. + The chart must contain only one series. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'varyByCategories?: boolean;' + return: + type: boolean + - name: xErrorBars + uid: excel!Excel.Interfaces.ChartSeriesData#xErrorBars:member + package: excel! + fullName: xErrorBars + summary: Represents the error bar object of a chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'xErrorBars?: Excel.Interfaces.ChartErrorBarsData;' + return: + type: + - name: yErrorBars + uid: excel!Excel.Interfaces.ChartSeriesData#yErrorBars:member + package: excel! + fullName: yErrorBars + summary: Represents the error bar object of a chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'yErrorBars?: Excel.Interfaces.ChartErrorBarsData;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartseriesformatdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartseriesformatdata.yml new file mode 100644 index 0000000000..9530db4ea5 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartseriesformatdata.yml @@ -0,0 +1,29 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartSeriesFormatData +uid: excel!Excel.Interfaces.ChartSeriesFormatData:interface +package: excel! +fullName: Excel.Interfaces.ChartSeriesFormatData +summary: >- + An interface describing the data returned by calling + `chartSeriesFormat.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: line + uid: excel!Excel.Interfaces.ChartSeriesFormatData#line:member + package: excel! + fullName: line + summary: Represents line formatting. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'line?: Excel.Interfaces.ChartLineFormatData;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartseriesformatloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartseriesformatloadoptions.yml new file mode 100644 index 0000000000..9d2c9273ed --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartseriesformatloadoptions.yml @@ -0,0 +1,47 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartSeriesFormatLoadOptions +uid: excel!Excel.Interfaces.ChartSeriesFormatLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartSeriesFormatLoadOptions +summary: Encapsulates the format properties for the chart series +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartSeriesFormatLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: line + uid: excel!Excel.Interfaces.ChartSeriesFormatLoadOptions#line:member + package: excel! + fullName: line + summary: Represents line formatting. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'line?: Excel.Interfaces.ChartLineFormatLoadOptions;' + return: + type: >- + diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartseriesformatupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartseriesformatupdatedata.yml new file mode 100644 index 0000000000..808a1b191a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartseriesformatupdatedata.yml @@ -0,0 +1,31 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartSeriesFormatUpdateData +uid: excel!Excel.Interfaces.ChartSeriesFormatUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartSeriesFormatUpdateData +summary: >- + An interface for updating data on the `ChartSeriesFormat` object, for use in + `chartSeriesFormat.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: line + uid: excel!Excel.Interfaces.ChartSeriesFormatUpdateData#line:member + package: excel! + fullName: line + summary: Represents line formatting. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'line?: Excel.Interfaces.ChartLineFormatUpdateData;' + return: + type: >- + diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartseriesloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartseriesloadoptions.yml new file mode 100644 index 0000000000..9e5756a3ba --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartseriesloadoptions.yml @@ -0,0 +1,764 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartSeriesLoadOptions +uid: excel!Excel.Interfaces.ChartSeriesLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartSeriesLoadOptions +summary: Represents a series in a chart. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: axisGroup + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#axisGroup:member + package: excel! + fullName: axisGroup + summary: Specifies the group for the specified series. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'axisGroup?: boolean;' + return: + type: boolean + - name: binOptions + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#binOptions:member + package: excel! + fullName: binOptions + summary: Encapsulates the bin options for histogram charts and pareto charts. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'binOptions?: Excel.Interfaces.ChartBinOptionsLoadOptions;' + return: + type: >- + + - name: boxwhiskerOptions + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#boxwhiskerOptions:member + package: excel! + fullName: boxwhiskerOptions + summary: Encapsulates the options for the box and whisker charts. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'boxwhiskerOptions?: Excel.Interfaces.ChartBoxwhiskerOptionsLoadOptions;' + return: + type: >- + + - name: bubbleScale + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#bubbleScale:member + package: excel! + fullName: bubbleScale + summary: >- + This can be an integer value from 0 (zero) to 300, representing the + percentage of the default size. This property only applies to bubble + charts. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'bubbleScale?: boolean;' + return: + type: boolean + - name: chartType + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#chartType:member + package: excel! + fullName: chartType + summary: Represents the chart type of a series. See `Excel.ChartType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'chartType?: boolean;' + return: + type: boolean + - name: dataLabels + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#dataLabels:member + package: excel! + fullName: dataLabels + summary: Represents a collection of all data labels in the series. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'dataLabels?: Excel.Interfaces.ChartDataLabelsLoadOptions;' + return: + type: >- + + - name: doughnutHoleSize + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#doughnutHoleSize:member + package: excel! + fullName: doughnutHoleSize + summary: >- + Represents the doughnut hole size of a chart series. Only valid on + doughnut and doughnut exploded charts. Throws an `InvalidArgument` error + on invalid charts. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'doughnutHoleSize?: boolean;' + return: + type: boolean + - name: explosion + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#explosion:member + package: excel! + fullName: explosion + summary: >- + Specifies the explosion value for a pie-chart or doughnut-chart slice. + Returns 0 (zero) if there's no explosion (the tip of the slice is in the + center of the pie). + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'explosion?: boolean;' + return: + type: boolean + - name: filtered + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#filtered:member + package: excel! + fullName: filtered + summary: Specifies if the series is filtered. Not applicable for surface charts. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'filtered?: boolean;' + return: + type: boolean + - name: firstSliceAngle + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#firstSliceAngle:member + package: excel! + fullName: firstSliceAngle + summary: >- + Specifies the angle of the first pie-chart or doughnut-chart slice, in + degrees (clockwise from vertical). Applies only to pie, 3-D pie, and + doughnut charts. Can be a value from 0 through 360. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'firstSliceAngle?: boolean;' + return: + type: boolean + - name: format + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#format:member + package: excel! + fullName: format + summary: >- + Represents the formatting of a chart series, which includes fill and line + formatting. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartSeriesFormatLoadOptions;' + return: + type: >- + + - name: gapWidth + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#gapWidth:member + package: excel! + fullName: gapWidth + summary: >- + Represents the gap width of a chart series. Only valid on bar and column + charts, as well as specific classes of line and pie charts. Throws an + invalid argument exception on invalid charts. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gapWidth?: boolean;' + return: + type: boolean + - name: gradientMaximumColor + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#gradientMaximumColor:member + package: excel! + fullName: gradientMaximumColor + summary: Specifies the color for maximum value of a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientMaximumColor?: boolean;' + return: + type: boolean + - name: gradientMaximumType + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#gradientMaximumType:member + package: excel! + fullName: gradientMaximumType + summary: Specifies the type for maximum value of a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientMaximumType?: boolean;' + return: + type: boolean + - name: gradientMaximumValue + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#gradientMaximumValue:member + package: excel! + fullName: gradientMaximumValue + summary: Specifies the maximum value of a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientMaximumValue?: boolean;' + return: + type: boolean + - name: gradientMidpointColor + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#gradientMidpointColor:member + package: excel! + fullName: gradientMidpointColor + summary: Specifies the color for the midpoint value of a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientMidpointColor?: boolean;' + return: + type: boolean + - name: gradientMidpointType + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#gradientMidpointType:member + package: excel! + fullName: gradientMidpointType + summary: Specifies the type for the midpoint value of a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientMidpointType?: boolean;' + return: + type: boolean + - name: gradientMidpointValue + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#gradientMidpointValue:member + package: excel! + fullName: gradientMidpointValue + summary: Specifies the midpoint value of a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientMidpointValue?: boolean;' + return: + type: boolean + - name: gradientMinimumColor + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#gradientMinimumColor:member + package: excel! + fullName: gradientMinimumColor + summary: Specifies the color for the minimum value of a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientMinimumColor?: boolean;' + return: + type: boolean + - name: gradientMinimumType + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#gradientMinimumType:member + package: excel! + fullName: gradientMinimumType + summary: Specifies the type for the minimum value of a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientMinimumType?: boolean;' + return: + type: boolean + - name: gradientMinimumValue + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#gradientMinimumValue:member + package: excel! + fullName: gradientMinimumValue + summary: Specifies the minimum value of a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientMinimumValue?: boolean;' + return: + type: boolean + - name: gradientStyle + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#gradientStyle:member + package: excel! + fullName: gradientStyle + summary: Specifies the series gradient style of a region map chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientStyle?: boolean;' + return: + type: boolean + - name: hasDataLabels + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#hasDataLabels:member + package: excel! + fullName: hasDataLabels + summary: Specifies if the series has data labels. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'hasDataLabels?: boolean;' + return: + type: boolean + - name: invertColor + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#invertColor:member + package: excel! + fullName: invertColor + summary: Specifies the fill color for negative data points in a series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'invertColor?: boolean;' + return: + type: boolean + - name: invertIfNegative + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#invertIfNegative:member + package: excel! + fullName: invertIfNegative + summary: >- + True if Excel inverts the pattern in the item when it corresponds to a + negative number. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'invertIfNegative?: boolean;' + return: + type: boolean + - name: mapOptions + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#mapOptions:member + package: excel! + fullName: mapOptions + summary: Encapsulates the options for a region map chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'mapOptions?: Excel.Interfaces.ChartMapOptionsLoadOptions;' + return: + type: >- + + - name: markerBackgroundColor + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#markerBackgroundColor:member + package: excel! + fullName: markerBackgroundColor + summary: Specifies the marker background color of a chart series. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'markerBackgroundColor?: boolean;' + return: + type: boolean + - name: markerForegroundColor + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#markerForegroundColor:member + package: excel! + fullName: markerForegroundColor + summary: Specifies the marker foreground color of a chart series. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'markerForegroundColor?: boolean;' + return: + type: boolean + - name: markerSize + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#markerSize:member + package: excel! + fullName: markerSize + summary: >- + Specifies the marker size of a chart series. The supported size range is 2 + to 72. This method returns an InvalidArgument error if it's set with a + size outside of the supported range. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'markerSize?: boolean;' + return: + type: boolean + - name: markerStyle + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#markerStyle:member + package: excel! + fullName: markerStyle + summary: >- + Specifies the marker style of a chart series. See `Excel.ChartMarkerStyle` + for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'markerStyle?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#name:member + package: excel! + fullName: name + summary: >- + Specifies the name of a series in a chart. The name's length should not be + greater than 255 characters. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: overlap + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#overlap:member + package: excel! + fullName: overlap + summary: >- + Specifies how bars and columns are positioned. Can be a value between -100 + and 100. Applies only to 2-D bar and 2-D column charts. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'overlap?: boolean;' + return: + type: boolean + - name: parentLabelStrategy + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#parentLabelStrategy:member + package: excel! + fullName: parentLabelStrategy + summary: Specifies the series parent label strategy area for a treemap chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'parentLabelStrategy?: boolean;' + return: + type: boolean + - name: plotOrder + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#plotOrder:member + package: excel! + fullName: plotOrder + summary: Specifies the plot order of a chart series within the chart group. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'plotOrder?: boolean;' + return: + type: boolean + - name: points + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#points:member + package: excel! + fullName: points + summary: Returns a collection of all points in the series. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'points?: Excel.Interfaces.ChartPointsCollectionLoadOptions;' + return: + type: >- + + - name: secondPlotSize + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#secondPlotSize:member + package: excel! + fullName: secondPlotSize + summary: >- + Specifies the size of the secondary section of either a pie-of-pie chart + or a bar-of-pie chart, as a percentage of the size of the primary pie. Can + be a value from 5 to 200. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'secondPlotSize?: boolean;' + return: + type: boolean + - name: showConnectorLines + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#showConnectorLines:member + package: excel! + fullName: showConnectorLines + summary: Specifies whether connector lines are shown in waterfall charts. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showConnectorLines?: boolean;' + return: + type: boolean + - name: showLeaderLines + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#showLeaderLines:member + package: excel! + fullName: showLeaderLines + summary: >- + Specifies whether leader lines are displayed for each data label in the + series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showLeaderLines?: boolean;' + return: + type: boolean + - name: showShadow + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#showShadow:member + package: excel! + fullName: showShadow + summary: Specifies if the series has a shadow. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showShadow?: boolean;' + return: + type: boolean + - name: smooth + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#smooth:member + package: excel! + fullName: smooth + summary: >- + Specifies if the series is smooth. Only applicable to line and scatter + charts. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'smooth?: boolean;' + return: + type: boolean + - name: splitType + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#splitType:member + package: excel! + fullName: splitType + summary: >- + Specifies the way the two sections of either a pie-of-pie chart or a + bar-of-pie chart are split. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'splitType?: boolean;' + return: + type: boolean + - name: splitValue + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#splitValue:member + package: excel! + fullName: splitValue + summary: >- + Specifies the threshold value that separates two sections of either a + pie-of-pie chart or a bar-of-pie chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'splitValue?: boolean;' + return: + type: boolean + - name: varyByCategories + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#varyByCategories:member + package: excel! + fullName: varyByCategories + summary: >- + True if Excel assigns a different color or pattern to each data marker. + The chart must contain only one series. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'varyByCategories?: boolean;' + return: + type: boolean + - name: xErrorBars + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#xErrorBars:member + package: excel! + fullName: xErrorBars + summary: Represents the error bar object of a chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'xErrorBars?: Excel.Interfaces.ChartErrorBarsLoadOptions;' + return: + type: >- + + - name: yErrorBars + uid: excel!Excel.Interfaces.ChartSeriesLoadOptions#yErrorBars:member + package: excel! + fullName: yErrorBars + summary: Represents the error bar object of a chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'yErrorBars?: Excel.Interfaces.ChartErrorBarsLoadOptions;' + return: + type: >- + diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartseriesupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartseriesupdatedata.yml new file mode 100644 index 0000000000..65f9c32395 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartseriesupdatedata.yml @@ -0,0 +1,810 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartSeriesUpdateData +uid: excel!Excel.Interfaces.ChartSeriesUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartSeriesUpdateData +summary: >- + An interface for updating data on the `ChartSeries` object, for use in + `chartSeries.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: axisGroup + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#axisGroup:member + package: excel! + fullName: axisGroup + summary: Specifies the group for the specified series. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'axisGroup?: Excel.ChartAxisGroup | "Primary" | "Secondary";' + return: + type: >- + | "Primary" | + "Secondary" + - name: binOptions + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#binOptions:member + package: excel! + fullName: binOptions + summary: Encapsulates the bin options for histogram charts and pareto charts. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'binOptions?: Excel.Interfaces.ChartBinOptionsUpdateData;' + return: + type: >- + + - name: boxwhiskerOptions + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#boxwhiskerOptions:member + package: excel! + fullName: boxwhiskerOptions + summary: Encapsulates the options for the box and whisker charts. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'boxwhiskerOptions?: Excel.Interfaces.ChartBoxwhiskerOptionsUpdateData;' + return: + type: >- + + - name: bubbleScale + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#bubbleScale:member + package: excel! + fullName: bubbleScale + summary: >- + This can be an integer value from 0 (zero) to 300, representing the + percentage of the default size. This property only applies to bubble + charts. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'bubbleScale?: number;' + return: + type: number + - name: chartType + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#chartType:member + package: excel! + fullName: chartType + summary: Represents the chart type of a series. See `Excel.ChartType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + chartType?: Excel.ChartType | "Invalid" | "ColumnClustered" | + "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | + "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" + | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | + "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | + "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | + "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | + "XYScatterSmoothNoMarkers" | "XYScatterLines" | + "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | + "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | + "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | + "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | + "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" + | "CylinderColClustered" | "CylinderColStacked" | + "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" + | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | + "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | + "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | + "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | + "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | + "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | + "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | + "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | + "Sunburst" | "Funnel"; + return: + type: >- + | "Invalid" | + "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | + "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | + "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | + "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" + | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | + "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | + "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | + "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | + "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | + "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | + "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | + "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | + "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | + "CylinderColStacked100" | "CylinderBarClustered" | + "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | + "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | + "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | + "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | + "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | + "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" + | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | + "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | + "Treemap" | "Waterfall" | "Sunburst" | "Funnel" + - name: dataLabels + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#dataLabels:member + package: excel! + fullName: dataLabels + summary: Represents a collection of all data labels in the series. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'dataLabels?: Excel.Interfaces.ChartDataLabelsUpdateData;' + return: + type: >- + + - name: doughnutHoleSize + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#doughnutHoleSize:member + package: excel! + fullName: doughnutHoleSize + summary: >- + Represents the doughnut hole size of a chart series. Only valid on + doughnut and doughnut exploded charts. Throws an `InvalidArgument` error + on invalid charts. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'doughnutHoleSize?: number;' + return: + type: number + - name: explosion + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#explosion:member + package: excel! + fullName: explosion + summary: >- + Specifies the explosion value for a pie-chart or doughnut-chart slice. + Returns 0 (zero) if there's no explosion (the tip of the slice is in the + center of the pie). + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'explosion?: number;' + return: + type: number + - name: filtered + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#filtered:member + package: excel! + fullName: filtered + summary: Specifies if the series is filtered. Not applicable for surface charts. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'filtered?: boolean;' + return: + type: boolean + - name: firstSliceAngle + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#firstSliceAngle:member + package: excel! + fullName: firstSliceAngle + summary: >- + Specifies the angle of the first pie-chart or doughnut-chart slice, in + degrees (clockwise from vertical). Applies only to pie, 3-D pie, and + doughnut charts. Can be a value from 0 through 360. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'firstSliceAngle?: number;' + return: + type: number + - name: format + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#format:member + package: excel! + fullName: format + summary: >- + Represents the formatting of a chart series, which includes fill and line + formatting. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartSeriesFormatUpdateData;' + return: + type: >- + + - name: gapWidth + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#gapWidth:member + package: excel! + fullName: gapWidth + summary: >- + Represents the gap width of a chart series. Only valid on bar and column + charts, as well as specific classes of line and pie charts. Throws an + invalid argument exception on invalid charts. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gapWidth?: number;' + return: + type: number + - name: gradientMaximumColor + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#gradientMaximumColor:member + package: excel! + fullName: gradientMaximumColor + summary: Specifies the color for maximum value of a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientMaximumColor?: string;' + return: + type: string + - name: gradientMaximumType + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#gradientMaximumType:member + package: excel! + fullName: gradientMaximumType + summary: Specifies the type for maximum value of a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + gradientMaximumType?: Excel.ChartGradientStyleType | "ExtremeValue" | + "Number" | "Percent"; + return: + type: >- + | + "ExtremeValue" | "Number" | "Percent" + - name: gradientMaximumValue + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#gradientMaximumValue:member + package: excel! + fullName: gradientMaximumValue + summary: Specifies the maximum value of a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientMaximumValue?: number;' + return: + type: number + - name: gradientMidpointColor + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#gradientMidpointColor:member + package: excel! + fullName: gradientMidpointColor + summary: Specifies the color for the midpoint value of a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientMidpointColor?: string;' + return: + type: string + - name: gradientMidpointType + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#gradientMidpointType:member + package: excel! + fullName: gradientMidpointType + summary: Specifies the type for the midpoint value of a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + gradientMidpointType?: Excel.ChartGradientStyleType | "ExtremeValue" | + "Number" | "Percent"; + return: + type: >- + | + "ExtremeValue" | "Number" | "Percent" + - name: gradientMidpointValue + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#gradientMidpointValue:member + package: excel! + fullName: gradientMidpointValue + summary: Specifies the midpoint value of a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientMidpointValue?: number;' + return: + type: number + - name: gradientMinimumColor + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#gradientMinimumColor:member + package: excel! + fullName: gradientMinimumColor + summary: Specifies the color for the minimum value of a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientMinimumColor?: string;' + return: + type: string + - name: gradientMinimumType + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#gradientMinimumType:member + package: excel! + fullName: gradientMinimumType + summary: Specifies the type for the minimum value of a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + gradientMinimumType?: Excel.ChartGradientStyleType | "ExtremeValue" | + "Number" | "Percent"; + return: + type: >- + | + "ExtremeValue" | "Number" | "Percent" + - name: gradientMinimumValue + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#gradientMinimumValue:member + package: excel! + fullName: gradientMinimumValue + summary: Specifies the minimum value of a region map chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientMinimumValue?: number;' + return: + type: number + - name: gradientStyle + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#gradientStyle:member + package: excel! + fullName: gradientStyle + summary: Specifies the series gradient style of a region map chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + gradientStyle?: Excel.ChartGradientStyle | "TwoPhaseColor" | + "ThreePhaseColor"; + return: + type: >- + | "TwoPhaseColor" | + "ThreePhaseColor" + - name: hasDataLabels + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#hasDataLabels:member + package: excel! + fullName: hasDataLabels + summary: Specifies if the series has data labels. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'hasDataLabels?: boolean;' + return: + type: boolean + - name: invertColor + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#invertColor:member + package: excel! + fullName: invertColor + summary: Specifies the fill color for negative data points in a series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'invertColor?: string;' + return: + type: string + - name: invertIfNegative + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#invertIfNegative:member + package: excel! + fullName: invertIfNegative + summary: >- + True if Excel inverts the pattern in the item when it corresponds to a + negative number. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'invertIfNegative?: boolean;' + return: + type: boolean + - name: mapOptions + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#mapOptions:member + package: excel! + fullName: mapOptions + summary: Encapsulates the options for a region map chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'mapOptions?: Excel.Interfaces.ChartMapOptionsUpdateData;' + return: + type: >- + + - name: markerBackgroundColor + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#markerBackgroundColor:member + package: excel! + fullName: markerBackgroundColor + summary: Specifies the marker background color of a chart series. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'markerBackgroundColor?: string;' + return: + type: string + - name: markerForegroundColor + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#markerForegroundColor:member + package: excel! + fullName: markerForegroundColor + summary: Specifies the marker foreground color of a chart series. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'markerForegroundColor?: string;' + return: + type: string + - name: markerSize + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#markerSize:member + package: excel! + fullName: markerSize + summary: >- + Specifies the marker size of a chart series. The supported size range is 2 + to 72. This method returns an InvalidArgument error if it's set with a + size outside of the supported range. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'markerSize?: number;' + return: + type: number + - name: markerStyle + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#markerStyle:member + package: excel! + fullName: markerStyle + summary: >- + Specifies the marker style of a chart series. See `Excel.ChartMarkerStyle` + for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + markerStyle?: Excel.ChartMarkerStyle | "Invalid" | "Automatic" | "None" + | "Square" | "Diamond" | "Triangle" | "X" | "Star" | "Dot" | "Dash" | + "Circle" | "Plus" | "Picture"; + return: + type: >- + | "Invalid" | + "Automatic" | "None" | "Square" | "Diamond" | "Triangle" | "X" | + "Star" | "Dot" | "Dash" | "Circle" | "Plus" | "Picture" + - name: name + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#name:member + package: excel! + fullName: name + summary: >- + Specifies the name of a series in a chart. The name's length should not be + greater than 255 characters. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: overlap + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#overlap:member + package: excel! + fullName: overlap + summary: >- + Specifies how bars and columns are positioned. Can be a value between -100 + and 100. Applies only to 2-D bar and 2-D column charts. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'overlap?: number;' + return: + type: number + - name: parentLabelStrategy + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#parentLabelStrategy:member + package: excel! + fullName: parentLabelStrategy + summary: Specifies the series parent label strategy area for a treemap chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + parentLabelStrategy?: Excel.ChartParentLabelStrategy | "None" | "Banner" + | "Overlapping"; + return: + type: >- + | "None" | + "Banner" | "Overlapping" + - name: plotOrder + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#plotOrder:member + package: excel! + fullName: plotOrder + summary: Specifies the plot order of a chart series within the chart group. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'plotOrder?: number;' + return: + type: number + - name: secondPlotSize + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#secondPlotSize:member + package: excel! + fullName: secondPlotSize + summary: >- + Specifies the size of the secondary section of either a pie-of-pie chart + or a bar-of-pie chart, as a percentage of the size of the primary pie. Can + be a value from 5 to 200. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'secondPlotSize?: number;' + return: + type: number + - name: showConnectorLines + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#showConnectorLines:member + package: excel! + fullName: showConnectorLines + summary: Specifies whether connector lines are shown in waterfall charts. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showConnectorLines?: boolean;' + return: + type: boolean + - name: showLeaderLines + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#showLeaderLines:member + package: excel! + fullName: showLeaderLines + summary: >- + Specifies whether leader lines are displayed for each data label in the + series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showLeaderLines?: boolean;' + return: + type: boolean + - name: showShadow + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#showShadow:member + package: excel! + fullName: showShadow + summary: Specifies if the series has a shadow. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showShadow?: boolean;' + return: + type: boolean + - name: smooth + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#smooth:member + package: excel! + fullName: smooth + summary: >- + Specifies if the series is smooth. Only applicable to line and scatter + charts. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'smooth?: boolean;' + return: + type: boolean + - name: splitType + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#splitType:member + package: excel! + fullName: splitType + summary: >- + Specifies the way the two sections of either a pie-of-pie chart or a + bar-of-pie chart are split. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + splitType?: Excel.ChartSplitType | "SplitByPosition" | "SplitByValue" | + "SplitByPercentValue" | "SplitByCustomSplit"; + return: + type: >- + | "SplitByPosition" | + "SplitByValue" | "SplitByPercentValue" | "SplitByCustomSplit" + - name: splitValue + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#splitValue:member + package: excel! + fullName: splitValue + summary: >- + Specifies the threshold value that separates two sections of either a + pie-of-pie chart or a bar-of-pie chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'splitValue?: number;' + return: + type: number + - name: varyByCategories + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#varyByCategories:member + package: excel! + fullName: varyByCategories + summary: >- + True if Excel assigns a different color or pattern to each data marker. + The chart must contain only one series. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'varyByCategories?: boolean;' + return: + type: boolean + - name: xErrorBars + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#xErrorBars:member + package: excel! + fullName: xErrorBars + summary: Represents the error bar object of a chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'xErrorBars?: Excel.Interfaces.ChartErrorBarsUpdateData;' + return: + type: >- + + - name: yErrorBars + uid: excel!Excel.Interfaces.ChartSeriesUpdateData#yErrorBars:member + package: excel! + fullName: yErrorBars + summary: Represents the error bar object of a chart series. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'yErrorBars?: Excel.Interfaces.ChartErrorBarsUpdateData;' + return: + type: >- + diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttitledata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttitledata.yml new file mode 100644 index 0000000000..7f236b842c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttitledata.yml @@ -0,0 +1,241 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartTitleData +uid: excel!Excel.Interfaces.ChartTitleData:interface +package: excel! +fullName: Excel.Interfaces.ChartTitleData +summary: >- + An interface describing the data returned by calling `chartTitle.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: format + uid: excel!Excel.Interfaces.ChartTitleData#format:member + package: excel! + fullName: format + summary: >- + Represents the formatting of a chart title, which includes fill and font + formatting. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartTitleFormatData;' + return: + type: + - name: height + uid: excel!Excel.Interfaces.ChartTitleData#height:member + package: excel! + fullName: height + summary: >- + Returns the height, in points, of the chart title. Value is `null` if the + chart title is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height?: number;' + return: + type: number + - name: horizontalAlignment + uid: excel!Excel.Interfaces.ChartTitleData#horizontalAlignment:member + package: excel! + fullName: horizontalAlignment + summary: Specifies the horizontal alignment for chart title. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + horizontalAlignment?: Excel.ChartTextHorizontalAlignment | "Center" | + "Left" | "Right" | "Justify" | "Distributed"; + return: + type: >- + | + "Center" | "Left" | "Right" | "Justify" | "Distributed" + - name: left + uid: excel!Excel.Interfaces.ChartTitleData#left:member + package: excel! + fullName: left + summary: >- + Specifies the distance, in points, from the left edge of chart title to + the left edge of chart area. Value is `null` if the chart title is not + visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: number;' + return: + type: number + - name: overlay + uid: excel!Excel.Interfaces.ChartTitleData#overlay:member + package: excel! + fullName: overlay + summary: Specifies if the chart title will overlay the chart. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'overlay?: boolean;' + return: + type: boolean + - name: position + uid: excel!Excel.Interfaces.ChartTitleData#position:member + package: excel! + fullName: position + summary: >- + Represents the position of chart title. See `Excel.ChartTitlePosition` for + details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + position?: Excel.ChartTitlePosition | "Automatic" | "Top" | "Bottom" | + "Left" | "Right"; + return: + type: >- + | "Automatic" | + "Top" | "Bottom" | "Left" | "Right" + - name: showShadow + uid: excel!Excel.Interfaces.ChartTitleData#showShadow:member + package: excel! + fullName: showShadow + summary: >- + Represents a boolean value that determines if the chart title has a + shadow. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showShadow?: boolean;' + return: + type: boolean + - name: text + uid: excel!Excel.Interfaces.ChartTitleData#text:member + package: excel! + fullName: text + summary: Specifies the chart's title text. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'text?: string;' + return: + type: string + - name: textOrientation + uid: excel!Excel.Interfaces.ChartTitleData#textOrientation:member + package: excel! + fullName: textOrientation + summary: >- + Specifies the angle to which the text is oriented for the chart title. The + value should either be an integer from -90 to 90 or the integer 180 for + vertically-oriented text. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textOrientation?: number;' + return: + type: number + - name: top + uid: excel!Excel.Interfaces.ChartTitleData#top:member + package: excel! + fullName: top + summary: >- + Specifies the distance, in points, from the top edge of chart title to the + top of chart area. Value is `null` if the chart title is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: number;' + return: + type: number + - name: verticalAlignment + uid: excel!Excel.Interfaces.ChartTitleData#verticalAlignment:member + package: excel! + fullName: verticalAlignment + summary: >- + Specifies the vertical alignment of chart title. See + `Excel.ChartTextVerticalAlignment` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + verticalAlignment?: Excel.ChartTextVerticalAlignment | "Center" | + "Bottom" | "Top" | "Justify" | "Distributed"; + return: + type: >- + | "Center" + | "Bottom" | "Top" | "Justify" | "Distributed" + - name: visible + uid: excel!Excel.Interfaces.ChartTitleData#visible:member + package: excel! + fullName: visible + summary: Specifies if the chart title is visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean + - name: width + uid: excel!Excel.Interfaces.ChartTitleData#width:member + package: excel! + fullName: width + summary: >- + Specifies the width, in points, of the chart title. Value is `null` if the + chart title is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttitleformatdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttitleformatdata.yml new file mode 100644 index 0000000000..4e74293b4e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttitleformatdata.yml @@ -0,0 +1,48 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartTitleFormatData +uid: excel!Excel.Interfaces.ChartTitleFormatData:interface +package: excel! +fullName: Excel.Interfaces.ChartTitleFormatData +summary: >- + An interface describing the data returned by calling + `chartTitleFormat.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: border + uid: excel!Excel.Interfaces.ChartTitleFormatData#border:member + package: excel! + fullName: border + summary: >- + Represents the border format of chart title, which includes color, + linestyle, and weight. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'border?: Excel.Interfaces.ChartBorderData;' + return: + type: + - name: font + uid: excel!Excel.Interfaces.ChartTitleFormatData#font:member + package: excel! + fullName: font + summary: >- + Represents the font attributes (such as font name, font size, and color) + for an object. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.Interfaces.ChartFontData;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttitleformatloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttitleformatloadoptions.yml new file mode 100644 index 0000000000..06d5ccf335 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttitleformatloadoptions.yml @@ -0,0 +1,64 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartTitleFormatLoadOptions +uid: excel!Excel.Interfaces.ChartTitleFormatLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartTitleFormatLoadOptions +summary: Provides access to the formatting options for a chart title. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartTitleFormatLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: border + uid: excel!Excel.Interfaces.ChartTitleFormatLoadOptions#border:member + package: excel! + fullName: border + summary: >- + Represents the border format of chart title, which includes color, + linestyle, and weight. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'border?: Excel.Interfaces.ChartBorderLoadOptions;' + return: + type: + - name: font + uid: excel!Excel.Interfaces.ChartTitleFormatLoadOptions#font:member + package: excel! + fullName: font + summary: >- + Represents the font attributes (such as font name, font size, and color) + for an object. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.Interfaces.ChartFontLoadOptions;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttitleformatupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttitleformatupdatedata.yml new file mode 100644 index 0000000000..e19a658d31 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttitleformatupdatedata.yml @@ -0,0 +1,48 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartTitleFormatUpdateData +uid: excel!Excel.Interfaces.ChartTitleFormatUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartTitleFormatUpdateData +summary: >- + An interface for updating data on the `ChartTitleFormat` object, for use in + `chartTitleFormat.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: border + uid: excel!Excel.Interfaces.ChartTitleFormatUpdateData#border:member + package: excel! + fullName: border + summary: >- + Represents the border format of chart title, which includes color, + linestyle, and weight. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'border?: Excel.Interfaces.ChartBorderUpdateData;' + return: + type: + - name: font + uid: excel!Excel.Interfaces.ChartTitleFormatUpdateData#font:member + package: excel! + fullName: font + summary: >- + Represents the font attributes (such as font name, font size, and color) + for an object. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.Interfaces.ChartFontUpdateData;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttitleloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttitleloadoptions.yml new file mode 100644 index 0000000000..cad51a8c02 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttitleloadoptions.yml @@ -0,0 +1,247 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartTitleLoadOptions +uid: excel!Excel.Interfaces.ChartTitleLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartTitleLoadOptions +summary: Represents a chart title object of a chart. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartTitleLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: format + uid: excel!Excel.Interfaces.ChartTitleLoadOptions#format:member + package: excel! + fullName: format + summary: >- + Represents the formatting of a chart title, which includes fill and font + formatting. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartTitleFormatLoadOptions;' + return: + type: >- + + - name: height + uid: excel!Excel.Interfaces.ChartTitleLoadOptions#height:member + package: excel! + fullName: height + summary: >- + Returns the height, in points, of the chart title. Value is `null` if the + chart title is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height?: boolean;' + return: + type: boolean + - name: horizontalAlignment + uid: excel!Excel.Interfaces.ChartTitleLoadOptions#horizontalAlignment:member + package: excel! + fullName: horizontalAlignment + summary: Specifies the horizontal alignment for chart title. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'horizontalAlignment?: boolean;' + return: + type: boolean + - name: left + uid: excel!Excel.Interfaces.ChartTitleLoadOptions#left:member + package: excel! + fullName: left + summary: >- + Specifies the distance, in points, from the left edge of chart title to + the left edge of chart area. Value is `null` if the chart title is not + visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: boolean;' + return: + type: boolean + - name: overlay + uid: excel!Excel.Interfaces.ChartTitleLoadOptions#overlay:member + package: excel! + fullName: overlay + summary: Specifies if the chart title will overlay the chart. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'overlay?: boolean;' + return: + type: boolean + - name: position + uid: excel!Excel.Interfaces.ChartTitleLoadOptions#position:member + package: excel! + fullName: position + summary: >- + Represents the position of chart title. See `Excel.ChartTitlePosition` for + details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'position?: boolean;' + return: + type: boolean + - name: showShadow + uid: excel!Excel.Interfaces.ChartTitleLoadOptions#showShadow:member + package: excel! + fullName: showShadow + summary: >- + Represents a boolean value that determines if the chart title has a + shadow. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showShadow?: boolean;' + return: + type: boolean + - name: text + uid: excel!Excel.Interfaces.ChartTitleLoadOptions#text:member + package: excel! + fullName: text + summary: Specifies the chart's title text. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'text?: boolean;' + return: + type: boolean + - name: textOrientation + uid: excel!Excel.Interfaces.ChartTitleLoadOptions#textOrientation:member + package: excel! + fullName: textOrientation + summary: >- + Specifies the angle to which the text is oriented for the chart title. The + value should either be an integer from -90 to 90 or the integer 180 for + vertically-oriented text. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textOrientation?: boolean;' + return: + type: boolean + - name: top + uid: excel!Excel.Interfaces.ChartTitleLoadOptions#top:member + package: excel! + fullName: top + summary: >- + Specifies the distance, in points, from the top edge of chart title to the + top of chart area. Value is `null` if the chart title is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: boolean;' + return: + type: boolean + - name: verticalAlignment + uid: excel!Excel.Interfaces.ChartTitleLoadOptions#verticalAlignment:member + package: excel! + fullName: verticalAlignment + summary: >- + Specifies the vertical alignment of chart title. See + `Excel.ChartTextVerticalAlignment` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'verticalAlignment?: boolean;' + return: + type: boolean + - name: visible + uid: excel!Excel.Interfaces.ChartTitleLoadOptions#visible:member + package: excel! + fullName: visible + summary: Specifies if the chart title is visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean + - name: width + uid: excel!Excel.Interfaces.ChartTitleLoadOptions#width:member + package: excel! + fullName: width + summary: >- + Specifies the width, in points, of the chart title. Value is `null` if the + chart title is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttitleupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttitleupdatedata.yml new file mode 100644 index 0000000000..1fef9708d3 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttitleupdatedata.yml @@ -0,0 +1,209 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartTitleUpdateData +uid: excel!Excel.Interfaces.ChartTitleUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartTitleUpdateData +summary: >- + An interface for updating data on the `ChartTitle` object, for use in + `chartTitle.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: format + uid: excel!Excel.Interfaces.ChartTitleUpdateData#format:member + package: excel! + fullName: format + summary: >- + Represents the formatting of a chart title, which includes fill and font + formatting. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartTitleFormatUpdateData;' + return: + type: >- + + - name: horizontalAlignment + uid: excel!Excel.Interfaces.ChartTitleUpdateData#horizontalAlignment:member + package: excel! + fullName: horizontalAlignment + summary: Specifies the horizontal alignment for chart title. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + horizontalAlignment?: Excel.ChartTextHorizontalAlignment | "Center" | + "Left" | "Right" | "Justify" | "Distributed"; + return: + type: >- + | + "Center" | "Left" | "Right" | "Justify" | "Distributed" + - name: left + uid: excel!Excel.Interfaces.ChartTitleUpdateData#left:member + package: excel! + fullName: left + summary: >- + Specifies the distance, in points, from the left edge of chart title to + the left edge of chart area. Value is `null` if the chart title is not + visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: number;' + return: + type: number + - name: overlay + uid: excel!Excel.Interfaces.ChartTitleUpdateData#overlay:member + package: excel! + fullName: overlay + summary: Specifies if the chart title will overlay the chart. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'overlay?: boolean;' + return: + type: boolean + - name: position + uid: excel!Excel.Interfaces.ChartTitleUpdateData#position:member + package: excel! + fullName: position + summary: >- + Represents the position of chart title. See `Excel.ChartTitlePosition` for + details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + position?: Excel.ChartTitlePosition | "Automatic" | "Top" | "Bottom" | + "Left" | "Right"; + return: + type: >- + | "Automatic" | + "Top" | "Bottom" | "Left" | "Right" + - name: showShadow + uid: excel!Excel.Interfaces.ChartTitleUpdateData#showShadow:member + package: excel! + fullName: showShadow + summary: >- + Represents a boolean value that determines if the chart title has a + shadow. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showShadow?: boolean;' + return: + type: boolean + - name: text + uid: excel!Excel.Interfaces.ChartTitleUpdateData#text:member + package: excel! + fullName: text + summary: Specifies the chart's title text. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'text?: string;' + return: + type: string + - name: textOrientation + uid: excel!Excel.Interfaces.ChartTitleUpdateData#textOrientation:member + package: excel! + fullName: textOrientation + summary: >- + Specifies the angle to which the text is oriented for the chart title. The + value should either be an integer from -90 to 90 or the integer 180 for + vertically-oriented text. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textOrientation?: number;' + return: + type: number + - name: top + uid: excel!Excel.Interfaces.ChartTitleUpdateData#top:member + package: excel! + fullName: top + summary: >- + Specifies the distance, in points, from the top edge of chart title to the + top of chart area. Value is `null` if the chart title is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: number;' + return: + type: number + - name: verticalAlignment + uid: excel!Excel.Interfaces.ChartTitleUpdateData#verticalAlignment:member + package: excel! + fullName: verticalAlignment + summary: >- + Specifies the vertical alignment of chart title. See + `Excel.ChartTextVerticalAlignment` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + verticalAlignment?: Excel.ChartTextVerticalAlignment | "Center" | + "Bottom" | "Top" | "Justify" | "Distributed"; + return: + type: >- + | "Center" + | "Bottom" | "Top" | "Justify" | "Distributed" + - name: visible + uid: excel!Excel.Interfaces.ChartTitleUpdateData#visible:member + package: excel! + fullName: visible + summary: Specifies if the chart title is visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlinecollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlinecollectiondata.yml new file mode 100644 index 0000000000..5448179559 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlinecollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartTrendlineCollectionData +uid: excel!Excel.Interfaces.ChartTrendlineCollectionData:interface +package: excel! +fullName: Excel.Interfaces.ChartTrendlineCollectionData +summary: >- + An interface describing the data returned by calling + `chartTrendlineCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.ChartTrendlineCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.ChartTrendlineData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlinecollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlinecollectionloadoptions.yml new file mode 100644 index 0000000000..eeeb36838a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlinecollectionloadoptions.yml @@ -0,0 +1,232 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartTrendlineCollectionLoadOptions +uid: excel!Excel.Interfaces.ChartTrendlineCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartTrendlineCollectionLoadOptions +summary: Represents a collection of chart trendlines. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartTrendlineCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: backwardPeriod + uid: >- + excel!Excel.Interfaces.ChartTrendlineCollectionLoadOptions#backwardPeriod:member + package: excel! + fullName: backwardPeriod + summary: >- + For EACH ITEM in the collection: Represents the number of periods that the + trendline extends backward. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'backwardPeriod?: boolean;' + return: + type: boolean + - name: format + uid: excel!Excel.Interfaces.ChartTrendlineCollectionLoadOptions#format:member + package: excel! + fullName: format + summary: >- + For EACH ITEM in the collection: Represents the formatting of a chart + trendline. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartTrendlineFormatLoadOptions;' + return: + type: >- + + - name: forwardPeriod + uid: >- + excel!Excel.Interfaces.ChartTrendlineCollectionLoadOptions#forwardPeriod:member + package: excel! + fullName: forwardPeriod + summary: >- + For EACH ITEM in the collection: Represents the number of periods that the + trendline extends forward. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'forwardPeriod?: boolean;' + return: + type: boolean + - name: intercept + uid: >- + excel!Excel.Interfaces.ChartTrendlineCollectionLoadOptions#intercept:member + package: excel! + fullName: intercept + summary: >- + For EACH ITEM in the collection: Represents the intercept value of the + trendline. Can be set to a numeric value or an empty string (for automatic + values). The returned value is always a number. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'intercept?: boolean;' + return: + type: boolean + - name: label + uid: excel!Excel.Interfaces.ChartTrendlineCollectionLoadOptions#label:member + package: excel! + fullName: label + summary: >- + For EACH ITEM in the collection: Represents the label of a chart + trendline. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'label?: Excel.Interfaces.ChartTrendlineLabelLoadOptions;' + return: + type: >- + + - name: movingAveragePeriod + uid: >- + excel!Excel.Interfaces.ChartTrendlineCollectionLoadOptions#movingAveragePeriod:member + package: excel! + fullName: movingAveragePeriod + summary: >- + For EACH ITEM in the collection: Represents the period of a chart + trendline. Only applicable to trendlines with the type `MovingAverage`. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'movingAveragePeriod?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.ChartTrendlineCollectionLoadOptions#name:member + package: excel! + fullName: name + summary: >- + For EACH ITEM in the collection: Represents the name of the trendline. Can + be set to a string value, a `null` value represents automatic values. The + returned value is always a string + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: polynomialOrder + uid: >- + excel!Excel.Interfaces.ChartTrendlineCollectionLoadOptions#polynomialOrder:member + package: excel! + fullName: polynomialOrder + summary: >- + For EACH ITEM in the collection: Represents the order of a chart + trendline. Only applicable to trendlines with the type `Polynomial`. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'polynomialOrder?: boolean;' + return: + type: boolean + - name: showEquation + uid: >- + excel!Excel.Interfaces.ChartTrendlineCollectionLoadOptions#showEquation:member + package: excel! + fullName: showEquation + summary: >- + For EACH ITEM in the collection: True if the equation for the trendline is + displayed on the chart. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showEquation?: boolean;' + return: + type: boolean + - name: showRSquared + uid: >- + excel!Excel.Interfaces.ChartTrendlineCollectionLoadOptions#showRSquared:member + package: excel! + fullName: showRSquared + summary: >- + For EACH ITEM in the collection: True if the r-squared value for the + trendline is displayed on the chart. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showRSquared?: boolean;' + return: + type: boolean + - name: type + uid: excel!Excel.Interfaces.ChartTrendlineCollectionLoadOptions#type:member + package: excel! + fullName: type + summary: 'For EACH ITEM in the collection: Represents the type of a chart trendline.' + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlinecollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlinecollectionupdatedata.yml new file mode 100644 index 0000000000..7a1c7958d7 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlinecollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartTrendlineCollectionUpdateData +uid: excel!Excel.Interfaces.ChartTrendlineCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartTrendlineCollectionUpdateData +summary: >- + An interface for updating data on the `ChartTrendlineCollection` object, for + use in `chartTrendlineCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.ChartTrendlineCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.ChartTrendlineData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlinedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlinedata.yml new file mode 100644 index 0000000000..8480513dde --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlinedata.yml @@ -0,0 +1,198 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartTrendlineData +uid: excel!Excel.Interfaces.ChartTrendlineData:interface +package: excel! +fullName: Excel.Interfaces.ChartTrendlineData +summary: >- + An interface describing the data returned by calling + `chartTrendline.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: backwardPeriod + uid: excel!Excel.Interfaces.ChartTrendlineData#backwardPeriod:member + package: excel! + fullName: backwardPeriod + summary: Represents the number of periods that the trendline extends backward. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'backwardPeriod?: number;' + return: + type: number + - name: format + uid: excel!Excel.Interfaces.ChartTrendlineData#format:member + package: excel! + fullName: format + summary: Represents the formatting of a chart trendline. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartTrendlineFormatData;' + return: + type: >- + + - name: forwardPeriod + uid: excel!Excel.Interfaces.ChartTrendlineData#forwardPeriod:member + package: excel! + fullName: forwardPeriod + summary: Represents the number of periods that the trendline extends forward. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'forwardPeriod?: number;' + return: + type: number + - name: intercept + uid: excel!Excel.Interfaces.ChartTrendlineData#intercept:member + package: excel! + fullName: intercept + summary: >- + Represents the intercept value of the trendline. Can be set to a numeric + value or an empty string (for automatic values). The returned value is + always a number. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'intercept?: any;' + return: + type: any + - name: label + uid: excel!Excel.Interfaces.ChartTrendlineData#label:member + package: excel! + fullName: label + summary: Represents the label of a chart trendline. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'label?: Excel.Interfaces.ChartTrendlineLabelData;' + return: + type: >- + + - name: movingAveragePeriod + uid: excel!Excel.Interfaces.ChartTrendlineData#movingAveragePeriod:member + package: excel! + fullName: movingAveragePeriod + summary: >- + Represents the period of a chart trendline. Only applicable to trendlines + with the type `MovingAverage`. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'movingAveragePeriod?: number;' + return: + type: number + - name: name + uid: excel!Excel.Interfaces.ChartTrendlineData#name:member + package: excel! + fullName: name + summary: >- + Represents the name of the trendline. Can be set to a string value, a + `null` value represents automatic values. The returned value is always a + string + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: polynomialOrder + uid: excel!Excel.Interfaces.ChartTrendlineData#polynomialOrder:member + package: excel! + fullName: polynomialOrder + summary: >- + Represents the order of a chart trendline. Only applicable to trendlines + with the type `Polynomial`. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'polynomialOrder?: number;' + return: + type: number + - name: showEquation + uid: excel!Excel.Interfaces.ChartTrendlineData#showEquation:member + package: excel! + fullName: showEquation + summary: True if the equation for the trendline is displayed on the chart. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showEquation?: boolean;' + return: + type: boolean + - name: showRSquared + uid: excel!Excel.Interfaces.ChartTrendlineData#showRSquared:member + package: excel! + fullName: showRSquared + summary: True if the r-squared value for the trendline is displayed on the chart. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showRSquared?: boolean;' + return: + type: boolean + - name: type + uid: excel!Excel.Interfaces.ChartTrendlineData#type:member + package: excel! + fullName: type + summary: Represents the type of a chart trendline. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + type?: Excel.ChartTrendlineType | "Linear" | "Exponential" | + "Logarithmic" | "MovingAverage" | "Polynomial" | "Power"; + return: + type: >- + | "Linear" | + "Exponential" | "Logarithmic" | "MovingAverage" | "Polynomial" | + "Power" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlineformatdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlineformatdata.yml new file mode 100644 index 0000000000..9b28475ac3 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlineformatdata.yml @@ -0,0 +1,29 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartTrendlineFormatData +uid: excel!Excel.Interfaces.ChartTrendlineFormatData:interface +package: excel! +fullName: Excel.Interfaces.ChartTrendlineFormatData +summary: >- + An interface describing the data returned by calling + `chartTrendlineFormat.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: line + uid: excel!Excel.Interfaces.ChartTrendlineFormatData#line:member + package: excel! + fullName: line + summary: Represents chart line formatting. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'line?: Excel.Interfaces.ChartLineFormatData;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlineformatloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlineformatloadoptions.yml new file mode 100644 index 0000000000..864e0b365a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlineformatloadoptions.yml @@ -0,0 +1,47 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartTrendlineFormatLoadOptions +uid: excel!Excel.Interfaces.ChartTrendlineFormatLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartTrendlineFormatLoadOptions +summary: Represents the format properties for the chart trendline. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartTrendlineFormatLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: line + uid: excel!Excel.Interfaces.ChartTrendlineFormatLoadOptions#line:member + package: excel! + fullName: line + summary: Represents chart line formatting. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'line?: Excel.Interfaces.ChartLineFormatLoadOptions;' + return: + type: >- + diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlineformatupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlineformatupdatedata.yml new file mode 100644 index 0000000000..9708ecd490 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlineformatupdatedata.yml @@ -0,0 +1,31 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartTrendlineFormatUpdateData +uid: excel!Excel.Interfaces.ChartTrendlineFormatUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartTrendlineFormatUpdateData +summary: >- + An interface for updating data on the `ChartTrendlineFormat` object, for use + in `chartTrendlineFormat.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: line + uid: excel!Excel.Interfaces.ChartTrendlineFormatUpdateData#line:member + package: excel! + fullName: line + summary: Represents chart line formatting. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'line?: Excel.Interfaces.ChartLineFormatUpdateData;' + return: + type: >- + diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlinelabeldata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlinelabeldata.yml new file mode 100644 index 0000000000..060bae024f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlinelabeldata.yml @@ -0,0 +1,245 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartTrendlineLabelData +uid: excel!Excel.Interfaces.ChartTrendlineLabelData:interface +package: excel! +fullName: Excel.Interfaces.ChartTrendlineLabelData +summary: >- + An interface describing the data returned by calling + `chartTrendlineLabel.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: autoText + uid: excel!Excel.Interfaces.ChartTrendlineLabelData#autoText:member + package: excel! + fullName: autoText + summary: >- + Specifies if the trendline label automatically generates appropriate text + based on context. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'autoText?: boolean;' + return: + type: boolean + - name: format + uid: excel!Excel.Interfaces.ChartTrendlineLabelData#format:member + package: excel! + fullName: format + summary: The format of the chart trendline label. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartTrendlineLabelFormatData;' + return: + type: >- + + - name: formula + uid: excel!Excel.Interfaces.ChartTrendlineLabelData#formula:member + package: excel! + fullName: formula + summary: >- + String value that represents the formula of the chart trendline label + using A1-style notation. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formula?: string;' + return: + type: string + - name: height + uid: excel!Excel.Interfaces.ChartTrendlineLabelData#height:member + package: excel! + fullName: height + summary: >- + Returns the height, in points, of the chart trendline label. Value is + `null` if the chart trendline label is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height?: number;' + return: + type: number + - name: horizontalAlignment + uid: excel!Excel.Interfaces.ChartTrendlineLabelData#horizontalAlignment:member + package: excel! + fullName: horizontalAlignment + summary: >- + Represents the horizontal alignment of the chart trendline label. See + `Excel.ChartTextHorizontalAlignment` for details. This property is valid + only when `TextOrientation` of a trendline label is -90, 90, or 180. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + horizontalAlignment?: Excel.ChartTextHorizontalAlignment | "Center" | + "Left" | "Right" | "Justify" | "Distributed"; + return: + type: >- + | + "Center" | "Left" | "Right" | "Justify" | "Distributed" + - name: left + uid: excel!Excel.Interfaces.ChartTrendlineLabelData#left:member + package: excel! + fullName: left + summary: >- + Represents the distance, in points, from the left edge of the chart + trendline label to the left edge of the chart area. Value is `null` if the + chart trendline label is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: number;' + return: + type: number + - name: linkNumberFormat + uid: excel!Excel.Interfaces.ChartTrendlineLabelData#linkNumberFormat:member + package: excel! + fullName: linkNumberFormat + summary: >- + Specifies if the number format is linked to the cells (so that the number + format changes in the labels when it changes in the cells). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'linkNumberFormat?: boolean;' + return: + type: boolean + - name: numberFormat + uid: excel!Excel.Interfaces.ChartTrendlineLabelData#numberFormat:member + package: excel! + fullName: numberFormat + summary: String value that represents the format code for the trendline label. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat?: string;' + return: + type: string + - name: text + uid: excel!Excel.Interfaces.ChartTrendlineLabelData#text:member + package: excel! + fullName: text + summary: String representing the text of the trendline label on a chart. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'text?: string;' + return: + type: string + - name: textOrientation + uid: excel!Excel.Interfaces.ChartTrendlineLabelData#textOrientation:member + package: excel! + fullName: textOrientation + summary: >- + Represents the angle to which the text is oriented for the chart trendline + label. The value should either be an integer from -90 to 90 or the integer + 180 for vertically-oriented text. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textOrientation?: number;' + return: + type: number + - name: top + uid: excel!Excel.Interfaces.ChartTrendlineLabelData#top:member + package: excel! + fullName: top + summary: >- + Represents the distance, in points, from the top edge of the chart + trendline label to the top of the chart area. Value is `null` if the chart + trendline label is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: number;' + return: + type: number + - name: verticalAlignment + uid: excel!Excel.Interfaces.ChartTrendlineLabelData#verticalAlignment:member + package: excel! + fullName: verticalAlignment + summary: >- + Represents the vertical alignment of the chart trendline label. See + `Excel.ChartTextVerticalAlignment` for details. This property is valid + only when `TextOrientation` of a trendline label is 0. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + verticalAlignment?: Excel.ChartTextVerticalAlignment | "Center" | + "Bottom" | "Top" | "Justify" | "Distributed"; + return: + type: >- + | "Center" + | "Bottom" | "Top" | "Justify" | "Distributed" + - name: width + uid: excel!Excel.Interfaces.ChartTrendlineLabelData#width:member + package: excel! + fullName: width + summary: >- + Returns the width, in points, of the chart trendline label. Value is + `null` if the chart trendline label is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlinelabelformatdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlinelabelformatdata.yml new file mode 100644 index 0000000000..794487b4b8 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlinelabelformatdata.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartTrendlineLabelFormatData +uid: excel!Excel.Interfaces.ChartTrendlineLabelFormatData:interface +package: excel! +fullName: Excel.Interfaces.ChartTrendlineLabelFormatData +summary: >- + An interface describing the data returned by calling + `chartTrendlineLabelFormat.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: border + uid: excel!Excel.Interfaces.ChartTrendlineLabelFormatData#border:member + package: excel! + fullName: border + summary: Specifies the border format, which includes color, linestyle, and weight. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'border?: Excel.Interfaces.ChartBorderData;' + return: + type: + - name: font + uid: excel!Excel.Interfaces.ChartTrendlineLabelFormatData#font:member + package: excel! + fullName: font + summary: >- + Specifies the font attributes (such as font name, font size, and color) + for a chart trendline label. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.Interfaces.ChartFontData;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlinelabelformatloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlinelabelformatloadoptions.yml new file mode 100644 index 0000000000..e1d2c267a4 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlinelabelformatloadoptions.yml @@ -0,0 +1,62 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartTrendlineLabelFormatLoadOptions +uid: excel!Excel.Interfaces.ChartTrendlineLabelFormatLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartTrendlineLabelFormatLoadOptions +summary: Encapsulates the format properties for the chart trendline label. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartTrendlineLabelFormatLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: border + uid: excel!Excel.Interfaces.ChartTrendlineLabelFormatLoadOptions#border:member + package: excel! + fullName: border + summary: Specifies the border format, which includes color, linestyle, and weight. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'border?: Excel.Interfaces.ChartBorderLoadOptions;' + return: + type: + - name: font + uid: excel!Excel.Interfaces.ChartTrendlineLabelFormatLoadOptions#font:member + package: excel! + fullName: font + summary: >- + Specifies the font attributes (such as font name, font size, and color) + for a chart trendline label. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.Interfaces.ChartFontLoadOptions;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlinelabelformatupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlinelabelformatupdatedata.yml new file mode 100644 index 0000000000..eec48d8c44 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlinelabelformatupdatedata.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartTrendlineLabelFormatUpdateData +uid: excel!Excel.Interfaces.ChartTrendlineLabelFormatUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartTrendlineLabelFormatUpdateData +summary: >- + An interface for updating data on the `ChartTrendlineLabelFormat` object, for + use in `chartTrendlineLabelFormat.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: border + uid: excel!Excel.Interfaces.ChartTrendlineLabelFormatUpdateData#border:member + package: excel! + fullName: border + summary: Specifies the border format, which includes color, linestyle, and weight. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'border?: Excel.Interfaces.ChartBorderUpdateData;' + return: + type: + - name: font + uid: excel!Excel.Interfaces.ChartTrendlineLabelFormatUpdateData#font:member + package: excel! + fullName: font + summary: >- + Specifies the font attributes (such as font name, font size, and color) + for a chart trendline label. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.Interfaces.ChartFontUpdateData;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlinelabelloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlinelabelloadoptions.yml new file mode 100644 index 0000000000..0bbcd5dabe --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlinelabelloadoptions.yml @@ -0,0 +1,257 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartTrendlineLabelLoadOptions +uid: excel!Excel.Interfaces.ChartTrendlineLabelLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartTrendlineLabelLoadOptions +summary: This object represents the attributes for a chart trendline label object. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartTrendlineLabelLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: autoText + uid: excel!Excel.Interfaces.ChartTrendlineLabelLoadOptions#autoText:member + package: excel! + fullName: autoText + summary: >- + Specifies if the trendline label automatically generates appropriate text + based on context. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'autoText?: boolean;' + return: + type: boolean + - name: format + uid: excel!Excel.Interfaces.ChartTrendlineLabelLoadOptions#format:member + package: excel! + fullName: format + summary: The format of the chart trendline label. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartTrendlineLabelFormatLoadOptions;' + return: + type: >- + + - name: formula + uid: excel!Excel.Interfaces.ChartTrendlineLabelLoadOptions#formula:member + package: excel! + fullName: formula + summary: >- + String value that represents the formula of the chart trendline label + using A1-style notation. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formula?: boolean;' + return: + type: boolean + - name: height + uid: excel!Excel.Interfaces.ChartTrendlineLabelLoadOptions#height:member + package: excel! + fullName: height + summary: >- + Returns the height, in points, of the chart trendline label. Value is + `null` if the chart trendline label is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height?: boolean;' + return: + type: boolean + - name: horizontalAlignment + uid: >- + excel!Excel.Interfaces.ChartTrendlineLabelLoadOptions#horizontalAlignment:member + package: excel! + fullName: horizontalAlignment + summary: >- + Represents the horizontal alignment of the chart trendline label. See + `Excel.ChartTextHorizontalAlignment` for details. This property is valid + only when `TextOrientation` of a trendline label is -90, 90, or 180. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'horizontalAlignment?: boolean;' + return: + type: boolean + - name: left + uid: excel!Excel.Interfaces.ChartTrendlineLabelLoadOptions#left:member + package: excel! + fullName: left + summary: >- + Represents the distance, in points, from the left edge of the chart + trendline label to the left edge of the chart area. Value is `null` if the + chart trendline label is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: boolean;' + return: + type: boolean + - name: linkNumberFormat + uid: >- + excel!Excel.Interfaces.ChartTrendlineLabelLoadOptions#linkNumberFormat:member + package: excel! + fullName: linkNumberFormat + summary: >- + Specifies if the number format is linked to the cells (so that the number + format changes in the labels when it changes in the cells). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'linkNumberFormat?: boolean;' + return: + type: boolean + - name: numberFormat + uid: excel!Excel.Interfaces.ChartTrendlineLabelLoadOptions#numberFormat:member + package: excel! + fullName: numberFormat + summary: String value that represents the format code for the trendline label. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat?: boolean;' + return: + type: boolean + - name: text + uid: excel!Excel.Interfaces.ChartTrendlineLabelLoadOptions#text:member + package: excel! + fullName: text + summary: String representing the text of the trendline label on a chart. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'text?: boolean;' + return: + type: boolean + - name: textOrientation + uid: >- + excel!Excel.Interfaces.ChartTrendlineLabelLoadOptions#textOrientation:member + package: excel! + fullName: textOrientation + summary: >- + Represents the angle to which the text is oriented for the chart trendline + label. The value should either be an integer from -90 to 90 or the integer + 180 for vertically-oriented text. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textOrientation?: boolean;' + return: + type: boolean + - name: top + uid: excel!Excel.Interfaces.ChartTrendlineLabelLoadOptions#top:member + package: excel! + fullName: top + summary: >- + Represents the distance, in points, from the top edge of the chart + trendline label to the top of the chart area. Value is `null` if the chart + trendline label is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: boolean;' + return: + type: boolean + - name: verticalAlignment + uid: >- + excel!Excel.Interfaces.ChartTrendlineLabelLoadOptions#verticalAlignment:member + package: excel! + fullName: verticalAlignment + summary: >- + Represents the vertical alignment of the chart trendline label. See + `Excel.ChartTextVerticalAlignment` for details. This property is valid + only when `TextOrientation` of a trendline label is 0. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'verticalAlignment?: boolean;' + return: + type: boolean + - name: width + uid: excel!Excel.Interfaces.ChartTrendlineLabelLoadOptions#width:member + package: excel! + fullName: width + summary: >- + Returns the width, in points, of the chart trendline label. Value is + `null` if the chart trendline label is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlinelabelupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlinelabelupdatedata.yml new file mode 100644 index 0000000000..38eb794054 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlinelabelupdatedata.yml @@ -0,0 +1,215 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartTrendlineLabelUpdateData +uid: excel!Excel.Interfaces.ChartTrendlineLabelUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartTrendlineLabelUpdateData +summary: >- + An interface for updating data on the `ChartTrendlineLabel` object, for use in + `chartTrendlineLabel.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: autoText + uid: excel!Excel.Interfaces.ChartTrendlineLabelUpdateData#autoText:member + package: excel! + fullName: autoText + summary: >- + Specifies if the trendline label automatically generates appropriate text + based on context. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'autoText?: boolean;' + return: + type: boolean + - name: format + uid: excel!Excel.Interfaces.ChartTrendlineLabelUpdateData#format:member + package: excel! + fullName: format + summary: The format of the chart trendline label. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartTrendlineLabelFormatUpdateData;' + return: + type: >- + + - name: formula + uid: excel!Excel.Interfaces.ChartTrendlineLabelUpdateData#formula:member + package: excel! + fullName: formula + summary: >- + String value that represents the formula of the chart trendline label + using A1-style notation. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formula?: string;' + return: + type: string + - name: horizontalAlignment + uid: >- + excel!Excel.Interfaces.ChartTrendlineLabelUpdateData#horizontalAlignment:member + package: excel! + fullName: horizontalAlignment + summary: >- + Represents the horizontal alignment of the chart trendline label. See + `Excel.ChartTextHorizontalAlignment` for details. This property is valid + only when `TextOrientation` of a trendline label is -90, 90, or 180. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + horizontalAlignment?: Excel.ChartTextHorizontalAlignment | "Center" | + "Left" | "Right" | "Justify" | "Distributed"; + return: + type: >- + | + "Center" | "Left" | "Right" | "Justify" | "Distributed" + - name: left + uid: excel!Excel.Interfaces.ChartTrendlineLabelUpdateData#left:member + package: excel! + fullName: left + summary: >- + Represents the distance, in points, from the left edge of the chart + trendline label to the left edge of the chart area. Value is `null` if the + chart trendline label is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: number;' + return: + type: number + - name: linkNumberFormat + uid: >- + excel!Excel.Interfaces.ChartTrendlineLabelUpdateData#linkNumberFormat:member + package: excel! + fullName: linkNumberFormat + summary: >- + Specifies if the number format is linked to the cells (so that the number + format changes in the labels when it changes in the cells). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'linkNumberFormat?: boolean;' + return: + type: boolean + - name: numberFormat + uid: excel!Excel.Interfaces.ChartTrendlineLabelUpdateData#numberFormat:member + package: excel! + fullName: numberFormat + summary: String value that represents the format code for the trendline label. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat?: string;' + return: + type: string + - name: text + uid: excel!Excel.Interfaces.ChartTrendlineLabelUpdateData#text:member + package: excel! + fullName: text + summary: String representing the text of the trendline label on a chart. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'text?: string;' + return: + type: string + - name: textOrientation + uid: >- + excel!Excel.Interfaces.ChartTrendlineLabelUpdateData#textOrientation:member + package: excel! + fullName: textOrientation + summary: >- + Represents the angle to which the text is oriented for the chart trendline + label. The value should either be an integer from -90 to 90 or the integer + 180 for vertically-oriented text. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textOrientation?: number;' + return: + type: number + - name: top + uid: excel!Excel.Interfaces.ChartTrendlineLabelUpdateData#top:member + package: excel! + fullName: top + summary: >- + Represents the distance, in points, from the top edge of the chart + trendline label to the top of the chart area. Value is `null` if the chart + trendline label is not visible. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: number;' + return: + type: number + - name: verticalAlignment + uid: >- + excel!Excel.Interfaces.ChartTrendlineLabelUpdateData#verticalAlignment:member + package: excel! + fullName: verticalAlignment + summary: >- + Represents the vertical alignment of the chart trendline label. See + `Excel.ChartTextVerticalAlignment` for details. This property is valid + only when `TextOrientation` of a trendline label is 0. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + verticalAlignment?: Excel.ChartTextVerticalAlignment | "Center" | + "Bottom" | "Top" | "Justify" | "Distributed"; + return: + type: >- + | "Center" + | "Bottom" | "Top" | "Justify" | "Distributed" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlineloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlineloadoptions.yml new file mode 100644 index 0000000000..132af7e88f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlineloadoptions.yml @@ -0,0 +1,212 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartTrendlineLoadOptions +uid: excel!Excel.Interfaces.ChartTrendlineLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ChartTrendlineLoadOptions +summary: This object represents the attributes for a chart trendline object. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ChartTrendlineLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: backwardPeriod + uid: excel!Excel.Interfaces.ChartTrendlineLoadOptions#backwardPeriod:member + package: excel! + fullName: backwardPeriod + summary: Represents the number of periods that the trendline extends backward. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'backwardPeriod?: boolean;' + return: + type: boolean + - name: format + uid: excel!Excel.Interfaces.ChartTrendlineLoadOptions#format:member + package: excel! + fullName: format + summary: Represents the formatting of a chart trendline. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartTrendlineFormatLoadOptions;' + return: + type: >- + + - name: forwardPeriod + uid: excel!Excel.Interfaces.ChartTrendlineLoadOptions#forwardPeriod:member + package: excel! + fullName: forwardPeriod + summary: Represents the number of periods that the trendline extends forward. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'forwardPeriod?: boolean;' + return: + type: boolean + - name: intercept + uid: excel!Excel.Interfaces.ChartTrendlineLoadOptions#intercept:member + package: excel! + fullName: intercept + summary: >- + Represents the intercept value of the trendline. Can be set to a numeric + value or an empty string (for automatic values). The returned value is + always a number. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'intercept?: boolean;' + return: + type: boolean + - name: label + uid: excel!Excel.Interfaces.ChartTrendlineLoadOptions#label:member + package: excel! + fullName: label + summary: Represents the label of a chart trendline. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'label?: Excel.Interfaces.ChartTrendlineLabelLoadOptions;' + return: + type: >- + + - name: movingAveragePeriod + uid: >- + excel!Excel.Interfaces.ChartTrendlineLoadOptions#movingAveragePeriod:member + package: excel! + fullName: movingAveragePeriod + summary: >- + Represents the period of a chart trendline. Only applicable to trendlines + with the type `MovingAverage`. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'movingAveragePeriod?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.ChartTrendlineLoadOptions#name:member + package: excel! + fullName: name + summary: >- + Represents the name of the trendline. Can be set to a string value, a + `null` value represents automatic values. The returned value is always a + string + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: polynomialOrder + uid: excel!Excel.Interfaces.ChartTrendlineLoadOptions#polynomialOrder:member + package: excel! + fullName: polynomialOrder + summary: >- + Represents the order of a chart trendline. Only applicable to trendlines + with the type `Polynomial`. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'polynomialOrder?: boolean;' + return: + type: boolean + - name: showEquation + uid: excel!Excel.Interfaces.ChartTrendlineLoadOptions#showEquation:member + package: excel! + fullName: showEquation + summary: True if the equation for the trendline is displayed on the chart. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showEquation?: boolean;' + return: + type: boolean + - name: showRSquared + uid: excel!Excel.Interfaces.ChartTrendlineLoadOptions#showRSquared:member + package: excel! + fullName: showRSquared + summary: True if the r-squared value for the trendline is displayed on the chart. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showRSquared?: boolean;' + return: + type: boolean + - name: type + uid: excel!Excel.Interfaces.ChartTrendlineLoadOptions#type:member + package: excel! + fullName: type + summary: Represents the type of a chart trendline. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlineupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlineupdatedata.yml new file mode 100644 index 0000000000..b98fb35c54 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.charttrendlineupdatedata.yml @@ -0,0 +1,200 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartTrendlineUpdateData +uid: excel!Excel.Interfaces.ChartTrendlineUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartTrendlineUpdateData +summary: >- + An interface for updating data on the `ChartTrendline` object, for use in + `chartTrendline.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: backwardPeriod + uid: excel!Excel.Interfaces.ChartTrendlineUpdateData#backwardPeriod:member + package: excel! + fullName: backwardPeriod + summary: Represents the number of periods that the trendline extends backward. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'backwardPeriod?: number;' + return: + type: number + - name: format + uid: excel!Excel.Interfaces.ChartTrendlineUpdateData#format:member + package: excel! + fullName: format + summary: Represents the formatting of a chart trendline. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartTrendlineFormatUpdateData;' + return: + type: >- + + - name: forwardPeriod + uid: excel!Excel.Interfaces.ChartTrendlineUpdateData#forwardPeriod:member + package: excel! + fullName: forwardPeriod + summary: Represents the number of periods that the trendline extends forward. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'forwardPeriod?: number;' + return: + type: number + - name: intercept + uid: excel!Excel.Interfaces.ChartTrendlineUpdateData#intercept:member + package: excel! + fullName: intercept + summary: >- + Represents the intercept value of the trendline. Can be set to a numeric + value or an empty string (for automatic values). The returned value is + always a number. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'intercept?: any;' + return: + type: any + - name: label + uid: excel!Excel.Interfaces.ChartTrendlineUpdateData#label:member + package: excel! + fullName: label + summary: Represents the label of a chart trendline. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'label?: Excel.Interfaces.ChartTrendlineLabelUpdateData;' + return: + type: >- + + - name: movingAveragePeriod + uid: excel!Excel.Interfaces.ChartTrendlineUpdateData#movingAveragePeriod:member + package: excel! + fullName: movingAveragePeriod + summary: >- + Represents the period of a chart trendline. Only applicable to trendlines + with the type `MovingAverage`. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'movingAveragePeriod?: number;' + return: + type: number + - name: name + uid: excel!Excel.Interfaces.ChartTrendlineUpdateData#name:member + package: excel! + fullName: name + summary: >- + Represents the name of the trendline. Can be set to a string value, a + `null` value represents automatic values. The returned value is always a + string + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: polynomialOrder + uid: excel!Excel.Interfaces.ChartTrendlineUpdateData#polynomialOrder:member + package: excel! + fullName: polynomialOrder + summary: >- + Represents the order of a chart trendline. Only applicable to trendlines + with the type `Polynomial`. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'polynomialOrder?: number;' + return: + type: number + - name: showEquation + uid: excel!Excel.Interfaces.ChartTrendlineUpdateData#showEquation:member + package: excel! + fullName: showEquation + summary: True if the equation for the trendline is displayed on the chart. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showEquation?: boolean;' + return: + type: boolean + - name: showRSquared + uid: excel!Excel.Interfaces.ChartTrendlineUpdateData#showRSquared:member + package: excel! + fullName: showRSquared + summary: True if the r-squared value for the trendline is displayed on the chart. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showRSquared?: boolean;' + return: + type: boolean + - name: type + uid: excel!Excel.Interfaces.ChartTrendlineUpdateData#type:member + package: excel! + fullName: type + summary: Represents the type of a chart trendline. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + type?: Excel.ChartTrendlineType | "Linear" | "Exponential" | + "Logarithmic" | "MovingAverage" | "Polynomial" | "Power"; + return: + type: >- + | "Linear" | + "Exponential" | "Logarithmic" | "MovingAverage" | "Polynomial" | + "Power" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartupdatedata.yml new file mode 100644 index 0000000000..517c6633e9 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.chartupdatedata.yml @@ -0,0 +1,405 @@ +### YamlMime:TSType +name: Excel.Interfaces.ChartUpdateData +uid: excel!Excel.Interfaces.ChartUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ChartUpdateData +summary: >- + An interface for updating data on the `Chart` object, for use in `chart.set({ + ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: axes + uid: excel!Excel.Interfaces.ChartUpdateData#axes:member + package: excel! + fullName: axes + summary: Represents chart axes. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'axes?: Excel.Interfaces.ChartAxesUpdateData;' + return: + type: + - name: categoryLabelLevel + uid: excel!Excel.Interfaces.ChartUpdateData#categoryLabelLevel:member + package: excel! + fullName: categoryLabelLevel + summary: >- + Specifies a chart category label level enumeration constant, referring to + the level of the source category labels. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'categoryLabelLevel?: number;' + return: + type: number + - name: chartType + uid: excel!Excel.Interfaces.ChartUpdateData#chartType:member + package: excel! + fullName: chartType + summary: Specifies the type of the chart. See `Excel.ChartType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + chartType?: Excel.ChartType | "Invalid" | "ColumnClustered" | + "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | + "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" + | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | + "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | + "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | + "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | + "XYScatterSmoothNoMarkers" | "XYScatterLines" | + "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | + "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | + "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | + "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | + "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" + | "CylinderColClustered" | "CylinderColStacked" | + "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" + | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | + "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | + "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | + "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | + "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | + "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | + "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | + "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | + "Sunburst" | "Funnel"; + return: + type: >- + | "Invalid" | + "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | + "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | + "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | + "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" + | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | + "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | + "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | + "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | + "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | + "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | + "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | + "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | + "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | + "CylinderColStacked100" | "CylinderBarClustered" | + "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | + "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | + "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | + "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | + "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | + "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" + | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | + "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | + "Treemap" | "Waterfall" | "Sunburst" | "Funnel" + - name: dataLabels + uid: excel!Excel.Interfaces.ChartUpdateData#dataLabels:member + package: excel! + fullName: dataLabels + summary: Represents the data labels on the chart. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'dataLabels?: Excel.Interfaces.ChartDataLabelsUpdateData;' + return: + type: >- + + - name: displayBlanksAs + uid: excel!Excel.Interfaces.ChartUpdateData#displayBlanksAs:member + package: excel! + fullName: displayBlanksAs + summary: Specifies the way that blank cells are plotted on a chart. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + displayBlanksAs?: Excel.ChartDisplayBlanksAs | "NotPlotted" | "Zero" | + "Interplotted"; + return: + type: >- + | "NotPlotted" | + "Zero" | "Interplotted" + - name: format + uid: excel!Excel.Interfaces.ChartUpdateData#format:member + package: excel! + fullName: format + summary: Encapsulates the format properties for the chart area. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ChartAreaFormatUpdateData;' + return: + type: >- + + - name: height + uid: excel!Excel.Interfaces.ChartUpdateData#height:member + package: excel! + fullName: height + summary: Specifies the height, in points, of the chart object. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height?: number;' + return: + type: number + - name: left + uid: excel!Excel.Interfaces.ChartUpdateData#left:member + package: excel! + fullName: left + summary: >- + The distance, in points, from the left side of the chart to the worksheet + origin. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: number;' + return: + type: number + - name: legend + uid: excel!Excel.Interfaces.ChartUpdateData#legend:member + package: excel! + fullName: legend + summary: Represents the legend for the chart. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'legend?: Excel.Interfaces.ChartLegendUpdateData;' + return: + type: + - name: name + uid: excel!Excel.Interfaces.ChartUpdateData#name:member + package: excel! + fullName: name + summary: Specifies the name of a chart object. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: pivotOptions + uid: excel!Excel.Interfaces.ChartUpdateData#pivotOptions:member + package: excel! + fullName: pivotOptions + summary: Encapsulates the options for a pivot chart. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'pivotOptions?: Excel.Interfaces.ChartPivotOptionsUpdateData;' + return: + type: >- + + - name: plotArea + uid: excel!Excel.Interfaces.ChartUpdateData#plotArea:member + package: excel! + fullName: plotArea + summary: Represents the plot area for the chart. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'plotArea?: Excel.Interfaces.ChartPlotAreaUpdateData;' + return: + type: >- + + - name: plotBy + uid: excel!Excel.Interfaces.ChartUpdateData#plotBy:member + package: excel! + fullName: plotBy + summary: Specifies the way columns or rows are used as data series on the chart. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'plotBy?: Excel.ChartPlotBy | "Rows" | "Columns";' + return: + type: | "Rows" | "Columns" + - name: plotVisibleOnly + uid: excel!Excel.Interfaces.ChartUpdateData#plotVisibleOnly:member + package: excel! + fullName: plotVisibleOnly + summary: >- + True if only visible cells are plotted. False if both visible and hidden + cells are plotted. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'plotVisibleOnly?: boolean;' + return: + type: boolean + - name: seriesNameLevel + uid: excel!Excel.Interfaces.ChartUpdateData#seriesNameLevel:member + package: excel! + fullName: seriesNameLevel + summary: >- + Specifies a chart series name level enumeration constant, referring to the + level of the source series names. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'seriesNameLevel?: number;' + return: + type: number + - name: showAllFieldButtons + uid: excel!Excel.Interfaces.ChartUpdateData#showAllFieldButtons:member + package: excel! + fullName: showAllFieldButtons + summary: Specifies whether to display all field buttons on a PivotChart. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showAllFieldButtons?: boolean;' + return: + type: boolean + - name: showDataLabelsOverMaximum + uid: excel!Excel.Interfaces.ChartUpdateData#showDataLabelsOverMaximum:member + package: excel! + fullName: showDataLabelsOverMaximum + summary: >- + Specifies whether to show the data labels when the value is greater than + the maximum value on the value axis. If the value axis becomes smaller + than the size of the data points, you can use this property to set whether + to show the data labels. This property applies to 2-D charts only. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showDataLabelsOverMaximum?: boolean;' + return: + type: boolean + - name: style + uid: excel!Excel.Interfaces.ChartUpdateData#style:member + package: excel! + fullName: style + summary: Specifies the chart style for the chart. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'style?: number;' + return: + type: number + - name: title + uid: excel!Excel.Interfaces.ChartUpdateData#title:member + package: excel! + fullName: title + summary: >- + Represents the title of the specified chart, including the text, + visibility, position, and formatting of the title. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'title?: Excel.Interfaces.ChartTitleUpdateData;' + return: + type: + - name: top + uid: excel!Excel.Interfaces.ChartUpdateData#top:member + package: excel! + fullName: top + summary: >- + Specifies the distance, in points, from the top edge of the object to the + top of row 1 (on a worksheet) or the top of the chart area (on a chart). + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: number;' + return: + type: number + - name: width + uid: excel!Excel.Interfaces.ChartUpdateData#width:member + package: excel! + fullName: width + summary: Specifies the width, in points, of the chart object. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.collectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.collectionloadoptions.yml new file mode 100644 index 0000000000..7cb2edf70d --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.collectionloadoptions.yml @@ -0,0 +1,43 @@ +### YamlMime:TSType +name: Excel.Interfaces.CollectionLoadOptions +uid: excel!Excel.Interfaces.CollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.CollectionLoadOptions +summary: Provides ways to load properties of only a subset of members of a collection. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $skip + uid: excel!Excel.Interfaces.CollectionLoadOptions#$skip:member + package: excel! + fullName: $skip + summary: >- + Specify the number of items in the collection that are to be skipped and + not included in the result. If top is specified, the selection of result + will start after skipping the specified number of items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$skip?: number;' + return: + type: number + - name: $top + uid: excel!Excel.Interfaces.CollectionLoadOptions#$top:member + package: excel! + fullName: $top + summary: >- + Specify the number of items in the queried collection to be included in + the result. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$top?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.colorscaleconditionalformatdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.colorscaleconditionalformatdata.yml new file mode 100644 index 0000000000..358778be59 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.colorscaleconditionalformatdata.yml @@ -0,0 +1,49 @@ +### YamlMime:TSType +name: Excel.Interfaces.ColorScaleConditionalFormatData +uid: excel!Excel.Interfaces.ColorScaleConditionalFormatData:interface +package: excel! +fullName: Excel.Interfaces.ColorScaleConditionalFormatData +summary: >- + An interface describing the data returned by calling + `colorScaleConditionalFormat.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: criteria + uid: excel!Excel.Interfaces.ColorScaleConditionalFormatData#criteria:member + package: excel! + fullName: criteria + summary: >- + The criteria of the color scale. Midpoint is optional when using a two + point color scale. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'criteria?: Excel.ConditionalColorScaleCriteria;' + return: + type: + - name: threeColorScale + uid: >- + excel!Excel.Interfaces.ColorScaleConditionalFormatData#threeColorScale:member + package: excel! + fullName: threeColorScale + summary: >- + If `true`, the color scale will have three points (minimum, + midpoint, maximum), otherwise it will have two (minimum, maximum). + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'threeColorScale?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.colorscaleconditionalformatloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.colorscaleconditionalformatloadoptions.yml new file mode 100644 index 0000000000..ef74ec7c19 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.colorscaleconditionalformatloadoptions.yml @@ -0,0 +1,66 @@ +### YamlMime:TSType +name: Excel.Interfaces.ColorScaleConditionalFormatLoadOptions +uid: excel!Excel.Interfaces.ColorScaleConditionalFormatLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ColorScaleConditionalFormatLoadOptions +summary: Represents the color scale criteria for conditional formatting. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ColorScaleConditionalFormatLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: criteria + uid: >- + excel!Excel.Interfaces.ColorScaleConditionalFormatLoadOptions#criteria:member + package: excel! + fullName: criteria + summary: >- + The criteria of the color scale. Midpoint is optional when using a two + point color scale. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'criteria?: boolean;' + return: + type: boolean + - name: threeColorScale + uid: >- + excel!Excel.Interfaces.ColorScaleConditionalFormatLoadOptions#threeColorScale:member + package: excel! + fullName: threeColorScale + summary: >- + If `true`, the color scale will have three points (minimum, + midpoint, maximum), otherwise it will have two (minimum, maximum). + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'threeColorScale?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.colorscaleconditionalformatupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.colorscaleconditionalformatupdatedata.yml new file mode 100644 index 0000000000..2db2f41834 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.colorscaleconditionalformatupdatedata.yml @@ -0,0 +1,32 @@ +### YamlMime:TSType +name: Excel.Interfaces.ColorScaleConditionalFormatUpdateData +uid: excel!Excel.Interfaces.ColorScaleConditionalFormatUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ColorScaleConditionalFormatUpdateData +summary: >- + An interface for updating data on the `ColorScaleConditionalFormat` object, + for use in `colorScaleConditionalFormat.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: criteria + uid: >- + excel!Excel.Interfaces.ColorScaleConditionalFormatUpdateData#criteria:member + package: excel! + fullName: criteria + summary: >- + The criteria of the color scale. Midpoint is optional when using a two + point color scale. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'criteria?: Excel.ConditionalColorScaleCriteria;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.commentcollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.commentcollectiondata.yml new file mode 100644 index 0000000000..3563583d49 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.commentcollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.CommentCollectionData +uid: excel!Excel.Interfaces.CommentCollectionData:interface +package: excel! +fullName: Excel.Interfaces.CommentCollectionData +summary: >- + An interface describing the data returned by calling + `commentCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.CommentCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.CommentData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.commentcollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.commentcollectionloadoptions.yml new file mode 100644 index 0000000000..0d53bb36bc --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.commentcollectionloadoptions.yml @@ -0,0 +1,186 @@ +### YamlMime:TSType +name: Excel.Interfaces.CommentCollectionLoadOptions +uid: excel!Excel.Interfaces.CommentCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.CommentCollectionLoadOptions +summary: Represents a collection of comment objects that are part of the workbook. +remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.CommentCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: authorEmail + uid: excel!Excel.Interfaces.CommentCollectionLoadOptions#authorEmail:member + package: excel! + fullName: authorEmail + summary: 'For EACH ITEM in the collection: Gets the email of the comment''s author.' + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'authorEmail?: boolean;' + return: + type: boolean + - name: authorName + uid: excel!Excel.Interfaces.CommentCollectionLoadOptions#authorName:member + package: excel! + fullName: authorName + summary: 'For EACH ITEM in the collection: Gets the name of the comment''s author.' + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'authorName?: boolean;' + return: + type: boolean + - name: content + uid: excel!Excel.Interfaces.CommentCollectionLoadOptions#content:member + package: excel! + fullName: content + summary: >- + For EACH ITEM in the collection: The comment's content. The string is + plain text. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'content?: boolean;' + return: + type: boolean + - name: contentType + uid: excel!Excel.Interfaces.CommentCollectionLoadOptions#contentType:member + package: excel! + fullName: contentType + summary: 'For EACH ITEM in the collection: Gets the content type of the comment.' + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'contentType?: boolean;' + return: + type: boolean + - name: creationDate + uid: excel!Excel.Interfaces.CommentCollectionLoadOptions#creationDate:member + package: excel! + fullName: creationDate + summary: >- + For EACH ITEM in the collection: Gets the creation time of the comment. + Returns `null` if the comment was converted from a note, since the comment + does not have a creation date. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'creationDate?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.CommentCollectionLoadOptions#id:member + package: excel! + fullName: id + summary: 'For EACH ITEM in the collection: Specifies the comment identifier.' + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: mentions + uid: excel!Excel.Interfaces.CommentCollectionLoadOptions#mentions:member + package: excel! + fullName: mentions + summary: >- + For EACH ITEM in the collection: Gets the entities (e.g., people) that are + mentioned in comments. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'mentions?: boolean;' + return: + type: boolean + - name: resolved + uid: excel!Excel.Interfaces.CommentCollectionLoadOptions#resolved:member + package: excel! + fullName: resolved + summary: >- + For EACH ITEM in the collection: The comment thread status. A value of + `true` means that the comment thread is resolved. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'resolved?: boolean;' + return: + type: boolean + - name: richContent + uid: excel!Excel.Interfaces.CommentCollectionLoadOptions#richContent:member + package: excel! + fullName: richContent + summary: >- + For EACH ITEM in the collection: Gets the rich comment content (e.g., + mentions in comments). This string is not meant to be displayed to + end-users. Your add-in should only use this to parse rich comment content. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'richContent?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.commentcollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.commentcollectionupdatedata.yml new file mode 100644 index 0000000000..27e0e20136 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.commentcollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.CommentCollectionUpdateData +uid: excel!Excel.Interfaces.CommentCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.CommentCollectionUpdateData +summary: >- + An interface for updating data on the `CommentCollection` object, for use in + `commentCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.CommentCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.CommentData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.commentdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.commentdata.yml new file mode 100644 index 0000000000..ea1a5384a6 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.commentdata.yml @@ -0,0 +1,181 @@ +### YamlMime:TSType +name: Excel.Interfaces.CommentData +uid: excel!Excel.Interfaces.CommentData:interface +package: excel! +fullName: Excel.Interfaces.CommentData +summary: >- + An interface describing the data returned by calling `comment.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: authorEmail + uid: excel!Excel.Interfaces.CommentData#authorEmail:member + package: excel! + fullName: authorEmail + summary: Gets the email of the comment's author. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'authorEmail?: string;' + return: + type: string + - name: authorName + uid: excel!Excel.Interfaces.CommentData#authorName:member + package: excel! + fullName: authorName + summary: Gets the name of the comment's author. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'authorName?: string;' + return: + type: string + - name: content + uid: excel!Excel.Interfaces.CommentData#content:member + package: excel! + fullName: content + summary: The comment's content. The string is plain text. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'content?: string;' + return: + type: string + - name: contentType + uid: excel!Excel.Interfaces.CommentData#contentType:member + package: excel! + fullName: contentType + summary: Gets the content type of the comment. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'contentType?: Excel.ContentType | "Plain" | "Mention";' + return: + type: | "Plain" | "Mention" + - name: creationDate + uid: excel!Excel.Interfaces.CommentData#creationDate:member + package: excel! + fullName: creationDate + summary: >- + Gets the creation time of the comment. Returns `null` if the comment was + converted from a note, since the comment does not have a creation date. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'creationDate?: Date;' + return: + type: Date + - name: id + uid: excel!Excel.Interfaces.CommentData#id:member + package: excel! + fullName: id + summary: Specifies the comment identifier. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: string;' + return: + type: string + - name: mentions + uid: excel!Excel.Interfaces.CommentData#mentions:member + package: excel! + fullName: mentions + summary: Gets the entities (e.g., people) that are mentioned in comments. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'mentions?: Excel.CommentMention[];' + return: + type: [] + - name: replies + uid: excel!Excel.Interfaces.CommentData#replies:member + package: excel! + fullName: replies + summary: Represents a collection of reply objects associated with the comment. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'replies?: Excel.Interfaces.CommentReplyData[];' + return: + type: [] + - name: resolved + uid: excel!Excel.Interfaces.CommentData#resolved:member + package: excel! + fullName: resolved + summary: >- + The comment thread status. A value of `true` means that the comment thread + is resolved. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'resolved?: boolean;' + return: + type: boolean + - name: richContent + uid: excel!Excel.Interfaces.CommentData#richContent:member + package: excel! + fullName: richContent + summary: >- + Gets the rich comment content (e.g., mentions in comments). This string is + not meant to be displayed to end-users. Your add-in should only use this + to parse rich comment content. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'richContent?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.commentloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.commentloadoptions.yml new file mode 100644 index 0000000000..7da0235cd1 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.commentloadoptions.yml @@ -0,0 +1,181 @@ +### YamlMime:TSType +name: Excel.Interfaces.CommentLoadOptions +uid: excel!Excel.Interfaces.CommentLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.CommentLoadOptions +summary: Represents a comment in the workbook. +remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.CommentLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: authorEmail + uid: excel!Excel.Interfaces.CommentLoadOptions#authorEmail:member + package: excel! + fullName: authorEmail + summary: Gets the email of the comment's author. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'authorEmail?: boolean;' + return: + type: boolean + - name: authorName + uid: excel!Excel.Interfaces.CommentLoadOptions#authorName:member + package: excel! + fullName: authorName + summary: Gets the name of the comment's author. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'authorName?: boolean;' + return: + type: boolean + - name: content + uid: excel!Excel.Interfaces.CommentLoadOptions#content:member + package: excel! + fullName: content + summary: The comment's content. The string is plain text. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'content?: boolean;' + return: + type: boolean + - name: contentType + uid: excel!Excel.Interfaces.CommentLoadOptions#contentType:member + package: excel! + fullName: contentType + summary: Gets the content type of the comment. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'contentType?: boolean;' + return: + type: boolean + - name: creationDate + uid: excel!Excel.Interfaces.CommentLoadOptions#creationDate:member + package: excel! + fullName: creationDate + summary: >- + Gets the creation time of the comment. Returns `null` if the comment was + converted from a note, since the comment does not have a creation date. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'creationDate?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.CommentLoadOptions#id:member + package: excel! + fullName: id + summary: Specifies the comment identifier. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: mentions + uid: excel!Excel.Interfaces.CommentLoadOptions#mentions:member + package: excel! + fullName: mentions + summary: Gets the entities (e.g., people) that are mentioned in comments. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'mentions?: boolean;' + return: + type: boolean + - name: resolved + uid: excel!Excel.Interfaces.CommentLoadOptions#resolved:member + package: excel! + fullName: resolved + summary: >- + The comment thread status. A value of `true` means that the comment thread + is resolved. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'resolved?: boolean;' + return: + type: boolean + - name: richContent + uid: excel!Excel.Interfaces.CommentLoadOptions#richContent:member + package: excel! + fullName: richContent + summary: >- + Gets the rich comment content (e.g., mentions in comments). This string is + not meant to be displayed to end-users. Your add-in should only use this + to parse rich comment content. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'richContent?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.commentreplycollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.commentreplycollectiondata.yml new file mode 100644 index 0000000000..6e611b0ecc --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.commentreplycollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.CommentReplyCollectionData +uid: excel!Excel.Interfaces.CommentReplyCollectionData:interface +package: excel! +fullName: Excel.Interfaces.CommentReplyCollectionData +summary: >- + An interface describing the data returned by calling + `commentReplyCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.CommentReplyCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.CommentReplyData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.commentreplycollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.commentreplycollectionloadoptions.yml new file mode 100644 index 0000000000..8b2bf28f84 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.commentreplycollectionloadoptions.yml @@ -0,0 +1,193 @@ +### YamlMime:TSType +name: Excel.Interfaces.CommentReplyCollectionLoadOptions +uid: excel!Excel.Interfaces.CommentReplyCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.CommentReplyCollectionLoadOptions +summary: Represents a collection of comment reply objects that are part of the comment. +remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.CommentReplyCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: authorEmail + uid: >- + excel!Excel.Interfaces.CommentReplyCollectionLoadOptions#authorEmail:member + package: excel! + fullName: authorEmail + summary: >- + For EACH ITEM in the collection: Gets the email of the comment reply's + author. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'authorEmail?: boolean;' + return: + type: boolean + - name: authorName + uid: excel!Excel.Interfaces.CommentReplyCollectionLoadOptions#authorName:member + package: excel! + fullName: authorName + summary: >- + For EACH ITEM in the collection: Gets the name of the comment reply's + author. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'authorName?: boolean;' + return: + type: boolean + - name: content + uid: excel!Excel.Interfaces.CommentReplyCollectionLoadOptions#content:member + package: excel! + fullName: content + summary: >- + For EACH ITEM in the collection: The comment reply's content. The string + is plain text. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'content?: boolean;' + return: + type: boolean + - name: contentType + uid: >- + excel!Excel.Interfaces.CommentReplyCollectionLoadOptions#contentType:member + package: excel! + fullName: contentType + summary: 'For EACH ITEM in the collection: The content type of the reply.' + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'contentType?: boolean;' + return: + type: boolean + - name: creationDate + uid: >- + excel!Excel.Interfaces.CommentReplyCollectionLoadOptions#creationDate:member + package: excel! + fullName: creationDate + summary: >- + For EACH ITEM in the collection: Gets the creation time of the comment + reply. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'creationDate?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.CommentReplyCollectionLoadOptions#id:member + package: excel! + fullName: id + summary: 'For EACH ITEM in the collection: Specifies the comment reply identifier.' + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: mentions + uid: excel!Excel.Interfaces.CommentReplyCollectionLoadOptions#mentions:member + package: excel! + fullName: mentions + summary: >- + For EACH ITEM in the collection: The entities (e.g., people) that are + mentioned in comments. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'mentions?: boolean;' + return: + type: boolean + - name: resolved + uid: excel!Excel.Interfaces.CommentReplyCollectionLoadOptions#resolved:member + package: excel! + fullName: resolved + summary: >- + For EACH ITEM in the collection: The comment reply status. A value of + `true` means the reply is in the resolved state. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'resolved?: boolean;' + return: + type: boolean + - name: richContent + uid: >- + excel!Excel.Interfaces.CommentReplyCollectionLoadOptions#richContent:member + package: excel! + fullName: richContent + summary: >- + For EACH ITEM in the collection: The rich comment content (e.g., mentions + in comments). This string is not meant to be displayed to end-users. Your + add-in should only use this to parse rich comment content. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'richContent?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.commentreplycollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.commentreplycollectionupdatedata.yml new file mode 100644 index 0000000000..de6d324296 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.commentreplycollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.CommentReplyCollectionUpdateData +uid: excel!Excel.Interfaces.CommentReplyCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.CommentReplyCollectionUpdateData +summary: >- + An interface for updating data on the `CommentReplyCollection` object, for use + in `commentReplyCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.CommentReplyCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.CommentReplyData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.commentreplydata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.commentreplydata.yml new file mode 100644 index 0000000000..88b9e2178e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.commentreplydata.yml @@ -0,0 +1,163 @@ +### YamlMime:TSType +name: Excel.Interfaces.CommentReplyData +uid: excel!Excel.Interfaces.CommentReplyData:interface +package: excel! +fullName: Excel.Interfaces.CommentReplyData +summary: >- + An interface describing the data returned by calling + `commentReply.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: authorEmail + uid: excel!Excel.Interfaces.CommentReplyData#authorEmail:member + package: excel! + fullName: authorEmail + summary: Gets the email of the comment reply's author. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'authorEmail?: string;' + return: + type: string + - name: authorName + uid: excel!Excel.Interfaces.CommentReplyData#authorName:member + package: excel! + fullName: authorName + summary: Gets the name of the comment reply's author. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'authorName?: string;' + return: + type: string + - name: content + uid: excel!Excel.Interfaces.CommentReplyData#content:member + package: excel! + fullName: content + summary: The comment reply's content. The string is plain text. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'content?: string;' + return: + type: string + - name: contentType + uid: excel!Excel.Interfaces.CommentReplyData#contentType:member + package: excel! + fullName: contentType + summary: The content type of the reply. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'contentType?: Excel.ContentType | "Plain" | "Mention";' + return: + type: | "Plain" | "Mention" + - name: creationDate + uid: excel!Excel.Interfaces.CommentReplyData#creationDate:member + package: excel! + fullName: creationDate + summary: Gets the creation time of the comment reply. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'creationDate?: Date;' + return: + type: Date + - name: id + uid: excel!Excel.Interfaces.CommentReplyData#id:member + package: excel! + fullName: id + summary: Specifies the comment reply identifier. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: string;' + return: + type: string + - name: mentions + uid: excel!Excel.Interfaces.CommentReplyData#mentions:member + package: excel! + fullName: mentions + summary: The entities (e.g., people) that are mentioned in comments. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'mentions?: Excel.CommentMention[];' + return: + type: [] + - name: resolved + uid: excel!Excel.Interfaces.CommentReplyData#resolved:member + package: excel! + fullName: resolved + summary: >- + The comment reply status. A value of `true` means the reply is in the + resolved state. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'resolved?: boolean;' + return: + type: boolean + - name: richContent + uid: excel!Excel.Interfaces.CommentReplyData#richContent:member + package: excel! + fullName: richContent + summary: >- + The rich comment content (e.g., mentions in comments). This string is not + meant to be displayed to end-users. Your add-in should only use this to + parse rich comment content. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'richContent?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.commentreplyloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.commentreplyloadoptions.yml new file mode 100644 index 0000000000..626028da68 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.commentreplyloadoptions.yml @@ -0,0 +1,179 @@ +### YamlMime:TSType +name: Excel.Interfaces.CommentReplyLoadOptions +uid: excel!Excel.Interfaces.CommentReplyLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.CommentReplyLoadOptions +summary: Represents a comment reply in the workbook. +remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.CommentReplyLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: authorEmail + uid: excel!Excel.Interfaces.CommentReplyLoadOptions#authorEmail:member + package: excel! + fullName: authorEmail + summary: Gets the email of the comment reply's author. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'authorEmail?: boolean;' + return: + type: boolean + - name: authorName + uid: excel!Excel.Interfaces.CommentReplyLoadOptions#authorName:member + package: excel! + fullName: authorName + summary: Gets the name of the comment reply's author. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'authorName?: boolean;' + return: + type: boolean + - name: content + uid: excel!Excel.Interfaces.CommentReplyLoadOptions#content:member + package: excel! + fullName: content + summary: The comment reply's content. The string is plain text. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'content?: boolean;' + return: + type: boolean + - name: contentType + uid: excel!Excel.Interfaces.CommentReplyLoadOptions#contentType:member + package: excel! + fullName: contentType + summary: The content type of the reply. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'contentType?: boolean;' + return: + type: boolean + - name: creationDate + uid: excel!Excel.Interfaces.CommentReplyLoadOptions#creationDate:member + package: excel! + fullName: creationDate + summary: Gets the creation time of the comment reply. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'creationDate?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.CommentReplyLoadOptions#id:member + package: excel! + fullName: id + summary: Specifies the comment reply identifier. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: mentions + uid: excel!Excel.Interfaces.CommentReplyLoadOptions#mentions:member + package: excel! + fullName: mentions + summary: The entities (e.g., people) that are mentioned in comments. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'mentions?: boolean;' + return: + type: boolean + - name: resolved + uid: excel!Excel.Interfaces.CommentReplyLoadOptions#resolved:member + package: excel! + fullName: resolved + summary: >- + The comment reply status. A value of `true` means the reply is in the + resolved state. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'resolved?: boolean;' + return: + type: boolean + - name: richContent + uid: excel!Excel.Interfaces.CommentReplyLoadOptions#richContent:member + package: excel! + fullName: richContent + summary: >- + The rich comment content (e.g., mentions in comments). This string is not + meant to be displayed to end-users. Your add-in should only use this to + parse rich comment content. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'richContent?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.commentreplyupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.commentreplyupdatedata.yml new file mode 100644 index 0000000000..1da2fb8d82 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.commentreplyupdatedata.yml @@ -0,0 +1,30 @@ +### YamlMime:TSType +name: Excel.Interfaces.CommentReplyUpdateData +uid: excel!Excel.Interfaces.CommentReplyUpdateData:interface +package: excel! +fullName: Excel.Interfaces.CommentReplyUpdateData +summary: >- + An interface for updating data on the `CommentReply` object, for use in + `commentReply.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: content + uid: excel!Excel.Interfaces.CommentReplyUpdateData#content:member + package: excel! + fullName: content + summary: The comment reply's content. The string is plain text. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'content?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.commentupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.commentupdatedata.yml new file mode 100644 index 0000000000..b86beca6b7 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.commentupdatedata.yml @@ -0,0 +1,48 @@ +### YamlMime:TSType +name: Excel.Interfaces.CommentUpdateData +uid: excel!Excel.Interfaces.CommentUpdateData:interface +package: excel! +fullName: Excel.Interfaces.CommentUpdateData +summary: >- + An interface for updating data on the `Comment` object, for use in + `comment.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: content + uid: excel!Excel.Interfaces.CommentUpdateData#content:member + package: excel! + fullName: content + summary: The comment's content. The string is plain text. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'content?: string;' + return: + type: string + - name: resolved + uid: excel!Excel.Interfaces.CommentUpdateData#resolved:member + package: excel! + fullName: resolved + summary: >- + The comment thread status. A value of `true` means that the comment thread + is resolved. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'resolved?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionaldatabarnegativeformatdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionaldatabarnegativeformatdata.yml new file mode 100644 index 0000000000..671719982f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionaldatabarnegativeformatdata.yml @@ -0,0 +1,87 @@ +### YamlMime:TSType +name: Excel.Interfaces.ConditionalDataBarNegativeFormatData +uid: excel!Excel.Interfaces.ConditionalDataBarNegativeFormatData:interface +package: excel! +fullName: Excel.Interfaces.ConditionalDataBarNegativeFormatData +summary: >- + An interface describing the data returned by calling + `conditionalDataBarNegativeFormat.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: borderColor + uid: >- + excel!Excel.Interfaces.ConditionalDataBarNegativeFormatData#borderColor:member + package: excel! + fullName: borderColor + summary: >- + HTML color code representing the color of the border line, in the form + \#RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). Value + is "" (an empty string) if no border is present or set. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'borderColor?: string;' + return: + type: string + - name: fillColor + uid: >- + excel!Excel.Interfaces.ConditionalDataBarNegativeFormatData#fillColor:member + package: excel! + fullName: fillColor + summary: >- + HTML color code representing the fill color, in the form \#RRGGBB (e.g., + "FFA500") or as a named HTML color (e.g., "orange"). + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'fillColor?: string;' + return: + type: string + - name: matchPositiveBorderColor + uid: >- + excel!Excel.Interfaces.ConditionalDataBarNegativeFormatData#matchPositiveBorderColor:member + package: excel! + fullName: matchPositiveBorderColor + summary: >- + Specifies if the negative data bar has the same border color as the + positive data bar. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'matchPositiveBorderColor?: boolean;' + return: + type: boolean + - name: matchPositiveFillColor + uid: >- + excel!Excel.Interfaces.ConditionalDataBarNegativeFormatData#matchPositiveFillColor:member + package: excel! + fullName: matchPositiveFillColor + summary: >- + Specifies if the negative data bar has the same fill color as the positive + data bar. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'matchPositiveFillColor?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionaldatabarnegativeformatloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionaldatabarnegativeformatloadoptions.yml new file mode 100644 index 0000000000..cfbba23f50 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionaldatabarnegativeformatloadoptions.yml @@ -0,0 +1,104 @@ +### YamlMime:TSType +name: Excel.Interfaces.ConditionalDataBarNegativeFormatLoadOptions +uid: excel!Excel.Interfaces.ConditionalDataBarNegativeFormatLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ConditionalDataBarNegativeFormatLoadOptions +summary: Represents a conditional format for the negative side of the data bar. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: >- + excel!Excel.Interfaces.ConditionalDataBarNegativeFormatLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: borderColor + uid: >- + excel!Excel.Interfaces.ConditionalDataBarNegativeFormatLoadOptions#borderColor:member + package: excel! + fullName: borderColor + summary: >- + HTML color code representing the color of the border line, in the form + \#RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). Value + is "" (an empty string) if no border is present or set. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'borderColor?: boolean;' + return: + type: boolean + - name: fillColor + uid: >- + excel!Excel.Interfaces.ConditionalDataBarNegativeFormatLoadOptions#fillColor:member + package: excel! + fullName: fillColor + summary: >- + HTML color code representing the fill color, in the form \#RRGGBB (e.g., + "FFA500") or as a named HTML color (e.g., "orange"). + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'fillColor?: boolean;' + return: + type: boolean + - name: matchPositiveBorderColor + uid: >- + excel!Excel.Interfaces.ConditionalDataBarNegativeFormatLoadOptions#matchPositiveBorderColor:member + package: excel! + fullName: matchPositiveBorderColor + summary: >- + Specifies if the negative data bar has the same border color as the + positive data bar. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'matchPositiveBorderColor?: boolean;' + return: + type: boolean + - name: matchPositiveFillColor + uid: >- + excel!Excel.Interfaces.ConditionalDataBarNegativeFormatLoadOptions#matchPositiveFillColor:member + package: excel! + fullName: matchPositiveFillColor + summary: >- + Specifies if the negative data bar has the same fill color as the positive + data bar. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'matchPositiveFillColor?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionaldatabarnegativeformatupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionaldatabarnegativeformatupdatedata.yml new file mode 100644 index 0000000000..9740130837 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionaldatabarnegativeformatupdatedata.yml @@ -0,0 +1,87 @@ +### YamlMime:TSType +name: Excel.Interfaces.ConditionalDataBarNegativeFormatUpdateData +uid: excel!Excel.Interfaces.ConditionalDataBarNegativeFormatUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ConditionalDataBarNegativeFormatUpdateData +summary: >- + An interface for updating data on the `ConditionalDataBarNegativeFormat` + object, for use in `conditionalDataBarNegativeFormat.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: borderColor + uid: >- + excel!Excel.Interfaces.ConditionalDataBarNegativeFormatUpdateData#borderColor:member + package: excel! + fullName: borderColor + summary: >- + HTML color code representing the color of the border line, in the form + \#RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). Value + is "" (an empty string) if no border is present or set. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'borderColor?: string;' + return: + type: string + - name: fillColor + uid: >- + excel!Excel.Interfaces.ConditionalDataBarNegativeFormatUpdateData#fillColor:member + package: excel! + fullName: fillColor + summary: >- + HTML color code representing the fill color, in the form \#RRGGBB (e.g., + "FFA500") or as a named HTML color (e.g., "orange"). + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'fillColor?: string;' + return: + type: string + - name: matchPositiveBorderColor + uid: >- + excel!Excel.Interfaces.ConditionalDataBarNegativeFormatUpdateData#matchPositiveBorderColor:member + package: excel! + fullName: matchPositiveBorderColor + summary: >- + Specifies if the negative data bar has the same border color as the + positive data bar. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'matchPositiveBorderColor?: boolean;' + return: + type: boolean + - name: matchPositiveFillColor + uid: >- + excel!Excel.Interfaces.ConditionalDataBarNegativeFormatUpdateData#matchPositiveFillColor:member + package: excel! + fullName: matchPositiveFillColor + summary: >- + Specifies if the negative data bar has the same fill color as the positive + data bar. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'matchPositiveFillColor?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionaldatabarpositiveformatdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionaldatabarpositiveformatdata.yml new file mode 100644 index 0000000000..f750f38bea --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionaldatabarpositiveformatdata.yml @@ -0,0 +1,67 @@ +### YamlMime:TSType +name: Excel.Interfaces.ConditionalDataBarPositiveFormatData +uid: excel!Excel.Interfaces.ConditionalDataBarPositiveFormatData:interface +package: excel! +fullName: Excel.Interfaces.ConditionalDataBarPositiveFormatData +summary: >- + An interface describing the data returned by calling + `conditionalDataBarPositiveFormat.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: borderColor + uid: >- + excel!Excel.Interfaces.ConditionalDataBarPositiveFormatData#borderColor:member + package: excel! + fullName: borderColor + summary: >- + HTML color code representing the color of the border line, in the form + \#RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). Value + is "" (an empty string) if no border is present or set. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'borderColor?: string;' + return: + type: string + - name: fillColor + uid: >- + excel!Excel.Interfaces.ConditionalDataBarPositiveFormatData#fillColor:member + package: excel! + fullName: fillColor + summary: >- + HTML color code representing the fill color, in the form \#RRGGBB (e.g., + "FFA500") or as a named HTML color (e.g., "orange"). + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'fillColor?: string;' + return: + type: string + - name: gradientFill + uid: >- + excel!Excel.Interfaces.ConditionalDataBarPositiveFormatData#gradientFill:member + package: excel! + fullName: gradientFill + summary: Specifies if the data bar has a gradient. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientFill?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionaldatabarpositiveformatloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionaldatabarpositiveformatloadoptions.yml new file mode 100644 index 0000000000..e76bb3e9da --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionaldatabarpositiveformatloadoptions.yml @@ -0,0 +1,84 @@ +### YamlMime:TSType +name: Excel.Interfaces.ConditionalDataBarPositiveFormatLoadOptions +uid: excel!Excel.Interfaces.ConditionalDataBarPositiveFormatLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ConditionalDataBarPositiveFormatLoadOptions +summary: Represents a conditional format for the positive side of the data bar. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: >- + excel!Excel.Interfaces.ConditionalDataBarPositiveFormatLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: borderColor + uid: >- + excel!Excel.Interfaces.ConditionalDataBarPositiveFormatLoadOptions#borderColor:member + package: excel! + fullName: borderColor + summary: >- + HTML color code representing the color of the border line, in the form + \#RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). Value + is "" (an empty string) if no border is present or set. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'borderColor?: boolean;' + return: + type: boolean + - name: fillColor + uid: >- + excel!Excel.Interfaces.ConditionalDataBarPositiveFormatLoadOptions#fillColor:member + package: excel! + fullName: fillColor + summary: >- + HTML color code representing the fill color, in the form \#RRGGBB (e.g., + "FFA500") or as a named HTML color (e.g., "orange"). + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'fillColor?: boolean;' + return: + type: boolean + - name: gradientFill + uid: >- + excel!Excel.Interfaces.ConditionalDataBarPositiveFormatLoadOptions#gradientFill:member + package: excel! + fullName: gradientFill + summary: Specifies if the data bar has a gradient. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientFill?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionaldatabarpositiveformatupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionaldatabarpositiveformatupdatedata.yml new file mode 100644 index 0000000000..f8da85c253 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionaldatabarpositiveformatupdatedata.yml @@ -0,0 +1,67 @@ +### YamlMime:TSType +name: Excel.Interfaces.ConditionalDataBarPositiveFormatUpdateData +uid: excel!Excel.Interfaces.ConditionalDataBarPositiveFormatUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ConditionalDataBarPositiveFormatUpdateData +summary: >- + An interface for updating data on the `ConditionalDataBarPositiveFormat` + object, for use in `conditionalDataBarPositiveFormat.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: borderColor + uid: >- + excel!Excel.Interfaces.ConditionalDataBarPositiveFormatUpdateData#borderColor:member + package: excel! + fullName: borderColor + summary: >- + HTML color code representing the color of the border line, in the form + \#RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). Value + is "" (an empty string) if no border is present or set. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'borderColor?: string;' + return: + type: string + - name: fillColor + uid: >- + excel!Excel.Interfaces.ConditionalDataBarPositiveFormatUpdateData#fillColor:member + package: excel! + fullName: fillColor + summary: >- + HTML color code representing the fill color, in the form \#RRGGBB (e.g., + "FFA500") or as a named HTML color (e.g., "orange"). + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'fillColor?: string;' + return: + type: string + - name: gradientFill + uid: >- + excel!Excel.Interfaces.ConditionalDataBarPositiveFormatUpdateData#gradientFill:member + package: excel! + fullName: gradientFill + summary: Specifies if the data bar has a gradient. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'gradientFill?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalformatcollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalformatcollectiondata.yml new file mode 100644 index 0000000000..c50d1f9ae3 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalformatcollectiondata.yml @@ -0,0 +1,29 @@ +### YamlMime:TSType +name: Excel.Interfaces.ConditionalFormatCollectionData +uid: excel!Excel.Interfaces.ConditionalFormatCollectionData:interface +package: excel! +fullName: Excel.Interfaces.ConditionalFormatCollectionData +summary: >- + An interface describing the data returned by calling + `conditionalFormatCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.ConditionalFormatCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.ConditionalFormatData[];' + return: + type: >- + [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalformatcollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalformatcollectionloadoptions.yml new file mode 100644 index 0000000000..ac7be2a5c4 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalformatcollectionloadoptions.yml @@ -0,0 +1,469 @@ +### YamlMime:TSType +name: Excel.Interfaces.ConditionalFormatCollectionLoadOptions +uid: excel!Excel.Interfaces.ConditionalFormatCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ConditionalFormatCollectionLoadOptions +summary: >- + Represents a collection of all the conditional formats that are overlap the + range. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ConditionalFormatCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: cellValue + uid: >- + excel!Excel.Interfaces.ConditionalFormatCollectionLoadOptions#cellValue:member + package: excel! + fullName: cellValue + summary: >- + For EACH ITEM in the collection: Returns the cell value conditional format + properties if the current conditional format is a `CellValue` type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'cellValue?: Excel.Interfaces.CellValueConditionalFormatLoadOptions;' + return: + type: >- + + - name: cellValueOrNullObject + uid: >- + excel!Excel.Interfaces.ConditionalFormatCollectionLoadOptions#cellValueOrNullObject:member + package: excel! + fullName: cellValueOrNullObject + summary: >- + For EACH ITEM in the collection: Returns the cell value conditional format + properties if the current conditional format is a `CellValue` type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + cellValueOrNullObject?: + Excel.Interfaces.CellValueConditionalFormatLoadOptions; + return: + type: >- + + - name: colorScale + uid: >- + excel!Excel.Interfaces.ConditionalFormatCollectionLoadOptions#colorScale:member + package: excel! + fullName: colorScale + summary: >- + For EACH ITEM in the collection: Returns the color scale conditional + format properties if the current conditional format is a `ColorScale` + type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'colorScale?: Excel.Interfaces.ColorScaleConditionalFormatLoadOptions;' + return: + type: >- + + - name: colorScaleOrNullObject + uid: >- + excel!Excel.Interfaces.ConditionalFormatCollectionLoadOptions#colorScaleOrNullObject:member + package: excel! + fullName: colorScaleOrNullObject + summary: >- + For EACH ITEM in the collection: Returns the color scale conditional + format properties if the current conditional format is a `ColorScale` + type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + colorScaleOrNullObject?: + Excel.Interfaces.ColorScaleConditionalFormatLoadOptions; + return: + type: >- + + - name: custom + uid: >- + excel!Excel.Interfaces.ConditionalFormatCollectionLoadOptions#custom:member + package: excel! + fullName: custom + summary: >- + For EACH ITEM in the collection: Returns the custom conditional format + properties if the current conditional format is a custom type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'custom?: Excel.Interfaces.CustomConditionalFormatLoadOptions;' + return: + type: >- + + - name: customOrNullObject + uid: >- + excel!Excel.Interfaces.ConditionalFormatCollectionLoadOptions#customOrNullObject:member + package: excel! + fullName: customOrNullObject + summary: >- + For EACH ITEM in the collection: Returns the custom conditional format + properties if the current conditional format is a custom type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + customOrNullObject?: + Excel.Interfaces.CustomConditionalFormatLoadOptions; + return: + type: >- + + - name: dataBar + uid: >- + excel!Excel.Interfaces.ConditionalFormatCollectionLoadOptions#dataBar:member + package: excel! + fullName: dataBar + summary: >- + For EACH ITEM in the collection: Returns the data bar properties if the + current conditional format is a data bar. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'dataBar?: Excel.Interfaces.DataBarConditionalFormatLoadOptions;' + return: + type: >- + + - name: dataBarOrNullObject + uid: >- + excel!Excel.Interfaces.ConditionalFormatCollectionLoadOptions#dataBarOrNullObject:member + package: excel! + fullName: dataBarOrNullObject + summary: >- + For EACH ITEM in the collection: Returns the data bar properties if the + current conditional format is a data bar. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + dataBarOrNullObject?: + Excel.Interfaces.DataBarConditionalFormatLoadOptions; + return: + type: >- + + - name: iconSet + uid: >- + excel!Excel.Interfaces.ConditionalFormatCollectionLoadOptions#iconSet:member + package: excel! + fullName: iconSet + summary: >- + For EACH ITEM in the collection: Returns the icon set conditional format + properties if the current conditional format is an `IconSet` type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'iconSet?: Excel.Interfaces.IconSetConditionalFormatLoadOptions;' + return: + type: >- + + - name: iconSetOrNullObject + uid: >- + excel!Excel.Interfaces.ConditionalFormatCollectionLoadOptions#iconSetOrNullObject:member + package: excel! + fullName: iconSetOrNullObject + summary: >- + For EACH ITEM in the collection: Returns the icon set conditional format + properties if the current conditional format is an `IconSet` type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + iconSetOrNullObject?: + Excel.Interfaces.IconSetConditionalFormatLoadOptions; + return: + type: >- + + - name: id + uid: excel!Excel.Interfaces.ConditionalFormatCollectionLoadOptions#id:member + package: excel! + fullName: id + summary: >- + For EACH ITEM in the collection: The priority of the conditional format in + the current `ConditionalFormatCollection`. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: preset + uid: >- + excel!Excel.Interfaces.ConditionalFormatCollectionLoadOptions#preset:member + package: excel! + fullName: preset + summary: >- + For EACH ITEM in the collection: Returns the preset criteria conditional + format. See `Excel.PresetCriteriaConditionalFormat` for more details. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'preset?: Excel.Interfaces.PresetCriteriaConditionalFormatLoadOptions;' + return: + type: >- + + - name: presetOrNullObject + uid: >- + excel!Excel.Interfaces.ConditionalFormatCollectionLoadOptions#presetOrNullObject:member + package: excel! + fullName: presetOrNullObject + summary: >- + For EACH ITEM in the collection: Returns the preset criteria conditional + format. See `Excel.PresetCriteriaConditionalFormat` for more details. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + presetOrNullObject?: + Excel.Interfaces.PresetCriteriaConditionalFormatLoadOptions; + return: + type: >- + + - name: priority + uid: >- + excel!Excel.Interfaces.ConditionalFormatCollectionLoadOptions#priority:member + package: excel! + fullName: priority + summary: >- + For EACH ITEM in the collection: The priority (or index) within the + conditional format collection that this conditional format currently + exists in. Changing this also changes other conditional formats' + priorities, to allow for a contiguous priority order. Use a negative + priority to begin from the back. Priorities greater than the bounds will + get and set to the maximum (or minimum if negative) priority. Also note + that if you change the priority, you have to re-fetch a new copy of the + object at that new priority location if you want to make further changes + to it. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'priority?: boolean;' + return: + type: boolean + - name: stopIfTrue + uid: >- + excel!Excel.Interfaces.ConditionalFormatCollectionLoadOptions#stopIfTrue:member + package: excel! + fullName: stopIfTrue + summary: >- + For EACH ITEM in the collection: If the conditions of this conditional + format are met, no lower-priority formats shall take effect on that cell. + Value is `null` on data bars, icon sets, and color scales as there's no + concept of `StopIfTrue` for these. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'stopIfTrue?: boolean;' + return: + type: boolean + - name: textComparison + uid: >- + excel!Excel.Interfaces.ConditionalFormatCollectionLoadOptions#textComparison:member + package: excel! + fullName: textComparison + summary: >- + For EACH ITEM in the collection: Returns the specific text conditional + format properties if the current conditional format is a text type. For + example, to format cells matching the word "Text". + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textComparison?: Excel.Interfaces.TextConditionalFormatLoadOptions;' + return: + type: >- + + - name: textComparisonOrNullObject + uid: >- + excel!Excel.Interfaces.ConditionalFormatCollectionLoadOptions#textComparisonOrNullObject:member + package: excel! + fullName: textComparisonOrNullObject + summary: >- + For EACH ITEM in the collection: Returns the specific text conditional + format properties if the current conditional format is a text type. For + example, to format cells matching the word "Text". + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + textComparisonOrNullObject?: + Excel.Interfaces.TextConditionalFormatLoadOptions; + return: + type: >- + + - name: topBottom + uid: >- + excel!Excel.Interfaces.ConditionalFormatCollectionLoadOptions#topBottom:member + package: excel! + fullName: topBottom + summary: >- + For EACH ITEM in the collection: Returns the top/bottom conditional format + properties if the current conditional format is a `TopBottom` type. For + example, to format the top 10% or bottom 10 items. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'topBottom?: Excel.Interfaces.TopBottomConditionalFormatLoadOptions;' + return: + type: >- + + - name: topBottomOrNullObject + uid: >- + excel!Excel.Interfaces.ConditionalFormatCollectionLoadOptions#topBottomOrNullObject:member + package: excel! + fullName: topBottomOrNullObject + summary: >- + For EACH ITEM in the collection: Returns the top/bottom conditional format + properties if the current conditional format is a `TopBottom` type. For + example, to format the top 10% or bottom 10 items. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + topBottomOrNullObject?: + Excel.Interfaces.TopBottomConditionalFormatLoadOptions; + return: + type: >- + + - name: type + uid: excel!Excel.Interfaces.ConditionalFormatCollectionLoadOptions#type:member + package: excel! + fullName: type + summary: >- + For EACH ITEM in the collection: A type of conditional format. Only one + can be set at a time. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalformatcollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalformatcollectionupdatedata.yml new file mode 100644 index 0000000000..d47e93ec1e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalformatcollectionupdatedata.yml @@ -0,0 +1,29 @@ +### YamlMime:TSType +name: Excel.Interfaces.ConditionalFormatCollectionUpdateData +uid: excel!Excel.Interfaces.ConditionalFormatCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ConditionalFormatCollectionUpdateData +summary: >- + An interface for updating data on the `ConditionalFormatCollection` object, + for use in `conditionalFormatCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.ConditionalFormatCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.ConditionalFormatData[];' + return: + type: >- + [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalformatdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalformatdata.yml new file mode 100644 index 0000000000..fab7e6dd72 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalformatdata.yml @@ -0,0 +1,414 @@ +### YamlMime:TSType +name: Excel.Interfaces.ConditionalFormatData +uid: excel!Excel.Interfaces.ConditionalFormatData:interface +package: excel! +fullName: Excel.Interfaces.ConditionalFormatData +summary: >- + An interface describing the data returned by calling + `conditionalFormat.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: cellValue + uid: excel!Excel.Interfaces.ConditionalFormatData#cellValue:member + package: excel! + fullName: cellValue + summary: >- + Returns the cell value conditional format properties if the current + conditional format is a `CellValue` type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'cellValue?: Excel.Interfaces.CellValueConditionalFormatData;' + return: + type: >- + + - name: cellValueOrNullObject + uid: excel!Excel.Interfaces.ConditionalFormatData#cellValueOrNullObject:member + package: excel! + fullName: cellValueOrNullObject + summary: >- + Returns the cell value conditional format properties if the current + conditional format is a `CellValue` type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'cellValueOrNullObject?: Excel.Interfaces.CellValueConditionalFormatData;' + return: + type: >- + + - name: colorScale + uid: excel!Excel.Interfaces.ConditionalFormatData#colorScale:member + package: excel! + fullName: colorScale + summary: >- + Returns the color scale conditional format properties if the current + conditional format is a `ColorScale` type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'colorScale?: Excel.Interfaces.ColorScaleConditionalFormatData;' + return: + type: >- + + - name: colorScaleOrNullObject + uid: excel!Excel.Interfaces.ConditionalFormatData#colorScaleOrNullObject:member + package: excel! + fullName: colorScaleOrNullObject + summary: >- + Returns the color scale conditional format properties if the current + conditional format is a `ColorScale` type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + colorScaleOrNullObject?: + Excel.Interfaces.ColorScaleConditionalFormatData; + return: + type: >- + + - name: custom + uid: excel!Excel.Interfaces.ConditionalFormatData#custom:member + package: excel! + fullName: custom + summary: >- + Returns the custom conditional format properties if the current + conditional format is a custom type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'custom?: Excel.Interfaces.CustomConditionalFormatData;' + return: + type: >- + + - name: customOrNullObject + uid: excel!Excel.Interfaces.ConditionalFormatData#customOrNullObject:member + package: excel! + fullName: customOrNullObject + summary: >- + Returns the custom conditional format properties if the current + conditional format is a custom type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'customOrNullObject?: Excel.Interfaces.CustomConditionalFormatData;' + return: + type: >- + + - name: dataBar + uid: excel!Excel.Interfaces.ConditionalFormatData#dataBar:member + package: excel! + fullName: dataBar + summary: >- + Returns the data bar properties if the current conditional format is a + data bar. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'dataBar?: Excel.Interfaces.DataBarConditionalFormatData;' + return: + type: >- + + - name: dataBarOrNullObject + uid: excel!Excel.Interfaces.ConditionalFormatData#dataBarOrNullObject:member + package: excel! + fullName: dataBarOrNullObject + summary: >- + Returns the data bar properties if the current conditional format is a + data bar. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'dataBarOrNullObject?: Excel.Interfaces.DataBarConditionalFormatData;' + return: + type: >- + + - name: iconSet + uid: excel!Excel.Interfaces.ConditionalFormatData#iconSet:member + package: excel! + fullName: iconSet + summary: >- + Returns the icon set conditional format properties if the current + conditional format is an `IconSet` type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'iconSet?: Excel.Interfaces.IconSetConditionalFormatData;' + return: + type: >- + + - name: iconSetOrNullObject + uid: excel!Excel.Interfaces.ConditionalFormatData#iconSetOrNullObject:member + package: excel! + fullName: iconSetOrNullObject + summary: >- + Returns the icon set conditional format properties if the current + conditional format is an `IconSet` type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'iconSetOrNullObject?: Excel.Interfaces.IconSetConditionalFormatData;' + return: + type: >- + + - name: id + uid: excel!Excel.Interfaces.ConditionalFormatData#id:member + package: excel! + fullName: id + summary: >- + The priority of the conditional format in the current + `ConditionalFormatCollection`. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: string;' + return: + type: string + - name: preset + uid: excel!Excel.Interfaces.ConditionalFormatData#preset:member + package: excel! + fullName: preset + summary: >- + Returns the preset criteria conditional format. See + `Excel.PresetCriteriaConditionalFormat` for more details. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'preset?: Excel.Interfaces.PresetCriteriaConditionalFormatData;' + return: + type: >- + + - name: presetOrNullObject + uid: excel!Excel.Interfaces.ConditionalFormatData#presetOrNullObject:member + package: excel! + fullName: presetOrNullObject + summary: >- + Returns the preset criteria conditional format. See + `Excel.PresetCriteriaConditionalFormat` for more details. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + presetOrNullObject?: + Excel.Interfaces.PresetCriteriaConditionalFormatData; + return: + type: >- + + - name: priority + uid: excel!Excel.Interfaces.ConditionalFormatData#priority:member + package: excel! + fullName: priority + summary: >- + The priority (or index) within the conditional format collection that this + conditional format currently exists in. Changing this also changes other + conditional formats' priorities, to allow for a contiguous priority order. + Use a negative priority to begin from the back. Priorities greater than + the bounds will get and set to the maximum (or minimum if negative) + priority. Also note that if you change the priority, you have to re-fetch + a new copy of the object at that new priority location if you want to make + further changes to it. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'priority?: number;' + return: + type: number + - name: stopIfTrue + uid: excel!Excel.Interfaces.ConditionalFormatData#stopIfTrue:member + package: excel! + fullName: stopIfTrue + summary: >- + If the conditions of this conditional format are met, no lower-priority + formats shall take effect on that cell. Value is `null` on data bars, icon + sets, and color scales as there's no concept of `StopIfTrue` for these. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'stopIfTrue?: boolean;' + return: + type: boolean + - name: textComparison + uid: excel!Excel.Interfaces.ConditionalFormatData#textComparison:member + package: excel! + fullName: textComparison + summary: >- + Returns the specific text conditional format properties if the current + conditional format is a text type. For example, to format cells matching + the word "Text". + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textComparison?: Excel.Interfaces.TextConditionalFormatData;' + return: + type: >- + + - name: textComparisonOrNullObject + uid: >- + excel!Excel.Interfaces.ConditionalFormatData#textComparisonOrNullObject:member + package: excel! + fullName: textComparisonOrNullObject + summary: >- + Returns the specific text conditional format properties if the current + conditional format is a text type. For example, to format cells matching + the word "Text". + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textComparisonOrNullObject?: Excel.Interfaces.TextConditionalFormatData;' + return: + type: >- + + - name: topBottom + uid: excel!Excel.Interfaces.ConditionalFormatData#topBottom:member + package: excel! + fullName: topBottom + summary: >- + Returns the top/bottom conditional format properties if the current + conditional format is a `TopBottom` type. For example, to format the top + 10% or bottom 10 items. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'topBottom?: Excel.Interfaces.TopBottomConditionalFormatData;' + return: + type: >- + + - name: topBottomOrNullObject + uid: excel!Excel.Interfaces.ConditionalFormatData#topBottomOrNullObject:member + package: excel! + fullName: topBottomOrNullObject + summary: >- + Returns the top/bottom conditional format properties if the current + conditional format is a `TopBottom` type. For example, to format the top + 10% or bottom 10 items. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'topBottomOrNullObject?: Excel.Interfaces.TopBottomConditionalFormatData;' + return: + type: >- + + - name: type + uid: excel!Excel.Interfaces.ConditionalFormatData#type:member + package: excel! + fullName: type + summary: A type of conditional format. Only one can be set at a time. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + type?: Excel.ConditionalFormatType | "Custom" | "DataBar" | "ColorScale" + | "IconSet" | "TopBottom" | "PresetCriteria" | "ContainsText" | + "CellValue"; + return: + type: >- + | "Custom" | + "DataBar" | "ColorScale" | "IconSet" | "TopBottom" | "PresetCriteria" + | "ContainsText" | "CellValue" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalformatloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalformatloadoptions.yml new file mode 100644 index 0000000000..a91f3cbe68 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalformatloadoptions.yml @@ -0,0 +1,456 @@ +### YamlMime:TSType +name: Excel.Interfaces.ConditionalFormatLoadOptions +uid: excel!Excel.Interfaces.ConditionalFormatLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ConditionalFormatLoadOptions +summary: >- + An object encapsulating a conditional format's range, format, rule, and other + properties. To learn more about the conditional formatting object model, read + [Apply conditional formatting to Excel + ranges](https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-conditional-formatting). +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ConditionalFormatLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: cellValue + uid: excel!Excel.Interfaces.ConditionalFormatLoadOptions#cellValue:member + package: excel! + fullName: cellValue + summary: >- + Returns the cell value conditional format properties if the current + conditional format is a `CellValue` type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'cellValue?: Excel.Interfaces.CellValueConditionalFormatLoadOptions;' + return: + type: >- + + - name: cellValueOrNullObject + uid: >- + excel!Excel.Interfaces.ConditionalFormatLoadOptions#cellValueOrNullObject:member + package: excel! + fullName: cellValueOrNullObject + summary: >- + Returns the cell value conditional format properties if the current + conditional format is a `CellValue` type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + cellValueOrNullObject?: + Excel.Interfaces.CellValueConditionalFormatLoadOptions; + return: + type: >- + + - name: colorScale + uid: excel!Excel.Interfaces.ConditionalFormatLoadOptions#colorScale:member + package: excel! + fullName: colorScale + summary: >- + Returns the color scale conditional format properties if the current + conditional format is a `ColorScale` type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'colorScale?: Excel.Interfaces.ColorScaleConditionalFormatLoadOptions;' + return: + type: >- + + - name: colorScaleOrNullObject + uid: >- + excel!Excel.Interfaces.ConditionalFormatLoadOptions#colorScaleOrNullObject:member + package: excel! + fullName: colorScaleOrNullObject + summary: >- + Returns the color scale conditional format properties if the current + conditional format is a `ColorScale` type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + colorScaleOrNullObject?: + Excel.Interfaces.ColorScaleConditionalFormatLoadOptions; + return: + type: >- + + - name: custom + uid: excel!Excel.Interfaces.ConditionalFormatLoadOptions#custom:member + package: excel! + fullName: custom + summary: >- + Returns the custom conditional format properties if the current + conditional format is a custom type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'custom?: Excel.Interfaces.CustomConditionalFormatLoadOptions;' + return: + type: >- + + - name: customOrNullObject + uid: >- + excel!Excel.Interfaces.ConditionalFormatLoadOptions#customOrNullObject:member + package: excel! + fullName: customOrNullObject + summary: >- + Returns the custom conditional format properties if the current + conditional format is a custom type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + customOrNullObject?: + Excel.Interfaces.CustomConditionalFormatLoadOptions; + return: + type: >- + + - name: dataBar + uid: excel!Excel.Interfaces.ConditionalFormatLoadOptions#dataBar:member + package: excel! + fullName: dataBar + summary: >- + Returns the data bar properties if the current conditional format is a + data bar. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'dataBar?: Excel.Interfaces.DataBarConditionalFormatLoadOptions;' + return: + type: >- + + - name: dataBarOrNullObject + uid: >- + excel!Excel.Interfaces.ConditionalFormatLoadOptions#dataBarOrNullObject:member + package: excel! + fullName: dataBarOrNullObject + summary: >- + Returns the data bar properties if the current conditional format is a + data bar. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + dataBarOrNullObject?: + Excel.Interfaces.DataBarConditionalFormatLoadOptions; + return: + type: >- + + - name: iconSet + uid: excel!Excel.Interfaces.ConditionalFormatLoadOptions#iconSet:member + package: excel! + fullName: iconSet + summary: >- + Returns the icon set conditional format properties if the current + conditional format is an `IconSet` type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'iconSet?: Excel.Interfaces.IconSetConditionalFormatLoadOptions;' + return: + type: >- + + - name: iconSetOrNullObject + uid: >- + excel!Excel.Interfaces.ConditionalFormatLoadOptions#iconSetOrNullObject:member + package: excel! + fullName: iconSetOrNullObject + summary: >- + Returns the icon set conditional format properties if the current + conditional format is an `IconSet` type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + iconSetOrNullObject?: + Excel.Interfaces.IconSetConditionalFormatLoadOptions; + return: + type: >- + + - name: id + uid: excel!Excel.Interfaces.ConditionalFormatLoadOptions#id:member + package: excel! + fullName: id + summary: >- + The priority of the conditional format in the current + `ConditionalFormatCollection`. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: preset + uid: excel!Excel.Interfaces.ConditionalFormatLoadOptions#preset:member + package: excel! + fullName: preset + summary: >- + Returns the preset criteria conditional format. See + `Excel.PresetCriteriaConditionalFormat` for more details. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'preset?: Excel.Interfaces.PresetCriteriaConditionalFormatLoadOptions;' + return: + type: >- + + - name: presetOrNullObject + uid: >- + excel!Excel.Interfaces.ConditionalFormatLoadOptions#presetOrNullObject:member + package: excel! + fullName: presetOrNullObject + summary: >- + Returns the preset criteria conditional format. See + `Excel.PresetCriteriaConditionalFormat` for more details. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + presetOrNullObject?: + Excel.Interfaces.PresetCriteriaConditionalFormatLoadOptions; + return: + type: >- + + - name: priority + uid: excel!Excel.Interfaces.ConditionalFormatLoadOptions#priority:member + package: excel! + fullName: priority + summary: >- + The priority (or index) within the conditional format collection that this + conditional format currently exists in. Changing this also changes other + conditional formats' priorities, to allow for a contiguous priority order. + Use a negative priority to begin from the back. Priorities greater than + the bounds will get and set to the maximum (or minimum if negative) + priority. Also note that if you change the priority, you have to re-fetch + a new copy of the object at that new priority location if you want to make + further changes to it. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'priority?: boolean;' + return: + type: boolean + - name: stopIfTrue + uid: excel!Excel.Interfaces.ConditionalFormatLoadOptions#stopIfTrue:member + package: excel! + fullName: stopIfTrue + summary: >- + If the conditions of this conditional format are met, no lower-priority + formats shall take effect on that cell. Value is `null` on data bars, icon + sets, and color scales as there's no concept of `StopIfTrue` for these. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'stopIfTrue?: boolean;' + return: + type: boolean + - name: textComparison + uid: excel!Excel.Interfaces.ConditionalFormatLoadOptions#textComparison:member + package: excel! + fullName: textComparison + summary: >- + Returns the specific text conditional format properties if the current + conditional format is a text type. For example, to format cells matching + the word "Text". + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textComparison?: Excel.Interfaces.TextConditionalFormatLoadOptions;' + return: + type: >- + + - name: textComparisonOrNullObject + uid: >- + excel!Excel.Interfaces.ConditionalFormatLoadOptions#textComparisonOrNullObject:member + package: excel! + fullName: textComparisonOrNullObject + summary: >- + Returns the specific text conditional format properties if the current + conditional format is a text type. For example, to format cells matching + the word "Text". + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + textComparisonOrNullObject?: + Excel.Interfaces.TextConditionalFormatLoadOptions; + return: + type: >- + + - name: topBottom + uid: excel!Excel.Interfaces.ConditionalFormatLoadOptions#topBottom:member + package: excel! + fullName: topBottom + summary: >- + Returns the top/bottom conditional format properties if the current + conditional format is a `TopBottom` type. For example, to format the top + 10% or bottom 10 items. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'topBottom?: Excel.Interfaces.TopBottomConditionalFormatLoadOptions;' + return: + type: >- + + - name: topBottomOrNullObject + uid: >- + excel!Excel.Interfaces.ConditionalFormatLoadOptions#topBottomOrNullObject:member + package: excel! + fullName: topBottomOrNullObject + summary: >- + Returns the top/bottom conditional format properties if the current + conditional format is a `TopBottom` type. For example, to format the top + 10% or bottom 10 items. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + topBottomOrNullObject?: + Excel.Interfaces.TopBottomConditionalFormatLoadOptions; + return: + type: >- + + - name: type + uid: excel!Excel.Interfaces.ConditionalFormatLoadOptions#type:member + package: excel! + fullName: type + summary: A type of conditional format. Only one can be set at a time. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalformatruledata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalformatruledata.yml new file mode 100644 index 0000000000..5d0660a01d --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalformatruledata.yml @@ -0,0 +1,65 @@ +### YamlMime:TSType +name: Excel.Interfaces.ConditionalFormatRuleData +uid: excel!Excel.Interfaces.ConditionalFormatRuleData:interface +package: excel! +fullName: Excel.Interfaces.ConditionalFormatRuleData +summary: >- + An interface describing the data returned by calling + `conditionalFormatRule.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: formula + uid: excel!Excel.Interfaces.ConditionalFormatRuleData#formula:member + package: excel! + fullName: formula + summary: >- + The formula, if required, on which to evaluate the conditional format + rule. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formula?: string;' + return: + type: string + - name: formulaLocal + uid: excel!Excel.Interfaces.ConditionalFormatRuleData#formulaLocal:member + package: excel! + fullName: formulaLocal + summary: >- + The formula, if required, on which to evaluate the conditional format rule + in the user's language. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulaLocal?: string;' + return: + type: string + - name: formulaR1C1 + uid: excel!Excel.Interfaces.ConditionalFormatRuleData#formulaR1C1:member + package: excel! + fullName: formulaR1C1 + summary: >- + The formula, if required, on which to evaluate the conditional format rule + in R1C1-style notation. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulaR1C1?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalformatruleloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalformatruleloadoptions.yml new file mode 100644 index 0000000000..9d352e9f34 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalformatruleloadoptions.yml @@ -0,0 +1,82 @@ +### YamlMime:TSType +name: Excel.Interfaces.ConditionalFormatRuleLoadOptions +uid: excel!Excel.Interfaces.ConditionalFormatRuleLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ConditionalFormatRuleLoadOptions +summary: Represents a rule, for all traditional rule/format pairings. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ConditionalFormatRuleLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: formula + uid: excel!Excel.Interfaces.ConditionalFormatRuleLoadOptions#formula:member + package: excel! + fullName: formula + summary: >- + The formula, if required, on which to evaluate the conditional format + rule. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formula?: boolean;' + return: + type: boolean + - name: formulaLocal + uid: >- + excel!Excel.Interfaces.ConditionalFormatRuleLoadOptions#formulaLocal:member + package: excel! + fullName: formulaLocal + summary: >- + The formula, if required, on which to evaluate the conditional format rule + in the user's language. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulaLocal?: boolean;' + return: + type: boolean + - name: formulaR1C1 + uid: excel!Excel.Interfaces.ConditionalFormatRuleLoadOptions#formulaR1C1:member + package: excel! + fullName: formulaR1C1 + summary: >- + The formula, if required, on which to evaluate the conditional format rule + in R1C1-style notation. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulaR1C1?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalformatruleupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalformatruleupdatedata.yml new file mode 100644 index 0000000000..a3e8a89f10 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalformatruleupdatedata.yml @@ -0,0 +1,65 @@ +### YamlMime:TSType +name: Excel.Interfaces.ConditionalFormatRuleUpdateData +uid: excel!Excel.Interfaces.ConditionalFormatRuleUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ConditionalFormatRuleUpdateData +summary: >- + An interface for updating data on the `ConditionalFormatRule` object, for use + in `conditionalFormatRule.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: formula + uid: excel!Excel.Interfaces.ConditionalFormatRuleUpdateData#formula:member + package: excel! + fullName: formula + summary: >- + The formula, if required, on which to evaluate the conditional format + rule. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formula?: string;' + return: + type: string + - name: formulaLocal + uid: excel!Excel.Interfaces.ConditionalFormatRuleUpdateData#formulaLocal:member + package: excel! + fullName: formulaLocal + summary: >- + The formula, if required, on which to evaluate the conditional format rule + in the user's language. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulaLocal?: string;' + return: + type: string + - name: formulaR1C1 + uid: excel!Excel.Interfaces.ConditionalFormatRuleUpdateData#formulaR1C1:member + package: excel! + fullName: formulaR1C1 + summary: >- + The formula, if required, on which to evaluate the conditional format rule + in R1C1-style notation. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulaR1C1?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalformatupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalformatupdatedata.yml new file mode 100644 index 0000000000..34f526e26a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalformatupdatedata.yml @@ -0,0 +1,401 @@ +### YamlMime:TSType +name: Excel.Interfaces.ConditionalFormatUpdateData +uid: excel!Excel.Interfaces.ConditionalFormatUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ConditionalFormatUpdateData +summary: >- + An interface for updating data on the `ConditionalFormat` object, for use in + `conditionalFormat.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: cellValue + uid: excel!Excel.Interfaces.ConditionalFormatUpdateData#cellValue:member + package: excel! + fullName: cellValue + summary: >- + Returns the cell value conditional format properties if the current + conditional format is a `CellValue` type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'cellValue?: Excel.Interfaces.CellValueConditionalFormatUpdateData;' + return: + type: >- + + - name: cellValueOrNullObject + uid: >- + excel!Excel.Interfaces.ConditionalFormatUpdateData#cellValueOrNullObject:member + package: excel! + fullName: cellValueOrNullObject + summary: >- + Returns the cell value conditional format properties if the current + conditional format is a `CellValue` type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + cellValueOrNullObject?: + Excel.Interfaces.CellValueConditionalFormatUpdateData; + return: + type: >- + + - name: colorScale + uid: excel!Excel.Interfaces.ConditionalFormatUpdateData#colorScale:member + package: excel! + fullName: colorScale + summary: >- + Returns the color scale conditional format properties if the current + conditional format is a `ColorScale` type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'colorScale?: Excel.Interfaces.ColorScaleConditionalFormatUpdateData;' + return: + type: >- + + - name: colorScaleOrNullObject + uid: >- + excel!Excel.Interfaces.ConditionalFormatUpdateData#colorScaleOrNullObject:member + package: excel! + fullName: colorScaleOrNullObject + summary: >- + Returns the color scale conditional format properties if the current + conditional format is a `ColorScale` type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + colorScaleOrNullObject?: + Excel.Interfaces.ColorScaleConditionalFormatUpdateData; + return: + type: >- + + - name: custom + uid: excel!Excel.Interfaces.ConditionalFormatUpdateData#custom:member + package: excel! + fullName: custom + summary: >- + Returns the custom conditional format properties if the current + conditional format is a custom type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'custom?: Excel.Interfaces.CustomConditionalFormatUpdateData;' + return: + type: >- + + - name: customOrNullObject + uid: >- + excel!Excel.Interfaces.ConditionalFormatUpdateData#customOrNullObject:member + package: excel! + fullName: customOrNullObject + summary: >- + Returns the custom conditional format properties if the current + conditional format is a custom type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'customOrNullObject?: Excel.Interfaces.CustomConditionalFormatUpdateData;' + return: + type: >- + + - name: dataBar + uid: excel!Excel.Interfaces.ConditionalFormatUpdateData#dataBar:member + package: excel! + fullName: dataBar + summary: >- + Returns the data bar properties if the current conditional format is a + data bar. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'dataBar?: Excel.Interfaces.DataBarConditionalFormatUpdateData;' + return: + type: >- + + - name: dataBarOrNullObject + uid: >- + excel!Excel.Interfaces.ConditionalFormatUpdateData#dataBarOrNullObject:member + package: excel! + fullName: dataBarOrNullObject + summary: >- + Returns the data bar properties if the current conditional format is a + data bar. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + dataBarOrNullObject?: + Excel.Interfaces.DataBarConditionalFormatUpdateData; + return: + type: >- + + - name: iconSet + uid: excel!Excel.Interfaces.ConditionalFormatUpdateData#iconSet:member + package: excel! + fullName: iconSet + summary: >- + Returns the icon set conditional format properties if the current + conditional format is an `IconSet` type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'iconSet?: Excel.Interfaces.IconSetConditionalFormatUpdateData;' + return: + type: >- + + - name: iconSetOrNullObject + uid: >- + excel!Excel.Interfaces.ConditionalFormatUpdateData#iconSetOrNullObject:member + package: excel! + fullName: iconSetOrNullObject + summary: >- + Returns the icon set conditional format properties if the current + conditional format is an `IconSet` type. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + iconSetOrNullObject?: + Excel.Interfaces.IconSetConditionalFormatUpdateData; + return: + type: >- + + - name: preset + uid: excel!Excel.Interfaces.ConditionalFormatUpdateData#preset:member + package: excel! + fullName: preset + summary: >- + Returns the preset criteria conditional format. See + `Excel.PresetCriteriaConditionalFormat` for more details. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'preset?: Excel.Interfaces.PresetCriteriaConditionalFormatUpdateData;' + return: + type: >- + + - name: presetOrNullObject + uid: >- + excel!Excel.Interfaces.ConditionalFormatUpdateData#presetOrNullObject:member + package: excel! + fullName: presetOrNullObject + summary: >- + Returns the preset criteria conditional format. See + `Excel.PresetCriteriaConditionalFormat` for more details. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + presetOrNullObject?: + Excel.Interfaces.PresetCriteriaConditionalFormatUpdateData; + return: + type: >- + + - name: priority + uid: excel!Excel.Interfaces.ConditionalFormatUpdateData#priority:member + package: excel! + fullName: priority + summary: >- + The priority (or index) within the conditional format collection that this + conditional format currently exists in. Changing this also changes other + conditional formats' priorities, to allow for a contiguous priority order. + Use a negative priority to begin from the back. Priorities greater than + the bounds will get and set to the maximum (or minimum if negative) + priority. Also note that if you change the priority, you have to re-fetch + a new copy of the object at that new priority location if you want to make + further changes to it. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'priority?: number;' + return: + type: number + - name: stopIfTrue + uid: excel!Excel.Interfaces.ConditionalFormatUpdateData#stopIfTrue:member + package: excel! + fullName: stopIfTrue + summary: >- + If the conditions of this conditional format are met, no lower-priority + formats shall take effect on that cell. Value is `null` on data bars, icon + sets, and color scales as there's no concept of `StopIfTrue` for these. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'stopIfTrue?: boolean;' + return: + type: boolean + - name: textComparison + uid: excel!Excel.Interfaces.ConditionalFormatUpdateData#textComparison:member + package: excel! + fullName: textComparison + summary: >- + Returns the specific text conditional format properties if the current + conditional format is a text type. For example, to format cells matching + the word "Text". + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textComparison?: Excel.Interfaces.TextConditionalFormatUpdateData;' + return: + type: >- + + - name: textComparisonOrNullObject + uid: >- + excel!Excel.Interfaces.ConditionalFormatUpdateData#textComparisonOrNullObject:member + package: excel! + fullName: textComparisonOrNullObject + summary: >- + Returns the specific text conditional format properties if the current + conditional format is a text type. For example, to format cells matching + the word "Text". + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + textComparisonOrNullObject?: + Excel.Interfaces.TextConditionalFormatUpdateData; + return: + type: >- + + - name: topBottom + uid: excel!Excel.Interfaces.ConditionalFormatUpdateData#topBottom:member + package: excel! + fullName: topBottom + summary: >- + Returns the top/bottom conditional format properties if the current + conditional format is a `TopBottom` type. For example, to format the top + 10% or bottom 10 items. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'topBottom?: Excel.Interfaces.TopBottomConditionalFormatUpdateData;' + return: + type: >- + + - name: topBottomOrNullObject + uid: >- + excel!Excel.Interfaces.ConditionalFormatUpdateData#topBottomOrNullObject:member + package: excel! + fullName: topBottomOrNullObject + summary: >- + Returns the top/bottom conditional format properties if the current + conditional format is a `TopBottom` type. For example, to format the top + 10% or bottom 10 items. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + topBottomOrNullObject?: + Excel.Interfaces.TopBottomConditionalFormatUpdateData; + return: + type: >- + diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangebordercollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangebordercollectiondata.yml new file mode 100644 index 0000000000..d849d56048 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangebordercollectiondata.yml @@ -0,0 +1,29 @@ +### YamlMime:TSType +name: Excel.Interfaces.ConditionalRangeBorderCollectionData +uid: excel!Excel.Interfaces.ConditionalRangeBorderCollectionData:interface +package: excel! +fullName: Excel.Interfaces.ConditionalRangeBorderCollectionData +summary: >- + An interface describing the data returned by calling + `conditionalRangeBorderCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.ConditionalRangeBorderCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.ConditionalRangeBorderData[];' + return: + type: >- + [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangebordercollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangebordercollectionloadoptions.yml new file mode 100644 index 0000000000..829582d370 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangebordercollectionloadoptions.yml @@ -0,0 +1,88 @@ +### YamlMime:TSType +name: Excel.Interfaces.ConditionalRangeBorderCollectionLoadOptions +uid: excel!Excel.Interfaces.ConditionalRangeBorderCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ConditionalRangeBorderCollectionLoadOptions +summary: Represents the border objects that make up range border. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: >- + excel!Excel.Interfaces.ConditionalRangeBorderCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: color + uid: >- + excel!Excel.Interfaces.ConditionalRangeBorderCollectionLoadOptions#color:member + package: excel! + fullName: color + summary: >- + For EACH ITEM in the collection: HTML color code representing the color of + the border line, in the form \#RRGGBB (e.g., "FFA500") or as a named HTML + color (e.g., "orange"). + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: boolean;' + return: + type: boolean + - name: sideIndex + uid: >- + excel!Excel.Interfaces.ConditionalRangeBorderCollectionLoadOptions#sideIndex:member + package: excel! + fullName: sideIndex + summary: >- + For EACH ITEM in the collection: Constant value that indicates the + specific side of the border. See `Excel.ConditionalRangeBorderIndex` for + details. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'sideIndex?: boolean;' + return: + type: boolean + - name: style + uid: >- + excel!Excel.Interfaces.ConditionalRangeBorderCollectionLoadOptions#style:member + package: excel! + fullName: style + summary: >- + For EACH ITEM in the collection: One of the constants of line style + specifying the line style for the border. See `Excel.BorderLineStyle` for + details. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'style?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangebordercollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangebordercollectionupdatedata.yml new file mode 100644 index 0000000000..02f79403a3 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangebordercollectionupdatedata.yml @@ -0,0 +1,106 @@ +### YamlMime:TSType +name: Excel.Interfaces.ConditionalRangeBorderCollectionUpdateData +uid: excel!Excel.Interfaces.ConditionalRangeBorderCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ConditionalRangeBorderCollectionUpdateData +summary: >- + An interface for updating data on the `ConditionalRangeBorderCollection` + object, for use in `conditionalRangeBorderCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: bottom + uid: >- + excel!Excel.Interfaces.ConditionalRangeBorderCollectionUpdateData#bottom:member + package: excel! + fullName: bottom + summary: Gets the bottom border. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'bottom?: Excel.Interfaces.ConditionalRangeBorderUpdateData;' + return: + type: >- + + - name: items + uid: >- + excel!Excel.Interfaces.ConditionalRangeBorderCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.ConditionalRangeBorderData[];' + return: + type: >- + [] + - name: left + uid: >- + excel!Excel.Interfaces.ConditionalRangeBorderCollectionUpdateData#left:member + package: excel! + fullName: left + summary: Gets the left border. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: Excel.Interfaces.ConditionalRangeBorderUpdateData;' + return: + type: >- + + - name: right + uid: >- + excel!Excel.Interfaces.ConditionalRangeBorderCollectionUpdateData#right:member + package: excel! + fullName: right + summary: Gets the right border. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'right?: Excel.Interfaces.ConditionalRangeBorderUpdateData;' + return: + type: >- + + - name: top + uid: >- + excel!Excel.Interfaces.ConditionalRangeBorderCollectionUpdateData#top:member + package: excel! + fullName: top + summary: Gets the top border. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: Excel.Interfaces.ConditionalRangeBorderUpdateData;' + return: + type: >- + diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangeborderdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangeborderdata.yml new file mode 100644 index 0000000000..28de2880b6 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangeborderdata.yml @@ -0,0 +1,73 @@ +### YamlMime:TSType +name: Excel.Interfaces.ConditionalRangeBorderData +uid: excel!Excel.Interfaces.ConditionalRangeBorderData:interface +package: excel! +fullName: Excel.Interfaces.ConditionalRangeBorderData +summary: >- + An interface describing the data returned by calling + `conditionalRangeBorder.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: color + uid: excel!Excel.Interfaces.ConditionalRangeBorderData#color:member + package: excel! + fullName: color + summary: >- + HTML color code representing the color of the border line, in the form + \#RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: string;' + return: + type: string + - name: sideIndex + uid: excel!Excel.Interfaces.ConditionalRangeBorderData#sideIndex:member + package: excel! + fullName: sideIndex + summary: >- + Constant value that indicates the specific side of the border. See + `Excel.ConditionalRangeBorderIndex` for details. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + sideIndex?: Excel.ConditionalRangeBorderIndex | "EdgeTop" | "EdgeBottom" + | "EdgeLeft" | "EdgeRight"; + return: + type: >- + | + "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight" + - name: style + uid: excel!Excel.Interfaces.ConditionalRangeBorderData#style:member + package: excel! + fullName: style + summary: >- + One of the constants of line style specifying the line style for the + border. See `Excel.BorderLineStyle` for details. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + style?: Excel.ConditionalRangeBorderLineStyle | "None" | "Continuous" | + "Dash" | "DashDot" | "DashDotDot" | "Dot"; + return: + type: >- + | + "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangeborderloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangeborderloadoptions.yml new file mode 100644 index 0000000000..eb85624d29 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangeborderloadoptions.yml @@ -0,0 +1,81 @@ +### YamlMime:TSType +name: Excel.Interfaces.ConditionalRangeBorderLoadOptions +uid: excel!Excel.Interfaces.ConditionalRangeBorderLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ConditionalRangeBorderLoadOptions +summary: Represents the border of an object. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ConditionalRangeBorderLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: color + uid: excel!Excel.Interfaces.ConditionalRangeBorderLoadOptions#color:member + package: excel! + fullName: color + summary: >- + HTML color code representing the color of the border line, in the form + \#RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: boolean;' + return: + type: boolean + - name: sideIndex + uid: excel!Excel.Interfaces.ConditionalRangeBorderLoadOptions#sideIndex:member + package: excel! + fullName: sideIndex + summary: >- + Constant value that indicates the specific side of the border. See + `Excel.ConditionalRangeBorderIndex` for details. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'sideIndex?: boolean;' + return: + type: boolean + - name: style + uid: excel!Excel.Interfaces.ConditionalRangeBorderLoadOptions#style:member + package: excel! + fullName: style + summary: >- + One of the constants of line style specifying the line style for the + border. See `Excel.BorderLineStyle` for details. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'style?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangeborderupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangeborderupdatedata.yml new file mode 100644 index 0000000000..3d3fd3d9a7 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangeborderupdatedata.yml @@ -0,0 +1,52 @@ +### YamlMime:TSType +name: Excel.Interfaces.ConditionalRangeBorderUpdateData +uid: excel!Excel.Interfaces.ConditionalRangeBorderUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ConditionalRangeBorderUpdateData +summary: >- + An interface for updating data on the `ConditionalRangeBorder` object, for use + in `conditionalRangeBorder.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: color + uid: excel!Excel.Interfaces.ConditionalRangeBorderUpdateData#color:member + package: excel! + fullName: color + summary: >- + HTML color code representing the color of the border line, in the form + \#RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: string;' + return: + type: string + - name: style + uid: excel!Excel.Interfaces.ConditionalRangeBorderUpdateData#style:member + package: excel! + fullName: style + summary: >- + One of the constants of line style specifying the line style for the + border. See `Excel.BorderLineStyle` for details. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + style?: Excel.ConditionalRangeBorderLineStyle | "None" | "Continuous" | + "Dash" | "DashDot" | "DashDotDot" | "Dot"; + return: + type: >- + | + "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangefilldata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangefilldata.yml new file mode 100644 index 0000000000..332bc6510e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangefilldata.yml @@ -0,0 +1,31 @@ +### YamlMime:TSType +name: Excel.Interfaces.ConditionalRangeFillData +uid: excel!Excel.Interfaces.ConditionalRangeFillData:interface +package: excel! +fullName: Excel.Interfaces.ConditionalRangeFillData +summary: >- + An interface describing the data returned by calling + `conditionalRangeFill.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: color + uid: excel!Excel.Interfaces.ConditionalRangeFillData#color:member + package: excel! + fullName: color + summary: >- + HTML color code representing the color of the fill, in the form \#RRGGBB + (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangefillloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangefillloadoptions.yml new file mode 100644 index 0000000000..b3a7a9c9ca --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangefillloadoptions.yml @@ -0,0 +1,47 @@ +### YamlMime:TSType +name: Excel.Interfaces.ConditionalRangeFillLoadOptions +uid: excel!Excel.Interfaces.ConditionalRangeFillLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ConditionalRangeFillLoadOptions +summary: Represents the background of a conditional range object. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ConditionalRangeFillLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: color + uid: excel!Excel.Interfaces.ConditionalRangeFillLoadOptions#color:member + package: excel! + fullName: color + summary: >- + HTML color code representing the color of the fill, in the form \#RRGGBB + (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangefillupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangefillupdatedata.yml new file mode 100644 index 0000000000..38c1c598e1 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangefillupdatedata.yml @@ -0,0 +1,31 @@ +### YamlMime:TSType +name: Excel.Interfaces.ConditionalRangeFillUpdateData +uid: excel!Excel.Interfaces.ConditionalRangeFillUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ConditionalRangeFillUpdateData +summary: >- + An interface for updating data on the `ConditionalRangeFill` object, for use + in `conditionalRangeFill.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: color + uid: excel!Excel.Interfaces.ConditionalRangeFillUpdateData#color:member + package: excel! + fullName: color + summary: >- + HTML color code representing the color of the fill, in the form \#RRGGBB + (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangefontdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangefontdata.yml new file mode 100644 index 0000000000..63f4a51ea2 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangefontdata.yml @@ -0,0 +1,97 @@ +### YamlMime:TSType +name: Excel.Interfaces.ConditionalRangeFontData +uid: excel!Excel.Interfaces.ConditionalRangeFontData:interface +package: excel! +fullName: Excel.Interfaces.ConditionalRangeFontData +summary: >- + An interface describing the data returned by calling + `conditionalRangeFont.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: bold + uid: excel!Excel.Interfaces.ConditionalRangeFontData#bold:member + package: excel! + fullName: bold + summary: Specifies if the font is bold. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'bold?: boolean;' + return: + type: boolean + - name: color + uid: excel!Excel.Interfaces.ConditionalRangeFontData#color:member + package: excel! + fullName: color + summary: >- + HTML color code representation of the text color (e.g., \#FF0000 + represents Red). + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: string;' + return: + type: string + - name: italic + uid: excel!Excel.Interfaces.ConditionalRangeFontData#italic:member + package: excel! + fullName: italic + summary: Specifies if the font is italic. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'italic?: boolean;' + return: + type: boolean + - name: strikethrough + uid: excel!Excel.Interfaces.ConditionalRangeFontData#strikethrough:member + package: excel! + fullName: strikethrough + summary: Specifies the strikethrough status of the font. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'strikethrough?: boolean;' + return: + type: boolean + - name: underline + uid: excel!Excel.Interfaces.ConditionalRangeFontData#underline:member + package: excel! + fullName: underline + summary: >- + The type of underline applied to the font. See + `Excel.ConditionalRangeFontUnderlineStyle` for details. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + underline?: Excel.ConditionalRangeFontUnderlineStyle | "None" | "Single" + | "Double"; + return: + type: >- + | + "None" | "Single" | "Double" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangefontloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangefontloadoptions.yml new file mode 100644 index 0000000000..43edce1e53 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangefontloadoptions.yml @@ -0,0 +1,112 @@ +### YamlMime:TSType +name: Excel.Interfaces.ConditionalRangeFontLoadOptions +uid: excel!Excel.Interfaces.ConditionalRangeFontLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ConditionalRangeFontLoadOptions +summary: >- + This object represents the font attributes (font style, color, etc.) for an + object. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ConditionalRangeFontLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: bold + uid: excel!Excel.Interfaces.ConditionalRangeFontLoadOptions#bold:member + package: excel! + fullName: bold + summary: Specifies if the font is bold. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'bold?: boolean;' + return: + type: boolean + - name: color + uid: excel!Excel.Interfaces.ConditionalRangeFontLoadOptions#color:member + package: excel! + fullName: color + summary: >- + HTML color code representation of the text color (e.g., \#FF0000 + represents Red). + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: boolean;' + return: + type: boolean + - name: italic + uid: excel!Excel.Interfaces.ConditionalRangeFontLoadOptions#italic:member + package: excel! + fullName: italic + summary: Specifies if the font is italic. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'italic?: boolean;' + return: + type: boolean + - name: strikethrough + uid: >- + excel!Excel.Interfaces.ConditionalRangeFontLoadOptions#strikethrough:member + package: excel! + fullName: strikethrough + summary: Specifies the strikethrough status of the font. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'strikethrough?: boolean;' + return: + type: boolean + - name: underline + uid: excel!Excel.Interfaces.ConditionalRangeFontLoadOptions#underline:member + package: excel! + fullName: underline + summary: >- + The type of underline applied to the font. See + `Excel.ConditionalRangeFontUnderlineStyle` for details. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'underline?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangefontupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangefontupdatedata.yml new file mode 100644 index 0000000000..8fe8cd3baa --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangefontupdatedata.yml @@ -0,0 +1,97 @@ +### YamlMime:TSType +name: Excel.Interfaces.ConditionalRangeFontUpdateData +uid: excel!Excel.Interfaces.ConditionalRangeFontUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ConditionalRangeFontUpdateData +summary: >- + An interface for updating data on the `ConditionalRangeFont` object, for use + in `conditionalRangeFont.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: bold + uid: excel!Excel.Interfaces.ConditionalRangeFontUpdateData#bold:member + package: excel! + fullName: bold + summary: Specifies if the font is bold. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'bold?: boolean;' + return: + type: boolean + - name: color + uid: excel!Excel.Interfaces.ConditionalRangeFontUpdateData#color:member + package: excel! + fullName: color + summary: >- + HTML color code representation of the text color (e.g., \#FF0000 + represents Red). + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: string;' + return: + type: string + - name: italic + uid: excel!Excel.Interfaces.ConditionalRangeFontUpdateData#italic:member + package: excel! + fullName: italic + summary: Specifies if the font is italic. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'italic?: boolean;' + return: + type: boolean + - name: strikethrough + uid: excel!Excel.Interfaces.ConditionalRangeFontUpdateData#strikethrough:member + package: excel! + fullName: strikethrough + summary: Specifies the strikethrough status of the font. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'strikethrough?: boolean;' + return: + type: boolean + - name: underline + uid: excel!Excel.Interfaces.ConditionalRangeFontUpdateData#underline:member + package: excel! + fullName: underline + summary: >- + The type of underline applied to the font. See + `Excel.ConditionalRangeFontUnderlineStyle` for details. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + underline?: Excel.ConditionalRangeFontUnderlineStyle | "None" | "Single" + | "Double"; + return: + type: >- + | + "None" | "Single" | "Double" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangeformatdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangeformatdata.yml new file mode 100644 index 0000000000..ac0e1bdad2 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangeformatdata.yml @@ -0,0 +1,86 @@ +### YamlMime:TSType +name: Excel.Interfaces.ConditionalRangeFormatData +uid: excel!Excel.Interfaces.ConditionalRangeFormatData:interface +package: excel! +fullName: Excel.Interfaces.ConditionalRangeFormatData +summary: >- + An interface describing the data returned by calling + `conditionalRangeFormat.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: borders + uid: excel!Excel.Interfaces.ConditionalRangeFormatData#borders:member + package: excel! + fullName: borders + summary: >- + Collection of border objects that apply to the overall conditional format + range. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'borders?: Excel.Interfaces.ConditionalRangeBorderData[];' + return: + type: >- + [] + - name: fill + uid: excel!Excel.Interfaces.ConditionalRangeFormatData#fill:member + package: excel! + fullName: fill + summary: Returns the fill object defined on the overall conditional format range. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'fill?: Excel.Interfaces.ConditionalRangeFillData;' + return: + type: >- + + - name: font + uid: excel!Excel.Interfaces.ConditionalRangeFormatData#font:member + package: excel! + fullName: font + summary: Returns the font object defined on the overall conditional format range. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.Interfaces.ConditionalRangeFontData;' + return: + type: >- + + - name: numberFormat + uid: excel!Excel.Interfaces.ConditionalRangeFormatData#numberFormat:member + package: excel! + fullName: numberFormat + summary: >- + Represents Excel's number format code for the given range. For more + information about Excel number formatting, see [Number format + codes](https://support.microsoft.com/office/5026bbd6-04bc-48cd-bf33-80f18b4eae68). Cleared if `null` is passed in. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat?: any;' + return: + type: any diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangeformatloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangeformatloadoptions.yml new file mode 100644 index 0000000000..4b719d42bf --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangeformatloadoptions.yml @@ -0,0 +1,108 @@ +### YamlMime:TSType +name: Excel.Interfaces.ConditionalRangeFormatLoadOptions +uid: excel!Excel.Interfaces.ConditionalRangeFormatLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ConditionalRangeFormatLoadOptions +summary: >- + A format object encapsulating the conditional formats range's font, fill, + borders, and other properties. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ConditionalRangeFormatLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: borders + uid: excel!Excel.Interfaces.ConditionalRangeFormatLoadOptions#borders:member + package: excel! + fullName: borders + summary: >- + Collection of border objects that apply to the overall conditional format + range. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'borders?: Excel.Interfaces.ConditionalRangeBorderCollectionLoadOptions;' + return: + type: >- + + - name: fill + uid: excel!Excel.Interfaces.ConditionalRangeFormatLoadOptions#fill:member + package: excel! + fullName: fill + summary: Returns the fill object defined on the overall conditional format range. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'fill?: Excel.Interfaces.ConditionalRangeFillLoadOptions;' + return: + type: >- + + - name: font + uid: excel!Excel.Interfaces.ConditionalRangeFormatLoadOptions#font:member + package: excel! + fullName: font + summary: Returns the font object defined on the overall conditional format range. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.Interfaces.ConditionalRangeFontLoadOptions;' + return: + type: >- + + - name: numberFormat + uid: >- + excel!Excel.Interfaces.ConditionalRangeFormatLoadOptions#numberFormat:member + package: excel! + fullName: numberFormat + summary: >- + Represents Excel's number format code for the given range. For more + information about Excel number formatting, see [Number format + codes](https://support.microsoft.com/office/5026bbd6-04bc-48cd-bf33-80f18b4eae68). Cleared if `null` is passed in. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangeformatupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangeformatupdatedata.yml new file mode 100644 index 0000000000..0d81fe9196 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.conditionalrangeformatupdatedata.yml @@ -0,0 +1,90 @@ +### YamlMime:TSType +name: Excel.Interfaces.ConditionalRangeFormatUpdateData +uid: excel!Excel.Interfaces.ConditionalRangeFormatUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ConditionalRangeFormatUpdateData +summary: >- + An interface for updating data on the `ConditionalRangeFormat` object, for use + in `conditionalRangeFormat.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: borders + uid: excel!Excel.Interfaces.ConditionalRangeFormatUpdateData#borders:member + package: excel! + fullName: borders + summary: >- + Collection of border objects that apply to the overall conditional format + range. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'borders?: Excel.Interfaces.ConditionalRangeBorderCollectionUpdateData;' + return: + type: >- + + - name: fill + uid: excel!Excel.Interfaces.ConditionalRangeFormatUpdateData#fill:member + package: excel! + fullName: fill + summary: Returns the fill object defined on the overall conditional format range. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'fill?: Excel.Interfaces.ConditionalRangeFillUpdateData;' + return: + type: >- + + - name: font + uid: excel!Excel.Interfaces.ConditionalRangeFormatUpdateData#font:member + package: excel! + fullName: font + summary: Returns the font object defined on the overall conditional format range. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.Interfaces.ConditionalRangeFontUpdateData;' + return: + type: >- + + - name: numberFormat + uid: >- + excel!Excel.Interfaces.ConditionalRangeFormatUpdateData#numberFormat:member + package: excel! + fullName: numberFormat + summary: >- + Represents Excel's number format code for the given range. For more + information about Excel number formatting, see [Number format + codes](https://support.microsoft.com/office/5026bbd6-04bc-48cd-bf33-80f18b4eae68). Cleared if `null` is passed in. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat?: any;' + return: + type: any diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.cultureinfodata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.cultureinfodata.yml new file mode 100644 index 0000000000..e4c29b0c3e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.cultureinfodata.yml @@ -0,0 +1,68 @@ +### YamlMime:TSType +name: Excel.Interfaces.CultureInfoData +uid: excel!Excel.Interfaces.CultureInfoData:interface +package: excel! +fullName: Excel.Interfaces.CultureInfoData +summary: >- + An interface describing the data returned by calling + `cultureInfo.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: datetimeFormat + uid: excel!Excel.Interfaces.CultureInfoData#datetimeFormat:member + package: excel! + fullName: datetimeFormat + summary: >- + Defines the culturally appropriate format of displaying date and time. + This is based on current system culture settings. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'datetimeFormat?: Excel.Interfaces.DatetimeFormatInfoData;' + return: + type: + - name: name + uid: excel!Excel.Interfaces.CultureInfoData#name:member + package: excel! + fullName: name + summary: >- + Gets the culture name in the format languagecode2-country/regioncode2 + (e.g., "zh-cn" or "en-us"). This is based on current system settings. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: numberFormat + uid: excel!Excel.Interfaces.CultureInfoData#numberFormat:member + package: excel! + fullName: numberFormat + summary: >- + Defines the culturally appropriate format of displaying numbers. This is + based on current system culture settings. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat?: Excel.Interfaces.NumberFormatInfoData;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.cultureinfoloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.cultureinfoloadoptions.yml new file mode 100644 index 0000000000..530896db4f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.cultureinfoloadoptions.yml @@ -0,0 +1,91 @@ +### YamlMime:TSType +name: Excel.Interfaces.CultureInfoLoadOptions +uid: excel!Excel.Interfaces.CultureInfoLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.CultureInfoLoadOptions +summary: >- + Provides information based on current system culture settings. This includes + the culture names, number formatting, and other culturally dependent settings. +remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.CultureInfoLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: datetimeFormat + uid: excel!Excel.Interfaces.CultureInfoLoadOptions#datetimeFormat:member + package: excel! + fullName: datetimeFormat + summary: >- + Defines the culturally appropriate format of displaying date and time. + This is based on current system culture settings. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'datetimeFormat?: Excel.Interfaces.DatetimeFormatInfoLoadOptions;' + return: + type: >- + + - name: name + uid: excel!Excel.Interfaces.CultureInfoLoadOptions#name:member + package: excel! + fullName: name + summary: >- + Gets the culture name in the format languagecode2-country/regioncode2 + (e.g., "zh-cn" or "en-us"). This is based on current system settings. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: numberFormat + uid: excel!Excel.Interfaces.CultureInfoLoadOptions#numberFormat:member + package: excel! + fullName: numberFormat + summary: >- + Defines the culturally appropriate format of displaying numbers. This is + based on current system culture settings. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat?: Excel.Interfaces.NumberFormatInfoLoadOptions;' + return: + type: >- + diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.customconditionalformatdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.customconditionalformatdata.yml new file mode 100644 index 0000000000..b81b7e5d97 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.customconditionalformatdata.yml @@ -0,0 +1,50 @@ +### YamlMime:TSType +name: Excel.Interfaces.CustomConditionalFormatData +uid: excel!Excel.Interfaces.CustomConditionalFormatData:interface +package: excel! +fullName: Excel.Interfaces.CustomConditionalFormatData +summary: >- + An interface describing the data returned by calling + `customConditionalFormat.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: format + uid: excel!Excel.Interfaces.CustomConditionalFormatData#format:member + package: excel! + fullName: format + summary: >- + Returns a format object, encapsulating the conditional formats font, fill, + borders, and other properties. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ConditionalRangeFormatData;' + return: + type: >- + + - name: rule + uid: excel!Excel.Interfaces.CustomConditionalFormatData#rule:member + package: excel! + fullName: rule + summary: Specifies the `Rule` object on this conditional format. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rule?: Excel.Interfaces.ConditionalFormatRuleData;' + return: + type: >- + diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.customconditionalformatloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.customconditionalformatloadoptions.yml new file mode 100644 index 0000000000..84bae0b202 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.customconditionalformatloadoptions.yml @@ -0,0 +1,68 @@ +### YamlMime:TSType +name: Excel.Interfaces.CustomConditionalFormatLoadOptions +uid: excel!Excel.Interfaces.CustomConditionalFormatLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.CustomConditionalFormatLoadOptions +summary: Represents a custom conditional format type. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.CustomConditionalFormatLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: format + uid: excel!Excel.Interfaces.CustomConditionalFormatLoadOptions#format:member + package: excel! + fullName: format + summary: >- + Returns a format object, encapsulating the conditional formats font, fill, + borders, and other properties. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ConditionalRangeFormatLoadOptions;' + return: + type: >- + + - name: rule + uid: excel!Excel.Interfaces.CustomConditionalFormatLoadOptions#rule:member + package: excel! + fullName: rule + summary: Specifies the `Rule` object on this conditional format. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rule?: Excel.Interfaces.ConditionalFormatRuleLoadOptions;' + return: + type: >- + diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.customconditionalformatupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.customconditionalformatupdatedata.yml new file mode 100644 index 0000000000..0dbefd9c9c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.customconditionalformatupdatedata.yml @@ -0,0 +1,52 @@ +### YamlMime:TSType +name: Excel.Interfaces.CustomConditionalFormatUpdateData +uid: excel!Excel.Interfaces.CustomConditionalFormatUpdateData:interface +package: excel! +fullName: Excel.Interfaces.CustomConditionalFormatUpdateData +summary: >- + An interface for updating data on the `CustomConditionalFormat` object, for + use in `customConditionalFormat.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: format + uid: excel!Excel.Interfaces.CustomConditionalFormatUpdateData#format:member + package: excel! + fullName: format + summary: >- + Returns a format object, encapsulating the conditional formats font, fill, + borders, and other properties. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ConditionalRangeFormatUpdateData;' + return: + type: >- + + - name: rule + uid: excel!Excel.Interfaces.CustomConditionalFormatUpdateData#rule:member + package: excel! + fullName: rule + summary: Specifies the `Rule` object on this conditional format. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rule?: Excel.Interfaces.ConditionalFormatRuleUpdateData;' + return: + type: >- + diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.customfunctionmanagerdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.customfunctionmanagerdata.yml new file mode 100644 index 0000000000..77bdbe0fa0 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.customfunctionmanagerdata.yml @@ -0,0 +1,13 @@ +### YamlMime:TSType +name: Excel.Interfaces.CustomFunctionManagerData +uid: excel!Excel.Interfaces.CustomFunctionManagerData:interface +package: excel! +fullName: Excel.Interfaces.CustomFunctionManagerData +summary: >- + An interface describing the data returned by calling + `customFunctionManager.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.custompropertycollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.custompropertycollectiondata.yml new file mode 100644 index 0000000000..f2790141d5 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.custompropertycollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.CustomPropertyCollectionData +uid: excel!Excel.Interfaces.CustomPropertyCollectionData:interface +package: excel! +fullName: Excel.Interfaces.CustomPropertyCollectionData +summary: >- + An interface describing the data returned by calling + `customPropertyCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.CustomPropertyCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.CustomPropertyData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.custompropertycollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.custompropertycollectionloadoptions.yml new file mode 100644 index 0000000000..1e1f4fa8b8 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.custompropertycollectionloadoptions.yml @@ -0,0 +1,83 @@ +### YamlMime:TSType +name: Excel.Interfaces.CustomPropertyCollectionLoadOptions +uid: excel!Excel.Interfaces.CustomPropertyCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.CustomPropertyCollectionLoadOptions +summary: Contains the collection of custom properties. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.CustomPropertyCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: key + uid: excel!Excel.Interfaces.CustomPropertyCollectionLoadOptions#key:member + package: excel! + fullName: key + summary: >- + For EACH ITEM in the collection: The key of the custom property. The key + is limited to 255 characters outside of Excel on the web (larger keys are + automatically trimmed to 255 characters on other platforms). + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'key?: boolean;' + return: + type: boolean + - name: type + uid: excel!Excel.Interfaces.CustomPropertyCollectionLoadOptions#type:member + package: excel! + fullName: type + summary: >- + For EACH ITEM in the collection: The type of the value used for the custom + property. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type?: boolean;' + return: + type: boolean + - name: value + uid: excel!Excel.Interfaces.CustomPropertyCollectionLoadOptions#value:member + package: excel! + fullName: value + summary: >- + For EACH ITEM in the collection: The value of the custom property. The + value is limited to 255 characters outside of Excel on the web (larger + values are automatically trimmed to 255 characters on other platforms). + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'value?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.custompropertycollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.custompropertycollectionupdatedata.yml new file mode 100644 index 0000000000..fb79572be6 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.custompropertycollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.CustomPropertyCollectionUpdateData +uid: excel!Excel.Interfaces.CustomPropertyCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.CustomPropertyCollectionUpdateData +summary: >- + An interface for updating data on the `CustomPropertyCollection` object, for + use in `customPropertyCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.CustomPropertyCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.CustomPropertyData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.custompropertydata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.custompropertydata.yml new file mode 100644 index 0000000000..60b38ff15c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.custompropertydata.yml @@ -0,0 +1,69 @@ +### YamlMime:TSType +name: Excel.Interfaces.CustomPropertyData +uid: excel!Excel.Interfaces.CustomPropertyData:interface +package: excel! +fullName: Excel.Interfaces.CustomPropertyData +summary: >- + An interface describing the data returned by calling + `customProperty.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: key + uid: excel!Excel.Interfaces.CustomPropertyData#key:member + package: excel! + fullName: key + summary: >- + The key of the custom property. The key is limited to 255 characters + outside of Excel on the web (larger keys are automatically trimmed to 255 + characters on other platforms). + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'key?: string;' + return: + type: string + - name: type + uid: excel!Excel.Interfaces.CustomPropertyData#type:member + package: excel! + fullName: type + summary: The type of the value used for the custom property. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + type?: Excel.DocumentPropertyType | "Number" | "Boolean" | "Date" | + "String" | "Float"; + return: + type: >- + | "Number" | + "Boolean" | "Date" | "String" | "Float" + - name: value + uid: excel!Excel.Interfaces.CustomPropertyData#value:member + package: excel! + fullName: value + summary: >- + The value of the custom property. The value is limited to 255 characters + outside of Excel on the web (larger values are automatically trimmed to + 255 characters on other platforms). + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'value?: any;' + return: + type: any diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.custompropertyloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.custompropertyloadoptions.yml new file mode 100644 index 0000000000..4190d58f04 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.custompropertyloadoptions.yml @@ -0,0 +1,81 @@ +### YamlMime:TSType +name: Excel.Interfaces.CustomPropertyLoadOptions +uid: excel!Excel.Interfaces.CustomPropertyLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.CustomPropertyLoadOptions +summary: Represents a custom property. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.CustomPropertyLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: key + uid: excel!Excel.Interfaces.CustomPropertyLoadOptions#key:member + package: excel! + fullName: key + summary: >- + The key of the custom property. The key is limited to 255 characters + outside of Excel on the web (larger keys are automatically trimmed to 255 + characters on other platforms). + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'key?: boolean;' + return: + type: boolean + - name: type + uid: excel!Excel.Interfaces.CustomPropertyLoadOptions#type:member + package: excel! + fullName: type + summary: The type of the value used for the custom property. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type?: boolean;' + return: + type: boolean + - name: value + uid: excel!Excel.Interfaces.CustomPropertyLoadOptions#value:member + package: excel! + fullName: value + summary: >- + The value of the custom property. The value is limited to 255 characters + outside of Excel on the web (larger values are automatically trimmed to + 255 characters on other platforms). + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'value?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.custompropertyupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.custompropertyupdatedata.yml new file mode 100644 index 0000000000..1d0297e452 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.custompropertyupdatedata.yml @@ -0,0 +1,32 @@ +### YamlMime:TSType +name: Excel.Interfaces.CustomPropertyUpdateData +uid: excel!Excel.Interfaces.CustomPropertyUpdateData:interface +package: excel! +fullName: Excel.Interfaces.CustomPropertyUpdateData +summary: >- + An interface for updating data on the `CustomProperty` object, for use in + `customProperty.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: value + uid: excel!Excel.Interfaces.CustomPropertyUpdateData#value:member + package: excel! + fullName: value + summary: >- + The value of the custom property. The value is limited to 255 characters + outside of Excel on the web (larger values are automatically trimmed to + 255 characters on other platforms). + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'value?: any;' + return: + type: any diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.customxmlpartcollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.customxmlpartcollectiondata.yml new file mode 100644 index 0000000000..71e6241def --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.customxmlpartcollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.CustomXmlPartCollectionData +uid: excel!Excel.Interfaces.CustomXmlPartCollectionData:interface +package: excel! +fullName: Excel.Interfaces.CustomXmlPartCollectionData +summary: >- + An interface describing the data returned by calling + `customXmlPartCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.CustomXmlPartCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.CustomXmlPartData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.customxmlpartcollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.customxmlpartcollectionloadoptions.yml new file mode 100644 index 0000000000..7b0175c537 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.customxmlpartcollectionloadoptions.yml @@ -0,0 +1,61 @@ +### YamlMime:TSType +name: Excel.Interfaces.CustomXmlPartCollectionLoadOptions +uid: excel!Excel.Interfaces.CustomXmlPartCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.CustomXmlPartCollectionLoadOptions +summary: A collection of custom XML parts. +remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.CustomXmlPartCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.CustomXmlPartCollectionLoadOptions#id:member + package: excel! + fullName: id + summary: 'For EACH ITEM in the collection: The custom XML part''s ID.' + remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: namespaceUri + uid: >- + excel!Excel.Interfaces.CustomXmlPartCollectionLoadOptions#namespaceUri:member + package: excel! + fullName: namespaceUri + summary: 'For EACH ITEM in the collection: The custom XML part''s namespace URI.' + remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'namespaceUri?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.customxmlpartcollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.customxmlpartcollectionupdatedata.yml new file mode 100644 index 0000000000..5b27ecbb0d --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.customxmlpartcollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.CustomXmlPartCollectionUpdateData +uid: excel!Excel.Interfaces.CustomXmlPartCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.CustomXmlPartCollectionUpdateData +summary: >- + An interface for updating data on the `CustomXmlPartCollection` object, for + use in `customXmlPartCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.CustomXmlPartCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.CustomXmlPartData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.customxmlpartdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.customxmlpartdata.yml new file mode 100644 index 0000000000..57976043c1 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.customxmlpartdata.yml @@ -0,0 +1,44 @@ +### YamlMime:TSType +name: Excel.Interfaces.CustomXmlPartData +uid: excel!Excel.Interfaces.CustomXmlPartData:interface +package: excel! +fullName: Excel.Interfaces.CustomXmlPartData +summary: >- + An interface describing the data returned by calling + `customXmlPart.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: id + uid: excel!Excel.Interfaces.CustomXmlPartData#id:member + package: excel! + fullName: id + summary: The custom XML part's ID. + remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: string;' + return: + type: string + - name: namespaceUri + uid: excel!Excel.Interfaces.CustomXmlPartData#namespaceUri:member + package: excel! + fullName: namespaceUri + summary: The custom XML part's namespace URI. + remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'namespaceUri?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.customxmlpartloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.customxmlpartloadoptions.yml new file mode 100644 index 0000000000..e644ed8811 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.customxmlpartloadoptions.yml @@ -0,0 +1,60 @@ +### YamlMime:TSType +name: Excel.Interfaces.CustomXmlPartLoadOptions +uid: excel!Excel.Interfaces.CustomXmlPartLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.CustomXmlPartLoadOptions +summary: Represents a custom XML part object in a workbook. +remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.CustomXmlPartLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.CustomXmlPartLoadOptions#id:member + package: excel! + fullName: id + summary: The custom XML part's ID. + remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: namespaceUri + uid: excel!Excel.Interfaces.CustomXmlPartLoadOptions#namespaceUri:member + package: excel! + fullName: namespaceUri + summary: The custom XML part's namespace URI. + remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'namespaceUri?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.customxmlpartscopedcollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.customxmlpartscopedcollectiondata.yml new file mode 100644 index 0000000000..035020b627 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.customxmlpartscopedcollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.CustomXmlPartScopedCollectionData +uid: excel!Excel.Interfaces.CustomXmlPartScopedCollectionData:interface +package: excel! +fullName: Excel.Interfaces.CustomXmlPartScopedCollectionData +summary: >- + An interface describing the data returned by calling + `customXmlPartScopedCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.CustomXmlPartScopedCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.CustomXmlPartData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.customxmlpartscopedcollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.customxmlpartscopedcollectionloadoptions.yml new file mode 100644 index 0000000000..ced2e81791 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.customxmlpartscopedcollectionloadoptions.yml @@ -0,0 +1,65 @@ +### YamlMime:TSType +name: Excel.Interfaces.CustomXmlPartScopedCollectionLoadOptions +uid: excel!Excel.Interfaces.CustomXmlPartScopedCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.CustomXmlPartScopedCollectionLoadOptions +summary: >- + A scoped collection of custom XML parts. A scoped collection is the result of + some operation (e.g., filtering by namespace). A scoped collection cannot be + scoped any further. +remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: >- + excel!Excel.Interfaces.CustomXmlPartScopedCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.CustomXmlPartScopedCollectionLoadOptions#id:member + package: excel! + fullName: id + summary: 'For EACH ITEM in the collection: The custom XML part''s ID.' + remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: namespaceUri + uid: >- + excel!Excel.Interfaces.CustomXmlPartScopedCollectionLoadOptions#namespaceUri:member + package: excel! + fullName: namespaceUri + summary: 'For EACH ITEM in the collection: The custom XML part''s namespace URI.' + remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'namespaceUri?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.customxmlpartscopedcollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.customxmlpartscopedcollectionupdatedata.yml new file mode 100644 index 0000000000..9cf37f8bab --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.customxmlpartscopedcollectionupdatedata.yml @@ -0,0 +1,28 @@ +### YamlMime:TSType +name: Excel.Interfaces.CustomXmlPartScopedCollectionUpdateData +uid: excel!Excel.Interfaces.CustomXmlPartScopedCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.CustomXmlPartScopedCollectionUpdateData +summary: >- + An interface for updating data on the `CustomXmlPartScopedCollection` object, + for use in `customXmlPartScopedCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: >- + excel!Excel.Interfaces.CustomXmlPartScopedCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.CustomXmlPartData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.databarconditionalformatdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.databarconditionalformatdata.yml new file mode 100644 index 0000000000..a5a3fc2eb1 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.databarconditionalformatdata.yml @@ -0,0 +1,163 @@ +### YamlMime:TSType +name: Excel.Interfaces.DataBarConditionalFormatData +uid: excel!Excel.Interfaces.DataBarConditionalFormatData:interface +package: excel! +fullName: Excel.Interfaces.DataBarConditionalFormatData +summary: >- + An interface describing the data returned by calling + `dataBarConditionalFormat.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: axisColor + uid: excel!Excel.Interfaces.DataBarConditionalFormatData#axisColor:member + package: excel! + fullName: axisColor + summary: >- + HTML color code representing the color of the Axis line, in the form + \#RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). Value + is "" (an empty string) if no axis is present or set. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'axisColor?: string;' + return: + type: string + - name: axisFormat + uid: excel!Excel.Interfaces.DataBarConditionalFormatData#axisFormat:member + package: excel! + fullName: axisFormat + summary: Representation of how the axis is determined for an Excel data bar. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + axisFormat?: Excel.ConditionalDataBarAxisFormat | "Automatic" | "None" | + "CellMidPoint"; + return: + type: >- + | + "Automatic" | "None" | "CellMidPoint" + - name: barDirection + uid: excel!Excel.Interfaces.DataBarConditionalFormatData#barDirection:member + package: excel! + fullName: barDirection + summary: Specifies the direction that the data bar graphic should be based on. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + barDirection?: Excel.ConditionalDataBarDirection | "Context" | + "LeftToRight" | "RightToLeft"; + return: + type: >- + | + "Context" | "LeftToRight" | "RightToLeft" + - name: lowerBoundRule + uid: excel!Excel.Interfaces.DataBarConditionalFormatData#lowerBoundRule:member + package: excel! + fullName: lowerBoundRule + summary: >- + The rule for what constitutes the lower bound (and how to calculate it, if + applicable) for a data bar. The `ConditionalDataBarRule` object must be + set as a JSON object (use `x.lowerBoundRule = {...}` instead of + `x.lowerBoundRule.formula = ...`). + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'lowerBoundRule?: Excel.ConditionalDataBarRule;' + return: + type: + - name: negativeFormat + uid: excel!Excel.Interfaces.DataBarConditionalFormatData#negativeFormat:member + package: excel! + fullName: negativeFormat + summary: Representation of all values to the left of the axis in an Excel data bar. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'negativeFormat?: Excel.Interfaces.ConditionalDataBarNegativeFormatData;' + return: + type: >- + + - name: positiveFormat + uid: excel!Excel.Interfaces.DataBarConditionalFormatData#positiveFormat:member + package: excel! + fullName: positiveFormat + summary: >- + Representation of all values to the right of the axis in an Excel data + bar. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'positiveFormat?: Excel.Interfaces.ConditionalDataBarPositiveFormatData;' + return: + type: >- + + - name: showDataBarOnly + uid: excel!Excel.Interfaces.DataBarConditionalFormatData#showDataBarOnly:member + package: excel! + fullName: showDataBarOnly + summary: >- + If `true`, hides the values from the cells where the data bar is + applied. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showDataBarOnly?: boolean;' + return: + type: boolean + - name: upperBoundRule + uid: excel!Excel.Interfaces.DataBarConditionalFormatData#upperBoundRule:member + package: excel! + fullName: upperBoundRule + summary: >- + The rule for what constitutes the upper bound (and how to calculate it, if + applicable) for a data bar. The `ConditionalDataBarRule` object must be + set as a JSON object (use `x.upperBoundRule = {...}` instead of + `x.upperBoundRule.formula = ...`). + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'upperBoundRule?: Excel.ConditionalDataBarRule;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.databarconditionalformatloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.databarconditionalformatloadoptions.yml new file mode 100644 index 0000000000..d107ade77a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.databarconditionalformatloadoptions.yml @@ -0,0 +1,183 @@ +### YamlMime:TSType +name: Excel.Interfaces.DataBarConditionalFormatLoadOptions +uid: excel!Excel.Interfaces.DataBarConditionalFormatLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.DataBarConditionalFormatLoadOptions +summary: Represents an Excel conditional data bar type. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.DataBarConditionalFormatLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: axisColor + uid: >- + excel!Excel.Interfaces.DataBarConditionalFormatLoadOptions#axisColor:member + package: excel! + fullName: axisColor + summary: >- + HTML color code representing the color of the Axis line, in the form + \#RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). Value + is "" (an empty string) if no axis is present or set. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'axisColor?: boolean;' + return: + type: boolean + - name: axisFormat + uid: >- + excel!Excel.Interfaces.DataBarConditionalFormatLoadOptions#axisFormat:member + package: excel! + fullName: axisFormat + summary: Representation of how the axis is determined for an Excel data bar. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'axisFormat?: boolean;' + return: + type: boolean + - name: barDirection + uid: >- + excel!Excel.Interfaces.DataBarConditionalFormatLoadOptions#barDirection:member + package: excel! + fullName: barDirection + summary: Specifies the direction that the data bar graphic should be based on. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'barDirection?: boolean;' + return: + type: boolean + - name: lowerBoundRule + uid: >- + excel!Excel.Interfaces.DataBarConditionalFormatLoadOptions#lowerBoundRule:member + package: excel! + fullName: lowerBoundRule + summary: >- + The rule for what constitutes the lower bound (and how to calculate it, if + applicable) for a data bar. The `ConditionalDataBarRule` object must be + set as a JSON object (use `x.lowerBoundRule = {...}` instead of + `x.lowerBoundRule.formula = ...`). + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'lowerBoundRule?: boolean;' + return: + type: boolean + - name: negativeFormat + uid: >- + excel!Excel.Interfaces.DataBarConditionalFormatLoadOptions#negativeFormat:member + package: excel! + fullName: negativeFormat + summary: Representation of all values to the left of the axis in an Excel data bar. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + negativeFormat?: + Excel.Interfaces.ConditionalDataBarNegativeFormatLoadOptions; + return: + type: >- + + - name: positiveFormat + uid: >- + excel!Excel.Interfaces.DataBarConditionalFormatLoadOptions#positiveFormat:member + package: excel! + fullName: positiveFormat + summary: >- + Representation of all values to the right of the axis in an Excel data + bar. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + positiveFormat?: + Excel.Interfaces.ConditionalDataBarPositiveFormatLoadOptions; + return: + type: >- + + - name: showDataBarOnly + uid: >- + excel!Excel.Interfaces.DataBarConditionalFormatLoadOptions#showDataBarOnly:member + package: excel! + fullName: showDataBarOnly + summary: >- + If `true`, hides the values from the cells where the data bar is + applied. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showDataBarOnly?: boolean;' + return: + type: boolean + - name: upperBoundRule + uid: >- + excel!Excel.Interfaces.DataBarConditionalFormatLoadOptions#upperBoundRule:member + package: excel! + fullName: upperBoundRule + summary: >- + The rule for what constitutes the upper bound (and how to calculate it, if + applicable) for a data bar. The `ConditionalDataBarRule` object must be + set as a JSON object (use `x.upperBoundRule = {...}` instead of + `x.upperBoundRule.formula = ...`). + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'upperBoundRule?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.databarconditionalformatupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.databarconditionalformatupdatedata.yml new file mode 100644 index 0000000000..e40a5cd37f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.databarconditionalformatupdatedata.yml @@ -0,0 +1,174 @@ +### YamlMime:TSType +name: Excel.Interfaces.DataBarConditionalFormatUpdateData +uid: excel!Excel.Interfaces.DataBarConditionalFormatUpdateData:interface +package: excel! +fullName: Excel.Interfaces.DataBarConditionalFormatUpdateData +summary: >- + An interface for updating data on the `DataBarConditionalFormat` object, for + use in `dataBarConditionalFormat.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: axisColor + uid: excel!Excel.Interfaces.DataBarConditionalFormatUpdateData#axisColor:member + package: excel! + fullName: axisColor + summary: >- + HTML color code representing the color of the Axis line, in the form + \#RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). Value + is "" (an empty string) if no axis is present or set. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'axisColor?: string;' + return: + type: string + - name: axisFormat + uid: >- + excel!Excel.Interfaces.DataBarConditionalFormatUpdateData#axisFormat:member + package: excel! + fullName: axisFormat + summary: Representation of how the axis is determined for an Excel data bar. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + axisFormat?: Excel.ConditionalDataBarAxisFormat | "Automatic" | "None" | + "CellMidPoint"; + return: + type: >- + | + "Automatic" | "None" | "CellMidPoint" + - name: barDirection + uid: >- + excel!Excel.Interfaces.DataBarConditionalFormatUpdateData#barDirection:member + package: excel! + fullName: barDirection + summary: Specifies the direction that the data bar graphic should be based on. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + barDirection?: Excel.ConditionalDataBarDirection | "Context" | + "LeftToRight" | "RightToLeft"; + return: + type: >- + | + "Context" | "LeftToRight" | "RightToLeft" + - name: lowerBoundRule + uid: >- + excel!Excel.Interfaces.DataBarConditionalFormatUpdateData#lowerBoundRule:member + package: excel! + fullName: lowerBoundRule + summary: >- + The rule for what constitutes the lower bound (and how to calculate it, if + applicable) for a data bar. The `ConditionalDataBarRule` object must be + set as a JSON object (use `x.lowerBoundRule = {...}` instead of + `x.lowerBoundRule.formula = ...`). + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'lowerBoundRule?: Excel.ConditionalDataBarRule;' + return: + type: + - name: negativeFormat + uid: >- + excel!Excel.Interfaces.DataBarConditionalFormatUpdateData#negativeFormat:member + package: excel! + fullName: negativeFormat + summary: Representation of all values to the left of the axis in an Excel data bar. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + negativeFormat?: + Excel.Interfaces.ConditionalDataBarNegativeFormatUpdateData; + return: + type: >- + + - name: positiveFormat + uid: >- + excel!Excel.Interfaces.DataBarConditionalFormatUpdateData#positiveFormat:member + package: excel! + fullName: positiveFormat + summary: >- + Representation of all values to the right of the axis in an Excel data + bar. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + positiveFormat?: + Excel.Interfaces.ConditionalDataBarPositiveFormatUpdateData; + return: + type: >- + + - name: showDataBarOnly + uid: >- + excel!Excel.Interfaces.DataBarConditionalFormatUpdateData#showDataBarOnly:member + package: excel! + fullName: showDataBarOnly + summary: >- + If `true`, hides the values from the cells where the data bar is + applied. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showDataBarOnly?: boolean;' + return: + type: boolean + - name: upperBoundRule + uid: >- + excel!Excel.Interfaces.DataBarConditionalFormatUpdateData#upperBoundRule:member + package: excel! + fullName: upperBoundRule + summary: >- + The rule for what constitutes the upper bound (and how to calculate it, if + applicable) for a data bar. The `ConditionalDataBarRule` object must be + set as a JSON object (use `x.upperBoundRule = {...}` instead of + `x.upperBoundRule.formula = ...`). + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'upperBoundRule?: Excel.ConditionalDataBarRule;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.datapivothierarchycollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.datapivothierarchycollectiondata.yml new file mode 100644 index 0000000000..3d5dc105bb --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.datapivothierarchycollectiondata.yml @@ -0,0 +1,29 @@ +### YamlMime:TSType +name: Excel.Interfaces.DataPivotHierarchyCollectionData +uid: excel!Excel.Interfaces.DataPivotHierarchyCollectionData:interface +package: excel! +fullName: Excel.Interfaces.DataPivotHierarchyCollectionData +summary: >- + An interface describing the data returned by calling + `dataPivotHierarchyCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.DataPivotHierarchyCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.DataPivotHierarchyData[];' + return: + type: >- + [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.datapivothierarchycollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.datapivothierarchycollectionloadoptions.yml new file mode 100644 index 0000000000..17e0cc08bd --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.datapivothierarchycollectionloadoptions.yml @@ -0,0 +1,148 @@ +### YamlMime:TSType +name: Excel.Interfaces.DataPivotHierarchyCollectionLoadOptions +uid: excel!Excel.Interfaces.DataPivotHierarchyCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.DataPivotHierarchyCollectionLoadOptions +summary: >- + Represents a collection of DataPivotHierarchy items associated with the + PivotTable. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.DataPivotHierarchyCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: field + uid: >- + excel!Excel.Interfaces.DataPivotHierarchyCollectionLoadOptions#field:member + package: excel! + fullName: field + summary: >- + For EACH ITEM in the collection: Returns the PivotFields associated with + the DataPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'field?: Excel.Interfaces.PivotFieldLoadOptions;' + return: + type: + - name: id + uid: excel!Excel.Interfaces.DataPivotHierarchyCollectionLoadOptions#id:member + package: excel! + fullName: id + summary: 'For EACH ITEM in the collection: ID of the DataPivotHierarchy.' + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.DataPivotHierarchyCollectionLoadOptions#name:member + package: excel! + fullName: name + summary: 'For EACH ITEM in the collection: Name of the DataPivotHierarchy.' + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: numberFormat + uid: >- + excel!Excel.Interfaces.DataPivotHierarchyCollectionLoadOptions#numberFormat:member + package: excel! + fullName: numberFormat + summary: 'For EACH ITEM in the collection: Number format of the DataPivotHierarchy.' + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat?: boolean;' + return: + type: boolean + - name: position + uid: >- + excel!Excel.Interfaces.DataPivotHierarchyCollectionLoadOptions#position:member + package: excel! + fullName: position + summary: 'For EACH ITEM in the collection: Position of the DataPivotHierarchy.' + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'position?: boolean;' + return: + type: boolean + - name: showAs + uid: >- + excel!Excel.Interfaces.DataPivotHierarchyCollectionLoadOptions#showAs:member + package: excel! + fullName: showAs + summary: >- + For EACH ITEM in the collection: Specifies if the data should be shown as + a specific summary calculation. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showAs?: boolean;' + return: + type: boolean + - name: summarizeBy + uid: >- + excel!Excel.Interfaces.DataPivotHierarchyCollectionLoadOptions#summarizeBy:member + package: excel! + fullName: summarizeBy + summary: >- + For EACH ITEM in the collection: Specifies if all items of the + DataPivotHierarchy are shown. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'summarizeBy?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.datapivothierarchycollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.datapivothierarchycollectionupdatedata.yml new file mode 100644 index 0000000000..4de7faaa70 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.datapivothierarchycollectionupdatedata.yml @@ -0,0 +1,29 @@ +### YamlMime:TSType +name: Excel.Interfaces.DataPivotHierarchyCollectionUpdateData +uid: excel!Excel.Interfaces.DataPivotHierarchyCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.DataPivotHierarchyCollectionUpdateData +summary: >- + An interface for updating data on the `DataPivotHierarchyCollection` object, + for use in `dataPivotHierarchyCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.DataPivotHierarchyCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.DataPivotHierarchyData[];' + return: + type: >- + [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.datapivothierarchydata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.datapivothierarchydata.yml new file mode 100644 index 0000000000..31de3c702b --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.datapivothierarchydata.yml @@ -0,0 +1,126 @@ +### YamlMime:TSType +name: Excel.Interfaces.DataPivotHierarchyData +uid: excel!Excel.Interfaces.DataPivotHierarchyData:interface +package: excel! +fullName: Excel.Interfaces.DataPivotHierarchyData +summary: >- + An interface describing the data returned by calling + `dataPivotHierarchy.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: field + uid: excel!Excel.Interfaces.DataPivotHierarchyData#field:member + package: excel! + fullName: field + summary: Returns the PivotFields associated with the DataPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'field?: Excel.Interfaces.PivotFieldData;' + return: + type: + - name: id + uid: excel!Excel.Interfaces.DataPivotHierarchyData#id:member + package: excel! + fullName: id + summary: ID of the DataPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: string;' + return: + type: string + - name: name + uid: excel!Excel.Interfaces.DataPivotHierarchyData#name:member + package: excel! + fullName: name + summary: Name of the DataPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: numberFormat + uid: excel!Excel.Interfaces.DataPivotHierarchyData#numberFormat:member + package: excel! + fullName: numberFormat + summary: Number format of the DataPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat?: string;' + return: + type: string + - name: position + uid: excel!Excel.Interfaces.DataPivotHierarchyData#position:member + package: excel! + fullName: position + summary: Position of the DataPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'position?: number;' + return: + type: number + - name: showAs + uid: excel!Excel.Interfaces.DataPivotHierarchyData#showAs:member + package: excel! + fullName: showAs + summary: Specifies if the data should be shown as a specific summary calculation. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showAs?: Excel.ShowAsRule;' + return: + type: + - name: summarizeBy + uid: excel!Excel.Interfaces.DataPivotHierarchyData#summarizeBy:member + package: excel! + fullName: summarizeBy + summary: Specifies if all items of the DataPivotHierarchy are shown. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + summarizeBy?: Excel.AggregationFunction | "Unknown" | "Automatic" | + "Sum" | "Count" | "Average" | "Max" | "Min" | "Product" | "CountNumbers" + | "StandardDeviation" | "StandardDeviationP" | "Variance" | "VarianceP"; + return: + type: >- + | "Unknown" | + "Automatic" | "Sum" | "Count" | "Average" | "Max" | "Min" | "Product" + | "CountNumbers" | "StandardDeviation" | "StandardDeviationP" | + "Variance" | "VarianceP" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.datapivothierarchyloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.datapivothierarchyloadoptions.yml new file mode 100644 index 0000000000..9bf8257a2b --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.datapivothierarchyloadoptions.yml @@ -0,0 +1,135 @@ +### YamlMime:TSType +name: Excel.Interfaces.DataPivotHierarchyLoadOptions +uid: excel!Excel.Interfaces.DataPivotHierarchyLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.DataPivotHierarchyLoadOptions +summary: Represents the Excel DataPivotHierarchy. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.DataPivotHierarchyLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: field + uid: excel!Excel.Interfaces.DataPivotHierarchyLoadOptions#field:member + package: excel! + fullName: field + summary: Returns the PivotFields associated with the DataPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'field?: Excel.Interfaces.PivotFieldLoadOptions;' + return: + type: + - name: id + uid: excel!Excel.Interfaces.DataPivotHierarchyLoadOptions#id:member + package: excel! + fullName: id + summary: ID of the DataPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.DataPivotHierarchyLoadOptions#name:member + package: excel! + fullName: name + summary: Name of the DataPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: numberFormat + uid: excel!Excel.Interfaces.DataPivotHierarchyLoadOptions#numberFormat:member + package: excel! + fullName: numberFormat + summary: Number format of the DataPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat?: boolean;' + return: + type: boolean + - name: position + uid: excel!Excel.Interfaces.DataPivotHierarchyLoadOptions#position:member + package: excel! + fullName: position + summary: Position of the DataPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'position?: boolean;' + return: + type: boolean + - name: showAs + uid: excel!Excel.Interfaces.DataPivotHierarchyLoadOptions#showAs:member + package: excel! + fullName: showAs + summary: Specifies if the data should be shown as a specific summary calculation. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showAs?: boolean;' + return: + type: boolean + - name: summarizeBy + uid: excel!Excel.Interfaces.DataPivotHierarchyLoadOptions#summarizeBy:member + package: excel! + fullName: summarizeBy + summary: Specifies if all items of the DataPivotHierarchy are shown. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'summarizeBy?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.datapivothierarchyupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.datapivothierarchyupdatedata.yml new file mode 100644 index 0000000000..4fa8b1315b --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.datapivothierarchyupdatedata.yml @@ -0,0 +1,111 @@ +### YamlMime:TSType +name: Excel.Interfaces.DataPivotHierarchyUpdateData +uid: excel!Excel.Interfaces.DataPivotHierarchyUpdateData:interface +package: excel! +fullName: Excel.Interfaces.DataPivotHierarchyUpdateData +summary: >- + An interface for updating data on the `DataPivotHierarchy` object, for use in + `dataPivotHierarchy.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: field + uid: excel!Excel.Interfaces.DataPivotHierarchyUpdateData#field:member + package: excel! + fullName: field + summary: Returns the PivotFields associated with the DataPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'field?: Excel.Interfaces.PivotFieldUpdateData;' + return: + type: + - name: name + uid: excel!Excel.Interfaces.DataPivotHierarchyUpdateData#name:member + package: excel! + fullName: name + summary: Name of the DataPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: numberFormat + uid: excel!Excel.Interfaces.DataPivotHierarchyUpdateData#numberFormat:member + package: excel! + fullName: numberFormat + summary: Number format of the DataPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat?: string;' + return: + type: string + - name: position + uid: excel!Excel.Interfaces.DataPivotHierarchyUpdateData#position:member + package: excel! + fullName: position + summary: Position of the DataPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'position?: number;' + return: + type: number + - name: showAs + uid: excel!Excel.Interfaces.DataPivotHierarchyUpdateData#showAs:member + package: excel! + fullName: showAs + summary: Specifies if the data should be shown as a specific summary calculation. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showAs?: Excel.ShowAsRule;' + return: + type: + - name: summarizeBy + uid: excel!Excel.Interfaces.DataPivotHierarchyUpdateData#summarizeBy:member + package: excel! + fullName: summarizeBy + summary: Specifies if all items of the DataPivotHierarchy are shown. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + summarizeBy?: Excel.AggregationFunction | "Unknown" | "Automatic" | + "Sum" | "Count" | "Average" | "Max" | "Min" | "Product" | "CountNumbers" + | "StandardDeviation" | "StandardDeviationP" | "Variance" | "VarianceP"; + return: + type: >- + | "Unknown" | + "Automatic" | "Sum" | "Count" | "Average" | "Max" | "Min" | "Product" + | "CountNumbers" | "StandardDeviation" | "StandardDeviationP" | + "Variance" | "VarianceP" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.datavalidationdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.datavalidationdata.yml new file mode 100644 index 0000000000..3186b3d616 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.datavalidationdata.yml @@ -0,0 +1,118 @@ +### YamlMime:TSType +name: Excel.Interfaces.DataValidationData +uid: excel!Excel.Interfaces.DataValidationData:interface +package: excel! +fullName: Excel.Interfaces.DataValidationData +summary: >- + An interface describing the data returned by calling + `dataValidation.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: errorAlert + uid: excel!Excel.Interfaces.DataValidationData#errorAlert:member + package: excel! + fullName: errorAlert + summary: Error alert when user enters invalid data. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'errorAlert?: Excel.DataValidationErrorAlert;' + return: + type: + - name: ignoreBlanks + uid: excel!Excel.Interfaces.DataValidationData#ignoreBlanks:member + package: excel! + fullName: ignoreBlanks + summary: >- + Specifies if data validation will be performed on blank cells. Default is + `true`. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'ignoreBlanks?: boolean;' + return: + type: boolean + - name: prompt + uid: excel!Excel.Interfaces.DataValidationData#prompt:member + package: excel! + fullName: prompt + summary: Prompt when users select a cell. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'prompt?: Excel.DataValidationPrompt;' + return: + type: + - name: rule + uid: excel!Excel.Interfaces.DataValidationData#rule:member + package: excel! + fullName: rule + summary: >- + Data validation rule that contains different type of data validation + criteria. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rule?: Excel.DataValidationRule;' + return: + type: + - name: type + uid: excel!Excel.Interfaces.DataValidationData#type:member + package: excel! + fullName: type + summary: Type of the data validation, see `Excel.DataValidationType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + type?: Excel.DataValidationType | "None" | "WholeNumber" | "Decimal" | + "List" | "Date" | "Time" | "TextLength" | "Custom" | "Inconsistent" | + "MixedCriteria"; + return: + type: >- + | "None" | + "WholeNumber" | "Decimal" | "List" | "Date" | "Time" | "TextLength" | + "Custom" | "Inconsistent" | "MixedCriteria" + - name: valid + uid: excel!Excel.Interfaces.DataValidationData#valid:member + package: excel! + fullName: valid + summary: >- + Represents if all cell values are valid according to the data validation + rules. Returns `true` if all cell values are valid, or `false` if all cell + values are invalid. Returns `null` if there are both valid and invalid + cell values within the range. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valid?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.datavalidationloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.datavalidationloadoptions.yml new file mode 100644 index 0000000000..85e8d0ae99 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.datavalidationloadoptions.yml @@ -0,0 +1,132 @@ +### YamlMime:TSType +name: Excel.Interfaces.DataValidationLoadOptions +uid: excel!Excel.Interfaces.DataValidationLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.DataValidationLoadOptions +summary: >- + Represents the data validation applied to the current range. To learn more + about the data validation object model, read [Add data validation to Excel + ranges](https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-data-validation). +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.DataValidationLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: errorAlert + uid: excel!Excel.Interfaces.DataValidationLoadOptions#errorAlert:member + package: excel! + fullName: errorAlert + summary: Error alert when user enters invalid data. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'errorAlert?: boolean;' + return: + type: boolean + - name: ignoreBlanks + uid: excel!Excel.Interfaces.DataValidationLoadOptions#ignoreBlanks:member + package: excel! + fullName: ignoreBlanks + summary: >- + Specifies if data validation will be performed on blank cells. Default is + `true`. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'ignoreBlanks?: boolean;' + return: + type: boolean + - name: prompt + uid: excel!Excel.Interfaces.DataValidationLoadOptions#prompt:member + package: excel! + fullName: prompt + summary: Prompt when users select a cell. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'prompt?: boolean;' + return: + type: boolean + - name: rule + uid: excel!Excel.Interfaces.DataValidationLoadOptions#rule:member + package: excel! + fullName: rule + summary: >- + Data validation rule that contains different type of data validation + criteria. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rule?: boolean;' + return: + type: boolean + - name: type + uid: excel!Excel.Interfaces.DataValidationLoadOptions#type:member + package: excel! + fullName: type + summary: Type of the data validation, see `Excel.DataValidationType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type?: boolean;' + return: + type: boolean + - name: valid + uid: excel!Excel.Interfaces.DataValidationLoadOptions#valid:member + package: excel! + fullName: valid + summary: >- + Represents if all cell values are valid according to the data validation + rules. Returns `true` if all cell values are valid, or `false` if all cell + values are invalid. Returns `null` if there are both valid and invalid + cell values within the range. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valid?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.datavalidationupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.datavalidationupdatedata.yml new file mode 100644 index 0000000000..7ff80158d9 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.datavalidationupdatedata.yml @@ -0,0 +1,78 @@ +### YamlMime:TSType +name: Excel.Interfaces.DataValidationUpdateData +uid: excel!Excel.Interfaces.DataValidationUpdateData:interface +package: excel! +fullName: Excel.Interfaces.DataValidationUpdateData +summary: >- + An interface for updating data on the `DataValidation` object, for use in + `dataValidation.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: errorAlert + uid: excel!Excel.Interfaces.DataValidationUpdateData#errorAlert:member + package: excel! + fullName: errorAlert + summary: Error alert when user enters invalid data. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'errorAlert?: Excel.DataValidationErrorAlert;' + return: + type: + - name: ignoreBlanks + uid: excel!Excel.Interfaces.DataValidationUpdateData#ignoreBlanks:member + package: excel! + fullName: ignoreBlanks + summary: >- + Specifies if data validation will be performed on blank cells. Default is + `true`. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'ignoreBlanks?: boolean;' + return: + type: boolean + - name: prompt + uid: excel!Excel.Interfaces.DataValidationUpdateData#prompt:member + package: excel! + fullName: prompt + summary: Prompt when users select a cell. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'prompt?: Excel.DataValidationPrompt;' + return: + type: + - name: rule + uid: excel!Excel.Interfaces.DataValidationUpdateData#rule:member + package: excel! + fullName: rule + summary: >- + Data validation rule that contains different type of data validation + criteria. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rule?: Excel.DataValidationRule;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.datetimeformatinfodata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.datetimeformatinfodata.yml new file mode 100644 index 0000000000..5dbda5e5f3 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.datetimeformatinfodata.yml @@ -0,0 +1,104 @@ +### YamlMime:TSType +name: Excel.Interfaces.DatetimeFormatInfoData +uid: excel!Excel.Interfaces.DatetimeFormatInfoData:interface +package: excel! +fullName: Excel.Interfaces.DatetimeFormatInfoData +summary: >- + An interface describing the data returned by calling + `datetimeFormatInfo.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: dateSeparator + uid: excel!Excel.Interfaces.DatetimeFormatInfoData#dateSeparator:member + package: excel! + fullName: dateSeparator + summary: >- + Gets the string used as the date separator. This is based on current + system settings. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'dateSeparator?: string;' + return: + type: string + - name: longDatePattern + uid: excel!Excel.Interfaces.DatetimeFormatInfoData#longDatePattern:member + package: excel! + fullName: longDatePattern + summary: >- + Gets the format string for a long date value. This is based on current + system settings. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'longDatePattern?: string;' + return: + type: string + - name: longTimePattern + uid: excel!Excel.Interfaces.DatetimeFormatInfoData#longTimePattern:member + package: excel! + fullName: longTimePattern + summary: >- + Gets the format string for a long time value. This is based on current + system settings. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'longTimePattern?: string;' + return: + type: string + - name: shortDatePattern + uid: excel!Excel.Interfaces.DatetimeFormatInfoData#shortDatePattern:member + package: excel! + fullName: shortDatePattern + summary: >- + Gets the format string for a short date value. This is based on current + system settings. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'shortDatePattern?: string;' + return: + type: string + - name: timeSeparator + uid: excel!Excel.Interfaces.DatetimeFormatInfoData#timeSeparator:member + package: excel! + fullName: timeSeparator + summary: >- + Gets the string used as the time separator. This is based on current + system settings. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'timeSeparator?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.datetimeformatinfoloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.datetimeformatinfoloadoptions.yml new file mode 100644 index 0000000000..5d63e96898 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.datetimeformatinfoloadoptions.yml @@ -0,0 +1,125 @@ +### YamlMime:TSType +name: Excel.Interfaces.DatetimeFormatInfoLoadOptions +uid: excel!Excel.Interfaces.DatetimeFormatInfoLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.DatetimeFormatInfoLoadOptions +summary: >- + Defines the culturally appropriate format of displaying numbers. This is based + on current system culture settings. +remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.DatetimeFormatInfoLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: dateSeparator + uid: excel!Excel.Interfaces.DatetimeFormatInfoLoadOptions#dateSeparator:member + package: excel! + fullName: dateSeparator + summary: >- + Gets the string used as the date separator. This is based on current + system settings. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'dateSeparator?: boolean;' + return: + type: boolean + - name: longDatePattern + uid: >- + excel!Excel.Interfaces.DatetimeFormatInfoLoadOptions#longDatePattern:member + package: excel! + fullName: longDatePattern + summary: >- + Gets the format string for a long date value. This is based on current + system settings. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'longDatePattern?: boolean;' + return: + type: boolean + - name: longTimePattern + uid: >- + excel!Excel.Interfaces.DatetimeFormatInfoLoadOptions#longTimePattern:member + package: excel! + fullName: longTimePattern + summary: >- + Gets the format string for a long time value. This is based on current + system settings. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'longTimePattern?: boolean;' + return: + type: boolean + - name: shortDatePattern + uid: >- + excel!Excel.Interfaces.DatetimeFormatInfoLoadOptions#shortDatePattern:member + package: excel! + fullName: shortDatePattern + summary: >- + Gets the format string for a short date value. This is based on current + system settings. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'shortDatePattern?: boolean;' + return: + type: boolean + - name: timeSeparator + uid: excel!Excel.Interfaces.DatetimeFormatInfoLoadOptions#timeSeparator:member + package: excel! + fullName: timeSeparator + summary: >- + Gets the string used as the time separator. This is based on current + system settings. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'timeSeparator?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.documentpropertiesdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.documentpropertiesdata.yml new file mode 100644 index 0000000000..e6e33af54c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.documentpropertiesdata.yml @@ -0,0 +1,196 @@ +### YamlMime:TSType +name: Excel.Interfaces.DocumentPropertiesData +uid: excel!Excel.Interfaces.DocumentPropertiesData:interface +package: excel! +fullName: Excel.Interfaces.DocumentPropertiesData +summary: >- + An interface describing the data returned by calling + `documentProperties.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: author + uid: excel!Excel.Interfaces.DocumentPropertiesData#author:member + package: excel! + fullName: author + summary: The author of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'author?: string;' + return: + type: string + - name: category + uid: excel!Excel.Interfaces.DocumentPropertiesData#category:member + package: excel! + fullName: category + summary: The category of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'category?: string;' + return: + type: string + - name: comments + uid: excel!Excel.Interfaces.DocumentPropertiesData#comments:member + package: excel! + fullName: comments + summary: >- + The Comments field in the metadata of the workbook. These have no + connection to comments by users made in the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'comments?: string;' + return: + type: string + - name: company + uid: excel!Excel.Interfaces.DocumentPropertiesData#company:member + package: excel! + fullName: company + summary: The company of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'company?: string;' + return: + type: string + - name: creationDate + uid: excel!Excel.Interfaces.DocumentPropertiesData#creationDate:member + package: excel! + fullName: creationDate + summary: Gets the creation date of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'creationDate?: Date;' + return: + type: Date + - name: custom + uid: excel!Excel.Interfaces.DocumentPropertiesData#custom:member + package: excel! + fullName: custom + summary: Gets the collection of custom properties of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'custom?: Excel.Interfaces.CustomPropertyData[];' + return: + type: [] + - name: keywords + uid: excel!Excel.Interfaces.DocumentPropertiesData#keywords:member + package: excel! + fullName: keywords + summary: The keywords of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'keywords?: string;' + return: + type: string + - name: lastAuthor + uid: excel!Excel.Interfaces.DocumentPropertiesData#lastAuthor:member + package: excel! + fullName: lastAuthor + summary: Gets the last author of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'lastAuthor?: string;' + return: + type: string + - name: manager + uid: excel!Excel.Interfaces.DocumentPropertiesData#manager:member + package: excel! + fullName: manager + summary: The manager of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'manager?: string;' + return: + type: string + - name: revisionNumber + uid: excel!Excel.Interfaces.DocumentPropertiesData#revisionNumber:member + package: excel! + fullName: revisionNumber + summary: Gets the revision number of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'revisionNumber?: number;' + return: + type: number + - name: subject + uid: excel!Excel.Interfaces.DocumentPropertiesData#subject:member + package: excel! + fullName: subject + summary: The subject of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'subject?: string;' + return: + type: string + - name: title + uid: excel!Excel.Interfaces.DocumentPropertiesData#title:member + package: excel! + fullName: title + summary: The title of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'title?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.documentpropertiesloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.documentpropertiesloadoptions.yml new file mode 100644 index 0000000000..d03f2ce922 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.documentpropertiesloadoptions.yml @@ -0,0 +1,197 @@ +### YamlMime:TSType +name: Excel.Interfaces.DocumentPropertiesLoadOptions +uid: excel!Excel.Interfaces.DocumentPropertiesLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.DocumentPropertiesLoadOptions +summary: Represents workbook properties. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.DocumentPropertiesLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: author + uid: excel!Excel.Interfaces.DocumentPropertiesLoadOptions#author:member + package: excel! + fullName: author + summary: The author of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'author?: boolean;' + return: + type: boolean + - name: category + uid: excel!Excel.Interfaces.DocumentPropertiesLoadOptions#category:member + package: excel! + fullName: category + summary: The category of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'category?: boolean;' + return: + type: boolean + - name: comments + uid: excel!Excel.Interfaces.DocumentPropertiesLoadOptions#comments:member + package: excel! + fullName: comments + summary: >- + The Comments field in the metadata of the workbook. These have no + connection to comments by users made in the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'comments?: boolean;' + return: + type: boolean + - name: company + uid: excel!Excel.Interfaces.DocumentPropertiesLoadOptions#company:member + package: excel! + fullName: company + summary: The company of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'company?: boolean;' + return: + type: boolean + - name: creationDate + uid: excel!Excel.Interfaces.DocumentPropertiesLoadOptions#creationDate:member + package: excel! + fullName: creationDate + summary: Gets the creation date of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'creationDate?: boolean;' + return: + type: boolean + - name: keywords + uid: excel!Excel.Interfaces.DocumentPropertiesLoadOptions#keywords:member + package: excel! + fullName: keywords + summary: The keywords of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'keywords?: boolean;' + return: + type: boolean + - name: lastAuthor + uid: excel!Excel.Interfaces.DocumentPropertiesLoadOptions#lastAuthor:member + package: excel! + fullName: lastAuthor + summary: Gets the last author of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'lastAuthor?: boolean;' + return: + type: boolean + - name: manager + uid: excel!Excel.Interfaces.DocumentPropertiesLoadOptions#manager:member + package: excel! + fullName: manager + summary: The manager of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'manager?: boolean;' + return: + type: boolean + - name: revisionNumber + uid: excel!Excel.Interfaces.DocumentPropertiesLoadOptions#revisionNumber:member + package: excel! + fullName: revisionNumber + summary: Gets the revision number of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'revisionNumber?: boolean;' + return: + type: boolean + - name: subject + uid: excel!Excel.Interfaces.DocumentPropertiesLoadOptions#subject:member + package: excel! + fullName: subject + summary: The subject of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'subject?: boolean;' + return: + type: boolean + - name: title + uid: excel!Excel.Interfaces.DocumentPropertiesLoadOptions#title:member + package: excel! + fullName: title + summary: The title of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'title?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.documentpropertiesupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.documentpropertiesupdatedata.yml new file mode 100644 index 0000000000..0bd01d8a9e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.documentpropertiesupdatedata.yml @@ -0,0 +1,151 @@ +### YamlMime:TSType +name: Excel.Interfaces.DocumentPropertiesUpdateData +uid: excel!Excel.Interfaces.DocumentPropertiesUpdateData:interface +package: excel! +fullName: Excel.Interfaces.DocumentPropertiesUpdateData +summary: >- + An interface for updating data on the `DocumentProperties` object, for use in + `documentProperties.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: author + uid: excel!Excel.Interfaces.DocumentPropertiesUpdateData#author:member + package: excel! + fullName: author + summary: The author of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'author?: string;' + return: + type: string + - name: category + uid: excel!Excel.Interfaces.DocumentPropertiesUpdateData#category:member + package: excel! + fullName: category + summary: The category of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'category?: string;' + return: + type: string + - name: comments + uid: excel!Excel.Interfaces.DocumentPropertiesUpdateData#comments:member + package: excel! + fullName: comments + summary: >- + The Comments field in the metadata of the workbook. These have no + connection to comments by users made in the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'comments?: string;' + return: + type: string + - name: company + uid: excel!Excel.Interfaces.DocumentPropertiesUpdateData#company:member + package: excel! + fullName: company + summary: The company of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'company?: string;' + return: + type: string + - name: keywords + uid: excel!Excel.Interfaces.DocumentPropertiesUpdateData#keywords:member + package: excel! + fullName: keywords + summary: The keywords of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'keywords?: string;' + return: + type: string + - name: manager + uid: excel!Excel.Interfaces.DocumentPropertiesUpdateData#manager:member + package: excel! + fullName: manager + summary: The manager of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'manager?: string;' + return: + type: string + - name: revisionNumber + uid: excel!Excel.Interfaces.DocumentPropertiesUpdateData#revisionNumber:member + package: excel! + fullName: revisionNumber + summary: Gets the revision number of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'revisionNumber?: number;' + return: + type: number + - name: subject + uid: excel!Excel.Interfaces.DocumentPropertiesUpdateData#subject:member + package: excel! + fullName: subject + summary: The subject of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'subject?: string;' + return: + type: string + - name: title + uid: excel!Excel.Interfaces.DocumentPropertiesUpdateData#title:member + package: excel! + fullName: title + summary: The title of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'title?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.filterdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.filterdata.yml new file mode 100644 index 0000000000..8755f90d3a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.filterdata.yml @@ -0,0 +1,29 @@ +### YamlMime:TSType +name: Excel.Interfaces.FilterData +uid: excel!Excel.Interfaces.FilterData:interface +package: excel! +fullName: Excel.Interfaces.FilterData +summary: >- + An interface describing the data returned by calling `filter.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: criteria + uid: excel!Excel.Interfaces.FilterData#criteria:member + package: excel! + fullName: criteria + summary: The currently applied filter on the given column. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'criteria?: Excel.FilterCriteria;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.filterloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.filterloadoptions.yml new file mode 100644 index 0000000000..9f2b64f1b9 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.filterloadoptions.yml @@ -0,0 +1,45 @@ +### YamlMime:TSType +name: Excel.Interfaces.FilterLoadOptions +uid: excel!Excel.Interfaces.FilterLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.FilterLoadOptions +summary: Manages the filtering of a table's column. +remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.FilterLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: criteria + uid: excel!Excel.Interfaces.FilterLoadOptions#criteria:member + package: excel! + fullName: criteria + summary: The currently applied filter on the given column. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'criteria?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.filterpivothierarchycollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.filterpivothierarchycollectiondata.yml new file mode 100644 index 0000000000..f73b789570 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.filterpivothierarchycollectiondata.yml @@ -0,0 +1,29 @@ +### YamlMime:TSType +name: Excel.Interfaces.FilterPivotHierarchyCollectionData +uid: excel!Excel.Interfaces.FilterPivotHierarchyCollectionData:interface +package: excel! +fullName: Excel.Interfaces.FilterPivotHierarchyCollectionData +summary: >- + An interface describing the data returned by calling + `filterPivotHierarchyCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.FilterPivotHierarchyCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.FilterPivotHierarchyData[];' + return: + type: >- + [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.filterpivothierarchycollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.filterpivothierarchycollectionloadoptions.yml new file mode 100644 index 0000000000..6920eeb014 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.filterpivothierarchycollectionloadoptions.yml @@ -0,0 +1,98 @@ +### YamlMime:TSType +name: Excel.Interfaces.FilterPivotHierarchyCollectionLoadOptions +uid: excel!Excel.Interfaces.FilterPivotHierarchyCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.FilterPivotHierarchyCollectionLoadOptions +summary: >- + Represents a collection of FilterPivotHierarchy items associated with the + PivotTable. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: >- + excel!Excel.Interfaces.FilterPivotHierarchyCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: enableMultipleFilterItems + uid: >- + excel!Excel.Interfaces.FilterPivotHierarchyCollectionLoadOptions#enableMultipleFilterItems:member + package: excel! + fullName: enableMultipleFilterItems + summary: >- + For EACH ITEM in the collection: Determines whether to allow multiple + filter items. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'enableMultipleFilterItems?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.FilterPivotHierarchyCollectionLoadOptions#id:member + package: excel! + fullName: id + summary: 'For EACH ITEM in the collection: ID of the FilterPivotHierarchy.' + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: name + uid: >- + excel!Excel.Interfaces.FilterPivotHierarchyCollectionLoadOptions#name:member + package: excel! + fullName: name + summary: 'For EACH ITEM in the collection: Name of the FilterPivotHierarchy.' + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: position + uid: >- + excel!Excel.Interfaces.FilterPivotHierarchyCollectionLoadOptions#position:member + package: excel! + fullName: position + summary: 'For EACH ITEM in the collection: Position of the FilterPivotHierarchy.' + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'position?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.filterpivothierarchycollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.filterpivothierarchycollectionupdatedata.yml new file mode 100644 index 0000000000..ea5e77643a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.filterpivothierarchycollectionupdatedata.yml @@ -0,0 +1,30 @@ +### YamlMime:TSType +name: Excel.Interfaces.FilterPivotHierarchyCollectionUpdateData +uid: excel!Excel.Interfaces.FilterPivotHierarchyCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.FilterPivotHierarchyCollectionUpdateData +summary: >- + An interface for updating data on the `FilterPivotHierarchyCollection` object, + for use in `filterPivotHierarchyCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: >- + excel!Excel.Interfaces.FilterPivotHierarchyCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.FilterPivotHierarchyData[];' + return: + type: >- + [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.filterpivothierarchydata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.filterpivothierarchydata.yml new file mode 100644 index 0000000000..4bbbc60af4 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.filterpivothierarchydata.yml @@ -0,0 +1,90 @@ +### YamlMime:TSType +name: Excel.Interfaces.FilterPivotHierarchyData +uid: excel!Excel.Interfaces.FilterPivotHierarchyData:interface +package: excel! +fullName: Excel.Interfaces.FilterPivotHierarchyData +summary: >- + An interface describing the data returned by calling + `filterPivotHierarchy.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: enableMultipleFilterItems + uid: >- + excel!Excel.Interfaces.FilterPivotHierarchyData#enableMultipleFilterItems:member + package: excel! + fullName: enableMultipleFilterItems + summary: Determines whether to allow multiple filter items. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'enableMultipleFilterItems?: boolean;' + return: + type: boolean + - name: fields + uid: excel!Excel.Interfaces.FilterPivotHierarchyData#fields:member + package: excel! + fullName: fields + summary: Returns the PivotFields associated with the FilterPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'fields?: Excel.Interfaces.PivotFieldData[];' + return: + type: [] + - name: id + uid: excel!Excel.Interfaces.FilterPivotHierarchyData#id:member + package: excel! + fullName: id + summary: ID of the FilterPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: string;' + return: + type: string + - name: name + uid: excel!Excel.Interfaces.FilterPivotHierarchyData#name:member + package: excel! + fullName: name + summary: Name of the FilterPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: position + uid: excel!Excel.Interfaces.FilterPivotHierarchyData#position:member + package: excel! + fullName: position + summary: Position of the FilterPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'position?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.filterpivothierarchyloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.filterpivothierarchyloadoptions.yml new file mode 100644 index 0000000000..8c8bac5b11 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.filterpivothierarchyloadoptions.yml @@ -0,0 +1,91 @@ +### YamlMime:TSType +name: Excel.Interfaces.FilterPivotHierarchyLoadOptions +uid: excel!Excel.Interfaces.FilterPivotHierarchyLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.FilterPivotHierarchyLoadOptions +summary: Represents the Excel FilterPivotHierarchy. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.FilterPivotHierarchyLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: enableMultipleFilterItems + uid: >- + excel!Excel.Interfaces.FilterPivotHierarchyLoadOptions#enableMultipleFilterItems:member + package: excel! + fullName: enableMultipleFilterItems + summary: Determines whether to allow multiple filter items. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'enableMultipleFilterItems?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.FilterPivotHierarchyLoadOptions#id:member + package: excel! + fullName: id + summary: ID of the FilterPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.FilterPivotHierarchyLoadOptions#name:member + package: excel! + fullName: name + summary: Name of the FilterPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: position + uid: excel!Excel.Interfaces.FilterPivotHierarchyLoadOptions#position:member + package: excel! + fullName: position + summary: Position of the FilterPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'position?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.filterpivothierarchyupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.filterpivothierarchyupdatedata.yml new file mode 100644 index 0000000000..d23732b6e3 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.filterpivothierarchyupdatedata.yml @@ -0,0 +1,60 @@ +### YamlMime:TSType +name: Excel.Interfaces.FilterPivotHierarchyUpdateData +uid: excel!Excel.Interfaces.FilterPivotHierarchyUpdateData:interface +package: excel! +fullName: Excel.Interfaces.FilterPivotHierarchyUpdateData +summary: >- + An interface for updating data on the `FilterPivotHierarchy` object, for use + in `filterPivotHierarchy.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: enableMultipleFilterItems + uid: >- + excel!Excel.Interfaces.FilterPivotHierarchyUpdateData#enableMultipleFilterItems:member + package: excel! + fullName: enableMultipleFilterItems + summary: Determines whether to allow multiple filter items. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'enableMultipleFilterItems?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.FilterPivotHierarchyUpdateData#name:member + package: excel! + fullName: name + summary: Name of the FilterPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: position + uid: excel!Excel.Interfaces.FilterPivotHierarchyUpdateData#position:member + package: excel! + fullName: position + summary: Position of the FilterPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'position?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.formatprotectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.formatprotectiondata.yml new file mode 100644 index 0000000000..43c3199abf --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.formatprotectiondata.yml @@ -0,0 +1,49 @@ +### YamlMime:TSType +name: Excel.Interfaces.FormatProtectionData +uid: excel!Excel.Interfaces.FormatProtectionData:interface +package: excel! +fullName: Excel.Interfaces.FormatProtectionData +summary: >- + An interface describing the data returned by calling + `formatProtection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: formulaHidden + uid: excel!Excel.Interfaces.FormatProtectionData#formulaHidden:member + package: excel! + fullName: formulaHidden + summary: >- + Specifies if Excel hides the formula for the cells in the range. A `null` + value indicates that the entire range doesn't have a uniform formula + hidden setting. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulaHidden?: boolean;' + return: + type: boolean + - name: locked + uid: excel!Excel.Interfaces.FormatProtectionData#locked:member + package: excel! + fullName: locked + summary: >- + Specifies if Excel locks the cells in the object. A `null` value indicates + that the entire range doesn't have a uniform lock setting. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'locked?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.formatprotectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.formatprotectionloadoptions.yml new file mode 100644 index 0000000000..8e30e8d835 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.formatprotectionloadoptions.yml @@ -0,0 +1,65 @@ +### YamlMime:TSType +name: Excel.Interfaces.FormatProtectionLoadOptions +uid: excel!Excel.Interfaces.FormatProtectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.FormatProtectionLoadOptions +summary: Represents the format protection of a range object. +remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.FormatProtectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: formulaHidden + uid: excel!Excel.Interfaces.FormatProtectionLoadOptions#formulaHidden:member + package: excel! + fullName: formulaHidden + summary: >- + Specifies if Excel hides the formula for the cells in the range. A `null` + value indicates that the entire range doesn't have a uniform formula + hidden setting. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulaHidden?: boolean;' + return: + type: boolean + - name: locked + uid: excel!Excel.Interfaces.FormatProtectionLoadOptions#locked:member + package: excel! + fullName: locked + summary: >- + Specifies if Excel locks the cells in the object. A `null` value indicates + that the entire range doesn't have a uniform lock setting. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'locked?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.formatprotectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.formatprotectionupdatedata.yml new file mode 100644 index 0000000000..935abed04d --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.formatprotectionupdatedata.yml @@ -0,0 +1,49 @@ +### YamlMime:TSType +name: Excel.Interfaces.FormatProtectionUpdateData +uid: excel!Excel.Interfaces.FormatProtectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.FormatProtectionUpdateData +summary: >- + An interface for updating data on the `FormatProtection` object, for use in + `formatProtection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: formulaHidden + uid: excel!Excel.Interfaces.FormatProtectionUpdateData#formulaHidden:member + package: excel! + fullName: formulaHidden + summary: >- + Specifies if Excel hides the formula for the cells in the range. A `null` + value indicates that the entire range doesn't have a uniform formula + hidden setting. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulaHidden?: boolean;' + return: + type: boolean + - name: locked + uid: excel!Excel.Interfaces.FormatProtectionUpdateData#locked:member + package: excel! + fullName: locked + summary: >- + Specifies if Excel locks the cells in the object. A `null` value indicates + that the entire range doesn't have a uniform lock setting. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'locked?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.functionresultdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.functionresultdata.yml new file mode 100644 index 0000000000..42c6001781 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.functionresultdata.yml @@ -0,0 +1,49 @@ +### YamlMime:TSType +name: Excel.Interfaces.FunctionResultData +uid: excel!Excel.Interfaces.FunctionResultData:interface +package: excel! +fullName: Excel.Interfaces.FunctionResultData +summary: >- + An interface describing the data returned by calling + `functionResult.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: error + uid: excel!Excel.Interfaces.FunctionResultData#error:member + package: excel! + fullName: error + summary: >- + Error value (such as "\#DIV/0") representing the error. If the error + string is not set, then the function succeeded, and its result is written + to the Value field. The error is always in the English locale. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'error?: string;' + return: + type: string + - name: value + uid: excel!Excel.Interfaces.FunctionResultData#value:member + package: excel! + fullName: value + summary: >- + The value of function evaluation. The value field will be populated only + if no error has occurred (i.e., the Error property is not set). + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'value?: T;' + return: + type: T diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.functionresultloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.functionresultloadoptions.yml new file mode 100644 index 0000000000..cdbd753328 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.functionresultloadoptions.yml @@ -0,0 +1,65 @@ +### YamlMime:TSType +name: Excel.Interfaces.FunctionResultLoadOptions +uid: excel!Excel.Interfaces.FunctionResultLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.FunctionResultLoadOptions +summary: An object containing the result of a function-evaluation operation +remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.FunctionResultLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: error + uid: excel!Excel.Interfaces.FunctionResultLoadOptions#error:member + package: excel! + fullName: error + summary: >- + Error value (such as "\#DIV/0") representing the error. If the error + string is not set, then the function succeeded, and its result is written + to the Value field. The error is always in the English locale. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'error?: boolean;' + return: + type: boolean + - name: value + uid: excel!Excel.Interfaces.FunctionResultLoadOptions#value:member + package: excel! + fullName: value + summary: >- + The value of function evaluation. The value field will be populated only + if no error has occurred (i.e., the Error property is not set). + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'value?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.geometricshapedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.geometricshapedata.yml new file mode 100644 index 0000000000..efa2f56beb --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.geometricshapedata.yml @@ -0,0 +1,29 @@ +### YamlMime:TSType +name: Excel.Interfaces.GeometricShapeData +uid: excel!Excel.Interfaces.GeometricShapeData:interface +package: excel! +fullName: Excel.Interfaces.GeometricShapeData +summary: >- + An interface describing the data returned by calling + `geometricShape.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: id + uid: excel!Excel.Interfaces.GeometricShapeData#id:member + package: excel! + fullName: id + summary: Returns the shape identifier. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.geometricshapeloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.geometricshapeloadoptions.yml new file mode 100644 index 0000000000..38987c0fe3 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.geometricshapeloadoptions.yml @@ -0,0 +1,63 @@ +### YamlMime:TSType +name: Excel.Interfaces.GeometricShapeLoadOptions +uid: excel!Excel.Interfaces.GeometricShapeLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.GeometricShapeLoadOptions +summary: >- + Represents a geometric shape inside a worksheet. A geometric shape can be a + rectangle, block arrow, equation symbol, flowchart item, star, banner, + callout, or any other basic shape in Excel. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.GeometricShapeLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.GeometricShapeLoadOptions#id:member + package: excel! + fullName: id + summary: Returns the shape identifier. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: shape + uid: excel!Excel.Interfaces.GeometricShapeLoadOptions#shape:member + package: excel! + fullName: shape + summary: Returns the `Shape` object for the geometric shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'shape?: Excel.Interfaces.ShapeLoadOptions;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.groupshapecollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.groupshapecollectiondata.yml new file mode 100644 index 0000000000..1b5a0f098a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.groupshapecollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.GroupShapeCollectionData +uid: excel!Excel.Interfaces.GroupShapeCollectionData:interface +package: excel! +fullName: Excel.Interfaces.GroupShapeCollectionData +summary: >- + An interface describing the data returned by calling + `groupShapeCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.GroupShapeCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.ShapeData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.groupshapecollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.groupshapecollectionloadoptions.yml new file mode 100644 index 0000000000..2d85014035 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.groupshapecollectionloadoptions.yml @@ -0,0 +1,486 @@ +### YamlMime:TSType +name: Excel.Interfaces.GroupShapeCollectionLoadOptions +uid: excel!Excel.Interfaces.GroupShapeCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.GroupShapeCollectionLoadOptions +summary: Represents the shape collection inside a shape group. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.GroupShapeCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: altTextDescription + uid: >- + excel!Excel.Interfaces.GroupShapeCollectionLoadOptions#altTextDescription:member + package: excel! + fullName: altTextDescription + summary: >- + For EACH ITEM in the collection: Specifies the alternative description + text for a `Shape` object. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'altTextDescription?: boolean;' + return: + type: boolean + - name: altTextTitle + uid: excel!Excel.Interfaces.GroupShapeCollectionLoadOptions#altTextTitle:member + package: excel! + fullName: altTextTitle + summary: >- + For EACH ITEM in the collection: Specifies the alternative title text for + a `Shape` object. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'altTextTitle?: boolean;' + return: + type: boolean + - name: connectionSiteCount + uid: >- + excel!Excel.Interfaces.GroupShapeCollectionLoadOptions#connectionSiteCount:member + package: excel! + fullName: connectionSiteCount + summary: >- + For EACH ITEM in the collection: Returns the number of connection sites on + this shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'connectionSiteCount?: boolean;' + return: + type: boolean + - name: displayName + uid: excel!Excel.Interfaces.GroupShapeCollectionLoadOptions#displayName:member + package: excel! + fullName: displayName + summary: >- + For EACH ITEM in the collection: Gets the display name of the shape. A + newly created shape has a generated name that is localized and may not + match its `name`. In this scenario, you can use this API to get + the name that is displayed in the UI. + remarks: >- + \[ [API set: ExcelApi + 1.15](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'displayName?: boolean;' + return: + type: boolean + - name: fill + uid: excel!Excel.Interfaces.GroupShapeCollectionLoadOptions#fill:member + package: excel! + fullName: fill + summary: >- + For EACH ITEM in the collection: Returns the fill formatting of this + shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'fill?: Excel.Interfaces.ShapeFillLoadOptions;' + return: + type: + - name: geometricShape + uid: >- + excel!Excel.Interfaces.GroupShapeCollectionLoadOptions#geometricShape:member + package: excel! + fullName: geometricShape + summary: >- + For EACH ITEM in the collection: Returns the geometric shape associated + with the shape. An error will be thrown if the shape type is not + "GeometricShape". + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'geometricShape?: Excel.Interfaces.GeometricShapeLoadOptions;' + return: + type: >- + + - name: geometricShapeType + uid: >- + excel!Excel.Interfaces.GroupShapeCollectionLoadOptions#geometricShapeType:member + package: excel! + fullName: geometricShapeType + summary: >- + For EACH ITEM in the collection: Specifies the geometric shape type of + this geometric shape. See `Excel.GeometricShapeType` for details. Returns + `null` if the shape type is not "GeometricShape". + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'geometricShapeType?: boolean;' + return: + type: boolean + - name: group + uid: excel!Excel.Interfaces.GroupShapeCollectionLoadOptions#group:member + package: excel! + fullName: group + summary: >- + For EACH ITEM in the collection: Returns the shape group associated with + the shape. An error will be thrown if the shape type is not "GroupShape". + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'group?: Excel.Interfaces.ShapeGroupLoadOptions;' + return: + type: + - name: height + uid: excel!Excel.Interfaces.GroupShapeCollectionLoadOptions#height:member + package: excel! + fullName: height + summary: >- + For EACH ITEM in the collection: Specifies the height, in points, of the + shape. Throws an `InvalidArgument` exception when set with a negative + value or zero as an input. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.GroupShapeCollectionLoadOptions#id:member + package: excel! + fullName: id + summary: 'For EACH ITEM in the collection: Specifies the shape identifier.' + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: image + uid: excel!Excel.Interfaces.GroupShapeCollectionLoadOptions#image:member + package: excel! + fullName: image + summary: >- + For EACH ITEM in the collection: Returns the image associated with the + shape. An error will be thrown if the shape type is not "Image". + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'image?: Excel.Interfaces.ImageLoadOptions;' + return: + type: + - name: left + uid: excel!Excel.Interfaces.GroupShapeCollectionLoadOptions#left:member + package: excel! + fullName: left + summary: >- + For EACH ITEM in the collection: The distance, in points, from the left + side of the shape to the left side of the worksheet. Throws an + `InvalidArgument` exception when set with a negative value as an input. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: boolean;' + return: + type: boolean + - name: level + uid: excel!Excel.Interfaces.GroupShapeCollectionLoadOptions#level:member + package: excel! + fullName: level + summary: >- + For EACH ITEM in the collection: Specifies the level of the specified + shape. For example, a level of 0 means that the shape is not part of any + groups, a level of 1 means the shape is part of a top-level group, and a + level of 2 means the shape is part of a sub-group of the top level. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'level?: boolean;' + return: + type: boolean + - name: line + uid: excel!Excel.Interfaces.GroupShapeCollectionLoadOptions#line:member + package: excel! + fullName: line + summary: >- + For EACH ITEM in the collection: Returns the line associated with the + shape. An error will be thrown if the shape type is not "Line". + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'line?: Excel.Interfaces.LineLoadOptions;' + return: + type: + - name: lineFormat + uid: excel!Excel.Interfaces.GroupShapeCollectionLoadOptions#lineFormat:member + package: excel! + fullName: lineFormat + summary: >- + For EACH ITEM in the collection: Returns the line formatting of this + shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'lineFormat?: Excel.Interfaces.ShapeLineFormatLoadOptions;' + return: + type: >- + + - name: lockAspectRatio + uid: >- + excel!Excel.Interfaces.GroupShapeCollectionLoadOptions#lockAspectRatio:member + package: excel! + fullName: lockAspectRatio + summary: >- + For EACH ITEM in the collection: Specifies if the aspect ratio of this + shape is locked. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'lockAspectRatio?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.GroupShapeCollectionLoadOptions#name:member + package: excel! + fullName: name + summary: 'For EACH ITEM in the collection: Specifies the name of the shape.' + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: parentGroup + uid: excel!Excel.Interfaces.GroupShapeCollectionLoadOptions#parentGroup:member + package: excel! + fullName: parentGroup + summary: 'For EACH ITEM in the collection: Specifies the parent group of this shape.' + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'parentGroup?: Excel.Interfaces.ShapeLoadOptions;' + return: + type: + - name: placement + uid: excel!Excel.Interfaces.GroupShapeCollectionLoadOptions#placement:member + package: excel! + fullName: placement + summary: >- + For EACH ITEM in the collection: Represents how the object is attached to + the cells below it. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'placement?: boolean;' + return: + type: boolean + - name: rotation + uid: excel!Excel.Interfaces.GroupShapeCollectionLoadOptions#rotation:member + package: excel! + fullName: rotation + summary: >- + For EACH ITEM in the collection: Specifies the rotation, in degrees, of + the shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rotation?: boolean;' + return: + type: boolean + - name: textFrame + uid: excel!Excel.Interfaces.GroupShapeCollectionLoadOptions#textFrame:member + package: excel! + fullName: textFrame + summary: >- + For EACH ITEM in the collection: Returns the text frame object of this + shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textFrame?: Excel.Interfaces.TextFrameLoadOptions;' + return: + type: + - name: top + uid: excel!Excel.Interfaces.GroupShapeCollectionLoadOptions#top:member + package: excel! + fullName: top + summary: >- + For EACH ITEM in the collection: The distance, in points, from the top + edge of the shape to the top edge of the worksheet. Throws an + `InvalidArgument` exception when set with a negative value as an input. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: boolean;' + return: + type: boolean + - name: type + uid: excel!Excel.Interfaces.GroupShapeCollectionLoadOptions#type:member + package: excel! + fullName: type + summary: >- + For EACH ITEM in the collection: Returns the type of this shape. See + `Excel.ShapeType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type?: boolean;' + return: + type: boolean + - name: visible + uid: excel!Excel.Interfaces.GroupShapeCollectionLoadOptions#visible:member + package: excel! + fullName: visible + summary: 'For EACH ITEM in the collection: Specifies if the shape is visible.' + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean + - name: width + uid: excel!Excel.Interfaces.GroupShapeCollectionLoadOptions#width:member + package: excel! + fullName: width + summary: >- + For EACH ITEM in the collection: Specifies the width, in points, of the + shape. Throws an `InvalidArgument` exception when set with a negative + value or zero as an input. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width?: boolean;' + return: + type: boolean + - name: zOrderPosition + uid: >- + excel!Excel.Interfaces.GroupShapeCollectionLoadOptions#zOrderPosition:member + package: excel! + fullName: zOrderPosition + summary: >- + For EACH ITEM in the collection: Returns the position of the specified + shape in the z-order, with 0 representing the bottom of the order stack. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'zOrderPosition?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.groupshapecollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.groupshapecollectionupdatedata.yml new file mode 100644 index 0000000000..f40b90dbbf --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.groupshapecollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.GroupShapeCollectionUpdateData +uid: excel!Excel.Interfaces.GroupShapeCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.GroupShapeCollectionUpdateData +summary: >- + An interface for updating data on the `GroupShapeCollection` object, for use + in `groupShapeCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.GroupShapeCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.ShapeData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.headerfooterdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.headerfooterdata.yml new file mode 100644 index 0000000000..f921c5865a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.headerfooterdata.yml @@ -0,0 +1,122 @@ +### YamlMime:TSType +name: Excel.Interfaces.HeaderFooterData +uid: excel!Excel.Interfaces.HeaderFooterData:interface +package: excel! +fullName: Excel.Interfaces.HeaderFooterData +summary: >- + An interface describing the data returned by calling + `headerFooter.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: centerFooter + uid: excel!Excel.Interfaces.HeaderFooterData#centerFooter:member + package: excel! + fullName: centerFooter + summary: >- + The center footer of the worksheet. To apply font formatting or insert a + variable value, use format codes specified here: + https://msdn.microsoft.com/library/bb225426.aspx. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'centerFooter?: string;' + return: + type: string + - name: centerHeader + uid: excel!Excel.Interfaces.HeaderFooterData#centerHeader:member + package: excel! + fullName: centerHeader + summary: >- + The center header of the worksheet. To apply font formatting or insert a + variable value, use format codes specified here: + https://msdn.microsoft.com/library/bb225426.aspx. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'centerHeader?: string;' + return: + type: string + - name: leftFooter + uid: excel!Excel.Interfaces.HeaderFooterData#leftFooter:member + package: excel! + fullName: leftFooter + summary: >- + The left footer of the worksheet. To apply font formatting or insert a + variable value, use format codes specified here: + https://msdn.microsoft.com/library/bb225426.aspx. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'leftFooter?: string;' + return: + type: string + - name: leftHeader + uid: excel!Excel.Interfaces.HeaderFooterData#leftHeader:member + package: excel! + fullName: leftHeader + summary: >- + The left header of the worksheet. To apply font formatting or insert a + variable value, use format codes specified here: + https://msdn.microsoft.com/library/bb225426.aspx. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'leftHeader?: string;' + return: + type: string + - name: rightFooter + uid: excel!Excel.Interfaces.HeaderFooterData#rightFooter:member + package: excel! + fullName: rightFooter + summary: >- + The right footer of the worksheet. To apply font formatting or insert a + variable value, use format codes specified here: + https://msdn.microsoft.com/library/bb225426.aspx. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rightFooter?: string;' + return: + type: string + - name: rightHeader + uid: excel!Excel.Interfaces.HeaderFooterData#rightHeader:member + package: excel! + fullName: rightHeader + summary: >- + The right header of the worksheet. To apply font formatting or insert a + variable value, use format codes specified here: + https://msdn.microsoft.com/library/bb225426.aspx. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rightHeader?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.headerfootergroupdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.headerfootergroupdata.yml new file mode 100644 index 0000000000..98c40ed347 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.headerfootergroupdata.yml @@ -0,0 +1,137 @@ +### YamlMime:TSType +name: Excel.Interfaces.HeaderFooterGroupData +uid: excel!Excel.Interfaces.HeaderFooterGroupData:interface +package: excel! +fullName: Excel.Interfaces.HeaderFooterGroupData +summary: >- + An interface describing the data returned by calling + `headerFooterGroup.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: defaultForAllPages + uid: excel!Excel.Interfaces.HeaderFooterGroupData#defaultForAllPages:member + package: excel! + fullName: defaultForAllPages + summary: >- + The general header/footer, used for all pages unless even/odd or first + page is specified. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'defaultForAllPages?: Excel.Interfaces.HeaderFooterData;' + return: + type: + - name: evenPages + uid: excel!Excel.Interfaces.HeaderFooterGroupData#evenPages:member + package: excel! + fullName: evenPages + summary: >- + The header/footer to use for even pages, odd header/footer needs to be + specified for odd pages. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'evenPages?: Excel.Interfaces.HeaderFooterData;' + return: + type: + - name: firstPage + uid: excel!Excel.Interfaces.HeaderFooterGroupData#firstPage:member + package: excel! + fullName: firstPage + summary: >- + The first page header/footer, for all other pages general or even/odd is + used. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'firstPage?: Excel.Interfaces.HeaderFooterData;' + return: + type: + - name: oddPages + uid: excel!Excel.Interfaces.HeaderFooterGroupData#oddPages:member + package: excel! + fullName: oddPages + summary: >- + The header/footer to use for odd pages, even header/footer needs to be + specified for even pages. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'oddPages?: Excel.Interfaces.HeaderFooterData;' + return: + type: + - name: state + uid: excel!Excel.Interfaces.HeaderFooterGroupData#state:member + package: excel! + fullName: state + summary: >- + The state by which headers/footers are set. See `Excel.HeaderFooterState` + for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + state?: Excel.HeaderFooterState | "Default" | "FirstAndDefault" | + "OddAndEven" | "FirstOddAndEven"; + return: + type: >- + | "Default" | + "FirstAndDefault" | "OddAndEven" | "FirstOddAndEven" + - name: useSheetMargins + uid: excel!Excel.Interfaces.HeaderFooterGroupData#useSheetMargins:member + package: excel! + fullName: useSheetMargins + summary: >- + Gets or sets a flag indicating if headers/footers are aligned with the + page margins set in the page layout options for the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'useSheetMargins?: boolean;' + return: + type: boolean + - name: useSheetScale + uid: excel!Excel.Interfaces.HeaderFooterGroupData#useSheetScale:member + package: excel! + fullName: useSheetScale + summary: >- + Gets or sets a flag indicating if headers/footers should be scaled by the + page percentage scale set in the page layout options for the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'useSheetScale?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.headerfootergrouploadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.headerfootergrouploadoptions.yml new file mode 100644 index 0000000000..c01b408c04 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.headerfootergrouploadoptions.yml @@ -0,0 +1,158 @@ +### YamlMime:TSType +name: Excel.Interfaces.HeaderFooterGroupLoadOptions +uid: excel!Excel.Interfaces.HeaderFooterGroupLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.HeaderFooterGroupLoadOptions +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.HeaderFooterGroupLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: defaultForAllPages + uid: >- + excel!Excel.Interfaces.HeaderFooterGroupLoadOptions#defaultForAllPages:member + package: excel! + fullName: defaultForAllPages + summary: >- + The general header/footer, used for all pages unless even/odd or first + page is specified. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'defaultForAllPages?: Excel.Interfaces.HeaderFooterLoadOptions;' + return: + type: >- + + - name: evenPages + uid: excel!Excel.Interfaces.HeaderFooterGroupLoadOptions#evenPages:member + package: excel! + fullName: evenPages + summary: >- + The header/footer to use for even pages, odd header/footer needs to be + specified for odd pages. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'evenPages?: Excel.Interfaces.HeaderFooterLoadOptions;' + return: + type: >- + + - name: firstPage + uid: excel!Excel.Interfaces.HeaderFooterGroupLoadOptions#firstPage:member + package: excel! + fullName: firstPage + summary: >- + The first page header/footer, for all other pages general or even/odd is + used. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'firstPage?: Excel.Interfaces.HeaderFooterLoadOptions;' + return: + type: >- + + - name: oddPages + uid: excel!Excel.Interfaces.HeaderFooterGroupLoadOptions#oddPages:member + package: excel! + fullName: oddPages + summary: >- + The header/footer to use for odd pages, even header/footer needs to be + specified for even pages. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'oddPages?: Excel.Interfaces.HeaderFooterLoadOptions;' + return: + type: >- + + - name: state + uid: excel!Excel.Interfaces.HeaderFooterGroupLoadOptions#state:member + package: excel! + fullName: state + summary: >- + The state by which headers/footers are set. See `Excel.HeaderFooterState` + for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'state?: boolean;' + return: + type: boolean + - name: useSheetMargins + uid: excel!Excel.Interfaces.HeaderFooterGroupLoadOptions#useSheetMargins:member + package: excel! + fullName: useSheetMargins + summary: >- + Gets or sets a flag indicating if headers/footers are aligned with the + page margins set in the page layout options for the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'useSheetMargins?: boolean;' + return: + type: boolean + - name: useSheetScale + uid: excel!Excel.Interfaces.HeaderFooterGroupLoadOptions#useSheetScale:member + package: excel! + fullName: useSheetScale + summary: >- + Gets or sets a flag indicating if headers/footers should be scaled by the + page percentage scale set in the page layout options for the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'useSheetScale?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.headerfootergroupupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.headerfootergroupupdatedata.yml new file mode 100644 index 0000000000..ba03ddbb2c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.headerfootergroupupdatedata.yml @@ -0,0 +1,138 @@ +### YamlMime:TSType +name: Excel.Interfaces.HeaderFooterGroupUpdateData +uid: excel!Excel.Interfaces.HeaderFooterGroupUpdateData:interface +package: excel! +fullName: Excel.Interfaces.HeaderFooterGroupUpdateData +summary: >- + An interface for updating data on the `HeaderFooterGroup` object, for use in + `headerFooterGroup.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: defaultForAllPages + uid: >- + excel!Excel.Interfaces.HeaderFooterGroupUpdateData#defaultForAllPages:member + package: excel! + fullName: defaultForAllPages + summary: >- + The general header/footer, used for all pages unless even/odd or first + page is specified. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'defaultForAllPages?: Excel.Interfaces.HeaderFooterUpdateData;' + return: + type: + - name: evenPages + uid: excel!Excel.Interfaces.HeaderFooterGroupUpdateData#evenPages:member + package: excel! + fullName: evenPages + summary: >- + The header/footer to use for even pages, odd header/footer needs to be + specified for odd pages. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'evenPages?: Excel.Interfaces.HeaderFooterUpdateData;' + return: + type: + - name: firstPage + uid: excel!Excel.Interfaces.HeaderFooterGroupUpdateData#firstPage:member + package: excel! + fullName: firstPage + summary: >- + The first page header/footer, for all other pages general or even/odd is + used. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'firstPage?: Excel.Interfaces.HeaderFooterUpdateData;' + return: + type: + - name: oddPages + uid: excel!Excel.Interfaces.HeaderFooterGroupUpdateData#oddPages:member + package: excel! + fullName: oddPages + summary: >- + The header/footer to use for odd pages, even header/footer needs to be + specified for even pages. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'oddPages?: Excel.Interfaces.HeaderFooterUpdateData;' + return: + type: + - name: state + uid: excel!Excel.Interfaces.HeaderFooterGroupUpdateData#state:member + package: excel! + fullName: state + summary: >- + The state by which headers/footers are set. See `Excel.HeaderFooterState` + for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + state?: Excel.HeaderFooterState | "Default" | "FirstAndDefault" | + "OddAndEven" | "FirstOddAndEven"; + return: + type: >- + | "Default" | + "FirstAndDefault" | "OddAndEven" | "FirstOddAndEven" + - name: useSheetMargins + uid: excel!Excel.Interfaces.HeaderFooterGroupUpdateData#useSheetMargins:member + package: excel! + fullName: useSheetMargins + summary: >- + Gets or sets a flag indicating if headers/footers are aligned with the + page margins set in the page layout options for the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'useSheetMargins?: boolean;' + return: + type: boolean + - name: useSheetScale + uid: excel!Excel.Interfaces.HeaderFooterGroupUpdateData#useSheetScale:member + package: excel! + fullName: useSheetScale + summary: >- + Gets or sets a flag indicating if headers/footers should be scaled by the + page percentage scale set in the page layout options for the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'useSheetScale?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.headerfooterloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.headerfooterloadoptions.yml new file mode 100644 index 0000000000..7954e5119c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.headerfooterloadoptions.yml @@ -0,0 +1,138 @@ +### YamlMime:TSType +name: Excel.Interfaces.HeaderFooterLoadOptions +uid: excel!Excel.Interfaces.HeaderFooterLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.HeaderFooterLoadOptions +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.HeaderFooterLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: centerFooter + uid: excel!Excel.Interfaces.HeaderFooterLoadOptions#centerFooter:member + package: excel! + fullName: centerFooter + summary: >- + The center footer of the worksheet. To apply font formatting or insert a + variable value, use format codes specified here: + https://msdn.microsoft.com/library/bb225426.aspx. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'centerFooter?: boolean;' + return: + type: boolean + - name: centerHeader + uid: excel!Excel.Interfaces.HeaderFooterLoadOptions#centerHeader:member + package: excel! + fullName: centerHeader + summary: >- + The center header of the worksheet. To apply font formatting or insert a + variable value, use format codes specified here: + https://msdn.microsoft.com/library/bb225426.aspx. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'centerHeader?: boolean;' + return: + type: boolean + - name: leftFooter + uid: excel!Excel.Interfaces.HeaderFooterLoadOptions#leftFooter:member + package: excel! + fullName: leftFooter + summary: >- + The left footer of the worksheet. To apply font formatting or insert a + variable value, use format codes specified here: + https://msdn.microsoft.com/library/bb225426.aspx. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'leftFooter?: boolean;' + return: + type: boolean + - name: leftHeader + uid: excel!Excel.Interfaces.HeaderFooterLoadOptions#leftHeader:member + package: excel! + fullName: leftHeader + summary: >- + The left header of the worksheet. To apply font formatting or insert a + variable value, use format codes specified here: + https://msdn.microsoft.com/library/bb225426.aspx. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'leftHeader?: boolean;' + return: + type: boolean + - name: rightFooter + uid: excel!Excel.Interfaces.HeaderFooterLoadOptions#rightFooter:member + package: excel! + fullName: rightFooter + summary: >- + The right footer of the worksheet. To apply font formatting or insert a + variable value, use format codes specified here: + https://msdn.microsoft.com/library/bb225426.aspx. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rightFooter?: boolean;' + return: + type: boolean + - name: rightHeader + uid: excel!Excel.Interfaces.HeaderFooterLoadOptions#rightHeader:member + package: excel! + fullName: rightHeader + summary: >- + The right header of the worksheet. To apply font formatting or insert a + variable value, use format codes specified here: + https://msdn.microsoft.com/library/bb225426.aspx. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rightHeader?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.headerfooterupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.headerfooterupdatedata.yml new file mode 100644 index 0000000000..14237ea32c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.headerfooterupdatedata.yml @@ -0,0 +1,122 @@ +### YamlMime:TSType +name: Excel.Interfaces.HeaderFooterUpdateData +uid: excel!Excel.Interfaces.HeaderFooterUpdateData:interface +package: excel! +fullName: Excel.Interfaces.HeaderFooterUpdateData +summary: >- + An interface for updating data on the `HeaderFooter` object, for use in + `headerFooter.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: centerFooter + uid: excel!Excel.Interfaces.HeaderFooterUpdateData#centerFooter:member + package: excel! + fullName: centerFooter + summary: >- + The center footer of the worksheet. To apply font formatting or insert a + variable value, use format codes specified here: + https://msdn.microsoft.com/library/bb225426.aspx. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'centerFooter?: string;' + return: + type: string + - name: centerHeader + uid: excel!Excel.Interfaces.HeaderFooterUpdateData#centerHeader:member + package: excel! + fullName: centerHeader + summary: >- + The center header of the worksheet. To apply font formatting or insert a + variable value, use format codes specified here: + https://msdn.microsoft.com/library/bb225426.aspx. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'centerHeader?: string;' + return: + type: string + - name: leftFooter + uid: excel!Excel.Interfaces.HeaderFooterUpdateData#leftFooter:member + package: excel! + fullName: leftFooter + summary: >- + The left footer of the worksheet. To apply font formatting or insert a + variable value, use format codes specified here: + https://msdn.microsoft.com/library/bb225426.aspx. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'leftFooter?: string;' + return: + type: string + - name: leftHeader + uid: excel!Excel.Interfaces.HeaderFooterUpdateData#leftHeader:member + package: excel! + fullName: leftHeader + summary: >- + The left header of the worksheet. To apply font formatting or insert a + variable value, use format codes specified here: + https://msdn.microsoft.com/library/bb225426.aspx. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'leftHeader?: string;' + return: + type: string + - name: rightFooter + uid: excel!Excel.Interfaces.HeaderFooterUpdateData#rightFooter:member + package: excel! + fullName: rightFooter + summary: >- + The right footer of the worksheet. To apply font formatting or insert a + variable value, use format codes specified here: + https://msdn.microsoft.com/library/bb225426.aspx. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rightFooter?: string;' + return: + type: string + - name: rightHeader + uid: excel!Excel.Interfaces.HeaderFooterUpdateData#rightHeader:member + package: excel! + fullName: rightHeader + summary: >- + The right header of the worksheet. To apply font formatting or insert a + variable value, use format codes specified here: + https://msdn.microsoft.com/library/bb225426.aspx. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rightHeader?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.iconsetconditionalformatdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.iconsetconditionalformatdata.yml new file mode 100644 index 0000000000..15983e8198 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.iconsetconditionalformatdata.yml @@ -0,0 +1,94 @@ +### YamlMime:TSType +name: Excel.Interfaces.IconSetConditionalFormatData +uid: excel!Excel.Interfaces.IconSetConditionalFormatData:interface +package: excel! +fullName: Excel.Interfaces.IconSetConditionalFormatData +summary: >- + An interface describing the data returned by calling + `iconSetConditionalFormat.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: criteria + uid: excel!Excel.Interfaces.IconSetConditionalFormatData#criteria:member + package: excel! + fullName: criteria + summary: >- + An array of criteria and icon sets for the rules and potential custom + icons for conditional icons. Note that for the first criterion only the + custom icon can be modified, while type, formula, and operator will be + ignored when set. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'criteria?: Excel.ConditionalIconCriterion[];' + return: + type: [] + - name: reverseIconOrder + uid: >- + excel!Excel.Interfaces.IconSetConditionalFormatData#reverseIconOrder:member + package: excel! + fullName: reverseIconOrder + summary: >- + If `true`, reverses the icon orders for the icon set. Note that + this cannot be set if custom icons are used. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'reverseIconOrder?: boolean;' + return: + type: boolean + - name: showIconOnly + uid: excel!Excel.Interfaces.IconSetConditionalFormatData#showIconOnly:member + package: excel! + fullName: showIconOnly + summary: If `true`, hides the values and only shows icons. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showIconOnly?: boolean;' + return: + type: boolean + - name: style + uid: excel!Excel.Interfaces.IconSetConditionalFormatData#style:member + package: excel! + fullName: style + summary: If set, displays the icon set option for the conditional format. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + style?: Excel.IconSet | "Invalid" | "ThreeArrows" | "ThreeArrowsGray" | + "ThreeFlags" | "ThreeTrafficLights1" | "ThreeTrafficLights2" | + "ThreeSigns" | "ThreeSymbols" | "ThreeSymbols2" | "FourArrows" | + "FourArrowsGray" | "FourRedToBlack" | "FourRating" | "FourTrafficLights" + | "FiveArrows" | "FiveArrowsGray" | "FiveRating" | "FiveQuarters" | + "ThreeStars" | "ThreeTriangles" | "FiveBoxes"; + return: + type: >- + | "Invalid" | "ThreeArrows" | + "ThreeArrowsGray" | "ThreeFlags" | "ThreeTrafficLights1" | + "ThreeTrafficLights2" | "ThreeSigns" | "ThreeSymbols" | + "ThreeSymbols2" | "FourArrows" | "FourArrowsGray" | "FourRedToBlack" | + "FourRating" | "FourTrafficLights" | "FiveArrows" | "FiveArrowsGray" | + "FiveRating" | "FiveQuarters" | "ThreeStars" | "ThreeTriangles" | + "FiveBoxes" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.iconsetconditionalformatloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.iconsetconditionalformatloadoptions.yml new file mode 100644 index 0000000000..e08e79013b --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.iconsetconditionalformatloadoptions.yml @@ -0,0 +1,98 @@ +### YamlMime:TSType +name: Excel.Interfaces.IconSetConditionalFormatLoadOptions +uid: excel!Excel.Interfaces.IconSetConditionalFormatLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.IconSetConditionalFormatLoadOptions +summary: Represents an icon set criteria for conditional formatting. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.IconSetConditionalFormatLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: criteria + uid: excel!Excel.Interfaces.IconSetConditionalFormatLoadOptions#criteria:member + package: excel! + fullName: criteria + summary: >- + An array of criteria and icon sets for the rules and potential custom + icons for conditional icons. Note that for the first criterion only the + custom icon can be modified, while type, formula, and operator will be + ignored when set. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'criteria?: boolean;' + return: + type: boolean + - name: reverseIconOrder + uid: >- + excel!Excel.Interfaces.IconSetConditionalFormatLoadOptions#reverseIconOrder:member + package: excel! + fullName: reverseIconOrder + summary: >- + If `true`, reverses the icon orders for the icon set. Note that + this cannot be set if custom icons are used. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'reverseIconOrder?: boolean;' + return: + type: boolean + - name: showIconOnly + uid: >- + excel!Excel.Interfaces.IconSetConditionalFormatLoadOptions#showIconOnly:member + package: excel! + fullName: showIconOnly + summary: If `true`, hides the values and only shows icons. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showIconOnly?: boolean;' + return: + type: boolean + - name: style + uid: excel!Excel.Interfaces.IconSetConditionalFormatLoadOptions#style:member + package: excel! + fullName: style + summary: If set, displays the icon set option for the conditional format. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'style?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.iconsetconditionalformatupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.iconsetconditionalformatupdatedata.yml new file mode 100644 index 0000000000..fefb1481cd --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.iconsetconditionalformatupdatedata.yml @@ -0,0 +1,95 @@ +### YamlMime:TSType +name: Excel.Interfaces.IconSetConditionalFormatUpdateData +uid: excel!Excel.Interfaces.IconSetConditionalFormatUpdateData:interface +package: excel! +fullName: Excel.Interfaces.IconSetConditionalFormatUpdateData +summary: >- + An interface for updating data on the `IconSetConditionalFormat` object, for + use in `iconSetConditionalFormat.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: criteria + uid: excel!Excel.Interfaces.IconSetConditionalFormatUpdateData#criteria:member + package: excel! + fullName: criteria + summary: >- + An array of criteria and icon sets for the rules and potential custom + icons for conditional icons. Note that for the first criterion only the + custom icon can be modified, while type, formula, and operator will be + ignored when set. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'criteria?: Excel.ConditionalIconCriterion[];' + return: + type: [] + - name: reverseIconOrder + uid: >- + excel!Excel.Interfaces.IconSetConditionalFormatUpdateData#reverseIconOrder:member + package: excel! + fullName: reverseIconOrder + summary: >- + If `true`, reverses the icon orders for the icon set. Note that + this cannot be set if custom icons are used. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'reverseIconOrder?: boolean;' + return: + type: boolean + - name: showIconOnly + uid: >- + excel!Excel.Interfaces.IconSetConditionalFormatUpdateData#showIconOnly:member + package: excel! + fullName: showIconOnly + summary: If `true`, hides the values and only shows icons. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showIconOnly?: boolean;' + return: + type: boolean + - name: style + uid: excel!Excel.Interfaces.IconSetConditionalFormatUpdateData#style:member + package: excel! + fullName: style + summary: If set, displays the icon set option for the conditional format. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + style?: Excel.IconSet | "Invalid" | "ThreeArrows" | "ThreeArrowsGray" | + "ThreeFlags" | "ThreeTrafficLights1" | "ThreeTrafficLights2" | + "ThreeSigns" | "ThreeSymbols" | "ThreeSymbols2" | "FourArrows" | + "FourArrowsGray" | "FourRedToBlack" | "FourRating" | "FourTrafficLights" + | "FiveArrows" | "FiveArrowsGray" | "FiveRating" | "FiveQuarters" | + "ThreeStars" | "ThreeTriangles" | "FiveBoxes"; + return: + type: >- + | "Invalid" | "ThreeArrows" | + "ThreeArrowsGray" | "ThreeFlags" | "ThreeTrafficLights1" | + "ThreeTrafficLights2" | "ThreeSigns" | "ThreeSymbols" | + "ThreeSymbols2" | "FourArrows" | "FourArrowsGray" | "FourRedToBlack" | + "FourRating" | "FourTrafficLights" | "FiveArrows" | "FiveArrowsGray" | + "FiveRating" | "FiveQuarters" | "ThreeStars" | "ThreeTriangles" | + "FiveBoxes" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.imagedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.imagedata.yml new file mode 100644 index 0000000000..823292e285 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.imagedata.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: Excel.Interfaces.ImageData +uid: excel!Excel.Interfaces.ImageData:interface +package: excel! +fullName: Excel.Interfaces.ImageData +summary: An interface describing the data returned by calling `image.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: format + uid: excel!Excel.Interfaces.ImageData#format:member + package: excel! + fullName: format + summary: Returns the format of the image. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + format?: Excel.PictureFormat | "UNKNOWN" | "BMP" | "JPEG" | "GIF" | + "PNG" | "SVG"; + return: + type: >- + | "UNKNOWN" | "BMP" | + "JPEG" | "GIF" | "PNG" | "SVG" + - name: id + uid: excel!Excel.Interfaces.ImageData#id:member + package: excel! + fullName: id + summary: Specifies the shape identifier for the image object. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.imageloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.imageloadoptions.yml new file mode 100644 index 0000000000..34727ed9cd --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.imageloadoptions.yml @@ -0,0 +1,77 @@ +### YamlMime:TSType +name: Excel.Interfaces.ImageLoadOptions +uid: excel!Excel.Interfaces.ImageLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ImageLoadOptions +summary: >- + Represents an image in the worksheet. To get the corresponding `Shape` object, + use `Image.shape`. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ImageLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: format + uid: excel!Excel.Interfaces.ImageLoadOptions#format:member + package: excel! + fullName: format + summary: Returns the format of the image. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.ImageLoadOptions#id:member + package: excel! + fullName: id + summary: Specifies the shape identifier for the image object. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: shape + uid: excel!Excel.Interfaces.ImageLoadOptions#shape:member + package: excel! + fullName: shape + summary: Returns the `Shape` object associated with the image. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'shape?: Excel.Interfaces.ShapeLoadOptions;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.iterativecalculationdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.iterativecalculationdata.yml new file mode 100644 index 0000000000..75c156476a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.iterativecalculationdata.yml @@ -0,0 +1,63 @@ +### YamlMime:TSType +name: Excel.Interfaces.IterativeCalculationData +uid: excel!Excel.Interfaces.IterativeCalculationData:interface +package: excel! +fullName: Excel.Interfaces.IterativeCalculationData +summary: >- + An interface describing the data returned by calling + `iterativeCalculation.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: enabled + uid: excel!Excel.Interfaces.IterativeCalculationData#enabled:member + package: excel! + fullName: enabled + summary: True if Excel will use iteration to resolve circular references. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'enabled?: boolean;' + return: + type: boolean + - name: maxChange + uid: excel!Excel.Interfaces.IterativeCalculationData#maxChange:member + package: excel! + fullName: maxChange + summary: >- + Specifies the maximum amount of change between each iteration as Excel + resolves circular references. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'maxChange?: number;' + return: + type: number + - name: maxIteration + uid: excel!Excel.Interfaces.IterativeCalculationData#maxIteration:member + package: excel! + fullName: maxIteration + summary: >- + Specifies the maximum number of iterations that Excel can use to resolve a + circular reference. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'maxIteration?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.iterativecalculationloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.iterativecalculationloadoptions.yml new file mode 100644 index 0000000000..b14eb44d47 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.iterativecalculationloadoptions.yml @@ -0,0 +1,79 @@ +### YamlMime:TSType +name: Excel.Interfaces.IterativeCalculationLoadOptions +uid: excel!Excel.Interfaces.IterativeCalculationLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.IterativeCalculationLoadOptions +summary: Represents the iterative calculation settings. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.IterativeCalculationLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: enabled + uid: excel!Excel.Interfaces.IterativeCalculationLoadOptions#enabled:member + package: excel! + fullName: enabled + summary: True if Excel will use iteration to resolve circular references. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'enabled?: boolean;' + return: + type: boolean + - name: maxChange + uid: excel!Excel.Interfaces.IterativeCalculationLoadOptions#maxChange:member + package: excel! + fullName: maxChange + summary: >- + Specifies the maximum amount of change between each iteration as Excel + resolves circular references. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'maxChange?: boolean;' + return: + type: boolean + - name: maxIteration + uid: excel!Excel.Interfaces.IterativeCalculationLoadOptions#maxIteration:member + package: excel! + fullName: maxIteration + summary: >- + Specifies the maximum number of iterations that Excel can use to resolve a + circular reference. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'maxIteration?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.iterativecalculationupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.iterativecalculationupdatedata.yml new file mode 100644 index 0000000000..5c15263557 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.iterativecalculationupdatedata.yml @@ -0,0 +1,63 @@ +### YamlMime:TSType +name: Excel.Interfaces.IterativeCalculationUpdateData +uid: excel!Excel.Interfaces.IterativeCalculationUpdateData:interface +package: excel! +fullName: Excel.Interfaces.IterativeCalculationUpdateData +summary: >- + An interface for updating data on the `IterativeCalculation` object, for use + in `iterativeCalculation.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: enabled + uid: excel!Excel.Interfaces.IterativeCalculationUpdateData#enabled:member + package: excel! + fullName: enabled + summary: True if Excel will use iteration to resolve circular references. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'enabled?: boolean;' + return: + type: boolean + - name: maxChange + uid: excel!Excel.Interfaces.IterativeCalculationUpdateData#maxChange:member + package: excel! + fullName: maxChange + summary: >- + Specifies the maximum amount of change between each iteration as Excel + resolves circular references. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'maxChange?: number;' + return: + type: number + - name: maxIteration + uid: excel!Excel.Interfaces.IterativeCalculationUpdateData#maxIteration:member + package: excel! + fullName: maxIteration + summary: >- + Specifies the maximum number of iterations that Excel can use to resolve a + circular reference. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'maxIteration?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.linedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.linedata.yml new file mode 100644 index 0000000000..dd2e024c8a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.linedata.yml @@ -0,0 +1,228 @@ +### YamlMime:TSType +name: Excel.Interfaces.LineData +uid: excel!Excel.Interfaces.LineData:interface +package: excel! +fullName: Excel.Interfaces.LineData +summary: An interface describing the data returned by calling `line.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: beginArrowheadLength + uid: excel!Excel.Interfaces.LineData#beginArrowheadLength:member + package: excel! + fullName: beginArrowheadLength + summary: >- + Represents the length of the arrowhead at the beginning of the specified + line. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + beginArrowheadLength?: Excel.ArrowheadLength | "Short" | "Medium" | + "Long"; + return: + type: >- + | "Short" | "Medium" | + "Long" + - name: beginArrowheadStyle + uid: excel!Excel.Interfaces.LineData#beginArrowheadStyle:member + package: excel! + fullName: beginArrowheadStyle + summary: >- + Represents the style of the arrowhead at the beginning of the specified + line. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + beginArrowheadStyle?: Excel.ArrowheadStyle | "None" | "Triangle" | + "Stealth" | "Diamond" | "Oval" | "Open"; + return: + type: >- + | "None" | "Triangle" | + "Stealth" | "Diamond" | "Oval" | "Open" + - name: beginArrowheadWidth + uid: excel!Excel.Interfaces.LineData#beginArrowheadWidth:member + package: excel! + fullName: beginArrowheadWidth + summary: >- + Represents the width of the arrowhead at the beginning of the specified + line. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + beginArrowheadWidth?: Excel.ArrowheadWidth | "Narrow" | "Medium" | + "Wide"; + return: + type: >- + | "Narrow" | "Medium" | + "Wide" + - name: beginConnectedSite + uid: excel!Excel.Interfaces.LineData#beginConnectedSite:member + package: excel! + fullName: beginConnectedSite + summary: >- + Represents the connection site to which the beginning of a connector is + connected. Returns `null` when the beginning of the line is not attached + to any shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'beginConnectedSite?: number;' + return: + type: number + - name: connectorType + uid: excel!Excel.Interfaces.LineData#connectorType:member + package: excel! + fullName: connectorType + summary: Represents the connector type for the line. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'connectorType?: Excel.ConnectorType | "Straight" | "Elbow" | "Curve";' + return: + type: >- + | "Straight" | "Elbow" | + "Curve" + - name: endArrowheadLength + uid: excel!Excel.Interfaces.LineData#endArrowheadLength:member + package: excel! + fullName: endArrowheadLength + summary: Represents the length of the arrowhead at the end of the specified line. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + endArrowheadLength?: Excel.ArrowheadLength | "Short" | "Medium" | + "Long"; + return: + type: >- + | "Short" | "Medium" | + "Long" + - name: endArrowheadStyle + uid: excel!Excel.Interfaces.LineData#endArrowheadStyle:member + package: excel! + fullName: endArrowheadStyle + summary: Represents the style of the arrowhead at the end of the specified line. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + endArrowheadStyle?: Excel.ArrowheadStyle | "None" | "Triangle" | + "Stealth" | "Diamond" | "Oval" | "Open"; + return: + type: >- + | "None" | "Triangle" | + "Stealth" | "Diamond" | "Oval" | "Open" + - name: endArrowheadWidth + uid: excel!Excel.Interfaces.LineData#endArrowheadWidth:member + package: excel! + fullName: endArrowheadWidth + summary: Represents the width of the arrowhead at the end of the specified line. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'endArrowheadWidth?: Excel.ArrowheadWidth | "Narrow" | "Medium" | "Wide";' + return: + type: >- + | "Narrow" | "Medium" | + "Wide" + - name: endConnectedSite + uid: excel!Excel.Interfaces.LineData#endConnectedSite:member + package: excel! + fullName: endConnectedSite + summary: >- + Represents the connection site to which the end of a connector is + connected. Returns `null` when the end of the line is not attached to any + shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'endConnectedSite?: number;' + return: + type: number + - name: id + uid: excel!Excel.Interfaces.LineData#id:member + package: excel! + fullName: id + summary: Specifies the shape identifier. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: string;' + return: + type: string + - name: isBeginConnected + uid: excel!Excel.Interfaces.LineData#isBeginConnected:member + package: excel! + fullName: isBeginConnected + summary: Specifies if the beginning of the specified line is connected to a shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'isBeginConnected?: boolean;' + return: + type: boolean + - name: isEndConnected + uid: excel!Excel.Interfaces.LineData#isEndConnected:member + package: excel! + fullName: isEndConnected + summary: Specifies if the end of the specified line is connected to a shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'isEndConnected?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.lineloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.lineloadoptions.yml new file mode 100644 index 0000000000..e5ca5fb0d0 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.lineloadoptions.yml @@ -0,0 +1,271 @@ +### YamlMime:TSType +name: Excel.Interfaces.LineLoadOptions +uid: excel!Excel.Interfaces.LineLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.LineLoadOptions +summary: >- + Represents a line inside a worksheet. To get the corresponding `Shape` object, + use `Line.shape`. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.LineLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: beginArrowheadLength + uid: excel!Excel.Interfaces.LineLoadOptions#beginArrowheadLength:member + package: excel! + fullName: beginArrowheadLength + summary: >- + Represents the length of the arrowhead at the beginning of the specified + line. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'beginArrowheadLength?: boolean;' + return: + type: boolean + - name: beginArrowheadStyle + uid: excel!Excel.Interfaces.LineLoadOptions#beginArrowheadStyle:member + package: excel! + fullName: beginArrowheadStyle + summary: >- + Represents the style of the arrowhead at the beginning of the specified + line. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'beginArrowheadStyle?: boolean;' + return: + type: boolean + - name: beginArrowheadWidth + uid: excel!Excel.Interfaces.LineLoadOptions#beginArrowheadWidth:member + package: excel! + fullName: beginArrowheadWidth + summary: >- + Represents the width of the arrowhead at the beginning of the specified + line. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'beginArrowheadWidth?: boolean;' + return: + type: boolean + - name: beginConnectedShape + uid: excel!Excel.Interfaces.LineLoadOptions#beginConnectedShape:member + package: excel! + fullName: beginConnectedShape + summary: >- + Represents the shape to which the beginning of the specified line is + attached. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'beginConnectedShape?: Excel.Interfaces.ShapeLoadOptions;' + return: + type: + - name: beginConnectedSite + uid: excel!Excel.Interfaces.LineLoadOptions#beginConnectedSite:member + package: excel! + fullName: beginConnectedSite + summary: >- + Represents the connection site to which the beginning of a connector is + connected. Returns `null` when the beginning of the line is not attached + to any shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'beginConnectedSite?: boolean;' + return: + type: boolean + - name: connectorType + uid: excel!Excel.Interfaces.LineLoadOptions#connectorType:member + package: excel! + fullName: connectorType + summary: Represents the connector type for the line. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'connectorType?: boolean;' + return: + type: boolean + - name: endArrowheadLength + uid: excel!Excel.Interfaces.LineLoadOptions#endArrowheadLength:member + package: excel! + fullName: endArrowheadLength + summary: Represents the length of the arrowhead at the end of the specified line. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'endArrowheadLength?: boolean;' + return: + type: boolean + - name: endArrowheadStyle + uid: excel!Excel.Interfaces.LineLoadOptions#endArrowheadStyle:member + package: excel! + fullName: endArrowheadStyle + summary: Represents the style of the arrowhead at the end of the specified line. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'endArrowheadStyle?: boolean;' + return: + type: boolean + - name: endArrowheadWidth + uid: excel!Excel.Interfaces.LineLoadOptions#endArrowheadWidth:member + package: excel! + fullName: endArrowheadWidth + summary: Represents the width of the arrowhead at the end of the specified line. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'endArrowheadWidth?: boolean;' + return: + type: boolean + - name: endConnectedShape + uid: excel!Excel.Interfaces.LineLoadOptions#endConnectedShape:member + package: excel! + fullName: endConnectedShape + summary: Represents the shape to which the end of the specified line is attached. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'endConnectedShape?: Excel.Interfaces.ShapeLoadOptions;' + return: + type: + - name: endConnectedSite + uid: excel!Excel.Interfaces.LineLoadOptions#endConnectedSite:member + package: excel! + fullName: endConnectedSite + summary: >- + Represents the connection site to which the end of a connector is + connected. Returns `null` when the end of the line is not attached to any + shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'endConnectedSite?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.LineLoadOptions#id:member + package: excel! + fullName: id + summary: Specifies the shape identifier. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: isBeginConnected + uid: excel!Excel.Interfaces.LineLoadOptions#isBeginConnected:member + package: excel! + fullName: isBeginConnected + summary: Specifies if the beginning of the specified line is connected to a shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'isBeginConnected?: boolean;' + return: + type: boolean + - name: isEndConnected + uid: excel!Excel.Interfaces.LineLoadOptions#isEndConnected:member + package: excel! + fullName: isEndConnected + summary: Specifies if the end of the specified line is connected to a shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'isEndConnected?: boolean;' + return: + type: boolean + - name: shape + uid: excel!Excel.Interfaces.LineLoadOptions#shape:member + package: excel! + fullName: shape + summary: Returns the `Shape` object associated with the line. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'shape?: Excel.Interfaces.ShapeLoadOptions;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.lineupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.lineupdatedata.yml new file mode 100644 index 0000000000..7512a9e7b2 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.lineupdatedata.yml @@ -0,0 +1,149 @@ +### YamlMime:TSType +name: Excel.Interfaces.LineUpdateData +uid: excel!Excel.Interfaces.LineUpdateData:interface +package: excel! +fullName: Excel.Interfaces.LineUpdateData +summary: >- + An interface for updating data on the `Line` object, for use in `line.set({ + ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: beginArrowheadLength + uid: excel!Excel.Interfaces.LineUpdateData#beginArrowheadLength:member + package: excel! + fullName: beginArrowheadLength + summary: >- + Represents the length of the arrowhead at the beginning of the specified + line. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + beginArrowheadLength?: Excel.ArrowheadLength | "Short" | "Medium" | + "Long"; + return: + type: >- + | "Short" | "Medium" | + "Long" + - name: beginArrowheadStyle + uid: excel!Excel.Interfaces.LineUpdateData#beginArrowheadStyle:member + package: excel! + fullName: beginArrowheadStyle + summary: >- + Represents the style of the arrowhead at the beginning of the specified + line. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + beginArrowheadStyle?: Excel.ArrowheadStyle | "None" | "Triangle" | + "Stealth" | "Diamond" | "Oval" | "Open"; + return: + type: >- + | "None" | "Triangle" | + "Stealth" | "Diamond" | "Oval" | "Open" + - name: beginArrowheadWidth + uid: excel!Excel.Interfaces.LineUpdateData#beginArrowheadWidth:member + package: excel! + fullName: beginArrowheadWidth + summary: >- + Represents the width of the arrowhead at the beginning of the specified + line. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + beginArrowheadWidth?: Excel.ArrowheadWidth | "Narrow" | "Medium" | + "Wide"; + return: + type: >- + | "Narrow" | "Medium" | + "Wide" + - name: connectorType + uid: excel!Excel.Interfaces.LineUpdateData#connectorType:member + package: excel! + fullName: connectorType + summary: Represents the connector type for the line. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'connectorType?: Excel.ConnectorType | "Straight" | "Elbow" | "Curve";' + return: + type: >- + | "Straight" | "Elbow" | + "Curve" + - name: endArrowheadLength + uid: excel!Excel.Interfaces.LineUpdateData#endArrowheadLength:member + package: excel! + fullName: endArrowheadLength + summary: Represents the length of the arrowhead at the end of the specified line. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + endArrowheadLength?: Excel.ArrowheadLength | "Short" | "Medium" | + "Long"; + return: + type: >- + | "Short" | "Medium" | + "Long" + - name: endArrowheadStyle + uid: excel!Excel.Interfaces.LineUpdateData#endArrowheadStyle:member + package: excel! + fullName: endArrowheadStyle + summary: Represents the style of the arrowhead at the end of the specified line. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + endArrowheadStyle?: Excel.ArrowheadStyle | "None" | "Triangle" | + "Stealth" | "Diamond" | "Oval" | "Open"; + return: + type: >- + | "None" | "Triangle" | + "Stealth" | "Diamond" | "Oval" | "Open" + - name: endArrowheadWidth + uid: excel!Excel.Interfaces.LineUpdateData#endArrowheadWidth:member + package: excel! + fullName: endArrowheadWidth + summary: Represents the width of the arrowhead at the end of the specified line. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'endArrowheadWidth?: Excel.ArrowheadWidth | "Narrow" | "Medium" | "Wide";' + return: + type: >- + | "Narrow" | "Medium" | + "Wide" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.linkedentitydatadomaincollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.linkedentitydatadomaincollectiondata.yml new file mode 100644 index 0000000000..df216c8a4b --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.linkedentitydatadomaincollectiondata.yml @@ -0,0 +1,29 @@ +### YamlMime:TSType +name: Excel.Interfaces.LinkedEntityDataDomainCollectionData +uid: excel!Excel.Interfaces.LinkedEntityDataDomainCollectionData:interface +package: excel! +fullName: Excel.Interfaces.LinkedEntityDataDomainCollectionData +summary: >- + An interface describing the data returned by calling + `linkedEntityDataDomainCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.LinkedEntityDataDomainCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.LinkedEntityDataDomainData[];' + return: + type: >- + [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.linkedentitydatadomaincollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.linkedentitydatadomaincollectionloadoptions.yml new file mode 100644 index 0000000000..94b7d42ad4 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.linkedentitydatadomaincollectionloadoptions.yml @@ -0,0 +1,258 @@ +### YamlMime:TSType +name: Excel.Interfaces.LinkedEntityDataDomainCollectionLoadOptions +uid: excel!Excel.Interfaces.LinkedEntityDataDomainCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.LinkedEntityDataDomainCollectionLoadOptions +summary: >- + Represents a collection of `LinkedEntityDataDomain` objects. The collection + can contain linked entity data domains such as stocks, geography, or + currencies defined by service data providers, such as Bing or Power BI, or + linked entity data domains defined by Office Add-ins. +remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + This interface isn't supported in Excel on the web. + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: >- + excel!Excel.Interfaces.LinkedEntityDataDomainCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: dataProvider + uid: >- + excel!Excel.Interfaces.LinkedEntityDataDomainCollectionLoadOptions#dataProvider:member + package: excel! + fullName: dataProvider + summary: >- + For EACH ITEM in the collection: Gets the name of the data provider for + the linked entity data domain. This name can change based on the + information provided by the data provider. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'dataProvider?: boolean;' + return: + type: boolean + - name: id + uid: >- + excel!Excel.Interfaces.LinkedEntityDataDomainCollectionLoadOptions#id:member + package: excel! + fullName: id + summary: >- + For EACH ITEM in the collection: Gets the ID of the linked entity data + domain defined by Office Add-ins. This ID is not applicable to linked + entity data domains defined by service data providers, such as Bing or + Power BI. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: lastRefreshed + uid: >- + excel!Excel.Interfaces.LinkedEntityDataDomainCollectionLoadOptions#lastRefreshed:member + package: excel! + fullName: lastRefreshed + summary: >- + For EACH ITEM in the collection: Gets the date and time (in the local time + zone) since the workbook was opened and the `LinkedEntityCellValue` + objects of this linked entity data domain were last refreshed. Returns + `undefined` if `LinkedEntityCellValue` objects have not been refreshed + since the workbook was opened. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'lastRefreshed?: boolean;' + return: + type: boolean + - name: loadFunctionId + uid: >- + excel!Excel.Interfaces.LinkedEntityDataDomainCollectionLoadOptions#loadFunctionId:member + package: excel! + fullName: loadFunctionId + summary: >- + For EACH ITEM in the collection: Gets the ID of the custom function that + is called on demand to resolve or refresh the `LinkedEntityCellValue` + objects of the linked entity data domain defined by Office Add-ins. For + further information, see [Autogenerate JSON metadata for custom functions: + ID](https://learn.microsoft.com/office/dev/add-ins/excel/custom-functions-json-autogeneration#id). This ID is not applicable to linked entity data domains defined by + service data providers, such as Bing or Power BI. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'loadFunctionId?: boolean;' + return: + type: boolean + - name: name + uid: >- + excel!Excel.Interfaces.LinkedEntityDataDomainCollectionLoadOptions#name:member + package: excel! + fullName: name + summary: >- + For EACH ITEM in the collection: Gets the name of the linked entity data + domain. This name can change based on the information provided by the data + provider. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: periodicRefreshInterval + uid: >- + excel!Excel.Interfaces.LinkedEntityDataDomainCollectionLoadOptions#periodicRefreshInterval:member + package: excel! + fullName: periodicRefreshInterval + summary: >- + For EACH ITEM in the collection: Gets the frequency, in seconds, at which + `LinkedEntityCellValue` objects of this linked entity data domain are + refreshed automatically. The refresh interval only applies if the + `refreshMode` is set to "Periodic". + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'periodicRefreshInterval?: boolean;' + return: + type: boolean + - name: refreshMode + uid: >- + excel!Excel.Interfaces.LinkedEntityDataDomainCollectionLoadOptions#refreshMode:member + package: excel! + fullName: refreshMode + summary: >- + For EACH ITEM in the collection: Specifies the refresh mode that defines + how and when the `LinkedEntityCellValue` objects of this linked entity + data domain are refreshed. If the refresh mode being set is not supported + by this linked entity data domain, then the current refresh mode is not + changed. If the refresh mode is set to "Periodic", the refresh interval is + set to the `periodicRefreshInterval` of this linked entity data domain. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'refreshMode?: boolean;' + return: + type: boolean + - name: serviceId + uid: >- + excel!Excel.Interfaces.LinkedEntityDataDomainCollectionLoadOptions#serviceId:member + package: excel! + fullName: serviceId + summary: >- + For EACH ITEM in the collection: Gets the service ID of the linked entity + data domain. This ID is a permanently reserved value for all linked entity + data domains which are defined by service data providers, such as Bing or + Power BI, or defined by Office Add-ins. This ID never changes across user + sessions. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'serviceId?: boolean;' + return: + type: boolean + - name: supportedRefreshModes + uid: >- + excel!Excel.Interfaces.LinkedEntityDataDomainCollectionLoadOptions#supportedRefreshModes:member + package: excel! + fullName: supportedRefreshModes + summary: >- + For EACH ITEM in the collection: Gets all the refresh modes supported by + the linked entity data domain. This array can change based on the + information provided by the data provider. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'supportedRefreshModes?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.linkedentitydatadomaincollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.linkedentitydatadomaincollectionupdatedata.yml new file mode 100644 index 0000000000..9d04a89fb9 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.linkedentitydatadomaincollectionupdatedata.yml @@ -0,0 +1,30 @@ +### YamlMime:TSType +name: Excel.Interfaces.LinkedEntityDataDomainCollectionUpdateData +uid: excel!Excel.Interfaces.LinkedEntityDataDomainCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.LinkedEntityDataDomainCollectionUpdateData +summary: >- + An interface for updating data on the `LinkedEntityDataDomainCollection` + object, for use in `linkedEntityDataDomainCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: >- + excel!Excel.Interfaces.LinkedEntityDataDomainCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.LinkedEntityDataDomainData[];' + return: + type: >- + [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.linkedentitydatadomaindata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.linkedentitydatadomaindata.yml new file mode 100644 index 0000000000..3446fe3d8b --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.linkedentitydatadomaindata.yml @@ -0,0 +1,198 @@ +### YamlMime:TSType +name: Excel.Interfaces.LinkedEntityDataDomainData +uid: excel!Excel.Interfaces.LinkedEntityDataDomainData:interface +package: excel! +fullName: Excel.Interfaces.LinkedEntityDataDomainData +summary: >- + An interface describing the data returned by calling + `linkedEntityDataDomain.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: dataProvider + uid: excel!Excel.Interfaces.LinkedEntityDataDomainData#dataProvider:member + package: excel! + fullName: dataProvider + summary: >- + Gets the name of the data provider for the linked entity data domain. This + name can change based on the information provided by the data provider. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'dataProvider?: string;' + return: + type: string + - name: id + uid: excel!Excel.Interfaces.LinkedEntityDataDomainData#id:member + package: excel! + fullName: id + summary: >- + Gets the ID of the linked entity data domain defined by Office Add-ins. + This ID is not applicable to linked entity data domains defined by service + data providers, such as Bing or Power BI. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: string;' + return: + type: string + - name: lastRefreshed + uid: excel!Excel.Interfaces.LinkedEntityDataDomainData#lastRefreshed:member + package: excel! + fullName: lastRefreshed + summary: >- + Gets the date and time (in the local time zone) since the workbook was + opened and the `LinkedEntityCellValue` objects of this linked entity data + domain were last refreshed. Returns `undefined` if `LinkedEntityCellValue` + objects have not been refreshed since the workbook was opened. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'lastRefreshed?: Date;' + return: + type: Date + - name: loadFunctionId + uid: excel!Excel.Interfaces.LinkedEntityDataDomainData#loadFunctionId:member + package: excel! + fullName: loadFunctionId + summary: >- + Gets the ID of the custom function that is called on demand to resolve or + refresh the `LinkedEntityCellValue` objects of the linked entity data + domain defined by Office Add-ins. For further information, see + [Autogenerate JSON metadata for custom functions: + ID](https://learn.microsoft.com/office/dev/add-ins/excel/custom-functions-json-autogeneration#id). This ID is not applicable to linked entity data domains defined by + service data providers, such as Bing or Power BI. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'loadFunctionId?: string;' + return: + type: string + - name: name + uid: excel!Excel.Interfaces.LinkedEntityDataDomainData#name:member + package: excel! + fullName: name + summary: >- + Gets the name of the linked entity data domain. This name can change based + on the information provided by the data provider. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: periodicRefreshInterval + uid: >- + excel!Excel.Interfaces.LinkedEntityDataDomainData#periodicRefreshInterval:member + package: excel! + fullName: periodicRefreshInterval + summary: >- + Gets the frequency, in seconds, at which `LinkedEntityCellValue` objects + of this linked entity data domain are refreshed automatically. The refresh + interval only applies if the `refreshMode` is set to "Periodic". + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'periodicRefreshInterval?: number;' + return: + type: number + - name: refreshMode + uid: excel!Excel.Interfaces.LinkedEntityDataDomainData#refreshMode:member + package: excel! + fullName: refreshMode + summary: >- + Specifies the refresh mode that defines how and when the + `LinkedEntityCellValue` objects of this linked entity data domain are + refreshed. If the refresh mode being set is not supported by this linked + entity data domain, then the current refresh mode is not changed. If the + refresh mode is set to "Periodic", the refresh interval is set to the + `periodicRefreshInterval` of this linked entity data domain. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + refreshMode?: Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | + "Manual" | "OnLoad" | "Periodic"; + return: + type: >- + | + "Unknown" | "Manual" | "OnLoad" | "Periodic" + - name: serviceId + uid: excel!Excel.Interfaces.LinkedEntityDataDomainData#serviceId:member + package: excel! + fullName: serviceId + summary: >- + Gets the service ID of the linked entity data domain. This ID is a + permanently reserved value for all linked entity data domains which are + defined by service data providers, such as Bing or Power BI, or defined by + Office Add-ins. This ID never changes across user sessions. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'serviceId?: number;' + return: + type: number + - name: supportedRefreshModes + uid: >- + excel!Excel.Interfaces.LinkedEntityDataDomainData#supportedRefreshModes:member + package: excel! + fullName: supportedRefreshModes + summary: >- + Gets all the refresh modes supported by the linked entity data domain. + This array can change based on the information provided by the data + provider. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'supportedRefreshModes?: Excel.LinkedEntityDataDomainRefreshMode[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.linkedentitydatadomainloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.linkedentitydatadomainloadoptions.yml new file mode 100644 index 0000000000..14e6a424f8 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.linkedentitydatadomainloadoptions.yml @@ -0,0 +1,250 @@ +### YamlMime:TSType +name: Excel.Interfaces.LinkedEntityDataDomainLoadOptions +uid: excel!Excel.Interfaces.LinkedEntityDataDomainLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.LinkedEntityDataDomainLoadOptions +summary: >- + Represents a specific category or field of information that shares some common + characteristics or attributes. A data domain is linked to a data provider, + that acts as the data source for `LinkedEntityCellValue` objects in the + workbook. A data domain is a category of data, such as stocks, geography, or + currencies. A data provider is a service, such as Bing, Power BI, or an Office + Add-in. +remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + This interface isn't supported in Excel on the web. + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.LinkedEntityDataDomainLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: dataProvider + uid: >- + excel!Excel.Interfaces.LinkedEntityDataDomainLoadOptions#dataProvider:member + package: excel! + fullName: dataProvider + summary: >- + Gets the name of the data provider for the linked entity data domain. This + name can change based on the information provided by the data provider. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'dataProvider?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.LinkedEntityDataDomainLoadOptions#id:member + package: excel! + fullName: id + summary: >- + Gets the ID of the linked entity data domain defined by Office Add-ins. + This ID is not applicable to linked entity data domains defined by service + data providers, such as Bing or Power BI. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: lastRefreshed + uid: >- + excel!Excel.Interfaces.LinkedEntityDataDomainLoadOptions#lastRefreshed:member + package: excel! + fullName: lastRefreshed + summary: >- + Gets the date and time (in the local time zone) since the workbook was + opened and the `LinkedEntityCellValue` objects of this linked entity data + domain were last refreshed. Returns `undefined` if `LinkedEntityCellValue` + objects have not been refreshed since the workbook was opened. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'lastRefreshed?: boolean;' + return: + type: boolean + - name: loadFunctionId + uid: >- + excel!Excel.Interfaces.LinkedEntityDataDomainLoadOptions#loadFunctionId:member + package: excel! + fullName: loadFunctionId + summary: >- + Gets the ID of the custom function that is called on demand to resolve or + refresh the `LinkedEntityCellValue` objects of the linked entity data + domain defined by Office Add-ins. For further information, see + [Autogenerate JSON metadata for custom functions: + ID](https://learn.microsoft.com/office/dev/add-ins/excel/custom-functions-json-autogeneration#id). This ID is not applicable to linked entity data domains defined by + service data providers, such as Bing or Power BI. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'loadFunctionId?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.LinkedEntityDataDomainLoadOptions#name:member + package: excel! + fullName: name + summary: >- + Gets the name of the linked entity data domain. This name can change based + on the information provided by the data provider. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: periodicRefreshInterval + uid: >- + excel!Excel.Interfaces.LinkedEntityDataDomainLoadOptions#periodicRefreshInterval:member + package: excel! + fullName: periodicRefreshInterval + summary: >- + Gets the frequency, in seconds, at which `LinkedEntityCellValue` objects + of this linked entity data domain are refreshed automatically. The refresh + interval only applies if the `refreshMode` is set to "Periodic". + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'periodicRefreshInterval?: boolean;' + return: + type: boolean + - name: refreshMode + uid: >- + excel!Excel.Interfaces.LinkedEntityDataDomainLoadOptions#refreshMode:member + package: excel! + fullName: refreshMode + summary: >- + Specifies the refresh mode that defines how and when the + `LinkedEntityCellValue` objects of this linked entity data domain are + refreshed. If the refresh mode being set is not supported by this linked + entity data domain, then the current refresh mode is not changed. If the + refresh mode is set to "Periodic", the refresh interval is set to the + `periodicRefreshInterval` of this linked entity data domain. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'refreshMode?: boolean;' + return: + type: boolean + - name: serviceId + uid: excel!Excel.Interfaces.LinkedEntityDataDomainLoadOptions#serviceId:member + package: excel! + fullName: serviceId + summary: >- + Gets the service ID of the linked entity data domain. This ID is a + permanently reserved value for all linked entity data domains which are + defined by service data providers, such as Bing or Power BI, or defined by + Office Add-ins. This ID never changes across user sessions. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'serviceId?: boolean;' + return: + type: boolean + - name: supportedRefreshModes + uid: >- + excel!Excel.Interfaces.LinkedEntityDataDomainLoadOptions#supportedRefreshModes:member + package: excel! + fullName: supportedRefreshModes + summary: >- + Gets all the refresh modes supported by the linked entity data domain. + This array can change based on the information provided by the data + provider. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'supportedRefreshModes?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.linkedentitydatadomainupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.linkedentitydatadomainupdatedata.yml new file mode 100644 index 0000000000..6ffbe21c11 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.linkedentitydatadomainupdatedata.yml @@ -0,0 +1,40 @@ +### YamlMime:TSType +name: Excel.Interfaces.LinkedEntityDataDomainUpdateData +uid: excel!Excel.Interfaces.LinkedEntityDataDomainUpdateData:interface +package: excel! +fullName: Excel.Interfaces.LinkedEntityDataDomainUpdateData +summary: >- + An interface for updating data on the `LinkedEntityDataDomain` object, for use + in `linkedEntityDataDomain.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: refreshMode + uid: excel!Excel.Interfaces.LinkedEntityDataDomainUpdateData#refreshMode:member + package: excel! + fullName: refreshMode + summary: >- + Specifies the refresh mode that defines how and when the + `LinkedEntityCellValue` objects of this linked entity data domain are + refreshed. If the refresh mode being set is not supported by this linked + entity data domain, then the current refresh mode is not changed. If the + refresh mode is set to "Periodic", the refresh interval is set to the + `periodicRefreshInterval` of this linked entity data domain. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + refreshMode?: Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | + "Manual" | "OnLoad" | "Periodic"; + return: + type: >- + | + "Unknown" | "Manual" | "OnLoad" | "Periodic" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.linkedworkbookcollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.linkedworkbookcollectiondata.yml new file mode 100644 index 0000000000..03b3abe018 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.linkedworkbookcollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.LinkedWorkbookCollectionData +uid: excel!Excel.Interfaces.LinkedWorkbookCollectionData:interface +package: excel! +fullName: Excel.Interfaces.LinkedWorkbookCollectionData +summary: >- + An interface describing the data returned by calling + `linkedWorkbookCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.LinkedWorkbookCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.LinkedWorkbookData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.linkedworkbookcollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.linkedworkbookcollectionupdatedata.yml new file mode 100644 index 0000000000..6204885913 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.linkedworkbookcollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.LinkedWorkbookCollectionUpdateData +uid: excel!Excel.Interfaces.LinkedWorkbookCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.LinkedWorkbookCollectionUpdateData +summary: >- + An interface for updating data on the `LinkedWorkbookCollection` object, for + use in `linkedWorkbookCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.LinkedWorkbookCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.LinkedWorkbookData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.linkedworkbookdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.linkedworkbookdata.yml new file mode 100644 index 0000000000..235d1aabae --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.linkedworkbookdata.yml @@ -0,0 +1,13 @@ +### YamlMime:TSType +name: Excel.Interfaces.LinkedWorkbookData +uid: excel!Excel.Interfaces.LinkedWorkbookData:interface +package: excel! +fullName: Excel.Interfaces.LinkedWorkbookData +summary: >- + An interface describing the data returned by calling + `linkedWorkbook.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.nameditemarrayvaluesdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.nameditemarrayvaluesdata.yml new file mode 100644 index 0000000000..ca456febea --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.nameditemarrayvaluesdata.yml @@ -0,0 +1,91 @@ +### YamlMime:TSType +name: Excel.Interfaces.NamedItemArrayValuesData +uid: excel!Excel.Interfaces.NamedItemArrayValuesData:interface +package: excel! +fullName: Excel.Interfaces.NamedItemArrayValuesData +summary: >- + An interface describing the data returned by calling + `namedItemArrayValues.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: types + uid: excel!Excel.Interfaces.NamedItemArrayValuesData#types:member + package: excel! + fullName: types + summary: Represents the types for each item in the named item array + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'types?: Excel.RangeValueType[][];' + return: + type: [][] + - name: values + uid: excel!Excel.Interfaces.NamedItemArrayValuesData#values:member + package: excel! + fullName: values + summary: Represents the values of each item in the named item array. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'values?: any[][];' + return: + type: any[][] + - name: valuesAsJson + uid: excel!Excel.Interfaces.NamedItemArrayValuesData#valuesAsJson:member + package: excel! + fullName: valuesAsJson + summary: >- + A JSON representation of the values in this named item array. Unlike + `NamedItemArrayValues.values`, `NamedItemArrayValues.valuesAsJson` + supports all data types which can be in a cell. Examples include formatted + number values and web images, in addition to the standard boolean, number, + and string values. Data returned from this API always aligns with the + en-US locale. To retrieve data in the user's display locale, use + `NamedItemArrayValues.valuesAsJsonLocal`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJson?: CellValue[][];' + return: + type: [][] + - name: valuesAsJsonLocal + uid: excel!Excel.Interfaces.NamedItemArrayValuesData#valuesAsJsonLocal:member + package: excel! + fullName: valuesAsJsonLocal + summary: >- + A JSON representation of the values in this named item array. Unlike + `NamedItemArrayValues.values`, + `NamedItemArrayValues.valuesAsJsonLocal` supports all data types which can + be in a cell. Examples include formatted number values and web images, in + addition to the standard boolean, number, and string values. Data returned + from this API always aligns with the user's display locale. To retrieve + data independent of locale, use `NamedItemArrayValues.valuesAsJson`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJsonLocal?: CellValue[][];' + return: + type: [][] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.nameditemarrayvaluesloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.nameditemarrayvaluesloadoptions.yml new file mode 100644 index 0000000000..9393d92a3c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.nameditemarrayvaluesloadoptions.yml @@ -0,0 +1,108 @@ +### YamlMime:TSType +name: Excel.Interfaces.NamedItemArrayValuesLoadOptions +uid: excel!Excel.Interfaces.NamedItemArrayValuesLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.NamedItemArrayValuesLoadOptions +summary: Represents an object containing values and types of a named item. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.NamedItemArrayValuesLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: types + uid: excel!Excel.Interfaces.NamedItemArrayValuesLoadOptions#types:member + package: excel! + fullName: types + summary: Represents the types for each item in the named item array + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'types?: boolean;' + return: + type: boolean + - name: values + uid: excel!Excel.Interfaces.NamedItemArrayValuesLoadOptions#values:member + package: excel! + fullName: values + summary: Represents the values of each item in the named item array. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'values?: boolean;' + return: + type: boolean + - name: valuesAsJson + uid: excel!Excel.Interfaces.NamedItemArrayValuesLoadOptions#valuesAsJson:member + package: excel! + fullName: valuesAsJson + summary: >- + A JSON representation of the values in this named item array. Unlike + `NamedItemArrayValues.values`, `NamedItemArrayValues.valuesAsJson` + supports all data types which can be in a cell. Examples include formatted + number values and web images, in addition to the standard boolean, number, + and string values. Data returned from this API always aligns with the + en-US locale. To retrieve data in the user's display locale, use + `NamedItemArrayValues.valuesAsJsonLocal`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJson?: boolean;' + return: + type: boolean + - name: valuesAsJsonLocal + uid: >- + excel!Excel.Interfaces.NamedItemArrayValuesLoadOptions#valuesAsJsonLocal:member + package: excel! + fullName: valuesAsJsonLocal + summary: >- + A JSON representation of the values in this named item array. Unlike + `NamedItemArrayValues.values`, + `NamedItemArrayValues.valuesAsJsonLocal` supports all data types which can + be in a cell. Examples include formatted number values and web images, in + addition to the standard boolean, number, and string values. Data returned + from this API always aligns with the user's display locale. To retrieve + data independent of locale, use `NamedItemArrayValues.valuesAsJson`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJsonLocal?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.nameditemcollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.nameditemcollectiondata.yml new file mode 100644 index 0000000000..d575439836 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.nameditemcollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.NamedItemCollectionData +uid: excel!Excel.Interfaces.NamedItemCollectionData:interface +package: excel! +fullName: Excel.Interfaces.NamedItemCollectionData +summary: >- + An interface describing the data returned by calling + `namedItemCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.NamedItemCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.NamedItemData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.nameditemcollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.nameditemcollectionloadoptions.yml new file mode 100644 index 0000000000..3cf0a2ab27 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.nameditemcollectionloadoptions.yml @@ -0,0 +1,259 @@ +### YamlMime:TSType +name: Excel.Interfaces.NamedItemCollectionLoadOptions +uid: excel!Excel.Interfaces.NamedItemCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.NamedItemCollectionLoadOptions +summary: >- + A collection of all the `NamedItem` objects that are part of the workbook or + worksheet, depending on how it was reached. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.NamedItemCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: arrayValues + uid: excel!Excel.Interfaces.NamedItemCollectionLoadOptions#arrayValues:member + package: excel! + fullName: arrayValues + summary: >- + For EACH ITEM in the collection: Returns an object containing values and + types of the named item. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'arrayValues?: Excel.Interfaces.NamedItemArrayValuesLoadOptions;' + return: + type: >- + + - name: comment + uid: excel!Excel.Interfaces.NamedItemCollectionLoadOptions#comment:member + package: excel! + fullName: comment + summary: >- + For EACH ITEM in the collection: Specifies the comment associated with + this name. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'comment?: boolean;' + return: + type: boolean + - name: formula + uid: excel!Excel.Interfaces.NamedItemCollectionLoadOptions#formula:member + package: excel! + fullName: formula + summary: >- + For EACH ITEM in the collection: The formula of the named item. Formulas + always start with an equal sign ("="). + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formula?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.NamedItemCollectionLoadOptions#name:member + package: excel! + fullName: name + summary: 'For EACH ITEM in the collection: The name of the object.' + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: scope + uid: excel!Excel.Interfaces.NamedItemCollectionLoadOptions#scope:member + package: excel! + fullName: scope + summary: >- + For EACH ITEM in the collection: Specifies if the name is scoped to the + workbook or to a specific worksheet. Possible values are: Worksheet, + Workbook. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'scope?: boolean;' + return: + type: boolean + - name: type + uid: excel!Excel.Interfaces.NamedItemCollectionLoadOptions#type:member + package: excel! + fullName: type + summary: >- + For EACH ITEM in the collection: Specifies the type of the value returned + by the name's formula. See `Excel.NamedItemType` for details. + remarks: >- + \[ [API set: ExcelApi 1.1 for String,Integer,Double,Boolean,Range,Error; + 1.7 for + Array](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type?: boolean;' + return: + type: boolean + - name: value + uid: excel!Excel.Interfaces.NamedItemCollectionLoadOptions#value:member + package: excel! + fullName: value + summary: >- + For EACH ITEM in the collection: 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: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'value?: boolean;' + return: + type: boolean + - name: valueAsJson + uid: excel!Excel.Interfaces.NamedItemCollectionLoadOptions#valueAsJson:member + package: excel! + fullName: valueAsJson + summary: >- + For EACH ITEM in the collection: A JSON representation of the values in + this named item. Unlike `NamedItem.value`, `NamedItem.valueAsJson` + supports all data types which can be in a cell. Examples include formatted + number values and web images, in addition to the standard boolean, number, + and string values. Data returned from this API always aligns with the + en-US locale. To retrieve data in the user's display locale, use + `NamedItem.valueAsJsonLocal`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valueAsJson?: boolean;' + return: + type: boolean + - name: valueAsJsonLocal + uid: >- + excel!Excel.Interfaces.NamedItemCollectionLoadOptions#valueAsJsonLocal:member + package: excel! + fullName: valueAsJsonLocal + summary: >- + For EACH ITEM in the collection: A JSON representation of the values in + this named item. Unlike `NamedItem.value`, + `NamedItem.valueAsJsonLocal` supports all data types which can be in a + cell. Examples include formatted number values and web images, in addition + to the standard boolean, number, and string values. Data returned from + this API always aligns with the user's display locale. To retrieve data + independent of locale, use `NamedItem.valueAsJson`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valueAsJsonLocal?: boolean;' + return: + type: boolean + - name: visible + uid: excel!Excel.Interfaces.NamedItemCollectionLoadOptions#visible:member + package: excel! + fullName: visible + summary: 'For EACH ITEM in the collection: Specifies if the object is visible.' + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean + - name: worksheet + uid: excel!Excel.Interfaces.NamedItemCollectionLoadOptions#worksheet:member + package: excel! + fullName: worksheet + summary: >- + For EACH ITEM in the collection: Returns the worksheet on which the named + item is scoped to. Throws an error if the item is scoped to the workbook + instead. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheet?: Excel.Interfaces.WorksheetLoadOptions;' + return: + type: + - name: worksheetOrNullObject + uid: >- + excel!Excel.Interfaces.NamedItemCollectionLoadOptions#worksheetOrNullObject:member + package: excel! + fullName: worksheetOrNullObject + summary: >- + For EACH ITEM in the collection: Returns the worksheet to which the named + item is scoped. If the item is scoped to the workbook instead, then this + method returns an object with its `isNullObject` property set to + `true`. For further information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheetOrNullObject?: Excel.Interfaces.WorksheetLoadOptions;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.nameditemcollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.nameditemcollectionupdatedata.yml new file mode 100644 index 0000000000..5c0231e2a6 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.nameditemcollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.NamedItemCollectionUpdateData +uid: excel!Excel.Interfaces.NamedItemCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.NamedItemCollectionUpdateData +summary: >- + An interface for updating data on the `NamedItemCollection` object, for use in + `namedItemCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.NamedItemCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.NamedItemData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.nameditemdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.nameditemdata.yml new file mode 100644 index 0000000000..3893ac21d8 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.nameditemdata.yml @@ -0,0 +1,199 @@ +### YamlMime:TSType +name: Excel.Interfaces.NamedItemData +uid: excel!Excel.Interfaces.NamedItemData:interface +package: excel! +fullName: Excel.Interfaces.NamedItemData +summary: >- + An interface describing the data returned by calling `namedItem.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: arrayValues + uid: excel!Excel.Interfaces.NamedItemData#arrayValues:member + package: excel! + fullName: arrayValues + summary: Returns an object containing values and types of the named item. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'arrayValues?: Excel.Interfaces.NamedItemArrayValuesData;' + return: + type: >- + + - name: comment + uid: excel!Excel.Interfaces.NamedItemData#comment:member + package: excel! + fullName: comment + summary: Specifies the comment associated with this name. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'comment?: string;' + return: + type: string + - name: formula + uid: excel!Excel.Interfaces.NamedItemData#formula:member + package: excel! + fullName: formula + summary: >- + The formula of the named item. Formulas always start with an equal sign + ("="). + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formula?: any;' + return: + type: any + - name: name + uid: excel!Excel.Interfaces.NamedItemData#name:member + package: excel! + fullName: name + summary: The name of the object. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: scope + uid: excel!Excel.Interfaces.NamedItemData#scope:member + package: excel! + fullName: scope + summary: >- + Specifies if the name is scoped to the workbook or to a specific + worksheet. Possible values are: Worksheet, Workbook. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'scope?: Excel.NamedItemScope | "Worksheet" | "Workbook";' + return: + type: >- + | "Worksheet" | + "Workbook" + - name: type + uid: excel!Excel.Interfaces.NamedItemData#type:member + package: excel! + fullName: type + summary: >- + Specifies the type of the value returned by the name's formula. See + `Excel.NamedItemType` for details. + remarks: >- + \[ [API set: ExcelApi 1.1 for String,Integer,Double,Boolean,Range,Error; + 1.7 for + Array](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + type?: Excel.NamedItemType | "String" | "Integer" | "Double" | "Boolean" + | "Range" | "Error" | "Array"; + return: + type: >- + | "String" | "Integer" | + "Double" | "Boolean" | "Range" | "Error" | "Array" + - name: value + uid: excel!Excel.Interfaces.NamedItemData#value:member + package: excel! + fullName: value + 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: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'value?: any;' + return: + type: any + - name: valueAsJson + uid: excel!Excel.Interfaces.NamedItemData#valueAsJson:member + package: excel! + fullName: valueAsJson + summary: >- + A JSON representation of the values in this named item. Unlike + `NamedItem.value`, `NamedItem.valueAsJson` supports all data types + which can be in a cell. Examples include formatted number values and web + images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the en-US locale. To + retrieve data in the user's display locale, use + `NamedItem.valueAsJsonLocal`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valueAsJson?: CellValue | string;' + return: + type: | string + - name: valueAsJsonLocal + uid: excel!Excel.Interfaces.NamedItemData#valueAsJsonLocal:member + package: excel! + fullName: valueAsJsonLocal + summary: >- + A JSON representation of the values in this named item. Unlike + `NamedItem.value`, `NamedItem.valueAsJsonLocal` supports all data + types which can be in a cell. Examples include formatted number values and + web images, in addition to the standard boolean, number, and string + values. Data returned from this API always aligns with the user's display + locale. To retrieve data independent of locale, use + `NamedItem.valueAsJson`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valueAsJsonLocal?: CellValue | string;' + return: + type: | string + - name: visible + uid: excel!Excel.Interfaces.NamedItemData#visible:member + package: excel! + fullName: visible + summary: Specifies if the object is visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.nameditemloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.nameditemloadoptions.yml new file mode 100644 index 0000000000..9caea7eeda --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.nameditemloadoptions.yml @@ -0,0 +1,252 @@ +### YamlMime:TSType +name: Excel.Interfaces.NamedItemLoadOptions +uid: excel!Excel.Interfaces.NamedItemLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.NamedItemLoadOptions +summary: >- + Represents a defined name for a range of cells or value. Names can be + primitive named objects (as seen in the type below), range object, or a + reference to a range. This object can be used to obtain range object + associated with names. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.NamedItemLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: arrayValues + uid: excel!Excel.Interfaces.NamedItemLoadOptions#arrayValues:member + package: excel! + fullName: arrayValues + summary: Returns an object containing values and types of the named item. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'arrayValues?: Excel.Interfaces.NamedItemArrayValuesLoadOptions;' + return: + type: >- + + - name: comment + uid: excel!Excel.Interfaces.NamedItemLoadOptions#comment:member + package: excel! + fullName: comment + summary: Specifies the comment associated with this name. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'comment?: boolean;' + return: + type: boolean + - name: formula + uid: excel!Excel.Interfaces.NamedItemLoadOptions#formula:member + package: excel! + fullName: formula + summary: >- + The formula of the named item. Formulas always start with an equal sign + ("="). + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formula?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.NamedItemLoadOptions#name:member + package: excel! + fullName: name + summary: The name of the object. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: scope + uid: excel!Excel.Interfaces.NamedItemLoadOptions#scope:member + package: excel! + fullName: scope + summary: >- + Specifies if the name is scoped to the workbook or to a specific + worksheet. Possible values are: Worksheet, Workbook. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'scope?: boolean;' + return: + type: boolean + - name: type + uid: excel!Excel.Interfaces.NamedItemLoadOptions#type:member + package: excel! + fullName: type + summary: >- + Specifies the type of the value returned by the name's formula. See + `Excel.NamedItemType` for details. + remarks: >- + \[ [API set: ExcelApi 1.1 for String,Integer,Double,Boolean,Range,Error; + 1.7 for + Array](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type?: boolean;' + return: + type: boolean + - name: value + uid: excel!Excel.Interfaces.NamedItemLoadOptions#value:member + package: excel! + fullName: value + 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: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'value?: boolean;' + return: + type: boolean + - name: valueAsJson + uid: excel!Excel.Interfaces.NamedItemLoadOptions#valueAsJson:member + package: excel! + fullName: valueAsJson + summary: >- + A JSON representation of the values in this named item. Unlike + `NamedItem.value`, `NamedItem.valueAsJson` supports all data types + which can be in a cell. Examples include formatted number values and web + images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the en-US locale. To + retrieve data in the user's display locale, use + `NamedItem.valueAsJsonLocal`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valueAsJson?: boolean;' + return: + type: boolean + - name: valueAsJsonLocal + uid: excel!Excel.Interfaces.NamedItemLoadOptions#valueAsJsonLocal:member + package: excel! + fullName: valueAsJsonLocal + summary: >- + A JSON representation of the values in this named item. Unlike + `NamedItem.value`, `NamedItem.valueAsJsonLocal` supports all data + types which can be in a cell. Examples include formatted number values and + web images, in addition to the standard boolean, number, and string + values. Data returned from this API always aligns with the user's display + locale. To retrieve data independent of locale, use + `NamedItem.valueAsJson`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valueAsJsonLocal?: boolean;' + return: + type: boolean + - name: visible + uid: excel!Excel.Interfaces.NamedItemLoadOptions#visible:member + package: excel! + fullName: visible + summary: Specifies if the object is visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean + - name: worksheet + uid: excel!Excel.Interfaces.NamedItemLoadOptions#worksheet:member + package: excel! + fullName: worksheet + summary: >- + Returns the worksheet on which the named item is scoped to. Throws an + error if the item is scoped to the workbook instead. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheet?: Excel.Interfaces.WorksheetLoadOptions;' + return: + type: + - name: worksheetOrNullObject + uid: excel!Excel.Interfaces.NamedItemLoadOptions#worksheetOrNullObject:member + package: excel! + fullName: worksheetOrNullObject + summary: >- + Returns the worksheet to which the named item is scoped. If the item is + scoped to the workbook instead, then this method returns an object with + its `isNullObject` property set to `true`. For further + information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheetOrNullObject?: Excel.Interfaces.WorksheetLoadOptions;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.nameditemupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.nameditemupdatedata.yml new file mode 100644 index 0000000000..1f077c5ba6 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.nameditemupdatedata.yml @@ -0,0 +1,61 @@ +### YamlMime:TSType +name: Excel.Interfaces.NamedItemUpdateData +uid: excel!Excel.Interfaces.NamedItemUpdateData:interface +package: excel! +fullName: Excel.Interfaces.NamedItemUpdateData +summary: >- + An interface for updating data on the `NamedItem` object, for use in + `namedItem.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: comment + uid: excel!Excel.Interfaces.NamedItemUpdateData#comment:member + package: excel! + fullName: comment + summary: Specifies the comment associated with this name. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'comment?: string;' + return: + type: string + - name: formula + uid: excel!Excel.Interfaces.NamedItemUpdateData#formula:member + package: excel! + fullName: formula + summary: >- + The formula of the named item. Formulas always start with an equal sign + ("="). + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formula?: any;' + return: + type: any + - name: visible + uid: excel!Excel.Interfaces.NamedItemUpdateData#visible:member + package: excel! + fullName: visible + summary: Specifies if the object is visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.namedsheetviewcollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.namedsheetviewcollectiondata.yml new file mode 100644 index 0000000000..ff459f44bb --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.namedsheetviewcollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.NamedSheetViewCollectionData +uid: excel!Excel.Interfaces.NamedSheetViewCollectionData:interface +package: excel! +fullName: Excel.Interfaces.NamedSheetViewCollectionData +summary: >- + An interface describing the data returned by calling + `namedSheetViewCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.NamedSheetViewCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.NamedSheetViewData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.namedsheetviewcollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.namedsheetviewcollectionupdatedata.yml new file mode 100644 index 0000000000..9ccd85dcba --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.namedsheetviewcollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.NamedSheetViewCollectionUpdateData +uid: excel!Excel.Interfaces.NamedSheetViewCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.NamedSheetViewCollectionUpdateData +summary: >- + An interface for updating data on the `NamedSheetViewCollection` object, for + use in `namedSheetViewCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.NamedSheetViewCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.NamedSheetViewData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.namedsheetviewdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.namedsheetviewdata.yml new file mode 100644 index 0000000000..c1e179d608 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.namedsheetviewdata.yml @@ -0,0 +1,13 @@ +### YamlMime:TSType +name: Excel.Interfaces.NamedSheetViewData +uid: excel!Excel.Interfaces.NamedSheetViewData:interface +package: excel! +fullName: Excel.Interfaces.NamedSheetViewData +summary: >- + An interface describing the data returned by calling + `namedSheetView.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.namedsheetviewupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.namedsheetviewupdatedata.yml new file mode 100644 index 0000000000..4841c3fb7b --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.namedsheetviewupdatedata.yml @@ -0,0 +1,13 @@ +### YamlMime:TSType +name: Excel.Interfaces.NamedSheetViewUpdateData +uid: excel!Excel.Interfaces.NamedSheetViewUpdateData:interface +package: excel! +fullName: Excel.Interfaces.NamedSheetViewUpdateData +summary: >- + An interface for updating data on the `NamedSheetView` object, for use in + `namedSheetView.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.notecollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.notecollectiondata.yml new file mode 100644 index 0000000000..a51f42b209 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.notecollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.NoteCollectionData +uid: excel!Excel.Interfaces.NoteCollectionData:interface +package: excel! +fullName: Excel.Interfaces.NoteCollectionData +summary: >- + An interface describing the data returned by calling + `noteCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.NoteCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.NoteData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.notecollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.notecollectionloadoptions.yml new file mode 100644 index 0000000000..4371761a29 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.notecollectionloadoptions.yml @@ -0,0 +1,112 @@ +### YamlMime:TSType +name: Excel.Interfaces.NoteCollectionLoadOptions +uid: excel!Excel.Interfaces.NoteCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.NoteCollectionLoadOptions +summary: Represents a collection of note objects that are part of the workbook. +remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.NoteCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: authorName + uid: excel!Excel.Interfaces.NoteCollectionLoadOptions#authorName:member + package: excel! + fullName: authorName + summary: 'For EACH ITEM in the collection: Gets the author of the note.' + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'authorName?: boolean;' + return: + type: boolean + - name: content + uid: excel!Excel.Interfaces.NoteCollectionLoadOptions#content:member + package: excel! + fullName: content + summary: 'For EACH ITEM in the collection: Specifies the text of the note.' + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'content?: boolean;' + return: + type: boolean + - name: height + uid: excel!Excel.Interfaces.NoteCollectionLoadOptions#height:member + package: excel! + fullName: height + summary: 'For EACH ITEM in the collection: Specifies the height of the note.' + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height?: boolean;' + return: + type: boolean + - name: visible + uid: excel!Excel.Interfaces.NoteCollectionLoadOptions#visible:member + package: excel! + fullName: visible + summary: >- + For EACH ITEM in the collection: Specifies the visibility of the note. A + value of `true` means the note is shown. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean + - name: width + uid: excel!Excel.Interfaces.NoteCollectionLoadOptions#width:member + package: excel! + fullName: width + summary: 'For EACH ITEM in the collection: Specifies the width of the note.' + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.notecollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.notecollectionupdatedata.yml new file mode 100644 index 0000000000..168fbb0213 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.notecollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.NoteCollectionUpdateData +uid: excel!Excel.Interfaces.NoteCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.NoteCollectionUpdateData +summary: >- + An interface for updating data on the `NoteCollection` object, for use in + `noteCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.NoteCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.NoteData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.notedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.notedata.yml new file mode 100644 index 0000000000..d2e6cccb09 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.notedata.yml @@ -0,0 +1,94 @@ +### YamlMime:TSType +name: Excel.Interfaces.NoteData +uid: excel!Excel.Interfaces.NoteData:interface +package: excel! +fullName: Excel.Interfaces.NoteData +summary: An interface describing the data returned by calling `note.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: authorName + uid: excel!Excel.Interfaces.NoteData#authorName:member + package: excel! + fullName: authorName + summary: Gets the author of the note. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'authorName?: string;' + return: + type: string + - name: content + uid: excel!Excel.Interfaces.NoteData#content:member + package: excel! + fullName: content + summary: Specifies the text of the note. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'content?: string;' + return: + type: string + - name: height + uid: excel!Excel.Interfaces.NoteData#height:member + package: excel! + fullName: height + summary: Specifies the height of the note. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height?: number;' + return: + type: number + - name: visible + uid: excel!Excel.Interfaces.NoteData#visible:member + package: excel! + fullName: visible + summary: >- + Specifies the visibility of the note. A value of `true` means the note is + shown. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean + - name: width + uid: excel!Excel.Interfaces.NoteData#width:member + package: excel! + fullName: width + summary: Specifies the width of the note. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.noteloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.noteloadoptions.yml new file mode 100644 index 0000000000..01df7989a1 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.noteloadoptions.yml @@ -0,0 +1,112 @@ +### YamlMime:TSType +name: Excel.Interfaces.NoteLoadOptions +uid: excel!Excel.Interfaces.NoteLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.NoteLoadOptions +summary: Represents a note in the workbook or worksheet. +remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.NoteLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: authorName + uid: excel!Excel.Interfaces.NoteLoadOptions#authorName:member + package: excel! + fullName: authorName + summary: Gets the author of the note. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'authorName?: boolean;' + return: + type: boolean + - name: content + uid: excel!Excel.Interfaces.NoteLoadOptions#content:member + package: excel! + fullName: content + summary: Specifies the text of the note. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'content?: boolean;' + return: + type: boolean + - name: height + uid: excel!Excel.Interfaces.NoteLoadOptions#height:member + package: excel! + fullName: height + summary: Specifies the height of the note. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height?: boolean;' + return: + type: boolean + - name: visible + uid: excel!Excel.Interfaces.NoteLoadOptions#visible:member + package: excel! + fullName: visible + summary: >- + Specifies the visibility of the note. A value of `true` means the note is + shown. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean + - name: width + uid: excel!Excel.Interfaces.NoteLoadOptions#width:member + package: excel! + fullName: width + summary: Specifies the width of the note. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.noteupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.noteupdatedata.yml new file mode 100644 index 0000000000..c52be7263a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.noteupdatedata.yml @@ -0,0 +1,80 @@ +### YamlMime:TSType +name: Excel.Interfaces.NoteUpdateData +uid: excel!Excel.Interfaces.NoteUpdateData:interface +package: excel! +fullName: Excel.Interfaces.NoteUpdateData +summary: >- + An interface for updating data on the `Note` object, for use in `note.set({ + ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: content + uid: excel!Excel.Interfaces.NoteUpdateData#content:member + package: excel! + fullName: content + summary: Specifies the text of the note. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'content?: string;' + return: + type: string + - name: height + uid: excel!Excel.Interfaces.NoteUpdateData#height:member + package: excel! + fullName: height + summary: Specifies the height of the note. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height?: number;' + return: + type: number + - name: visible + uid: excel!Excel.Interfaces.NoteUpdateData#visible:member + package: excel! + fullName: visible + summary: >- + Specifies the visibility of the note. A value of `true` means the note is + shown. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean + - name: width + uid: excel!Excel.Interfaces.NoteUpdateData#width:member + package: excel! + fullName: width + summary: Specifies the width of the note. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.numberformatinfodata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.numberformatinfodata.yml new file mode 100644 index 0000000000..cdc3838601 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.numberformatinfodata.yml @@ -0,0 +1,68 @@ +### YamlMime:TSType +name: Excel.Interfaces.NumberFormatInfoData +uid: excel!Excel.Interfaces.NumberFormatInfoData:interface +package: excel! +fullName: Excel.Interfaces.NumberFormatInfoData +summary: >- + An interface describing the data returned by calling + `numberFormatInfo.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: currencySymbol + uid: excel!Excel.Interfaces.NumberFormatInfoData#currencySymbol:member + package: excel! + fullName: currencySymbol + summary: >- + Gets the currency symbol for currency values. This is based on current + system settings. + remarks: >- + \[ [API set: ExcelApi + 1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'currencySymbol?: string;' + return: + type: string + - name: numberDecimalSeparator + uid: excel!Excel.Interfaces.NumberFormatInfoData#numberDecimalSeparator:member + package: excel! + fullName: numberDecimalSeparator + summary: >- + Gets the string used as the decimal separator for numeric values. This is + based on current system settings. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberDecimalSeparator?: string;' + return: + type: string + - name: numberGroupSeparator + uid: excel!Excel.Interfaces.NumberFormatInfoData#numberGroupSeparator:member + package: excel! + fullName: numberGroupSeparator + summary: >- + Gets the string used to separate groups of digits to the left of the + decimal for numeric values. This is based on current system settings. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberGroupSeparator?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.numberformatinfoloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.numberformatinfoloadoptions.yml new file mode 100644 index 0000000000..1350e5225e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.numberformatinfoloadoptions.yml @@ -0,0 +1,88 @@ +### YamlMime:TSType +name: Excel.Interfaces.NumberFormatInfoLoadOptions +uid: excel!Excel.Interfaces.NumberFormatInfoLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.NumberFormatInfoLoadOptions +summary: >- + Defines the culturally appropriate format of displaying numbers. This is based + on current system culture settings. +remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.NumberFormatInfoLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: currencySymbol + uid: excel!Excel.Interfaces.NumberFormatInfoLoadOptions#currencySymbol:member + package: excel! + fullName: currencySymbol + summary: >- + Gets the currency symbol for currency values. This is based on current + system settings. + remarks: >- + \[ [API set: ExcelApi + 1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'currencySymbol?: boolean;' + return: + type: boolean + - name: numberDecimalSeparator + uid: >- + excel!Excel.Interfaces.NumberFormatInfoLoadOptions#numberDecimalSeparator:member + package: excel! + fullName: numberDecimalSeparator + summary: >- + Gets the string used as the decimal separator for numeric values. This is + based on current system settings. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberDecimalSeparator?: boolean;' + return: + type: boolean + - name: numberGroupSeparator + uid: >- + excel!Excel.Interfaces.NumberFormatInfoLoadOptions#numberGroupSeparator:member + package: excel! + fullName: numberGroupSeparator + summary: >- + Gets the string used to separate groups of digits to the left of the + decimal for numeric values. This is based on current system settings. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberGroupSeparator?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pagebreakcollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pagebreakcollectiondata.yml new file mode 100644 index 0000000000..ea5aea2020 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pagebreakcollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.PageBreakCollectionData +uid: excel!Excel.Interfaces.PageBreakCollectionData:interface +package: excel! +fullName: Excel.Interfaces.PageBreakCollectionData +summary: >- + An interface describing the data returned by calling + `pageBreakCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.PageBreakCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.PageBreakData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pagebreakcollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pagebreakcollectionloadoptions.yml new file mode 100644 index 0000000000..f6e9e51914 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pagebreakcollectionloadoptions.yml @@ -0,0 +1,64 @@ +### YamlMime:TSType +name: Excel.Interfaces.PageBreakCollectionLoadOptions +uid: excel!Excel.Interfaces.PageBreakCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.PageBreakCollectionLoadOptions +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.PageBreakCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: columnIndex + uid: excel!Excel.Interfaces.PageBreakCollectionLoadOptions#columnIndex:member + package: excel! + fullName: columnIndex + summary: >- + For EACH ITEM in the collection: Specifies the column index for the page + break. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'columnIndex?: boolean;' + return: + type: boolean + - name: rowIndex + uid: excel!Excel.Interfaces.PageBreakCollectionLoadOptions#rowIndex:member + package: excel! + fullName: rowIndex + summary: >- + For EACH ITEM in the collection: Specifies the row index for the page + break. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rowIndex?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pagebreakcollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pagebreakcollectionupdatedata.yml new file mode 100644 index 0000000000..9155fcbdb8 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pagebreakcollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.PageBreakCollectionUpdateData +uid: excel!Excel.Interfaces.PageBreakCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.PageBreakCollectionUpdateData +summary: >- + An interface for updating data on the `PageBreakCollection` object, for use in + `pageBreakCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.PageBreakCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.PageBreakData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pagebreakdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pagebreakdata.yml new file mode 100644 index 0000000000..637e2b0db5 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pagebreakdata.yml @@ -0,0 +1,44 @@ +### YamlMime:TSType +name: Excel.Interfaces.PageBreakData +uid: excel!Excel.Interfaces.PageBreakData:interface +package: excel! +fullName: Excel.Interfaces.PageBreakData +summary: >- + An interface describing the data returned by calling `pageBreak.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: columnIndex + uid: excel!Excel.Interfaces.PageBreakData#columnIndex:member + package: excel! + fullName: columnIndex + summary: Specifies the column index for the page break. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'columnIndex?: number;' + return: + type: number + - name: rowIndex + uid: excel!Excel.Interfaces.PageBreakData#rowIndex:member + package: excel! + fullName: rowIndex + summary: Specifies the row index for the page break. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rowIndex?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pagebreakloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pagebreakloadoptions.yml new file mode 100644 index 0000000000..f39022efac --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pagebreakloadoptions.yml @@ -0,0 +1,60 @@ +### YamlMime:TSType +name: Excel.Interfaces.PageBreakLoadOptions +uid: excel!Excel.Interfaces.PageBreakLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.PageBreakLoadOptions +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.PageBreakLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: columnIndex + uid: excel!Excel.Interfaces.PageBreakLoadOptions#columnIndex:member + package: excel! + fullName: columnIndex + summary: Specifies the column index for the page break. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'columnIndex?: boolean;' + return: + type: boolean + - name: rowIndex + uid: excel!Excel.Interfaces.PageBreakLoadOptions#rowIndex:member + package: excel! + fullName: rowIndex + summary: Specifies the row index for the page break. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rowIndex?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pagelayoutdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pagelayoutdata.yml new file mode 100644 index 0000000000..c0ee6def71 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pagelayoutdata.yml @@ -0,0 +1,358 @@ +### YamlMime:TSType +name: Excel.Interfaces.PageLayoutData +uid: excel!Excel.Interfaces.PageLayoutData:interface +package: excel! +fullName: Excel.Interfaces.PageLayoutData +summary: >- + An interface describing the data returned by calling `pageLayout.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: blackAndWhite + uid: excel!Excel.Interfaces.PageLayoutData#blackAndWhite:member + package: excel! + fullName: blackAndWhite + summary: The worksheet's black and white print option. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'blackAndWhite?: boolean;' + return: + type: boolean + - name: bottomMargin + uid: excel!Excel.Interfaces.PageLayoutData#bottomMargin:member + package: excel! + fullName: bottomMargin + summary: The worksheet's bottom page margin to use for printing in points. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'bottomMargin?: number;' + return: + type: number + - name: centerHorizontally + uid: excel!Excel.Interfaces.PageLayoutData#centerHorizontally:member + package: excel! + fullName: centerHorizontally + summary: >- + The worksheet's center horizontally flag. This flag determines whether the + worksheet will be centered horizontally when it's printed. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'centerHorizontally?: boolean;' + return: + type: boolean + - name: centerVertically + uid: excel!Excel.Interfaces.PageLayoutData#centerVertically:member + package: excel! + fullName: centerVertically + summary: >- + The worksheet's center vertically flag. This flag determines whether the + worksheet will be centered vertically when it's printed. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'centerVertically?: boolean;' + return: + type: boolean + - name: draftMode + uid: excel!Excel.Interfaces.PageLayoutData#draftMode:member + package: excel! + fullName: draftMode + summary: >- + The worksheet's draft mode option. If `true`, the sheet will be + printed without graphics. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'draftMode?: boolean;' + return: + type: boolean + - name: firstPageNumber + uid: excel!Excel.Interfaces.PageLayoutData#firstPageNumber:member + package: excel! + fullName: firstPageNumber + summary: >- + The worksheet's first page number to print. A `null` value represents + "auto" page numbering. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'firstPageNumber?: number | "";' + return: + type: number | "" + - name: footerMargin + uid: excel!Excel.Interfaces.PageLayoutData#footerMargin:member + package: excel! + fullName: footerMargin + summary: The worksheet's footer margin, in points, for use when printing. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'footerMargin?: number;' + return: + type: number + - name: headerMargin + uid: excel!Excel.Interfaces.PageLayoutData#headerMargin:member + package: excel! + fullName: headerMargin + summary: The worksheet's header margin, in points, for use when printing. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'headerMargin?: number;' + return: + type: number + - name: headersFooters + uid: excel!Excel.Interfaces.PageLayoutData#headersFooters:member + package: excel! + fullName: headersFooters + summary: Header and footer configuration for the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'headersFooters?: Excel.Interfaces.HeaderFooterGroupData;' + return: + type: + - name: leftMargin + uid: excel!Excel.Interfaces.PageLayoutData#leftMargin:member + package: excel! + fullName: leftMargin + summary: The worksheet's left margin, in points, for use when printing. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'leftMargin?: number;' + return: + type: number + - name: orientation + uid: excel!Excel.Interfaces.PageLayoutData#orientation:member + package: excel! + fullName: orientation + summary: The worksheet's orientation of the page. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'orientation?: Excel.PageOrientation | "Portrait" | "Landscape";' + return: + type: >- + | "Portrait" | + "Landscape" + - name: paperSize + uid: excel!Excel.Interfaces.PageLayoutData#paperSize:member + package: excel! + fullName: paperSize + summary: The worksheet's paper size of the page. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + paperSize?: Excel.PaperType | "Letter" | "LetterSmall" | "Tabloid" | + "Ledger" | "Legal" | "Statement" | "Executive" | "A3" | "A4" | "A4Small" + | "A5" | "B4" | "B5" | "Folio" | "Quatro" | "Paper10x14" | "Paper11x17" + | "Note" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | + "Envelope14" | "Csheet" | "Dsheet" | "Esheet" | "EnvelopeDL" | + "EnvelopeC5" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC6" | + "EnvelopeC65" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | + "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "FanfoldUS" | + "FanfoldStdGerman" | "FanfoldLegalGerman"; + return: + type: >- + | "Letter" | "LetterSmall" | + "Tabloid" | "Ledger" | "Legal" | "Statement" | "Executive" | "A3" | + "A4" | "A4Small" | "A5" | "B4" | "B5" | "Folio" | "Quatro" | + "Paper10x14" | "Paper11x17" | "Note" | "Envelope9" | "Envelope10" | + "Envelope11" | "Envelope12" | "Envelope14" | "Csheet" | "Dsheet" | + "Esheet" | "EnvelopeDL" | "EnvelopeC5" | "EnvelopeC3" | "EnvelopeC4" | + "EnvelopeC6" | "EnvelopeC65" | "EnvelopeB4" | "EnvelopeB5" | + "EnvelopeB6" | "EnvelopeItaly" | "EnvelopeMonarch" | + "EnvelopePersonal" | "FanfoldUS" | "FanfoldStdGerman" | + "FanfoldLegalGerman" + - name: printComments + uid: excel!Excel.Interfaces.PageLayoutData#printComments:member + package: excel! + fullName: printComments + summary: Specifies if the worksheet's comments should be displayed when printing. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + printComments?: Excel.PrintComments | "NoComments" | "EndSheet" | + "InPlace"; + return: + type: >- + | "NoComments" | + "EndSheet" | "InPlace" + - name: printErrors + uid: excel!Excel.Interfaces.PageLayoutData#printErrors:member + package: excel! + fullName: printErrors + summary: The worksheet's print errors option. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + printErrors?: Excel.PrintErrorType | "AsDisplayed" | "Blank" | "Dash" | + "NotAvailable"; + return: + type: >- + | "AsDisplayed" | + "Blank" | "Dash" | "NotAvailable" + - name: printGridlines + uid: excel!Excel.Interfaces.PageLayoutData#printGridlines:member + package: excel! + fullName: printGridlines + summary: Specifies if the worksheet's gridlines will be printed. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'printGridlines?: boolean;' + return: + type: boolean + - name: printHeadings + uid: excel!Excel.Interfaces.PageLayoutData#printHeadings:member + package: excel! + fullName: printHeadings + summary: Specifies if the worksheet's headings will be printed. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'printHeadings?: boolean;' + return: + type: boolean + - name: printOrder + uid: excel!Excel.Interfaces.PageLayoutData#printOrder:member + package: excel! + fullName: printOrder + summary: >- + The worksheet's page print order option. This specifies the order to use + for processing the page number printed. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'printOrder?: Excel.PrintOrder | "DownThenOver" | "OverThenDown";' + return: + type: >- + | "DownThenOver" | + "OverThenDown" + - name: rightMargin + uid: excel!Excel.Interfaces.PageLayoutData#rightMargin:member + package: excel! + fullName: rightMargin + summary: The worksheet's right margin, in points, for use when printing. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rightMargin?: number;' + return: + type: number + - name: topMargin + uid: excel!Excel.Interfaces.PageLayoutData#topMargin:member + package: excel! + fullName: topMargin + summary: The worksheet's top margin, in points, for use when printing. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'topMargin?: number;' + return: + type: number + - name: zoom + uid: excel!Excel.Interfaces.PageLayoutData#zoom:member + package: excel! + fullName: zoom + summary: >- + The worksheet's print zoom options. The `PageLayoutZoomOptions` object + must be set as a JSON object (use `x.zoom = {...}` instead of + `x.zoom.scale = ...`). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'zoom?: Excel.PageLayoutZoomOptions;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pagelayoutloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pagelayoutloadoptions.yml new file mode 100644 index 0000000000..a0d7864993 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pagelayoutloadoptions.yml @@ -0,0 +1,348 @@ +### YamlMime:TSType +name: Excel.Interfaces.PageLayoutLoadOptions +uid: excel!Excel.Interfaces.PageLayoutLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.PageLayoutLoadOptions +summary: >- + Represents layout and print settings that are not dependent on any + printer-specific implementation. These settings include margins, orientation, + page numbering, title rows, and print area. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.PageLayoutLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: blackAndWhite + uid: excel!Excel.Interfaces.PageLayoutLoadOptions#blackAndWhite:member + package: excel! + fullName: blackAndWhite + summary: The worksheet's black and white print option. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'blackAndWhite?: boolean;' + return: + type: boolean + - name: bottomMargin + uid: excel!Excel.Interfaces.PageLayoutLoadOptions#bottomMargin:member + package: excel! + fullName: bottomMargin + summary: The worksheet's bottom page margin to use for printing in points. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'bottomMargin?: boolean;' + return: + type: boolean + - name: centerHorizontally + uid: excel!Excel.Interfaces.PageLayoutLoadOptions#centerHorizontally:member + package: excel! + fullName: centerHorizontally + summary: >- + The worksheet's center horizontally flag. This flag determines whether the + worksheet will be centered horizontally when it's printed. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'centerHorizontally?: boolean;' + return: + type: boolean + - name: centerVertically + uid: excel!Excel.Interfaces.PageLayoutLoadOptions#centerVertically:member + package: excel! + fullName: centerVertically + summary: >- + The worksheet's center vertically flag. This flag determines whether the + worksheet will be centered vertically when it's printed. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'centerVertically?: boolean;' + return: + type: boolean + - name: draftMode + uid: excel!Excel.Interfaces.PageLayoutLoadOptions#draftMode:member + package: excel! + fullName: draftMode + summary: >- + The worksheet's draft mode option. If `true`, the sheet will be + printed without graphics. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'draftMode?: boolean;' + return: + type: boolean + - name: firstPageNumber + uid: excel!Excel.Interfaces.PageLayoutLoadOptions#firstPageNumber:member + package: excel! + fullName: firstPageNumber + summary: >- + The worksheet's first page number to print. A `null` value represents + "auto" page numbering. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'firstPageNumber?: boolean;' + return: + type: boolean + - name: footerMargin + uid: excel!Excel.Interfaces.PageLayoutLoadOptions#footerMargin:member + package: excel! + fullName: footerMargin + summary: The worksheet's footer margin, in points, for use when printing. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'footerMargin?: boolean;' + return: + type: boolean + - name: headerMargin + uid: excel!Excel.Interfaces.PageLayoutLoadOptions#headerMargin:member + package: excel! + fullName: headerMargin + summary: The worksheet's header margin, in points, for use when printing. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'headerMargin?: boolean;' + return: + type: boolean + - name: headersFooters + uid: excel!Excel.Interfaces.PageLayoutLoadOptions#headersFooters:member + package: excel! + fullName: headersFooters + summary: Header and footer configuration for the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'headersFooters?: Excel.Interfaces.HeaderFooterGroupLoadOptions;' + return: + type: >- + + - name: leftMargin + uid: excel!Excel.Interfaces.PageLayoutLoadOptions#leftMargin:member + package: excel! + fullName: leftMargin + summary: The worksheet's left margin, in points, for use when printing. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'leftMargin?: boolean;' + return: + type: boolean + - name: orientation + uid: excel!Excel.Interfaces.PageLayoutLoadOptions#orientation:member + package: excel! + fullName: orientation + summary: The worksheet's orientation of the page. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'orientation?: boolean;' + return: + type: boolean + - name: paperSize + uid: excel!Excel.Interfaces.PageLayoutLoadOptions#paperSize:member + package: excel! + fullName: paperSize + summary: The worksheet's paper size of the page. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'paperSize?: boolean;' + return: + type: boolean + - name: printComments + uid: excel!Excel.Interfaces.PageLayoutLoadOptions#printComments:member + package: excel! + fullName: printComments + summary: Specifies if the worksheet's comments should be displayed when printing. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'printComments?: boolean;' + return: + type: boolean + - name: printErrors + uid: excel!Excel.Interfaces.PageLayoutLoadOptions#printErrors:member + package: excel! + fullName: printErrors + summary: The worksheet's print errors option. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'printErrors?: boolean;' + return: + type: boolean + - name: printGridlines + uid: excel!Excel.Interfaces.PageLayoutLoadOptions#printGridlines:member + package: excel! + fullName: printGridlines + summary: Specifies if the worksheet's gridlines will be printed. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'printGridlines?: boolean;' + return: + type: boolean + - name: printHeadings + uid: excel!Excel.Interfaces.PageLayoutLoadOptions#printHeadings:member + package: excel! + fullName: printHeadings + summary: Specifies if the worksheet's headings will be printed. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'printHeadings?: boolean;' + return: + type: boolean + - name: printOrder + uid: excel!Excel.Interfaces.PageLayoutLoadOptions#printOrder:member + package: excel! + fullName: printOrder + summary: >- + The worksheet's page print order option. This specifies the order to use + for processing the page number printed. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'printOrder?: boolean;' + return: + type: boolean + - name: rightMargin + uid: excel!Excel.Interfaces.PageLayoutLoadOptions#rightMargin:member + package: excel! + fullName: rightMargin + summary: The worksheet's right margin, in points, for use when printing. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rightMargin?: boolean;' + return: + type: boolean + - name: topMargin + uid: excel!Excel.Interfaces.PageLayoutLoadOptions#topMargin:member + package: excel! + fullName: topMargin + summary: The worksheet's top margin, in points, for use when printing. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'topMargin?: boolean;' + return: + type: boolean + - name: zoom + uid: excel!Excel.Interfaces.PageLayoutLoadOptions#zoom:member + package: excel! + fullName: zoom + summary: >- + The worksheet's print zoom options. The `PageLayoutZoomOptions` object + must be set as a JSON object (use `x.zoom = {...}` instead of + `x.zoom.scale = ...`). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'zoom?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pagelayoutupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pagelayoutupdatedata.yml new file mode 100644 index 0000000000..c8044364bd --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pagelayoutupdatedata.yml @@ -0,0 +1,360 @@ +### YamlMime:TSType +name: Excel.Interfaces.PageLayoutUpdateData +uid: excel!Excel.Interfaces.PageLayoutUpdateData:interface +package: excel! +fullName: Excel.Interfaces.PageLayoutUpdateData +summary: >- + An interface for updating data on the `PageLayout` object, for use in + `pageLayout.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: blackAndWhite + uid: excel!Excel.Interfaces.PageLayoutUpdateData#blackAndWhite:member + package: excel! + fullName: blackAndWhite + summary: The worksheet's black and white print option. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'blackAndWhite?: boolean;' + return: + type: boolean + - name: bottomMargin + uid: excel!Excel.Interfaces.PageLayoutUpdateData#bottomMargin:member + package: excel! + fullName: bottomMargin + summary: The worksheet's bottom page margin to use for printing in points. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'bottomMargin?: number;' + return: + type: number + - name: centerHorizontally + uid: excel!Excel.Interfaces.PageLayoutUpdateData#centerHorizontally:member + package: excel! + fullName: centerHorizontally + summary: >- + The worksheet's center horizontally flag. This flag determines whether the + worksheet will be centered horizontally when it's printed. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'centerHorizontally?: boolean;' + return: + type: boolean + - name: centerVertically + uid: excel!Excel.Interfaces.PageLayoutUpdateData#centerVertically:member + package: excel! + fullName: centerVertically + summary: >- + The worksheet's center vertically flag. This flag determines whether the + worksheet will be centered vertically when it's printed. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'centerVertically?: boolean;' + return: + type: boolean + - name: draftMode + uid: excel!Excel.Interfaces.PageLayoutUpdateData#draftMode:member + package: excel! + fullName: draftMode + summary: >- + The worksheet's draft mode option. If `true`, the sheet will be + printed without graphics. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'draftMode?: boolean;' + return: + type: boolean + - name: firstPageNumber + uid: excel!Excel.Interfaces.PageLayoutUpdateData#firstPageNumber:member + package: excel! + fullName: firstPageNumber + summary: >- + The worksheet's first page number to print. A `null` value represents + "auto" page numbering. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'firstPageNumber?: number | "";' + return: + type: number | "" + - name: footerMargin + uid: excel!Excel.Interfaces.PageLayoutUpdateData#footerMargin:member + package: excel! + fullName: footerMargin + summary: The worksheet's footer margin, in points, for use when printing. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'footerMargin?: number;' + return: + type: number + - name: headerMargin + uid: excel!Excel.Interfaces.PageLayoutUpdateData#headerMargin:member + package: excel! + fullName: headerMargin + summary: The worksheet's header margin, in points, for use when printing. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'headerMargin?: number;' + return: + type: number + - name: headersFooters + uid: excel!Excel.Interfaces.PageLayoutUpdateData#headersFooters:member + package: excel! + fullName: headersFooters + summary: Header and footer configuration for the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'headersFooters?: Excel.Interfaces.HeaderFooterGroupUpdateData;' + return: + type: >- + + - name: leftMargin + uid: excel!Excel.Interfaces.PageLayoutUpdateData#leftMargin:member + package: excel! + fullName: leftMargin + summary: The worksheet's left margin, in points, for use when printing. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'leftMargin?: number;' + return: + type: number + - name: orientation + uid: excel!Excel.Interfaces.PageLayoutUpdateData#orientation:member + package: excel! + fullName: orientation + summary: The worksheet's orientation of the page. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'orientation?: Excel.PageOrientation | "Portrait" | "Landscape";' + return: + type: >- + | "Portrait" | + "Landscape" + - name: paperSize + uid: excel!Excel.Interfaces.PageLayoutUpdateData#paperSize:member + package: excel! + fullName: paperSize + summary: The worksheet's paper size of the page. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + paperSize?: Excel.PaperType | "Letter" | "LetterSmall" | "Tabloid" | + "Ledger" | "Legal" | "Statement" | "Executive" | "A3" | "A4" | "A4Small" + | "A5" | "B4" | "B5" | "Folio" | "Quatro" | "Paper10x14" | "Paper11x17" + | "Note" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | + "Envelope14" | "Csheet" | "Dsheet" | "Esheet" | "EnvelopeDL" | + "EnvelopeC5" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC6" | + "EnvelopeC65" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | + "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "FanfoldUS" | + "FanfoldStdGerman" | "FanfoldLegalGerman"; + return: + type: >- + | "Letter" | "LetterSmall" | + "Tabloid" | "Ledger" | "Legal" | "Statement" | "Executive" | "A3" | + "A4" | "A4Small" | "A5" | "B4" | "B5" | "Folio" | "Quatro" | + "Paper10x14" | "Paper11x17" | "Note" | "Envelope9" | "Envelope10" | + "Envelope11" | "Envelope12" | "Envelope14" | "Csheet" | "Dsheet" | + "Esheet" | "EnvelopeDL" | "EnvelopeC5" | "EnvelopeC3" | "EnvelopeC4" | + "EnvelopeC6" | "EnvelopeC65" | "EnvelopeB4" | "EnvelopeB5" | + "EnvelopeB6" | "EnvelopeItaly" | "EnvelopeMonarch" | + "EnvelopePersonal" | "FanfoldUS" | "FanfoldStdGerman" | + "FanfoldLegalGerman" + - name: printComments + uid: excel!Excel.Interfaces.PageLayoutUpdateData#printComments:member + package: excel! + fullName: printComments + summary: Specifies if the worksheet's comments should be displayed when printing. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + printComments?: Excel.PrintComments | "NoComments" | "EndSheet" | + "InPlace"; + return: + type: >- + | "NoComments" | + "EndSheet" | "InPlace" + - name: printErrors + uid: excel!Excel.Interfaces.PageLayoutUpdateData#printErrors:member + package: excel! + fullName: printErrors + summary: The worksheet's print errors option. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + printErrors?: Excel.PrintErrorType | "AsDisplayed" | "Blank" | "Dash" | + "NotAvailable"; + return: + type: >- + | "AsDisplayed" | + "Blank" | "Dash" | "NotAvailable" + - name: printGridlines + uid: excel!Excel.Interfaces.PageLayoutUpdateData#printGridlines:member + package: excel! + fullName: printGridlines + summary: Specifies if the worksheet's gridlines will be printed. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'printGridlines?: boolean;' + return: + type: boolean + - name: printHeadings + uid: excel!Excel.Interfaces.PageLayoutUpdateData#printHeadings:member + package: excel! + fullName: printHeadings + summary: Specifies if the worksheet's headings will be printed. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'printHeadings?: boolean;' + return: + type: boolean + - name: printOrder + uid: excel!Excel.Interfaces.PageLayoutUpdateData#printOrder:member + package: excel! + fullName: printOrder + summary: >- + The worksheet's page print order option. This specifies the order to use + for processing the page number printed. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'printOrder?: Excel.PrintOrder | "DownThenOver" | "OverThenDown";' + return: + type: >- + | "DownThenOver" | + "OverThenDown" + - name: rightMargin + uid: excel!Excel.Interfaces.PageLayoutUpdateData#rightMargin:member + package: excel! + fullName: rightMargin + summary: The worksheet's right margin, in points, for use when printing. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rightMargin?: number;' + return: + type: number + - name: topMargin + uid: excel!Excel.Interfaces.PageLayoutUpdateData#topMargin:member + package: excel! + fullName: topMargin + summary: The worksheet's top margin, in points, for use when printing. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'topMargin?: number;' + return: + type: number + - name: zoom + uid: excel!Excel.Interfaces.PageLayoutUpdateData#zoom:member + package: excel! + fullName: zoom + summary: >- + The worksheet's print zoom options. The `PageLayoutZoomOptions` object + must be set as a JSON object (use `x.zoom = {...}` instead of + `x.zoom.scale = ...`). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'zoom?: Excel.PageLayoutZoomOptions;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotfieldcollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotfieldcollectiondata.yml new file mode 100644 index 0000000000..85aab1eb26 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotfieldcollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.PivotFieldCollectionData +uid: excel!Excel.Interfaces.PivotFieldCollectionData:interface +package: excel! +fullName: Excel.Interfaces.PivotFieldCollectionData +summary: >- + An interface describing the data returned by calling + `pivotFieldCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.PivotFieldCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.PivotFieldData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotfieldcollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotfieldcollectionloadoptions.yml new file mode 100644 index 0000000000..35114cff6b --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotfieldcollectionloadoptions.yml @@ -0,0 +1,94 @@ +### YamlMime:TSType +name: Excel.Interfaces.PivotFieldCollectionLoadOptions +uid: excel!Excel.Interfaces.PivotFieldCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.PivotFieldCollectionLoadOptions +summary: >- + Represents a collection of all the PivotFields that are part of a PivotTable's + hierarchy. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.PivotFieldCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.PivotFieldCollectionLoadOptions#id:member + package: excel! + fullName: id + summary: 'For EACH ITEM in the collection: ID of the PivotField.' + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.PivotFieldCollectionLoadOptions#name:member + package: excel! + fullName: name + summary: 'For EACH ITEM in the collection: Name of the PivotField.' + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: showAllItems + uid: excel!Excel.Interfaces.PivotFieldCollectionLoadOptions#showAllItems:member + package: excel! + fullName: showAllItems + summary: >- + For EACH ITEM in the collection: Determines whether to show all items of + the PivotField. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showAllItems?: boolean;' + return: + type: boolean + - name: subtotals + uid: excel!Excel.Interfaces.PivotFieldCollectionLoadOptions#subtotals:member + package: excel! + fullName: subtotals + summary: 'For EACH ITEM in the collection: Subtotals of the PivotField.' + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'subtotals?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotfieldcollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotfieldcollectionupdatedata.yml new file mode 100644 index 0000000000..dee62cf584 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotfieldcollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.PivotFieldCollectionUpdateData +uid: excel!Excel.Interfaces.PivotFieldCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.PivotFieldCollectionUpdateData +summary: >- + An interface for updating data on the `PivotFieldCollection` object, for use + in `pivotFieldCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.PivotFieldCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.PivotFieldData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotfielddata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotfielddata.yml new file mode 100644 index 0000000000..d52be898e6 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotfielddata.yml @@ -0,0 +1,89 @@ +### YamlMime:TSType +name: Excel.Interfaces.PivotFieldData +uid: excel!Excel.Interfaces.PivotFieldData:interface +package: excel! +fullName: Excel.Interfaces.PivotFieldData +summary: >- + An interface describing the data returned by calling `pivotField.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: id + uid: excel!Excel.Interfaces.PivotFieldData#id:member + package: excel! + fullName: id + summary: ID of the PivotField. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: string;' + return: + type: string + - name: items + uid: excel!Excel.Interfaces.PivotFieldData#items:member + package: excel! + fullName: items + summary: Returns the PivotItems associated with the PivotField. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.PivotItemData[];' + return: + type: [] + - name: name + uid: excel!Excel.Interfaces.PivotFieldData#name:member + package: excel! + fullName: name + summary: Name of the PivotField. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: showAllItems + uid: excel!Excel.Interfaces.PivotFieldData#showAllItems:member + package: excel! + fullName: showAllItems + summary: Determines whether to show all items of the PivotField. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showAllItems?: boolean;' + return: + type: boolean + - name: subtotals + uid: excel!Excel.Interfaces.PivotFieldData#subtotals:member + package: excel! + fullName: subtotals + summary: Subtotals of the PivotField. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'subtotals?: Excel.Subtotals;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotfieldloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotfieldloadoptions.yml new file mode 100644 index 0000000000..f5fca241a5 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotfieldloadoptions.yml @@ -0,0 +1,90 @@ +### YamlMime:TSType +name: Excel.Interfaces.PivotFieldLoadOptions +uid: excel!Excel.Interfaces.PivotFieldLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.PivotFieldLoadOptions +summary: Represents the Excel PivotField. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.PivotFieldLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.PivotFieldLoadOptions#id:member + package: excel! + fullName: id + summary: ID of the PivotField. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.PivotFieldLoadOptions#name:member + package: excel! + fullName: name + summary: Name of the PivotField. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: showAllItems + uid: excel!Excel.Interfaces.PivotFieldLoadOptions#showAllItems:member + package: excel! + fullName: showAllItems + summary: Determines whether to show all items of the PivotField. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showAllItems?: boolean;' + return: + type: boolean + - name: subtotals + uid: excel!Excel.Interfaces.PivotFieldLoadOptions#subtotals:member + package: excel! + fullName: subtotals + summary: Subtotals of the PivotField. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'subtotals?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotfieldupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotfieldupdatedata.yml new file mode 100644 index 0000000000..642ef93afb --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotfieldupdatedata.yml @@ -0,0 +1,59 @@ +### YamlMime:TSType +name: Excel.Interfaces.PivotFieldUpdateData +uid: excel!Excel.Interfaces.PivotFieldUpdateData:interface +package: excel! +fullName: Excel.Interfaces.PivotFieldUpdateData +summary: >- + An interface for updating data on the `PivotField` object, for use in + `pivotField.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: name + uid: excel!Excel.Interfaces.PivotFieldUpdateData#name:member + package: excel! + fullName: name + summary: Name of the PivotField. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: showAllItems + uid: excel!Excel.Interfaces.PivotFieldUpdateData#showAllItems:member + package: excel! + fullName: showAllItems + summary: Determines whether to show all items of the PivotField. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showAllItems?: boolean;' + return: + type: boolean + - name: subtotals + uid: excel!Excel.Interfaces.PivotFieldUpdateData#subtotals:member + package: excel! + fullName: subtotals + summary: Subtotals of the PivotField. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'subtotals?: Excel.Subtotals;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivothierarchycollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivothierarchycollectiondata.yml new file mode 100644 index 0000000000..57067ac8bc --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivothierarchycollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.PivotHierarchyCollectionData +uid: excel!Excel.Interfaces.PivotHierarchyCollectionData:interface +package: excel! +fullName: Excel.Interfaces.PivotHierarchyCollectionData +summary: >- + An interface describing the data returned by calling + `pivotHierarchyCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.PivotHierarchyCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.PivotHierarchyData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivothierarchycollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivothierarchycollectionloadoptions.yml new file mode 100644 index 0000000000..9c22b1f9d2 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivothierarchycollectionloadoptions.yml @@ -0,0 +1,62 @@ +### YamlMime:TSType +name: Excel.Interfaces.PivotHierarchyCollectionLoadOptions +uid: excel!Excel.Interfaces.PivotHierarchyCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.PivotHierarchyCollectionLoadOptions +summary: >- + Represents a collection of all the PivotHierarchies that are part of the + PivotTable. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.PivotHierarchyCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.PivotHierarchyCollectionLoadOptions#id:member + package: excel! + fullName: id + summary: 'For EACH ITEM in the collection: ID of the PivotHierarchy.' + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.PivotHierarchyCollectionLoadOptions#name:member + package: excel! + fullName: name + summary: 'For EACH ITEM in the collection: Name of the PivotHierarchy.' + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivothierarchycollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivothierarchycollectionupdatedata.yml new file mode 100644 index 0000000000..e1ef13bf10 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivothierarchycollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.PivotHierarchyCollectionUpdateData +uid: excel!Excel.Interfaces.PivotHierarchyCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.PivotHierarchyCollectionUpdateData +summary: >- + An interface for updating data on the `PivotHierarchyCollection` object, for + use in `pivotHierarchyCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.PivotHierarchyCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.PivotHierarchyData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivothierarchydata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivothierarchydata.yml new file mode 100644 index 0000000000..0cbdf57fcf --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivothierarchydata.yml @@ -0,0 +1,59 @@ +### YamlMime:TSType +name: Excel.Interfaces.PivotHierarchyData +uid: excel!Excel.Interfaces.PivotHierarchyData:interface +package: excel! +fullName: Excel.Interfaces.PivotHierarchyData +summary: >- + An interface describing the data returned by calling + `pivotHierarchy.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: fields + uid: excel!Excel.Interfaces.PivotHierarchyData#fields:member + package: excel! + fullName: fields + summary: Returns the PivotFields associated with the PivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'fields?: Excel.Interfaces.PivotFieldData[];' + return: + type: [] + - name: id + uid: excel!Excel.Interfaces.PivotHierarchyData#id:member + package: excel! + fullName: id + summary: ID of the PivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: string;' + return: + type: string + - name: name + uid: excel!Excel.Interfaces.PivotHierarchyData#name:member + package: excel! + fullName: name + summary: Name of the PivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivothierarchyloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivothierarchyloadoptions.yml new file mode 100644 index 0000000000..a4861a4e50 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivothierarchyloadoptions.yml @@ -0,0 +1,60 @@ +### YamlMime:TSType +name: Excel.Interfaces.PivotHierarchyLoadOptions +uid: excel!Excel.Interfaces.PivotHierarchyLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.PivotHierarchyLoadOptions +summary: Represents the Excel PivotHierarchy. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.PivotHierarchyLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.PivotHierarchyLoadOptions#id:member + package: excel! + fullName: id + summary: ID of the PivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.PivotHierarchyLoadOptions#name:member + package: excel! + fullName: name + summary: Name of the PivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivothierarchyupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivothierarchyupdatedata.yml new file mode 100644 index 0000000000..63ccd4ff9f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivothierarchyupdatedata.yml @@ -0,0 +1,29 @@ +### YamlMime:TSType +name: Excel.Interfaces.PivotHierarchyUpdateData +uid: excel!Excel.Interfaces.PivotHierarchyUpdateData:interface +package: excel! +fullName: Excel.Interfaces.PivotHierarchyUpdateData +summary: >- + An interface for updating data on the `PivotHierarchy` object, for use in + `pivotHierarchy.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: name + uid: excel!Excel.Interfaces.PivotHierarchyUpdateData#name:member + package: excel! + fullName: name + summary: Name of the PivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotitemcollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotitemcollectiondata.yml new file mode 100644 index 0000000000..10c17660c1 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotitemcollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.PivotItemCollectionData +uid: excel!Excel.Interfaces.PivotItemCollectionData:interface +package: excel! +fullName: Excel.Interfaces.PivotItemCollectionData +summary: >- + An interface describing the data returned by calling + `pivotItemCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.PivotItemCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.PivotItemData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotitemcollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotitemcollectionloadoptions.yml new file mode 100644 index 0000000000..368e460a49 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotitemcollectionloadoptions.yml @@ -0,0 +1,94 @@ +### YamlMime:TSType +name: Excel.Interfaces.PivotItemCollectionLoadOptions +uid: excel!Excel.Interfaces.PivotItemCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.PivotItemCollectionLoadOptions +summary: >- + Represents a collection of all the PivotItems related to their parent + PivotField. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.PivotItemCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.PivotItemCollectionLoadOptions#id:member + package: excel! + fullName: id + summary: 'For EACH ITEM in the collection: ID of the PivotItem.' + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: isExpanded + uid: excel!Excel.Interfaces.PivotItemCollectionLoadOptions#isExpanded:member + package: excel! + fullName: isExpanded + summary: >- + For EACH ITEM in the collection: Determines whether the item is expanded + to show child items or if it's collapsed and child items are hidden. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'isExpanded?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.PivotItemCollectionLoadOptions#name:member + package: excel! + fullName: name + summary: 'For EACH ITEM in the collection: Name of the PivotItem.' + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: visible + uid: excel!Excel.Interfaces.PivotItemCollectionLoadOptions#visible:member + package: excel! + fullName: visible + summary: 'For EACH ITEM in the collection: Specifies if the PivotItem is visible.' + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotitemcollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotitemcollectionupdatedata.yml new file mode 100644 index 0000000000..ccc57e99d2 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotitemcollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.PivotItemCollectionUpdateData +uid: excel!Excel.Interfaces.PivotItemCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.PivotItemCollectionUpdateData +summary: >- + An interface for updating data on the `PivotItemCollection` object, for use in + `pivotItemCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.PivotItemCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.PivotItemData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotitemdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotitemdata.yml new file mode 100644 index 0000000000..2be439ea87 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotitemdata.yml @@ -0,0 +1,76 @@ +### YamlMime:TSType +name: Excel.Interfaces.PivotItemData +uid: excel!Excel.Interfaces.PivotItemData:interface +package: excel! +fullName: Excel.Interfaces.PivotItemData +summary: >- + An interface describing the data returned by calling `pivotItem.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: id + uid: excel!Excel.Interfaces.PivotItemData#id:member + package: excel! + fullName: id + summary: ID of the PivotItem. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: string;' + return: + type: string + - name: isExpanded + uid: excel!Excel.Interfaces.PivotItemData#isExpanded:member + package: excel! + fullName: isExpanded + summary: >- + Determines whether the item is expanded to show child items or if it's + collapsed and child items are hidden. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'isExpanded?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.PivotItemData#name:member + package: excel! + fullName: name + summary: Name of the PivotItem. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: visible + uid: excel!Excel.Interfaces.PivotItemData#visible:member + package: excel! + fullName: visible + summary: Specifies if the PivotItem is visible. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotitemloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotitemloadoptions.yml new file mode 100644 index 0000000000..f26bbcf51e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotitemloadoptions.yml @@ -0,0 +1,92 @@ +### YamlMime:TSType +name: Excel.Interfaces.PivotItemLoadOptions +uid: excel!Excel.Interfaces.PivotItemLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.PivotItemLoadOptions +summary: Represents the Excel PivotItem. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.PivotItemLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.PivotItemLoadOptions#id:member + package: excel! + fullName: id + summary: ID of the PivotItem. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: isExpanded + uid: excel!Excel.Interfaces.PivotItemLoadOptions#isExpanded:member + package: excel! + fullName: isExpanded + summary: >- + Determines whether the item is expanded to show child items or if it's + collapsed and child items are hidden. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'isExpanded?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.PivotItemLoadOptions#name:member + package: excel! + fullName: name + summary: Name of the PivotItem. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: visible + uid: excel!Excel.Interfaces.PivotItemLoadOptions#visible:member + package: excel! + fullName: visible + summary: Specifies if the PivotItem is visible. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotitemupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotitemupdatedata.yml new file mode 100644 index 0000000000..756d31f634 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotitemupdatedata.yml @@ -0,0 +1,61 @@ +### YamlMime:TSType +name: Excel.Interfaces.PivotItemUpdateData +uid: excel!Excel.Interfaces.PivotItemUpdateData:interface +package: excel! +fullName: Excel.Interfaces.PivotItemUpdateData +summary: >- + An interface for updating data on the `PivotItem` object, for use in + `pivotItem.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: isExpanded + uid: excel!Excel.Interfaces.PivotItemUpdateData#isExpanded:member + package: excel! + fullName: isExpanded + summary: >- + Determines whether the item is expanded to show child items or if it's + collapsed and child items are hidden. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'isExpanded?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.PivotItemUpdateData#name:member + package: excel! + fullName: name + summary: Name of the PivotItem. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: visible + uid: excel!Excel.Interfaces.PivotItemUpdateData#visible:member + package: excel! + fullName: visible + summary: Specifies if the PivotItem is visible. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotlayoutdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotlayoutdata.yml new file mode 100644 index 0000000000..65e6c14750 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotlayoutdata.yml @@ -0,0 +1,244 @@ +### YamlMime:TSType +name: Excel.Interfaces.PivotLayoutData +uid: excel!Excel.Interfaces.PivotLayoutData:interface +package: excel! +fullName: Excel.Interfaces.PivotLayoutData +summary: >- + An interface describing the data returned by calling + `pivotLayout.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: altTextDescription + uid: excel!Excel.Interfaces.PivotLayoutData#altTextDescription:member + package: excel! + fullName: altTextDescription + summary: >- + The alt text description of the PivotTable. + + + Alt text provides alternative, text-based representations of the + information contained in the PivotTable. This information is useful for + people with vision or cognitive impairments who may not be able to see or + understand the table. A title can be read to a person with a disability + and is used to determine whether they wish to hear the description of the + content. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'altTextDescription?: string;' + return: + type: string + - name: altTextTitle + uid: excel!Excel.Interfaces.PivotLayoutData#altTextTitle:member + package: excel! + fullName: altTextTitle + summary: >- + The alt text title of the PivotTable. + + + Alt text provides alternative, text-based representations of the + information contained in the PivotTable. This information is useful for + people with vision or cognitive impairments who may not be able to see or + understand the table. A title can be read to a person with a disability + and is used to determine whether they wish to hear the description of the + content. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'altTextTitle?: string;' + return: + type: string + - name: autoFormat + uid: excel!Excel.Interfaces.PivotLayoutData#autoFormat:member + package: excel! + fullName: autoFormat + summary: >- + Specifies if formatting will be automatically formatted when it's + refreshed or when fields are moved. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'autoFormat?: boolean;' + return: + type: boolean + - name: emptyCellText + uid: excel!Excel.Interfaces.PivotLayoutData#emptyCellText:member + package: excel! + fullName: emptyCellText + summary: >- + The text that is automatically filled into any empty cell in the + PivotTable if `fillEmptyCells == true`. Note that this value + persists if `fillEmptyCells` is set to `false`, and that setting + this value does not set that property to `true`. By default, this + is an empty string. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'emptyCellText?: string;' + return: + type: string + - name: enableFieldList + uid: excel!Excel.Interfaces.PivotLayoutData#enableFieldList:member + package: excel! + fullName: enableFieldList + summary: Specifies if the field list can be shown in the UI. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'enableFieldList?: boolean;' + return: + type: boolean + - name: fillEmptyCells + uid: excel!Excel.Interfaces.PivotLayoutData#fillEmptyCells:member + package: excel! + fullName: fillEmptyCells + summary: >- + Specifies whether empty cells in the PivotTable should be populated with + the `emptyCellText`. Default is `false`. Note that the + value of `emptyCellText` persists when this property is set to `false`. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'fillEmptyCells?: boolean;' + return: + type: boolean + - name: layoutType + uid: excel!Excel.Interfaces.PivotLayoutData#layoutType:member + package: excel! + fullName: layoutType + summary: >- + This property indicates the PivotLayoutType of all fields on the + PivotTable. If fields have different states, this will be null. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'layoutType?: Excel.PivotLayoutType | "Compact" | "Tabular" | "Outline";' + return: + type: >- + | "Compact" | + "Tabular" | "Outline" + - name: preserveFormatting + uid: excel!Excel.Interfaces.PivotLayoutData#preserveFormatting:member + package: excel! + fullName: preserveFormatting + summary: >- + Specifies if formatting is preserved when the report is refreshed or + recalculated by operations such as pivoting, sorting, or changing page + field items. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'preserveFormatting?: boolean;' + return: + type: boolean + - name: showColumnGrandTotals + uid: excel!Excel.Interfaces.PivotLayoutData#showColumnGrandTotals:member + package: excel! + fullName: showColumnGrandTotals + summary: Specifies if the PivotTable report shows grand totals for columns. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showColumnGrandTotals?: boolean;' + return: + type: boolean + - name: showFieldHeaders + uid: excel!Excel.Interfaces.PivotLayoutData#showFieldHeaders:member + package: excel! + fullName: showFieldHeaders + summary: >- + Specifies whether the PivotTable displays field headers (field captions + and filter drop-downs). + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showFieldHeaders?: boolean;' + return: + type: boolean + - name: showRowGrandTotals + uid: excel!Excel.Interfaces.PivotLayoutData#showRowGrandTotals:member + package: excel! + fullName: showRowGrandTotals + summary: Specifies if the PivotTable report shows grand totals for rows. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showRowGrandTotals?: boolean;' + return: + type: boolean + - name: subtotalLocation + uid: excel!Excel.Interfaces.PivotLayoutData#subtotalLocation:member + package: excel! + fullName: subtotalLocation + summary: >- + This property indicates the `SubtotalLocationType` of all fields on the + PivotTable. If fields have different states, this will be `null`. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + subtotalLocation?: Excel.SubtotalLocationType | "AtTop" | "AtBottom" | + "Off"; + return: + type: >- + | "AtTop" | + "AtBottom" | "Off" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotlayoutloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotlayoutloadoptions.yml new file mode 100644 index 0000000000..12f2c42135 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotlayoutloadoptions.yml @@ -0,0 +1,254 @@ +### YamlMime:TSType +name: Excel.Interfaces.PivotLayoutLoadOptions +uid: excel!Excel.Interfaces.PivotLayoutLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.PivotLayoutLoadOptions +summary: Represents the visual layout of the PivotTable. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.PivotLayoutLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: altTextDescription + uid: excel!Excel.Interfaces.PivotLayoutLoadOptions#altTextDescription:member + package: excel! + fullName: altTextDescription + summary: >- + The alt text description of the PivotTable. + + + Alt text provides alternative, text-based representations of the + information contained in the PivotTable. This information is useful for + people with vision or cognitive impairments who may not be able to see or + understand the table. A title can be read to a person with a disability + and is used to determine whether they wish to hear the description of the + content. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'altTextDescription?: boolean;' + return: + type: boolean + - name: altTextTitle + uid: excel!Excel.Interfaces.PivotLayoutLoadOptions#altTextTitle:member + package: excel! + fullName: altTextTitle + summary: >- + The alt text title of the PivotTable. + + + Alt text provides alternative, text-based representations of the + information contained in the PivotTable. This information is useful for + people with vision or cognitive impairments who may not be able to see or + understand the table. A title can be read to a person with a disability + and is used to determine whether they wish to hear the description of the + content. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'altTextTitle?: boolean;' + return: + type: boolean + - name: autoFormat + uid: excel!Excel.Interfaces.PivotLayoutLoadOptions#autoFormat:member + package: excel! + fullName: autoFormat + summary: >- + Specifies if formatting will be automatically formatted when it's + refreshed or when fields are moved. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'autoFormat?: boolean;' + return: + type: boolean + - name: emptyCellText + uid: excel!Excel.Interfaces.PivotLayoutLoadOptions#emptyCellText:member + package: excel! + fullName: emptyCellText + summary: >- + The text that is automatically filled into any empty cell in the + PivotTable if `fillEmptyCells == true`. Note that this value + persists if `fillEmptyCells` is set to `false`, and that setting + this value does not set that property to `true`. By default, this + is an empty string. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'emptyCellText?: boolean;' + return: + type: boolean + - name: enableFieldList + uid: excel!Excel.Interfaces.PivotLayoutLoadOptions#enableFieldList:member + package: excel! + fullName: enableFieldList + summary: Specifies if the field list can be shown in the UI. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'enableFieldList?: boolean;' + return: + type: boolean + - name: fillEmptyCells + uid: excel!Excel.Interfaces.PivotLayoutLoadOptions#fillEmptyCells:member + package: excel! + fullName: fillEmptyCells + summary: >- + Specifies whether empty cells in the PivotTable should be populated with + the `emptyCellText`. Default is `false`. Note that the + value of `emptyCellText` persists when this property is set to `false`. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'fillEmptyCells?: boolean;' + return: + type: boolean + - name: layoutType + uid: excel!Excel.Interfaces.PivotLayoutLoadOptions#layoutType:member + package: excel! + fullName: layoutType + summary: >- + This property indicates the PivotLayoutType of all fields on the + PivotTable. If fields have different states, this will be null. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'layoutType?: boolean;' + return: + type: boolean + - name: preserveFormatting + uid: excel!Excel.Interfaces.PivotLayoutLoadOptions#preserveFormatting:member + package: excel! + fullName: preserveFormatting + summary: >- + Specifies if formatting is preserved when the report is refreshed or + recalculated by operations such as pivoting, sorting, or changing page + field items. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'preserveFormatting?: boolean;' + return: + type: boolean + - name: showColumnGrandTotals + uid: excel!Excel.Interfaces.PivotLayoutLoadOptions#showColumnGrandTotals:member + package: excel! + fullName: showColumnGrandTotals + summary: Specifies if the PivotTable report shows grand totals for columns. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showColumnGrandTotals?: boolean;' + return: + type: boolean + - name: showFieldHeaders + uid: excel!Excel.Interfaces.PivotLayoutLoadOptions#showFieldHeaders:member + package: excel! + fullName: showFieldHeaders + summary: >- + Specifies whether the PivotTable displays field headers (field captions + and filter drop-downs). + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showFieldHeaders?: boolean;' + return: + type: boolean + - name: showRowGrandTotals + uid: excel!Excel.Interfaces.PivotLayoutLoadOptions#showRowGrandTotals:member + package: excel! + fullName: showRowGrandTotals + summary: Specifies if the PivotTable report shows grand totals for rows. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showRowGrandTotals?: boolean;' + return: + type: boolean + - name: subtotalLocation + uid: excel!Excel.Interfaces.PivotLayoutLoadOptions#subtotalLocation:member + package: excel! + fullName: subtotalLocation + summary: >- + This property indicates the `SubtotalLocationType` of all fields on the + PivotTable. If fields have different states, this will be `null`. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'subtotalLocation?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotlayoutupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotlayoutupdatedata.yml new file mode 100644 index 0000000000..5d25c04c04 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivotlayoutupdatedata.yml @@ -0,0 +1,244 @@ +### YamlMime:TSType +name: Excel.Interfaces.PivotLayoutUpdateData +uid: excel!Excel.Interfaces.PivotLayoutUpdateData:interface +package: excel! +fullName: Excel.Interfaces.PivotLayoutUpdateData +summary: >- + An interface for updating data on the `PivotLayout` object, for use in + `pivotLayout.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: altTextDescription + uid: excel!Excel.Interfaces.PivotLayoutUpdateData#altTextDescription:member + package: excel! + fullName: altTextDescription + summary: >- + The alt text description of the PivotTable. + + + Alt text provides alternative, text-based representations of the + information contained in the PivotTable. This information is useful for + people with vision or cognitive impairments who may not be able to see or + understand the table. A title can be read to a person with a disability + and is used to determine whether they wish to hear the description of the + content. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'altTextDescription?: string;' + return: + type: string + - name: altTextTitle + uid: excel!Excel.Interfaces.PivotLayoutUpdateData#altTextTitle:member + package: excel! + fullName: altTextTitle + summary: >- + The alt text title of the PivotTable. + + + Alt text provides alternative, text-based representations of the + information contained in the PivotTable. This information is useful for + people with vision or cognitive impairments who may not be able to see or + understand the table. A title can be read to a person with a disability + and is used to determine whether they wish to hear the description of the + content. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'altTextTitle?: string;' + return: + type: string + - name: autoFormat + uid: excel!Excel.Interfaces.PivotLayoutUpdateData#autoFormat:member + package: excel! + fullName: autoFormat + summary: >- + Specifies if formatting will be automatically formatted when it's + refreshed or when fields are moved. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'autoFormat?: boolean;' + return: + type: boolean + - name: emptyCellText + uid: excel!Excel.Interfaces.PivotLayoutUpdateData#emptyCellText:member + package: excel! + fullName: emptyCellText + summary: >- + The text that is automatically filled into any empty cell in the + PivotTable if `fillEmptyCells == true`. Note that this value + persists if `fillEmptyCells` is set to `false`, and that setting + this value does not set that property to `true`. By default, this + is an empty string. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'emptyCellText?: string;' + return: + type: string + - name: enableFieldList + uid: excel!Excel.Interfaces.PivotLayoutUpdateData#enableFieldList:member + package: excel! + fullName: enableFieldList + summary: Specifies if the field list can be shown in the UI. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'enableFieldList?: boolean;' + return: + type: boolean + - name: fillEmptyCells + uid: excel!Excel.Interfaces.PivotLayoutUpdateData#fillEmptyCells:member + package: excel! + fullName: fillEmptyCells + summary: >- + Specifies whether empty cells in the PivotTable should be populated with + the `emptyCellText`. Default is `false`. Note that the + value of `emptyCellText` persists when this property is set to `false`. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'fillEmptyCells?: boolean;' + return: + type: boolean + - name: layoutType + uid: excel!Excel.Interfaces.PivotLayoutUpdateData#layoutType:member + package: excel! + fullName: layoutType + summary: >- + This property indicates the PivotLayoutType of all fields on the + PivotTable. If fields have different states, this will be null. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'layoutType?: Excel.PivotLayoutType | "Compact" | "Tabular" | "Outline";' + return: + type: >- + | "Compact" | + "Tabular" | "Outline" + - name: preserveFormatting + uid: excel!Excel.Interfaces.PivotLayoutUpdateData#preserveFormatting:member + package: excel! + fullName: preserveFormatting + summary: >- + Specifies if formatting is preserved when the report is refreshed or + recalculated by operations such as pivoting, sorting, or changing page + field items. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'preserveFormatting?: boolean;' + return: + type: boolean + - name: showColumnGrandTotals + uid: excel!Excel.Interfaces.PivotLayoutUpdateData#showColumnGrandTotals:member + package: excel! + fullName: showColumnGrandTotals + summary: Specifies if the PivotTable report shows grand totals for columns. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showColumnGrandTotals?: boolean;' + return: + type: boolean + - name: showFieldHeaders + uid: excel!Excel.Interfaces.PivotLayoutUpdateData#showFieldHeaders:member + package: excel! + fullName: showFieldHeaders + summary: >- + Specifies whether the PivotTable displays field headers (field captions + and filter drop-downs). + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showFieldHeaders?: boolean;' + return: + type: boolean + - name: showRowGrandTotals + uid: excel!Excel.Interfaces.PivotLayoutUpdateData#showRowGrandTotals:member + package: excel! + fullName: showRowGrandTotals + summary: Specifies if the PivotTable report shows grand totals for rows. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showRowGrandTotals?: boolean;' + return: + type: boolean + - name: subtotalLocation + uid: excel!Excel.Interfaces.PivotLayoutUpdateData#subtotalLocation:member + package: excel! + fullName: subtotalLocation + summary: >- + This property indicates the `SubtotalLocationType` of all fields on the + PivotTable. If fields have different states, this will be `null`. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + subtotalLocation?: Excel.SubtotalLocationType | "AtTop" | "AtBottom" | + "Off"; + return: + type: >- + | "AtTop" | + "AtBottom" | "Off" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottablecollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottablecollectiondata.yml new file mode 100644 index 0000000000..0f70507f02 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottablecollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.PivotTableCollectionData +uid: excel!Excel.Interfaces.PivotTableCollectionData:interface +package: excel! +fullName: Excel.Interfaces.PivotTableCollectionData +summary: >- + An interface describing the data returned by calling + `pivotTableCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.PivotTableCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.PivotTableData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottablecollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottablecollectionloadoptions.yml new file mode 100644 index 0000000000..b02486543a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottablecollectionloadoptions.yml @@ -0,0 +1,171 @@ +### YamlMime:TSType +name: Excel.Interfaces.PivotTableCollectionLoadOptions +uid: excel!Excel.Interfaces.PivotTableCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.PivotTableCollectionLoadOptions +summary: >- + Represents a collection of all the PivotTables that are part of the workbook + or worksheet. +remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.PivotTableCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: allowMultipleFiltersPerField + uid: >- + excel!Excel.Interfaces.PivotTableCollectionLoadOptions#allowMultipleFiltersPerField:member + package: excel! + fullName: allowMultipleFiltersPerField + summary: >- + For EACH ITEM in the collection: Specifies if the PivotTable allows the + application of multiple PivotFilters on a given PivotField in the table. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'allowMultipleFiltersPerField?: boolean;' + return: + type: boolean + - name: enableDataValueEditing + uid: >- + excel!Excel.Interfaces.PivotTableCollectionLoadOptions#enableDataValueEditing:member + package: excel! + fullName: enableDataValueEditing + summary: >- + For EACH ITEM in the collection: Specifies if the PivotTable allows values + in the data body to be edited by the user. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'enableDataValueEditing?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.PivotTableCollectionLoadOptions#id:member + package: excel! + fullName: id + summary: 'For EACH ITEM in the collection: ID of the PivotTable.' + remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: layout + uid: excel!Excel.Interfaces.PivotTableCollectionLoadOptions#layout:member + package: excel! + fullName: layout + summary: >- + For EACH ITEM in the collection: The PivotLayout describing the layout and + visual structure of the PivotTable. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'layout?: Excel.Interfaces.PivotLayoutLoadOptions;' + return: + type: + - name: name + uid: excel!Excel.Interfaces.PivotTableCollectionLoadOptions#name:member + package: excel! + fullName: name + summary: 'For EACH ITEM in the collection: Name of the PivotTable.' + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: refreshOnOpen + uid: >- + excel!Excel.Interfaces.PivotTableCollectionLoadOptions#refreshOnOpen:member + package: excel! + fullName: refreshOnOpen + summary: >- + For EACH ITEM in the collection: Specifies whether the PivotTable + refreshes when the workbook opens. Corresponds to "Refresh on load" + setting in the UI. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'refreshOnOpen?: boolean;' + return: + type: boolean + - name: useCustomSortLists + uid: >- + excel!Excel.Interfaces.PivotTableCollectionLoadOptions#useCustomSortLists:member + package: excel! + fullName: useCustomSortLists + summary: >- + For EACH ITEM in the collection: Specifies if the PivotTable uses custom + lists when sorting. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'useCustomSortLists?: boolean;' + return: + type: boolean + - name: worksheet + uid: excel!Excel.Interfaces.PivotTableCollectionLoadOptions#worksheet:member + package: excel! + fullName: worksheet + summary: >- + For EACH ITEM in the collection: The worksheet containing the current + PivotTable. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheet?: Excel.Interfaces.WorksheetLoadOptions;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottablecollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottablecollectionupdatedata.yml new file mode 100644 index 0000000000..5c552c6a52 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottablecollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.PivotTableCollectionUpdateData +uid: excel!Excel.Interfaces.PivotTableCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.PivotTableCollectionUpdateData +summary: >- + An interface for updating data on the `PivotTableCollection` object, for use + in `pivotTableCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.PivotTableCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.PivotTableData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottabledata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottabledata.yml new file mode 100644 index 0000000000..0162002df5 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottabledata.yml @@ -0,0 +1,197 @@ +### YamlMime:TSType +name: Excel.Interfaces.PivotTableData +uid: excel!Excel.Interfaces.PivotTableData:interface +package: excel! +fullName: Excel.Interfaces.PivotTableData +summary: >- + An interface describing the data returned by calling `pivotTable.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: allowMultipleFiltersPerField + uid: excel!Excel.Interfaces.PivotTableData#allowMultipleFiltersPerField:member + package: excel! + fullName: allowMultipleFiltersPerField + summary: >- + Specifies if the PivotTable allows the application of multiple + PivotFilters on a given PivotField in the table. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'allowMultipleFiltersPerField?: boolean;' + return: + type: boolean + - name: columnHierarchies + uid: excel!Excel.Interfaces.PivotTableData#columnHierarchies:member + package: excel! + fullName: columnHierarchies + summary: The Column Pivot Hierarchies of the PivotTable. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'columnHierarchies?: Excel.Interfaces.RowColumnPivotHierarchyData[];' + return: + type: >- + [] + - name: dataHierarchies + uid: excel!Excel.Interfaces.PivotTableData#dataHierarchies:member + package: excel! + fullName: dataHierarchies + summary: The Data Pivot Hierarchies of the PivotTable. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'dataHierarchies?: Excel.Interfaces.DataPivotHierarchyData[];' + return: + type: >- + [] + - name: enableDataValueEditing + uid: excel!Excel.Interfaces.PivotTableData#enableDataValueEditing:member + package: excel! + fullName: enableDataValueEditing + summary: >- + Specifies if the PivotTable allows values in the data body to be edited by + the user. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'enableDataValueEditing?: boolean;' + return: + type: boolean + - name: filterHierarchies + uid: excel!Excel.Interfaces.PivotTableData#filterHierarchies:member + package: excel! + fullName: filterHierarchies + summary: The Filter Pivot Hierarchies of the PivotTable. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'filterHierarchies?: Excel.Interfaces.FilterPivotHierarchyData[];' + return: + type: >- + [] + - name: hierarchies + uid: excel!Excel.Interfaces.PivotTableData#hierarchies:member + package: excel! + fullName: hierarchies + summary: The Pivot Hierarchies of the PivotTable. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'hierarchies?: Excel.Interfaces.PivotHierarchyData[];' + return: + type: [] + - name: id + uid: excel!Excel.Interfaces.PivotTableData#id:member + package: excel! + fullName: id + summary: ID of the PivotTable. + remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: string;' + return: + type: string + - name: name + uid: excel!Excel.Interfaces.PivotTableData#name:member + package: excel! + fullName: name + summary: Name of the PivotTable. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: refreshOnOpen + uid: excel!Excel.Interfaces.PivotTableData#refreshOnOpen:member + package: excel! + fullName: refreshOnOpen + summary: >- + Specifies whether the PivotTable refreshes when the workbook opens. + Corresponds to "Refresh on load" setting in the UI. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'refreshOnOpen?: boolean;' + return: + type: boolean + - name: rowHierarchies + uid: excel!Excel.Interfaces.PivotTableData#rowHierarchies:member + package: excel! + fullName: rowHierarchies + summary: The Row Pivot Hierarchies of the PivotTable. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rowHierarchies?: Excel.Interfaces.RowColumnPivotHierarchyData[];' + return: + type: >- + [] + - name: useCustomSortLists + uid: excel!Excel.Interfaces.PivotTableData#useCustomSortLists:member + package: excel! + fullName: useCustomSortLists + summary: Specifies if the PivotTable uses custom lists when sorting. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'useCustomSortLists?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottableloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottableloadoptions.yml new file mode 100644 index 0000000000..cb5bf7d4aa --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottableloadoptions.yml @@ -0,0 +1,165 @@ +### YamlMime:TSType +name: Excel.Interfaces.PivotTableLoadOptions +uid: excel!Excel.Interfaces.PivotTableLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.PivotTableLoadOptions +summary: >- + Represents an Excel PivotTable. To learn more about the PivotTable object + model, read [Work with PivotTables using the Excel JavaScript + API](https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-pivottables). +remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.PivotTableLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: allowMultipleFiltersPerField + uid: >- + excel!Excel.Interfaces.PivotTableLoadOptions#allowMultipleFiltersPerField:member + package: excel! + fullName: allowMultipleFiltersPerField + summary: >- + Specifies if the PivotTable allows the application of multiple + PivotFilters on a given PivotField in the table. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'allowMultipleFiltersPerField?: boolean;' + return: + type: boolean + - name: enableDataValueEditing + uid: excel!Excel.Interfaces.PivotTableLoadOptions#enableDataValueEditing:member + package: excel! + fullName: enableDataValueEditing + summary: >- + Specifies if the PivotTable allows values in the data body to be edited by + the user. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'enableDataValueEditing?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.PivotTableLoadOptions#id:member + package: excel! + fullName: id + summary: ID of the PivotTable. + remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: layout + uid: excel!Excel.Interfaces.PivotTableLoadOptions#layout:member + package: excel! + fullName: layout + summary: >- + The PivotLayout describing the layout and visual structure of the + PivotTable. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'layout?: Excel.Interfaces.PivotLayoutLoadOptions;' + return: + type: + - name: name + uid: excel!Excel.Interfaces.PivotTableLoadOptions#name:member + package: excel! + fullName: name + summary: Name of the PivotTable. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: refreshOnOpen + uid: excel!Excel.Interfaces.PivotTableLoadOptions#refreshOnOpen:member + package: excel! + fullName: refreshOnOpen + summary: >- + Specifies whether the PivotTable refreshes when the workbook opens. + Corresponds to "Refresh on load" setting in the UI. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'refreshOnOpen?: boolean;' + return: + type: boolean + - name: useCustomSortLists + uid: excel!Excel.Interfaces.PivotTableLoadOptions#useCustomSortLists:member + package: excel! + fullName: useCustomSortLists + summary: Specifies if the PivotTable uses custom lists when sorting. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'useCustomSortLists?: boolean;' + return: + type: boolean + - name: worksheet + uid: excel!Excel.Interfaces.PivotTableLoadOptions#worksheet:member + package: excel! + fullName: worksheet + summary: The worksheet containing the current PivotTable. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheet?: Excel.Interfaces.WorksheetLoadOptions;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottablescopedcollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottablescopedcollectiondata.yml new file mode 100644 index 0000000000..3e6594dd96 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottablescopedcollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.PivotTableScopedCollectionData +uid: excel!Excel.Interfaces.PivotTableScopedCollectionData:interface +package: excel! +fullName: Excel.Interfaces.PivotTableScopedCollectionData +summary: >- + An interface describing the data returned by calling + `pivotTableScopedCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.PivotTableScopedCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.PivotTableData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottablescopedcollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottablescopedcollectionloadoptions.yml new file mode 100644 index 0000000000..38862dc5a9 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottablescopedcollectionloadoptions.yml @@ -0,0 +1,175 @@ +### YamlMime:TSType +name: Excel.Interfaces.PivotTableScopedCollectionLoadOptions +uid: excel!Excel.Interfaces.PivotTableScopedCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.PivotTableScopedCollectionLoadOptions +summary: >- + Represents a scoped collection of PivotTables. The PivotTables are sorted + based on the location of the PivotTable's top-left corner. They are ordered + top-to-bottom and then left-to-right. +remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.PivotTableScopedCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: allowMultipleFiltersPerField + uid: >- + excel!Excel.Interfaces.PivotTableScopedCollectionLoadOptions#allowMultipleFiltersPerField:member + package: excel! + fullName: allowMultipleFiltersPerField + summary: >- + For EACH ITEM in the collection: Specifies if the PivotTable allows the + application of multiple PivotFilters on a given PivotField in the table. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'allowMultipleFiltersPerField?: boolean;' + return: + type: boolean + - name: enableDataValueEditing + uid: >- + excel!Excel.Interfaces.PivotTableScopedCollectionLoadOptions#enableDataValueEditing:member + package: excel! + fullName: enableDataValueEditing + summary: >- + For EACH ITEM in the collection: Specifies if the PivotTable allows values + in the data body to be edited by the user. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'enableDataValueEditing?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.PivotTableScopedCollectionLoadOptions#id:member + package: excel! + fullName: id + summary: 'For EACH ITEM in the collection: ID of the PivotTable.' + remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: layout + uid: excel!Excel.Interfaces.PivotTableScopedCollectionLoadOptions#layout:member + package: excel! + fullName: layout + summary: >- + For EACH ITEM in the collection: The PivotLayout describing the layout and + visual structure of the PivotTable. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'layout?: Excel.Interfaces.PivotLayoutLoadOptions;' + return: + type: + - name: name + uid: excel!Excel.Interfaces.PivotTableScopedCollectionLoadOptions#name:member + package: excel! + fullName: name + summary: 'For EACH ITEM in the collection: Name of the PivotTable.' + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: refreshOnOpen + uid: >- + excel!Excel.Interfaces.PivotTableScopedCollectionLoadOptions#refreshOnOpen:member + package: excel! + fullName: refreshOnOpen + summary: >- + For EACH ITEM in the collection: Specifies whether the PivotTable + refreshes when the workbook opens. Corresponds to "Refresh on load" + setting in the UI. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'refreshOnOpen?: boolean;' + return: + type: boolean + - name: useCustomSortLists + uid: >- + excel!Excel.Interfaces.PivotTableScopedCollectionLoadOptions#useCustomSortLists:member + package: excel! + fullName: useCustomSortLists + summary: >- + For EACH ITEM in the collection: Specifies if the PivotTable uses custom + lists when sorting. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'useCustomSortLists?: boolean;' + return: + type: boolean + - name: worksheet + uid: >- + excel!Excel.Interfaces.PivotTableScopedCollectionLoadOptions#worksheet:member + package: excel! + fullName: worksheet + summary: >- + For EACH ITEM in the collection: The worksheet containing the current + PivotTable. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheet?: Excel.Interfaces.WorksheetLoadOptions;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottablescopedcollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottablescopedcollectionupdatedata.yml new file mode 100644 index 0000000000..d044a5b396 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottablescopedcollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.PivotTableScopedCollectionUpdateData +uid: excel!Excel.Interfaces.PivotTableScopedCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.PivotTableScopedCollectionUpdateData +summary: >- + An interface for updating data on the `PivotTableScopedCollection` object, for + use in `pivotTableScopedCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.PivotTableScopedCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.PivotTableData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottablestylecollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottablestylecollectiondata.yml new file mode 100644 index 0000000000..26dca15a17 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottablestylecollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.PivotTableStyleCollectionData +uid: excel!Excel.Interfaces.PivotTableStyleCollectionData:interface +package: excel! +fullName: Excel.Interfaces.PivotTableStyleCollectionData +summary: >- + An interface describing the data returned by calling + `pivotTableStyleCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.PivotTableStyleCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.PivotTableStyleData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottablestylecollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottablestylecollectionloadoptions.yml new file mode 100644 index 0000000000..065b2d3d97 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottablestylecollectionloadoptions.yml @@ -0,0 +1,67 @@ +### YamlMime:TSType +name: Excel.Interfaces.PivotTableStyleCollectionLoadOptions +uid: excel!Excel.Interfaces.PivotTableStyleCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.PivotTableStyleCollectionLoadOptions +summary: Represents a collection of PivotTable styles. +remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.PivotTableStyleCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.PivotTableStyleCollectionLoadOptions#name:member + package: excel! + fullName: name + summary: >- + For EACH ITEM in the collection: Specifies the name of the PivotTable + style. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: readOnly + uid: >- + excel!Excel.Interfaces.PivotTableStyleCollectionLoadOptions#readOnly:member + package: excel! + fullName: readOnly + summary: >- + For EACH ITEM in the collection: Specifies if this `PivotTableStyle` + object is read-only. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readOnly?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottablestylecollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottablestylecollectionupdatedata.yml new file mode 100644 index 0000000000..81edf60c11 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottablestylecollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.PivotTableStyleCollectionUpdateData +uid: excel!Excel.Interfaces.PivotTableStyleCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.PivotTableStyleCollectionUpdateData +summary: >- + An interface for updating data on the `PivotTableStyleCollection` object, for + use in `pivotTableStyleCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.PivotTableStyleCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.PivotTableStyleData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottablestyledata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottablestyledata.yml new file mode 100644 index 0000000000..a722fd851b --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottablestyledata.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: Excel.Interfaces.PivotTableStyleData +uid: excel!Excel.Interfaces.PivotTableStyleData:interface +package: excel! +fullName: Excel.Interfaces.PivotTableStyleData +summary: >- + An interface describing the data returned by calling + `pivotTableStyle.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: name + uid: excel!Excel.Interfaces.PivotTableStyleData#name:member + package: excel! + fullName: name + summary: Specifies the name of the PivotTable style. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: readOnly + uid: excel!Excel.Interfaces.PivotTableStyleData#readOnly:member + package: excel! + fullName: readOnly + summary: Specifies if this `PivotTableStyle` object is read-only. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readOnly?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottablestyleloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottablestyleloadoptions.yml new file mode 100644 index 0000000000..f7901edda2 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottablestyleloadoptions.yml @@ -0,0 +1,64 @@ +### YamlMime:TSType +name: Excel.Interfaces.PivotTableStyleLoadOptions +uid: excel!Excel.Interfaces.PivotTableStyleLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.PivotTableStyleLoadOptions +summary: >- + Represents a PivotTable style, which defines style elements by PivotTable + region. +remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.PivotTableStyleLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.PivotTableStyleLoadOptions#name:member + package: excel! + fullName: name + summary: Specifies the name of the PivotTable style. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: readOnly + uid: excel!Excel.Interfaces.PivotTableStyleLoadOptions#readOnly:member + package: excel! + fullName: readOnly + summary: Specifies if this `PivotTableStyle` object is read-only. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readOnly?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottablestyleupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottablestyleupdatedata.yml new file mode 100644 index 0000000000..bf28d1e759 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottablestyleupdatedata.yml @@ -0,0 +1,30 @@ +### YamlMime:TSType +name: Excel.Interfaces.PivotTableStyleUpdateData +uid: excel!Excel.Interfaces.PivotTableStyleUpdateData:interface +package: excel! +fullName: Excel.Interfaces.PivotTableStyleUpdateData +summary: >- + An interface for updating data on the `PivotTableStyle` object, for use in + `pivotTableStyle.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: name + uid: excel!Excel.Interfaces.PivotTableStyleUpdateData#name:member + package: excel! + fullName: name + summary: Specifies the name of the PivotTable style. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottableupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottableupdatedata.yml new file mode 100644 index 0000000000..43de1f1c6e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.pivottableupdatedata.yml @@ -0,0 +1,98 @@ +### YamlMime:TSType +name: Excel.Interfaces.PivotTableUpdateData +uid: excel!Excel.Interfaces.PivotTableUpdateData:interface +package: excel! +fullName: Excel.Interfaces.PivotTableUpdateData +summary: >- + An interface for updating data on the `PivotTable` object, for use in + `pivotTable.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: allowMultipleFiltersPerField + uid: >- + excel!Excel.Interfaces.PivotTableUpdateData#allowMultipleFiltersPerField:member + package: excel! + fullName: allowMultipleFiltersPerField + summary: >- + Specifies if the PivotTable allows the application of multiple + PivotFilters on a given PivotField in the table. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'allowMultipleFiltersPerField?: boolean;' + return: + type: boolean + - name: enableDataValueEditing + uid: excel!Excel.Interfaces.PivotTableUpdateData#enableDataValueEditing:member + package: excel! + fullName: enableDataValueEditing + summary: >- + Specifies if the PivotTable allows values in the data body to be edited by + the user. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'enableDataValueEditing?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.PivotTableUpdateData#name:member + package: excel! + fullName: name + summary: Name of the PivotTable. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: refreshOnOpen + uid: excel!Excel.Interfaces.PivotTableUpdateData#refreshOnOpen:member + package: excel! + fullName: refreshOnOpen + summary: >- + Specifies whether the PivotTable refreshes when the workbook opens. + Corresponds to "Refresh on load" setting in the UI. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'refreshOnOpen?: boolean;' + return: + type: boolean + - name: useCustomSortLists + uid: excel!Excel.Interfaces.PivotTableUpdateData#useCustomSortLists:member + package: excel! + fullName: useCustomSortLists + summary: Specifies if the PivotTable uses custom lists when sorting. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'useCustomSortLists?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.presetcriteriaconditionalformatdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.presetcriteriaconditionalformatdata.yml new file mode 100644 index 0000000000..62593958b7 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.presetcriteriaconditionalformatdata.yml @@ -0,0 +1,48 @@ +### YamlMime:TSType +name: Excel.Interfaces.PresetCriteriaConditionalFormatData +uid: excel!Excel.Interfaces.PresetCriteriaConditionalFormatData:interface +package: excel! +fullName: Excel.Interfaces.PresetCriteriaConditionalFormatData +summary: >- + An interface describing the data returned by calling + `presetCriteriaConditionalFormat.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: format + uid: excel!Excel.Interfaces.PresetCriteriaConditionalFormatData#format:member + package: excel! + fullName: format + summary: >- + Returns a format object, encapsulating the conditional formats font, fill, + borders, and other properties. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ConditionalRangeFormatData;' + return: + type: >- + + - name: rule + uid: excel!Excel.Interfaces.PresetCriteriaConditionalFormatData#rule:member + package: excel! + fullName: rule + summary: The rule of the conditional format. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rule?: Excel.ConditionalPresetCriteriaRule;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.presetcriteriaconditionalformatloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.presetcriteriaconditionalformatloadoptions.yml new file mode 100644 index 0000000000..333bea5239 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.presetcriteriaconditionalformatloadoptions.yml @@ -0,0 +1,70 @@ +### YamlMime:TSType +name: Excel.Interfaces.PresetCriteriaConditionalFormatLoadOptions +uid: excel!Excel.Interfaces.PresetCriteriaConditionalFormatLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.PresetCriteriaConditionalFormatLoadOptions +summary: >- + Represents the preset criteria conditional format such as above average, below + average, unique values, contains blank, nonblank, error, and noerror. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: >- + excel!Excel.Interfaces.PresetCriteriaConditionalFormatLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: format + uid: >- + excel!Excel.Interfaces.PresetCriteriaConditionalFormatLoadOptions#format:member + package: excel! + fullName: format + summary: >- + Returns a format object, encapsulating the conditional formats font, fill, + borders, and other properties. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ConditionalRangeFormatLoadOptions;' + return: + type: >- + + - name: rule + uid: >- + excel!Excel.Interfaces.PresetCriteriaConditionalFormatLoadOptions#rule:member + package: excel! + fullName: rule + summary: The rule of the conditional format. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rule?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.presetcriteriaconditionalformatupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.presetcriteriaconditionalformatupdatedata.yml new file mode 100644 index 0000000000..68ff35ae40 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.presetcriteriaconditionalformatupdatedata.yml @@ -0,0 +1,51 @@ +### YamlMime:TSType +name: Excel.Interfaces.PresetCriteriaConditionalFormatUpdateData +uid: excel!Excel.Interfaces.PresetCriteriaConditionalFormatUpdateData:interface +package: excel! +fullName: Excel.Interfaces.PresetCriteriaConditionalFormatUpdateData +summary: >- + An interface for updating data on the `PresetCriteriaConditionalFormat` + object, for use in `presetCriteriaConditionalFormat.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: format + uid: >- + excel!Excel.Interfaces.PresetCriteriaConditionalFormatUpdateData#format:member + package: excel! + fullName: format + summary: >- + Returns a format object, encapsulating the conditional formats font, fill, + borders, and other properties. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ConditionalRangeFormatUpdateData;' + return: + type: >- + + - name: rule + uid: >- + excel!Excel.Interfaces.PresetCriteriaConditionalFormatUpdateData#rule:member + package: excel! + fullName: rule + summary: The rule of the conditional format. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rule?: Excel.ConditionalPresetCriteriaRule;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.querycollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.querycollectiondata.yml new file mode 100644 index 0000000000..d4eab0b347 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.querycollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.QueryCollectionData +uid: excel!Excel.Interfaces.QueryCollectionData:interface +package: excel! +fullName: Excel.Interfaces.QueryCollectionData +summary: >- + An interface describing the data returned by calling + `queryCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.QueryCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.QueryData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.querycollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.querycollectionloadoptions.yml new file mode 100644 index 0000000000..ddb775f11f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.querycollectionloadoptions.yml @@ -0,0 +1,137 @@ +### YamlMime:TSType +name: Excel.Interfaces.QueryCollectionLoadOptions +uid: excel!Excel.Interfaces.QueryCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.QueryCollectionLoadOptions +summary: Represents the collection of queries in the workbook. +remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.QueryCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: error + uid: excel!Excel.Interfaces.QueryCollectionLoadOptions#error:member + package: excel! + fullName: error + summary: >- + For EACH ITEM in the collection: Gets the query error message from when + the query was last refreshed. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'error?: boolean;' + return: + type: boolean + - name: loadedTo + uid: excel!Excel.Interfaces.QueryCollectionLoadOptions#loadedTo:member + package: excel! + fullName: loadedTo + summary: 'For EACH ITEM in the collection: Gets the query loaded to object type.' + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'loadedTo?: boolean;' + return: + type: boolean + - name: loadedToDataModel + uid: excel!Excel.Interfaces.QueryCollectionLoadOptions#loadedToDataModel:member + package: excel! + fullName: loadedToDataModel + summary: >- + For EACH ITEM in the collection: Specifies if the query loaded to the data + model. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'loadedToDataModel?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.QueryCollectionLoadOptions#name:member + package: excel! + fullName: name + summary: >- + For EACH ITEM in the collection: Gets the name of the query. Query names + cannot contain periods or quotation marks. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: refreshDate + uid: excel!Excel.Interfaces.QueryCollectionLoadOptions#refreshDate:member + package: excel! + fullName: refreshDate + summary: >- + For EACH ITEM in the collection: Gets the date and time when the query was + last refreshed. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'refreshDate?: boolean;' + return: + type: boolean + - name: rowsLoadedCount + uid: excel!Excel.Interfaces.QueryCollectionLoadOptions#rowsLoadedCount:member + package: excel! + fullName: rowsLoadedCount + summary: >- + For EACH ITEM in the collection: Gets the number of rows that were loaded + when the query was last refreshed. If last refresh has errors the value + will be -1. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rowsLoadedCount?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.querycollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.querycollectionupdatedata.yml new file mode 100644 index 0000000000..19b0e3175d --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.querycollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.QueryCollectionUpdateData +uid: excel!Excel.Interfaces.QueryCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.QueryCollectionUpdateData +summary: >- + An interface for updating data on the `QueryCollection` object, for use in + `queryCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.QueryCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.QueryData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.querydata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.querydata.yml new file mode 100644 index 0000000000..2094f93936 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.querydata.yml @@ -0,0 +1,122 @@ +### YamlMime:TSType +name: Excel.Interfaces.QueryData +uid: excel!Excel.Interfaces.QueryData:interface +package: excel! +fullName: Excel.Interfaces.QueryData +summary: An interface describing the data returned by calling `query.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: error + uid: excel!Excel.Interfaces.QueryData#error:member + package: excel! + fullName: error + summary: Gets the query error message from when the query was last refreshed. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + error?: Excel.QueryError | "Unknown" | "None" | "FailedLoadToWorksheet" + | "FailedLoadToDataModel" | "FailedDownload" | + "FailedToCompleteDownload"; + return: + type: >- + | "Unknown" | "None" | + "FailedLoadToWorksheet" | "FailedLoadToDataModel" | "FailedDownload" | + "FailedToCompleteDownload" + - name: loadedTo + uid: excel!Excel.Interfaces.QueryData#loadedTo:member + package: excel! + fullName: loadedTo + summary: Gets the query loaded to object type. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + loadedTo?: Excel.LoadToType | "ConnectionOnly" | "Table" | "PivotTable" + | "PivotChart"; + return: + type: >- + | "ConnectionOnly" | + "Table" | "PivotTable" | "PivotChart" + - name: loadedToDataModel + uid: excel!Excel.Interfaces.QueryData#loadedToDataModel:member + package: excel! + fullName: loadedToDataModel + summary: Specifies if the query loaded to the data model. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'loadedToDataModel?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.QueryData#name:member + package: excel! + fullName: name + summary: >- + Gets the name of the query. Query names cannot contain periods or + quotation marks. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: refreshDate + uid: excel!Excel.Interfaces.QueryData#refreshDate:member + package: excel! + fullName: refreshDate + summary: Gets the date and time when the query was last refreshed. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'refreshDate?: Date;' + return: + type: Date + - name: rowsLoadedCount + uid: excel!Excel.Interfaces.QueryData#rowsLoadedCount:member + package: excel! + fullName: rowsLoadedCount + summary: >- + Gets the number of rows that were loaded when the query was last + refreshed. If last refresh has errors the value will be -1. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rowsLoadedCount?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.queryloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.queryloadoptions.yml new file mode 100644 index 0000000000..619257b2b2 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.queryloadoptions.yml @@ -0,0 +1,130 @@ +### YamlMime:TSType +name: Excel.Interfaces.QueryLoadOptions +uid: excel!Excel.Interfaces.QueryLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.QueryLoadOptions +summary: Represents a Power Query query. +remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.QueryLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: error + uid: excel!Excel.Interfaces.QueryLoadOptions#error:member + package: excel! + fullName: error + summary: Gets the query error message from when the query was last refreshed. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'error?: boolean;' + return: + type: boolean + - name: loadedTo + uid: excel!Excel.Interfaces.QueryLoadOptions#loadedTo:member + package: excel! + fullName: loadedTo + summary: Gets the query loaded to object type. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'loadedTo?: boolean;' + return: + type: boolean + - name: loadedToDataModel + uid: excel!Excel.Interfaces.QueryLoadOptions#loadedToDataModel:member + package: excel! + fullName: loadedToDataModel + summary: Specifies if the query loaded to the data model. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'loadedToDataModel?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.QueryLoadOptions#name:member + package: excel! + fullName: name + summary: >- + Gets the name of the query. Query names cannot contain periods or + quotation marks. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: refreshDate + uid: excel!Excel.Interfaces.QueryLoadOptions#refreshDate:member + package: excel! + fullName: refreshDate + summary: Gets the date and time when the query was last refreshed. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'refreshDate?: boolean;' + return: + type: boolean + - name: rowsLoadedCount + uid: excel!Excel.Interfaces.QueryLoadOptions#rowsLoadedCount:member + package: excel! + fullName: rowsLoadedCount + summary: >- + Gets the number of rows that were loaded when the query was last + refreshed. If last refresh has errors the value will be -1. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rowsLoadedCount?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeareascollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeareascollectiondata.yml new file mode 100644 index 0000000000..d1f2b9f244 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeareascollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.RangeAreasCollectionData +uid: excel!Excel.Interfaces.RangeAreasCollectionData:interface +package: excel! +fullName: Excel.Interfaces.RangeAreasCollectionData +summary: >- + An interface describing the data returned by calling + `rangeAreasCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.RangeAreasCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.RangeAreasData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeareascollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeareascollectionloadoptions.yml new file mode 100644 index 0000000000..73e8b4544f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeareascollectionloadoptions.yml @@ -0,0 +1,214 @@ +### YamlMime:TSType +name: Excel.Interfaces.RangeAreasCollectionLoadOptions +uid: excel!Excel.Interfaces.RangeAreasCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.RangeAreasCollectionLoadOptions +summary: Contains the collection of cross-workbook level ranges. +remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.RangeAreasCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: address + uid: excel!Excel.Interfaces.RangeAreasCollectionLoadOptions#address:member + package: excel! + fullName: address + summary: >- + For EACH ITEM in the collection: Returns the `RangeAreas` reference in + A1-style. Address value will contain the worksheet name for each + rectangular block of cells (e.g., "Sheet1!A1:B4, Sheet1!D1:D4"). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'address?: boolean;' + return: + type: boolean + - name: addressLocal + uid: excel!Excel.Interfaces.RangeAreasCollectionLoadOptions#addressLocal:member + package: excel! + fullName: addressLocal + summary: >- + For EACH ITEM in the collection: Returns the `RangeAreas` reference in the + user locale. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'addressLocal?: boolean;' + return: + type: boolean + - name: areaCount + uid: excel!Excel.Interfaces.RangeAreasCollectionLoadOptions#areaCount:member + package: excel! + fullName: areaCount + summary: >- + For EACH ITEM in the collection: Returns the number of rectangular ranges + that comprise this `RangeAreas` object. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'areaCount?: boolean;' + return: + type: boolean + - name: cellCount + uid: excel!Excel.Interfaces.RangeAreasCollectionLoadOptions#cellCount:member + package: excel! + fullName: cellCount + summary: >- + For EACH ITEM in the collection: Returns the number of cells in the + `RangeAreas` object, summing up the cell counts of all of the individual + rectangular ranges. Returns -1 if the cell count exceeds 2^31-1 + (2,147,483,647). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'cellCount?: boolean;' + return: + type: boolean + - name: dataValidation + uid: >- + excel!Excel.Interfaces.RangeAreasCollectionLoadOptions#dataValidation:member + package: excel! + fullName: dataValidation + summary: >- + For EACH ITEM in the collection: Returns a data validation object for all + ranges in the `RangeAreas`. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'dataValidation?: Excel.Interfaces.DataValidationLoadOptions;' + return: + type: >- + + - name: format + uid: excel!Excel.Interfaces.RangeAreasCollectionLoadOptions#format:member + package: excel! + fullName: format + summary: >- + For EACH ITEM in the collection: Returns a `RangeFormat` object, + encapsulating the font, fill, borders, alignment, and other properties for + all ranges in the `RangeAreas` object. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.RangeFormatLoadOptions;' + return: + type: + - name: isEntireColumn + uid: >- + excel!Excel.Interfaces.RangeAreasCollectionLoadOptions#isEntireColumn:member + package: excel! + fullName: isEntireColumn + summary: >- + For EACH ITEM in the collection: Specifies if all the ranges on this + `RangeAreas` object represent entire columns (e.g., "A:C, Q:Z"). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'isEntireColumn?: boolean;' + return: + type: boolean + - name: isEntireRow + uid: excel!Excel.Interfaces.RangeAreasCollectionLoadOptions#isEntireRow:member + package: excel! + fullName: isEntireRow + summary: >- + For EACH ITEM in the collection: Specifies if all the ranges on this + `RangeAreas` object represent entire rows (e.g., "1:3, 5:7"). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'isEntireRow?: boolean;' + return: + type: boolean + - name: style + uid: excel!Excel.Interfaces.RangeAreasCollectionLoadOptions#style:member + package: excel! + fullName: style + summary: >- + For EACH ITEM in the collection: Represents the style for all ranges in + this `RangeAreas` object. If the styles of the cells are inconsistent, + `null` will be returned. For custom styles, the style name will be + returned. For built-in styles, a string representing a value in the + `BuiltInStyle` enum will be returned. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'style?: boolean;' + return: + type: boolean + - name: worksheet + uid: excel!Excel.Interfaces.RangeAreasCollectionLoadOptions#worksheet:member + package: excel! + fullName: worksheet + summary: >- + For EACH ITEM in the collection: Returns the worksheet for the current + `RangeAreas`. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheet?: Excel.Interfaces.WorksheetLoadOptions;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeareascollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeareascollectionupdatedata.yml new file mode 100644 index 0000000000..e381cb90e0 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeareascollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.RangeAreasCollectionUpdateData +uid: excel!Excel.Interfaces.RangeAreasCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.RangeAreasCollectionUpdateData +summary: >- + An interface for updating data on the `RangeAreasCollection` object, for use + in `rangeAreasCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.RangeAreasCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.RangeAreasData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeareasdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeareasdata.yml new file mode 100644 index 0000000000..3635f3b8de --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeareasdata.yml @@ -0,0 +1,205 @@ +### YamlMime:TSType +name: Excel.Interfaces.RangeAreasData +uid: excel!Excel.Interfaces.RangeAreasData:interface +package: excel! +fullName: Excel.Interfaces.RangeAreasData +summary: >- + An interface describing the data returned by calling `rangeAreas.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: address + uid: excel!Excel.Interfaces.RangeAreasData#address:member + package: excel! + fullName: address + summary: >- + Returns the `RangeAreas` reference in A1-style. Address value will contain + the worksheet name for each rectangular block of cells (e.g., + "Sheet1!A1:B4, Sheet1!D1:D4"). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'address?: string;' + return: + type: string + - name: addressLocal + uid: excel!Excel.Interfaces.RangeAreasData#addressLocal:member + package: excel! + fullName: addressLocal + summary: Returns the `RangeAreas` reference in the user locale. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'addressLocal?: string;' + return: + type: string + - name: areaCount + uid: excel!Excel.Interfaces.RangeAreasData#areaCount:member + package: excel! + fullName: areaCount + summary: >- + Returns the number of rectangular ranges that comprise this `RangeAreas` + object. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'areaCount?: number;' + return: + type: number + - name: areas + uid: excel!Excel.Interfaces.RangeAreasData#areas:member + package: excel! + fullName: areas + summary: >- + Returns a collection of rectangular ranges that comprise this `RangeAreas` + object. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'areas?: Excel.Interfaces.RangeData[];' + return: + type: [] + - name: cellCount + uid: excel!Excel.Interfaces.RangeAreasData#cellCount:member + package: excel! + fullName: cellCount + summary: >- + Returns the number of cells in the `RangeAreas` object, summing up the + cell counts of all of the individual rectangular ranges. Returns -1 if the + cell count exceeds 2^31-1 (2,147,483,647). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'cellCount?: number;' + return: + type: number + - name: conditionalFormats + uid: excel!Excel.Interfaces.RangeAreasData#conditionalFormats:member + package: excel! + fullName: conditionalFormats + summary: >- + Returns a collection of conditional formats that intersect with any cells + in this `RangeAreas` object. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'conditionalFormats?: Excel.Interfaces.ConditionalFormatData[];' + return: + type: >- + [] + - name: dataValidation + uid: excel!Excel.Interfaces.RangeAreasData#dataValidation:member + package: excel! + fullName: dataValidation + summary: >- + Returns a data validation object for all ranges in the `RangeAreas`. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'dataValidation?: Excel.Interfaces.DataValidationData;' + return: + type: + - name: format + uid: excel!Excel.Interfaces.RangeAreasData#format:member + package: excel! + fullName: format + summary: >- + Returns a `RangeFormat` object, encapsulating the font, fill, borders, + alignment, and other properties for all ranges in the `RangeAreas` object. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.RangeFormatData;' + return: + type: + - name: isEntireColumn + uid: excel!Excel.Interfaces.RangeAreasData#isEntireColumn:member + package: excel! + fullName: isEntireColumn + summary: >- + Specifies if all the ranges on this `RangeAreas` object represent entire + columns (e.g., "A:C, Q:Z"). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'isEntireColumn?: boolean;' + return: + type: boolean + - name: isEntireRow + uid: excel!Excel.Interfaces.RangeAreasData#isEntireRow:member + package: excel! + fullName: isEntireRow + summary: >- + Specifies if all the ranges on this `RangeAreas` object represent entire + rows (e.g., "1:3, 5:7"). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'isEntireRow?: boolean;' + return: + type: boolean + - name: style + uid: excel!Excel.Interfaces.RangeAreasData#style:member + package: excel! + fullName: style + summary: >- + Represents the style for all ranges in this `RangeAreas` object. If the + styles of the cells are inconsistent, `null` will be returned. For custom + styles, the style name will be returned. For built-in styles, a string + representing a value in the `BuiltInStyle` enum will be returned. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'style?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeareasloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeareasloadoptions.yml new file mode 100644 index 0000000000..172b6c4a11 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeareasloadoptions.yml @@ -0,0 +1,207 @@ +### YamlMime:TSType +name: Excel.Interfaces.RangeAreasLoadOptions +uid: excel!Excel.Interfaces.RangeAreasLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.RangeAreasLoadOptions +summary: >- + `RangeAreas` represents a collection of one or more rectangular ranges in the + same worksheet. To learn how to use discontiguous ranges, read [Work with + multiple ranges simultaneously in Excel + add-ins](https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-multiple-ranges). +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.RangeAreasLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: address + uid: excel!Excel.Interfaces.RangeAreasLoadOptions#address:member + package: excel! + fullName: address + summary: >- + Returns the `RangeAreas` reference in A1-style. Address value will contain + the worksheet name for each rectangular block of cells (e.g., + "Sheet1!A1:B4, Sheet1!D1:D4"). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'address?: boolean;' + return: + type: boolean + - name: addressLocal + uid: excel!Excel.Interfaces.RangeAreasLoadOptions#addressLocal:member + package: excel! + fullName: addressLocal + summary: Returns the `RangeAreas` reference in the user locale. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'addressLocal?: boolean;' + return: + type: boolean + - name: areaCount + uid: excel!Excel.Interfaces.RangeAreasLoadOptions#areaCount:member + package: excel! + fullName: areaCount + summary: >- + Returns the number of rectangular ranges that comprise this `RangeAreas` + object. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'areaCount?: boolean;' + return: + type: boolean + - name: cellCount + uid: excel!Excel.Interfaces.RangeAreasLoadOptions#cellCount:member + package: excel! + fullName: cellCount + summary: >- + Returns the number of cells in the `RangeAreas` object, summing up the + cell counts of all of the individual rectangular ranges. Returns -1 if the + cell count exceeds 2^31-1 (2,147,483,647). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'cellCount?: boolean;' + return: + type: boolean + - name: dataValidation + uid: excel!Excel.Interfaces.RangeAreasLoadOptions#dataValidation:member + package: excel! + fullName: dataValidation + summary: >- + Returns a data validation object for all ranges in the `RangeAreas`. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'dataValidation?: Excel.Interfaces.DataValidationLoadOptions;' + return: + type: >- + + - name: format + uid: excel!Excel.Interfaces.RangeAreasLoadOptions#format:member + package: excel! + fullName: format + summary: >- + Returns a `RangeFormat` object, encapsulating the font, fill, borders, + alignment, and other properties for all ranges in the `RangeAreas` object. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.RangeFormatLoadOptions;' + return: + type: + - name: isEntireColumn + uid: excel!Excel.Interfaces.RangeAreasLoadOptions#isEntireColumn:member + package: excel! + fullName: isEntireColumn + summary: >- + Specifies if all the ranges on this `RangeAreas` object represent entire + columns (e.g., "A:C, Q:Z"). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'isEntireColumn?: boolean;' + return: + type: boolean + - name: isEntireRow + uid: excel!Excel.Interfaces.RangeAreasLoadOptions#isEntireRow:member + package: excel! + fullName: isEntireRow + summary: >- + Specifies if all the ranges on this `RangeAreas` object represent entire + rows (e.g., "1:3, 5:7"). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'isEntireRow?: boolean;' + return: + type: boolean + - name: style + uid: excel!Excel.Interfaces.RangeAreasLoadOptions#style:member + package: excel! + fullName: style + summary: >- + Represents the style for all ranges in this `RangeAreas` object. If the + styles of the cells are inconsistent, `null` will be returned. For custom + styles, the style name will be returned. For built-in styles, a string + representing a value in the `BuiltInStyle` enum will be returned. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'style?: boolean;' + return: + type: boolean + - name: worksheet + uid: excel!Excel.Interfaces.RangeAreasLoadOptions#worksheet:member + package: excel! + fullName: worksheet + summary: Returns the worksheet for the current `RangeAreas`. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheet?: Excel.Interfaces.WorksheetLoadOptions;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeareasupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeareasupdatedata.yml new file mode 100644 index 0000000000..72f218bc2e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeareasupdatedata.yml @@ -0,0 +1,69 @@ +### YamlMime:TSType +name: Excel.Interfaces.RangeAreasUpdateData +uid: excel!Excel.Interfaces.RangeAreasUpdateData:interface +package: excel! +fullName: Excel.Interfaces.RangeAreasUpdateData +summary: >- + An interface for updating data on the `RangeAreas` object, for use in + `rangeAreas.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: dataValidation + uid: excel!Excel.Interfaces.RangeAreasUpdateData#dataValidation:member + package: excel! + fullName: dataValidation + summary: >- + Returns a data validation object for all ranges in the `RangeAreas`. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'dataValidation?: Excel.Interfaces.DataValidationUpdateData;' + return: + type: >- + + - name: format + uid: excel!Excel.Interfaces.RangeAreasUpdateData#format:member + package: excel! + fullName: format + summary: >- + Returns a `RangeFormat` object, encapsulating the font, fill, borders, + alignment, and other properties for all ranges in the `RangeAreas` object. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.RangeFormatUpdateData;' + return: + type: + - name: style + uid: excel!Excel.Interfaces.RangeAreasUpdateData#style:member + package: excel! + fullName: style + summary: >- + Represents the style for all ranges in this `RangeAreas` object. If the + styles of the cells are inconsistent, `null` will be returned. For custom + styles, the style name will be returned. For built-in styles, a string + representing a value in the `BuiltInStyle` enum will be returned. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'style?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangebordercollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangebordercollectiondata.yml new file mode 100644 index 0000000000..e8e62edbe4 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangebordercollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.RangeBorderCollectionData +uid: excel!Excel.Interfaces.RangeBorderCollectionData:interface +package: excel! +fullName: Excel.Interfaces.RangeBorderCollectionData +summary: >- + An interface describing the data returned by calling + `rangeBorderCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.RangeBorderCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.RangeBorderData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangebordercollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangebordercollectionloadoptions.yml new file mode 100644 index 0000000000..bfd3527118 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangebordercollectionloadoptions.yml @@ -0,0 +1,120 @@ +### YamlMime:TSType +name: Excel.Interfaces.RangeBorderCollectionLoadOptions +uid: excel!Excel.Interfaces.RangeBorderCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.RangeBorderCollectionLoadOptions +summary: Represents the border objects that make up the range border. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.RangeBorderCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: color + uid: excel!Excel.Interfaces.RangeBorderCollectionLoadOptions#color:member + package: excel! + fullName: color + summary: >- + For EACH ITEM in the collection: HTML color code representing the color of + the border line, in the form \#RRGGBB (e.g., "FFA500"), or as a named HTML + color (e.g., "orange"). + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: boolean;' + return: + type: boolean + - name: sideIndex + uid: excel!Excel.Interfaces.RangeBorderCollectionLoadOptions#sideIndex:member + package: excel! + fullName: sideIndex + summary: >- + For EACH ITEM in the collection: Constant value that indicates the + specific side of the border. See `Excel.BorderIndex` for details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'sideIndex?: boolean;' + return: + type: boolean + - name: style + uid: excel!Excel.Interfaces.RangeBorderCollectionLoadOptions#style:member + package: excel! + fullName: style + summary: >- + For EACH ITEM in the collection: One of the constants of line style + specifying the line style for the border. See `Excel.BorderLineStyle` for + details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'style?: boolean;' + return: + type: boolean + - name: tintAndShade + uid: >- + excel!Excel.Interfaces.RangeBorderCollectionLoadOptions#tintAndShade:member + package: excel! + fullName: tintAndShade + summary: >- + For EACH ITEM in the collection: Specifies a double that lightens or + darkens a color for the range border, the value is between -1 (darkest) + and 1 (brightest), with 0 for the original color. A `null` value indicates + that the border doesn't have a uniform `tintAndShade` setting. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tintAndShade?: boolean;' + return: + type: boolean + - name: weight + uid: excel!Excel.Interfaces.RangeBorderCollectionLoadOptions#weight:member + package: excel! + fullName: weight + summary: >- + For EACH ITEM in the collection: Specifies the weight of the border around + a range. See `Excel.BorderWeight` for details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'weight?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangebordercollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangebordercollectionupdatedata.yml new file mode 100644 index 0000000000..d037985332 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangebordercollectionupdatedata.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: Excel.Interfaces.RangeBorderCollectionUpdateData +uid: excel!Excel.Interfaces.RangeBorderCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.RangeBorderCollectionUpdateData +summary: >- + An interface for updating data on the `RangeBorderCollection` object, for use + in `rangeBorderCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.RangeBorderCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.RangeBorderData[];' + return: + type: [] + - name: tintAndShade + uid: excel!Excel.Interfaces.RangeBorderCollectionUpdateData#tintAndShade:member + package: excel! + fullName: tintAndShade + summary: >- + Specifies a double that lightens or darkens a color for range borders. The + value is between -1 (darkest) and 1 (brightest), with 0 for the original + color. A `null` value indicates that the entire border collection doesn't + have a uniform `tintAndShade` setting. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tintAndShade?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeborderdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeborderdata.yml new file mode 100644 index 0000000000..c46a7df81f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeborderdata.yml @@ -0,0 +1,114 @@ +### YamlMime:TSType +name: Excel.Interfaces.RangeBorderData +uid: excel!Excel.Interfaces.RangeBorderData:interface +package: excel! +fullName: Excel.Interfaces.RangeBorderData +summary: >- + An interface describing the data returned by calling + `rangeBorder.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: color + uid: excel!Excel.Interfaces.RangeBorderData#color:member + package: excel! + fullName: color + summary: >- + HTML color code representing the color of the border line, in the form + \#RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange"). + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: string;' + return: + type: string + - name: sideIndex + uid: excel!Excel.Interfaces.RangeBorderData#sideIndex:member + package: excel! + fullName: sideIndex + summary: >- + Constant value that indicates the specific side of the border. See + `Excel.BorderIndex` for details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + sideIndex?: Excel.BorderIndex | "EdgeTop" | "EdgeBottom" | "EdgeLeft" | + "EdgeRight" | "InsideVertical" | "InsideHorizontal" | "DiagonalDown" | + "DiagonalUp"; + return: + type: >- + | "EdgeTop" | "EdgeBottom" + | "EdgeLeft" | "EdgeRight" | "InsideVertical" | "InsideHorizontal" | + "DiagonalDown" | "DiagonalUp" + - name: style + uid: excel!Excel.Interfaces.RangeBorderData#style:member + package: excel! + fullName: style + summary: >- + One of the constants of line style specifying the line style for the + border. See `Excel.BorderLineStyle` for details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + style?: Excel.BorderLineStyle | "None" | "Continuous" | "Dash" | + "DashDot" | "DashDotDot" | "Dot" | "Double" | "SlantDashDot"; + return: + type: >- + | "None" | + "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot" | "Double" | + "SlantDashDot" + - name: tintAndShade + uid: excel!Excel.Interfaces.RangeBorderData#tintAndShade:member + package: excel! + fullName: tintAndShade + summary: >- + Specifies a double that lightens or darkens a color for the range border, + the value is between -1 (darkest) and 1 (brightest), with 0 for the + original color. A `null` value indicates that the border doesn't have a + uniform `tintAndShade` setting. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tintAndShade?: number;' + return: + type: number + - name: weight + uid: excel!Excel.Interfaces.RangeBorderData#weight:member + package: excel! + fullName: weight + summary: >- + Specifies the weight of the border around a range. See + `Excel.BorderWeight` for details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'weight?: Excel.BorderWeight | "Hairline" | "Thin" | "Medium" | "Thick";' + return: + type: >- + | "Hairline" | "Thin" | + "Medium" | "Thick" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeborderloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeborderloadoptions.yml new file mode 100644 index 0000000000..4295318d68 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeborderloadoptions.yml @@ -0,0 +1,117 @@ +### YamlMime:TSType +name: Excel.Interfaces.RangeBorderLoadOptions +uid: excel!Excel.Interfaces.RangeBorderLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.RangeBorderLoadOptions +summary: Represents the border of an object. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.RangeBorderLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: color + uid: excel!Excel.Interfaces.RangeBorderLoadOptions#color:member + package: excel! + fullName: color + summary: >- + HTML color code representing the color of the border line, in the form + \#RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange"). + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: boolean;' + return: + type: boolean + - name: sideIndex + uid: excel!Excel.Interfaces.RangeBorderLoadOptions#sideIndex:member + package: excel! + fullName: sideIndex + summary: >- + Constant value that indicates the specific side of the border. See + `Excel.BorderIndex` for details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'sideIndex?: boolean;' + return: + type: boolean + - name: style + uid: excel!Excel.Interfaces.RangeBorderLoadOptions#style:member + package: excel! + fullName: style + summary: >- + One of the constants of line style specifying the line style for the + border. See `Excel.BorderLineStyle` for details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'style?: boolean;' + return: + type: boolean + - name: tintAndShade + uid: excel!Excel.Interfaces.RangeBorderLoadOptions#tintAndShade:member + package: excel! + fullName: tintAndShade + summary: >- + Specifies a double that lightens or darkens a color for the range border, + the value is between -1 (darkest) and 1 (brightest), with 0 for the + original color. A `null` value indicates that the border doesn't have a + uniform `tintAndShade` setting. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tintAndShade?: boolean;' + return: + type: boolean + - name: weight + uid: excel!Excel.Interfaces.RangeBorderLoadOptions#weight:member + package: excel! + fullName: weight + summary: >- + Specifies the weight of the border around a range. See + `Excel.BorderWeight` for details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'weight?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeborderupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeborderupdatedata.yml new file mode 100644 index 0000000000..f6e6efc793 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeborderupdatedata.yml @@ -0,0 +1,91 @@ +### YamlMime:TSType +name: Excel.Interfaces.RangeBorderUpdateData +uid: excel!Excel.Interfaces.RangeBorderUpdateData:interface +package: excel! +fullName: Excel.Interfaces.RangeBorderUpdateData +summary: >- + An interface for updating data on the `RangeBorder` object, for use in + `rangeBorder.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: color + uid: excel!Excel.Interfaces.RangeBorderUpdateData#color:member + package: excel! + fullName: color + summary: >- + HTML color code representing the color of the border line, in the form + \#RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange"). + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: string;' + return: + type: string + - name: style + uid: excel!Excel.Interfaces.RangeBorderUpdateData#style:member + package: excel! + fullName: style + summary: >- + One of the constants of line style specifying the line style for the + border. See `Excel.BorderLineStyle` for details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + style?: Excel.BorderLineStyle | "None" | "Continuous" | "Dash" | + "DashDot" | "DashDotDot" | "Dot" | "Double" | "SlantDashDot"; + return: + type: >- + | "None" | + "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot" | "Double" | + "SlantDashDot" + - name: tintAndShade + uid: excel!Excel.Interfaces.RangeBorderUpdateData#tintAndShade:member + package: excel! + fullName: tintAndShade + summary: >- + Specifies a double that lightens or darkens a color for the range border, + the value is between -1 (darkest) and 1 (brightest), with 0 for the + original color. A `null` value indicates that the border doesn't have a + uniform `tintAndShade` setting. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tintAndShade?: number;' + return: + type: number + - name: weight + uid: excel!Excel.Interfaces.RangeBorderUpdateData#weight:member + package: excel! + fullName: weight + summary: >- + Specifies the weight of the border around a range. See + `Excel.BorderWeight` for details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'weight?: Excel.BorderWeight | "Hairline" | "Thin" | "Medium" | "Thick";' + return: + type: >- + | "Hairline" | "Thin" | + "Medium" | "Thick" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangecollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangecollectiondata.yml new file mode 100644 index 0000000000..d30f9d09f4 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangecollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.RangeCollectionData +uid: excel!Excel.Interfaces.RangeCollectionData:interface +package: excel! +fullName: Excel.Interfaces.RangeCollectionData +summary: >- + An interface describing the data returned by calling + `rangeCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.RangeCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.RangeData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangecollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangecollectionloadoptions.yml new file mode 100644 index 0000000000..db44158892 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangecollectionloadoptions.yml @@ -0,0 +1,695 @@ +### YamlMime:TSType +name: Excel.Interfaces.RangeCollectionLoadOptions +uid: excel!Excel.Interfaces.RangeCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.RangeCollectionLoadOptions +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.RangeCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: address + uid: excel!Excel.Interfaces.RangeCollectionLoadOptions#address:member + package: excel! + fullName: address + summary: >- + For EACH ITEM in the collection: Specifies the range reference in + A1-style. Address value contains the sheet reference (e.g., + "Sheet1!A1:B4"). + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'address?: boolean;' + return: + type: boolean + - name: addressLocal + uid: excel!Excel.Interfaces.RangeCollectionLoadOptions#addressLocal:member + package: excel! + fullName: addressLocal + summary: >- + For EACH ITEM in the collection: Represents the range reference for the + specified range in the language of the user. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'addressLocal?: boolean;' + return: + type: boolean + - name: cellCount + uid: excel!Excel.Interfaces.RangeCollectionLoadOptions#cellCount:member + package: excel! + fullName: cellCount + summary: >- + For EACH ITEM in the collection: Specifies the number of cells in the + range. This API will return -1 if the cell count exceeds 2^31-1 + (2,147,483,647). + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'cellCount?: boolean;' + return: + type: boolean + - name: columnCount + uid: excel!Excel.Interfaces.RangeCollectionLoadOptions#columnCount:member + package: excel! + fullName: columnCount + summary: >- + For EACH ITEM in the collection: Specifies the total number of columns in + the range. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'columnCount?: boolean;' + return: + type: boolean + - name: columnHidden + uid: excel!Excel.Interfaces.RangeCollectionLoadOptions#columnHidden:member + package: excel! + fullName: columnHidden + summary: >- + For EACH ITEM in the collection: Represents if all columns in the current + range are hidden. Value is `true` when all columns in a range are hidden. + Value is `false` when no columns in the range are hidden. Value is `null` + when some columns in a range are hidden and other columns in the same + range are not hidden. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'columnHidden?: boolean;' + return: + type: boolean + - name: columnIndex + uid: excel!Excel.Interfaces.RangeCollectionLoadOptions#columnIndex:member + package: excel! + fullName: columnIndex + summary: >- + For EACH ITEM in the collection: Specifies the column number of the first + cell in the range. Zero-indexed. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'columnIndex?: boolean;' + return: + type: boolean + - name: control + uid: excel!Excel.Interfaces.RangeCollectionLoadOptions#control:member + package: excel! + fullName: control + summary: >- + For EACH ITEM in the collection: Accesses the cell control applied to this + range. If the range has multiple cell controls, this returns + `EmptyCellControl`. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'control?: boolean;' + return: + type: boolean + - name: dataValidation + uid: excel!Excel.Interfaces.RangeCollectionLoadOptions#dataValidation:member + package: excel! + fullName: dataValidation + summary: 'For EACH ITEM in the collection: Returns a data validation object.' + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'dataValidation?: Excel.Interfaces.DataValidationLoadOptions;' + return: + type: >- + + - name: format + uid: excel!Excel.Interfaces.RangeCollectionLoadOptions#format:member + package: excel! + fullName: format + summary: >- + For EACH ITEM in the collection: Returns a format object, encapsulating + the range's font, fill, borders, alignment, and other properties. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.RangeFormatLoadOptions;' + return: + type: + - name: formulas + uid: excel!Excel.Interfaces.RangeCollectionLoadOptions#formulas:member + package: excel! + fullName: formulas + summary: >- + For EACH ITEM in the collection: Represents the formula in A1-style + notation. If a cell has no formula, its value is returned instead. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulas?: boolean;' + return: + type: boolean + - name: formulasLocal + uid: excel!Excel.Interfaces.RangeCollectionLoadOptions#formulasLocal:member + package: excel! + fullName: formulasLocal + summary: >- + For EACH ITEM in the collection: Represents the formula in A1-style + notation, in the user's language and number-formatting locale. For + example, the English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; + 1,5)" in German. If a cell has no formula, its value is returned instead. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulasLocal?: boolean;' + return: + type: boolean + - name: formulasR1C1 + uid: excel!Excel.Interfaces.RangeCollectionLoadOptions#formulasR1C1:member + package: excel! + fullName: formulasR1C1 + summary: >- + For EACH ITEM in the collection: Represents the formula in R1C1-style + notation. If a cell has no formula, its value is returned instead. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulasR1C1?: boolean;' + return: + type: boolean + - name: hasSpill + uid: excel!Excel.Interfaces.RangeCollectionLoadOptions#hasSpill:member + package: excel! + fullName: hasSpill + summary: >- + For EACH ITEM in the collection: Represents if all cells have a spill + border. Returns `true` if all cells have a spill border, or `false` if all + cells do not have a spill border. Returns `null` if there are cells both + with and without spill borders within the range. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'hasSpill?: boolean;' + return: + type: boolean + - name: height + uid: excel!Excel.Interfaces.RangeCollectionLoadOptions#height:member + package: excel! + fullName: height + summary: >- + For EACH ITEM in the collection: Returns the distance in points, for 100% + zoom, from the top edge of the range to the bottom edge of the range. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height?: boolean;' + return: + type: boolean + - name: hidden + uid: excel!Excel.Interfaces.RangeCollectionLoadOptions#hidden:member + package: excel! + fullName: hidden + summary: >- + For EACH ITEM in the collection: Represents if all cells in the current + range are hidden. Value is `true` when all cells in a range are hidden. + Value is `false` when no cells in the range are hidden. Value is `null` + when some cells in a range are hidden and other cells in the same range + are not hidden. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'hidden?: boolean;' + return: + type: boolean + - name: hyperlink + uid: excel!Excel.Interfaces.RangeCollectionLoadOptions#hyperlink:member + package: excel! + fullName: hyperlink + summary: >- + For EACH ITEM in the collection: Represents the hyperlink for the current + range. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'hyperlink?: boolean;' + return: + type: boolean + - name: isEntireColumn + uid: excel!Excel.Interfaces.RangeCollectionLoadOptions#isEntireColumn:member + package: excel! + fullName: isEntireColumn + summary: >- + For EACH ITEM in the collection: Represents if the current range is an + entire column. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'isEntireColumn?: boolean;' + return: + type: boolean + - name: isEntireRow + uid: excel!Excel.Interfaces.RangeCollectionLoadOptions#isEntireRow:member + package: excel! + fullName: isEntireRow + summary: >- + For EACH ITEM in the collection: Represents if the current range is an + entire row. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'isEntireRow?: boolean;' + return: + type: boolean + - name: left + uid: excel!Excel.Interfaces.RangeCollectionLoadOptions#left:member + package: excel! + fullName: left + summary: >- + For EACH ITEM in the collection: Returns the distance in points, for 100% + zoom, from the left edge of the worksheet to the left edge of the range. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: boolean;' + return: + type: boolean + - name: linkedDataTypeState + uid: >- + excel!Excel.Interfaces.RangeCollectionLoadOptions#linkedDataTypeState:member + package: excel! + fullName: linkedDataTypeState + summary: >- + For EACH ITEM in the collection: Represents the data type state of each + cell. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'linkedDataTypeState?: boolean;' + return: + type: boolean + - name: numberFormat + uid: excel!Excel.Interfaces.RangeCollectionLoadOptions#numberFormat:member + package: excel! + fullName: numberFormat + summary: >- + For EACH ITEM in the collection: Represents Excel's number format code for + the given range. For more information about Excel number formatting, see + [Number format + codes](https://support.microsoft.com/office/5026bbd6-04bc-48cd-bf33-80f18b4eae68). + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat?: boolean;' + return: + type: boolean + - name: numberFormatCategories + uid: >- + excel!Excel.Interfaces.RangeCollectionLoadOptions#numberFormatCategories:member + package: excel! + fullName: numberFormatCategories + summary: >- + For EACH ITEM in the collection: Represents the category of number format + of each cell. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormatCategories?: boolean;' + return: + type: boolean + - name: numberFormatLocal + uid: excel!Excel.Interfaces.RangeCollectionLoadOptions#numberFormatLocal:member + package: excel! + fullName: numberFormatLocal + summary: >- + For EACH ITEM in the collection: Represents Excel's number format code for + the given range, based on the language settings of the user. Excel does + not perform any language or format coercion when getting or setting the + `numberFormatLocal` property. Any returned text uses the locally-formatted + strings based on the language specified in the system settings. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormatLocal?: boolean;' + return: + type: boolean + - name: rowCount + uid: excel!Excel.Interfaces.RangeCollectionLoadOptions#rowCount:member + package: excel! + fullName: rowCount + summary: >- + For EACH ITEM in the collection: Returns the total number of rows in the + range. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rowCount?: boolean;' + return: + type: boolean + - name: rowHidden + uid: excel!Excel.Interfaces.RangeCollectionLoadOptions#rowHidden:member + package: excel! + fullName: rowHidden + summary: >- + For EACH ITEM in the collection: Represents if all rows in the current + range are hidden. Value is `true` when all rows in a range are hidden. + Value is `false` when no rows in the range are hidden. Value is `null` + when some rows in a range are hidden and other rows in the same range are + not hidden. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rowHidden?: boolean;' + return: + type: boolean + - name: rowIndex + uid: excel!Excel.Interfaces.RangeCollectionLoadOptions#rowIndex:member + package: excel! + fullName: rowIndex + summary: >- + For EACH ITEM in the collection: Returns the row number of the first cell + in the range. Zero-indexed. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rowIndex?: boolean;' + return: + type: boolean + - name: savedAsArray + uid: excel!Excel.Interfaces.RangeCollectionLoadOptions#savedAsArray:member + package: excel! + fullName: savedAsArray + summary: >- + For EACH ITEM in the collection: Represents if all the cells would be + saved as an array formula. Returns `true` if all cells would be saved as + an array formula, or `false` if all cells would not be saved as an array + formula. Returns `null` if some cells would be saved as an array formula + and some would not be. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'savedAsArray?: boolean;' + return: + type: boolean + - name: style + uid: excel!Excel.Interfaces.RangeCollectionLoadOptions#style:member + package: excel! + fullName: style + summary: >- + For EACH ITEM in the collection: Represents the style of the current + range. If the styles of the cells are inconsistent, `null` will be + returned. For custom styles, the style name will be returned. For built-in + styles, a string representing a value in the `BuiltInStyle` enum will be + returned. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'style?: boolean;' + return: + type: boolean + - name: text + uid: excel!Excel.Interfaces.RangeCollectionLoadOptions#text:member + package: excel! + fullName: text + summary: >- + For EACH ITEM in the collection: Text values of the specified range. The + text value will not depend on the cell width. The number sign (\#) + substitution that happens in the Excel UI will not affect the text value + returned by the API. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'text?: boolean;' + return: + type: boolean + - name: top + uid: excel!Excel.Interfaces.RangeCollectionLoadOptions#top:member + package: excel! + fullName: top + summary: >- + For EACH ITEM in the collection: Returns the distance in points, for 100% + zoom, from the top edge of the worksheet to the top edge of the range. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: boolean;' + return: + type: boolean + - name: values + uid: excel!Excel.Interfaces.RangeCollectionLoadOptions#values:member + package: excel! + fullName: values + summary: >- + For EACH ITEM in the collection: Represents the raw values of the + specified range. The data returned could be a string, number, or boolean. + Cells that contain an error will return the error string. If the returned + value starts with a plus ("+"), minus ("-"), or equal sign ("="), Excel + interprets this value as a formula. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'values?: boolean;' + return: + type: boolean + - name: valuesAsJson + uid: excel!Excel.Interfaces.RangeCollectionLoadOptions#valuesAsJson:member + package: excel! + fullName: valuesAsJson + summary: >- + For EACH ITEM in the collection: A JSON representation of the values in + the cells in this range. Unlike `Range.values`, + `Range.valuesAsJson` supports all data types which can be in a cell. + Examples include formatted number values and web images, in addition to + the standard boolean, number, and string values. Data returned from this + API always aligns with the en-US locale. To retrieve data in the user's + display locale, use `Range.valuesAsJsonLocal`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJson?: boolean;' + return: + type: boolean + - name: valuesAsJsonLocal + uid: excel!Excel.Interfaces.RangeCollectionLoadOptions#valuesAsJsonLocal:member + package: excel! + fullName: valuesAsJsonLocal + summary: >- + For EACH ITEM in the collection: A JSON representation of the values in + the cells in this range. Unlike `Range.values`, + `Range.valuesAsJsonLocal` supports all data types which can be in a cell. + Examples include formatted number values and web images, in addition to + the standard boolean, number, and string values. Data returned from this + API always aligns with the user's display locale. To retrieve data + independent of locale, use `Range.valuesAsJson`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJsonLocal?: boolean;' + return: + type: boolean + - name: valueTypes + uid: excel!Excel.Interfaces.RangeCollectionLoadOptions#valueTypes:member + package: excel! + fullName: valueTypes + summary: 'For EACH ITEM in the collection: Specifies the type of data in each cell.' + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valueTypes?: boolean;' + return: + type: boolean + - name: width + uid: excel!Excel.Interfaces.RangeCollectionLoadOptions#width:member + package: excel! + fullName: width + summary: >- + For EACH ITEM in the collection: Returns the distance in points, for 100% + zoom, from the left edge of the range to the right edge of the range. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width?: boolean;' + return: + type: boolean + - name: worksheet + uid: excel!Excel.Interfaces.RangeCollectionLoadOptions#worksheet:member + package: excel! + fullName: worksheet + summary: >- + For EACH ITEM in the collection: The worksheet containing the current + range. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheet?: Excel.Interfaces.WorksheetLoadOptions;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangecollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangecollectionupdatedata.yml new file mode 100644 index 0000000000..dbc6eba06e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangecollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.RangeCollectionUpdateData +uid: excel!Excel.Interfaces.RangeCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.RangeCollectionUpdateData +summary: >- + An interface for updating data on the `RangeCollection` object, for use in + `rangeCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.RangeCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.RangeData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangedata.yml new file mode 100644 index 0000000000..894016bc05 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangedata.yml @@ -0,0 +1,642 @@ +### YamlMime:TSType +name: Excel.Interfaces.RangeData +uid: excel!Excel.Interfaces.RangeData:interface +package: excel! +fullName: Excel.Interfaces.RangeData +summary: An interface describing the data returned by calling `range.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: address + uid: excel!Excel.Interfaces.RangeData#address:member + package: excel! + fullName: address + summary: >- + Specifies the range reference in A1-style. Address value contains the + sheet reference (e.g., "Sheet1!A1:B4"). + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'address?: string;' + return: + type: string + - name: addressLocal + uid: excel!Excel.Interfaces.RangeData#addressLocal:member + package: excel! + fullName: addressLocal + summary: >- + Represents the range reference for the specified range in the language of + the user. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'addressLocal?: string;' + return: + type: string + - name: cellCount + uid: excel!Excel.Interfaces.RangeData#cellCount:member + package: excel! + fullName: cellCount + summary: >- + Specifies the number of cells in the range. This API will return -1 if the + cell count exceeds 2^31-1 (2,147,483,647). + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'cellCount?: number;' + return: + type: number + - name: columnCount + uid: excel!Excel.Interfaces.RangeData#columnCount:member + package: excel! + fullName: columnCount + summary: Specifies the total number of columns in the range. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'columnCount?: number;' + return: + type: number + - name: columnHidden + uid: excel!Excel.Interfaces.RangeData#columnHidden:member + package: excel! + fullName: columnHidden + summary: >- + Represents if all columns in the current range are hidden. Value is `true` + when all columns in a range are hidden. Value is `false` when no columns + in the range are hidden. Value is `null` when some columns in a range are + hidden and other columns in the same range are not hidden. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'columnHidden?: boolean;' + return: + type: boolean + - name: columnIndex + uid: excel!Excel.Interfaces.RangeData#columnIndex:member + package: excel! + fullName: columnIndex + summary: Specifies the column number of the first cell in the range. Zero-indexed. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'columnIndex?: number;' + return: + type: number + - name: conditionalFormats + uid: excel!Excel.Interfaces.RangeData#conditionalFormats:member + package: excel! + fullName: conditionalFormats + summary: The collection of `ConditionalFormats` that intersect the range. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'conditionalFormats?: Excel.Interfaces.ConditionalFormatData[];' + return: + type: >- + [] + - name: control + uid: excel!Excel.Interfaces.RangeData#control:member + package: excel! + fullName: control + summary: >- + Accesses the cell control applied to this range. If the range has multiple + cell controls, this returns `EmptyCellControl`. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'control?: CellControl;' + return: + type: + - name: dataValidation + uid: excel!Excel.Interfaces.RangeData#dataValidation:member + package: excel! + fullName: dataValidation + summary: Returns a data validation object. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'dataValidation?: Excel.Interfaces.DataValidationData;' + return: + type: + - name: format + uid: excel!Excel.Interfaces.RangeData#format:member + package: excel! + fullName: format + summary: >- + Returns a format object, encapsulating the range's font, fill, borders, + alignment, and other properties. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.RangeFormatData;' + return: + type: + - name: formulas + uid: excel!Excel.Interfaces.RangeData#formulas:member + package: excel! + fullName: formulas + summary: >- + Represents the formula in A1-style notation. If a cell has no formula, its + value is returned instead. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulas?: any[][];' + return: + type: any[][] + - name: formulasLocal + uid: excel!Excel.Interfaces.RangeData#formulasLocal:member + package: excel! + fullName: formulasLocal + summary: >- + Represents the formula in A1-style notation, in the user's language and + number-formatting locale. For example, the English "=SUM(A1, 1.5)" formula + would become "=SUMME(A1; 1,5)" in German. If a cell has no formula, its + value is returned instead. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulasLocal?: any[][];' + return: + type: any[][] + - name: formulasR1C1 + uid: excel!Excel.Interfaces.RangeData#formulasR1C1:member + package: excel! + fullName: formulasR1C1 + summary: >- + Represents the formula in R1C1-style notation. If a cell has no formula, + its value is returned instead. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulasR1C1?: any[][];' + return: + type: any[][] + - name: hasSpill + uid: excel!Excel.Interfaces.RangeData#hasSpill:member + package: excel! + fullName: hasSpill + summary: >- + Represents if all cells have a spill border. Returns `true` if all cells + have a spill border, or `false` if all cells do not have a spill border. + Returns `null` if there are cells both with and without spill borders + within the range. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'hasSpill?: boolean;' + return: + type: boolean + - name: height + uid: excel!Excel.Interfaces.RangeData#height:member + package: excel! + fullName: height + summary: >- + Returns the distance in points, for 100% zoom, from the top edge of the + range to the bottom edge of the range. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height?: number;' + return: + type: number + - name: hidden + uid: excel!Excel.Interfaces.RangeData#hidden:member + package: excel! + fullName: hidden + summary: >- + Represents if all cells in the current range are hidden. Value is `true` + when all cells in a range are hidden. Value is `false` when no cells in + the range are hidden. Value is `null` when some cells in a range are + hidden and other cells in the same range are not hidden. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'hidden?: boolean;' + return: + type: boolean + - name: hyperlink + uid: excel!Excel.Interfaces.RangeData#hyperlink:member + package: excel! + fullName: hyperlink + summary: Represents the hyperlink for the current range. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'hyperlink?: Excel.RangeHyperlink;' + return: + type: + - name: isEntireColumn + uid: excel!Excel.Interfaces.RangeData#isEntireColumn:member + package: excel! + fullName: isEntireColumn + summary: Represents if the current range is an entire column. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'isEntireColumn?: boolean;' + return: + type: boolean + - name: isEntireRow + uid: excel!Excel.Interfaces.RangeData#isEntireRow:member + package: excel! + fullName: isEntireRow + summary: Represents if the current range is an entire row. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'isEntireRow?: boolean;' + return: + type: boolean + - name: left + uid: excel!Excel.Interfaces.RangeData#left:member + package: excel! + fullName: left + summary: >- + Returns the distance in points, for 100% zoom, from the left edge of the + worksheet to the left edge of the range. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: number;' + return: + type: number + - name: linkedDataTypeState + uid: excel!Excel.Interfaces.RangeData#linkedDataTypeState:member + package: excel! + fullName: linkedDataTypeState + summary: Represents the data type state of each cell. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'linkedDataTypeState?: Excel.LinkedDataTypeState[][];' + return: + type: [][] + - name: numberFormat + uid: excel!Excel.Interfaces.RangeData#numberFormat:member + package: excel! + fullName: numberFormat + summary: >- + Represents Excel's number format code for the given range. For more + information about Excel number formatting, see [Number format + codes](https://support.microsoft.com/office/5026bbd6-04bc-48cd-bf33-80f18b4eae68). + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat?: any[][];' + return: + type: any[][] + - name: numberFormatCategories + uid: excel!Excel.Interfaces.RangeData#numberFormatCategories:member + package: excel! + fullName: numberFormatCategories + summary: Represents the category of number format of each cell. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormatCategories?: Excel.NumberFormatCategory[][];' + return: + type: [][] + - name: numberFormatLocal + uid: excel!Excel.Interfaces.RangeData#numberFormatLocal:member + package: excel! + fullName: numberFormatLocal + summary: >- + Represents Excel's number format code for the given range, based on the + language settings of the user. Excel does not perform any language or + format coercion when getting or setting the `numberFormatLocal` property. + Any returned text uses the locally-formatted strings based on the language + specified in the system settings. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormatLocal?: any[][];' + return: + type: any[][] + - name: rowCount + uid: excel!Excel.Interfaces.RangeData#rowCount:member + package: excel! + fullName: rowCount + summary: Returns the total number of rows in the range. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rowCount?: number;' + return: + type: number + - name: rowHidden + uid: excel!Excel.Interfaces.RangeData#rowHidden:member + package: excel! + fullName: rowHidden + summary: >- + Represents if all rows in the current range are hidden. Value is `true` + when all rows in a range are hidden. Value is `false` when no rows in the + range are hidden. Value is `null` when some rows in a range are hidden and + other rows in the same range are not hidden. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rowHidden?: boolean;' + return: + type: boolean + - name: rowIndex + uid: excel!Excel.Interfaces.RangeData#rowIndex:member + package: excel! + fullName: rowIndex + summary: Returns the row number of the first cell in the range. Zero-indexed. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rowIndex?: number;' + return: + type: number + - name: savedAsArray + uid: excel!Excel.Interfaces.RangeData#savedAsArray:member + package: excel! + fullName: savedAsArray + summary: >- + Represents if all the cells would be saved as an array formula. Returns + `true` if all cells would be saved as an array formula, or `false` if all + cells would not be saved as an array formula. Returns `null` if some cells + would be saved as an array formula and some would not be. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'savedAsArray?: boolean;' + return: + type: boolean + - name: style + uid: excel!Excel.Interfaces.RangeData#style:member + package: excel! + fullName: style + summary: >- + Represents the style of the current range. If the styles of the cells are + inconsistent, `null` will be returned. For custom styles, the style name + will be returned. For built-in styles, a string representing a value in + the `BuiltInStyle` enum will be returned. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'style?: string;' + return: + type: string + - name: text + uid: excel!Excel.Interfaces.RangeData#text:member + package: excel! + fullName: text + summary: >- + Text values of the specified range. The text value will not depend on the + cell width. The number sign (\#) substitution that happens in the Excel UI + will not affect the text value returned by the API. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'text?: string[][];' + return: + type: string[][] + - name: top + uid: excel!Excel.Interfaces.RangeData#top:member + package: excel! + fullName: top + summary: >- + Returns the distance in points, for 100% zoom, from the top edge of the + worksheet to the top edge of the range. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: number;' + return: + type: number + - name: values + uid: excel!Excel.Interfaces.RangeData#values:member + package: excel! + fullName: values + summary: >- + Represents the raw values of the specified range. The data returned could + be a string, number, or boolean. Cells that contain an error will return + the error string. If the returned value starts with a plus ("+"), minus + ("-"), or equal sign ("="), Excel interprets this value as a formula. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'values?: any[][];' + return: + type: any[][] + - name: valuesAsJson + uid: excel!Excel.Interfaces.RangeData#valuesAsJson:member + package: excel! + fullName: valuesAsJson + summary: >- + A JSON representation of the values in the cells in this range. Unlike + `Range.values`, `Range.valuesAsJson` supports all data types which + can be in a cell. Examples include formatted number values and web images, + in addition to the standard boolean, number, and string values. Data + returned from this API always aligns with the en-US locale. To retrieve + data in the user's display locale, use `Range.valuesAsJsonLocal`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJson?: CellValue[][];' + return: + type: [][] + - name: valuesAsJsonLocal + uid: excel!Excel.Interfaces.RangeData#valuesAsJsonLocal:member + package: excel! + fullName: valuesAsJsonLocal + summary: >- + A JSON representation of the values in the cells in this range. Unlike + `Range.values`, `Range.valuesAsJsonLocal` supports all data types + which can be in a cell. Examples include formatted number values and web + images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the user's display locale. + To retrieve data independent of locale, use `Range.valuesAsJson`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJsonLocal?: CellValue[][];' + return: + type: [][] + - name: valueTypes + uid: excel!Excel.Interfaces.RangeData#valueTypes:member + package: excel! + fullName: valueTypes + summary: Specifies the type of data in each cell. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valueTypes?: Excel.RangeValueType[][];' + return: + type: [][] + - name: width + uid: excel!Excel.Interfaces.RangeData#width:member + package: excel! + fullName: width + summary: >- + Returns the distance in points, for 100% zoom, from the left edge of the + range to the right edge of the range. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangefilldata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangefilldata.yml new file mode 100644 index 0000000000..1dcb16f55d --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangefilldata.yml @@ -0,0 +1,114 @@ +### YamlMime:TSType +name: Excel.Interfaces.RangeFillData +uid: excel!Excel.Interfaces.RangeFillData:interface +package: excel! +fullName: Excel.Interfaces.RangeFillData +summary: >- + An interface describing the data returned by calling `rangeFill.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: color + uid: excel!Excel.Interfaces.RangeFillData#color:member + package: excel! + fullName: color + summary: >- + HTML color code representing the color of the background, in the form + \#RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange") + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: string;' + return: + type: string + - name: pattern + uid: excel!Excel.Interfaces.RangeFillData#pattern:member + package: excel! + fullName: pattern + summary: >- + The pattern of a range. See `Excel.FillPattern` for details. + LinearGradient and RectangularGradient are not supported. A `null` value + indicates that the entire range doesn't have a uniform pattern setting. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + pattern?: Excel.FillPattern | "None" | "Solid" | "Gray50" | "Gray75" | + "Gray25" | "Horizontal" | "Vertical" | "Down" | "Up" | "Checker" | + "SemiGray75" | "LightHorizontal" | "LightVertical" | "LightDown" | + "LightUp" | "Grid" | "CrissCross" | "Gray16" | "Gray8" | + "LinearGradient" | "RectangularGradient"; + return: + type: >- + | "None" | "Solid" | + "Gray50" | "Gray75" | "Gray25" | "Horizontal" | "Vertical" | "Down" | + "Up" | "Checker" | "SemiGray75" | "LightHorizontal" | "LightVertical" + | "LightDown" | "LightUp" | "Grid" | "CrissCross" | "Gray16" | "Gray8" + | "LinearGradient" | "RectangularGradient" + - name: patternColor + uid: excel!Excel.Interfaces.RangeFillData#patternColor:member + package: excel! + fullName: patternColor + summary: >- + The HTML color code representing the color of the range pattern, in the + form \#RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange"). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'patternColor?: string;' + return: + type: string + - name: patternTintAndShade + uid: excel!Excel.Interfaces.RangeFillData#patternTintAndShade:member + package: excel! + fullName: patternTintAndShade + summary: >- + Specifies a double that lightens or darkens a pattern color for the range + fill. The value is between -1 (darkest) and 1 (brightest), with 0 for the + original color. A `null` value indicates that the range doesn't have + uniform `patternTintAndShade` settings. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'patternTintAndShade?: number;' + return: + type: number + - name: tintAndShade + uid: excel!Excel.Interfaces.RangeFillData#tintAndShade:member + package: excel! + fullName: tintAndShade + summary: >- + Specifies a double that lightens or darkens a color for the range fill. + The value is between -1 (darkest) and 1 (brightest), with 0 for the + original color. A `null` value indicates that the range doesn't have + uniform `tintAndShade` settings. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tintAndShade?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangefillloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangefillloadoptions.yml new file mode 100644 index 0000000000..f749ae3937 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangefillloadoptions.yml @@ -0,0 +1,120 @@ +### YamlMime:TSType +name: Excel.Interfaces.RangeFillLoadOptions +uid: excel!Excel.Interfaces.RangeFillLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.RangeFillLoadOptions +summary: Represents the background of a range object. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.RangeFillLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: color + uid: excel!Excel.Interfaces.RangeFillLoadOptions#color:member + package: excel! + fullName: color + summary: >- + HTML color code representing the color of the background, in the form + \#RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange") + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: boolean;' + return: + type: boolean + - name: pattern + uid: excel!Excel.Interfaces.RangeFillLoadOptions#pattern:member + package: excel! + fullName: pattern + summary: >- + The pattern of a range. See `Excel.FillPattern` for details. + LinearGradient and RectangularGradient are not supported. A `null` value + indicates that the entire range doesn't have a uniform pattern setting. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'pattern?: boolean;' + return: + type: boolean + - name: patternColor + uid: excel!Excel.Interfaces.RangeFillLoadOptions#patternColor:member + package: excel! + fullName: patternColor + summary: >- + The HTML color code representing the color of the range pattern, in the + form \#RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange"). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'patternColor?: boolean;' + return: + type: boolean + - name: patternTintAndShade + uid: excel!Excel.Interfaces.RangeFillLoadOptions#patternTintAndShade:member + package: excel! + fullName: patternTintAndShade + summary: >- + Specifies a double that lightens or darkens a pattern color for the range + fill. The value is between -1 (darkest) and 1 (brightest), with 0 for the + original color. A `null` value indicates that the range doesn't have + uniform `patternTintAndShade` settings. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'patternTintAndShade?: boolean;' + return: + type: boolean + - name: tintAndShade + uid: excel!Excel.Interfaces.RangeFillLoadOptions#tintAndShade:member + package: excel! + fullName: tintAndShade + summary: >- + Specifies a double that lightens or darkens a color for the range fill. + The value is between -1 (darkest) and 1 (brightest), with 0 for the + original color. A `null` value indicates that the range doesn't have + uniform `tintAndShade` settings. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tintAndShade?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangefillupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangefillupdatedata.yml new file mode 100644 index 0000000000..ebebb7a0e1 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangefillupdatedata.yml @@ -0,0 +1,114 @@ +### YamlMime:TSType +name: Excel.Interfaces.RangeFillUpdateData +uid: excel!Excel.Interfaces.RangeFillUpdateData:interface +package: excel! +fullName: Excel.Interfaces.RangeFillUpdateData +summary: >- + An interface for updating data on the `RangeFill` object, for use in + `rangeFill.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: color + uid: excel!Excel.Interfaces.RangeFillUpdateData#color:member + package: excel! + fullName: color + summary: >- + HTML color code representing the color of the background, in the form + \#RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange") + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: string;' + return: + type: string + - name: pattern + uid: excel!Excel.Interfaces.RangeFillUpdateData#pattern:member + package: excel! + fullName: pattern + summary: >- + The pattern of a range. See `Excel.FillPattern` for details. + LinearGradient and RectangularGradient are not supported. A `null` value + indicates that the entire range doesn't have a uniform pattern setting. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + pattern?: Excel.FillPattern | "None" | "Solid" | "Gray50" | "Gray75" | + "Gray25" | "Horizontal" | "Vertical" | "Down" | "Up" | "Checker" | + "SemiGray75" | "LightHorizontal" | "LightVertical" | "LightDown" | + "LightUp" | "Grid" | "CrissCross" | "Gray16" | "Gray8" | + "LinearGradient" | "RectangularGradient"; + return: + type: >- + | "None" | "Solid" | + "Gray50" | "Gray75" | "Gray25" | "Horizontal" | "Vertical" | "Down" | + "Up" | "Checker" | "SemiGray75" | "LightHorizontal" | "LightVertical" + | "LightDown" | "LightUp" | "Grid" | "CrissCross" | "Gray16" | "Gray8" + | "LinearGradient" | "RectangularGradient" + - name: patternColor + uid: excel!Excel.Interfaces.RangeFillUpdateData#patternColor:member + package: excel! + fullName: patternColor + summary: >- + The HTML color code representing the color of the range pattern, in the + form \#RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange"). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'patternColor?: string;' + return: + type: string + - name: patternTintAndShade + uid: excel!Excel.Interfaces.RangeFillUpdateData#patternTintAndShade:member + package: excel! + fullName: patternTintAndShade + summary: >- + Specifies a double that lightens or darkens a pattern color for the range + fill. The value is between -1 (darkest) and 1 (brightest), with 0 for the + original color. A `null` value indicates that the range doesn't have + uniform `patternTintAndShade` settings. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'patternTintAndShade?: number;' + return: + type: number + - name: tintAndShade + uid: excel!Excel.Interfaces.RangeFillUpdateData#tintAndShade:member + package: excel! + fullName: tintAndShade + summary: >- + Specifies a double that lightens or darkens a color for the range fill. + The value is between -1 (darkest) and 1 (brightest), with 0 for the + original color. A `null` value indicates that the range doesn't have + uniform `tintAndShade` settings. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tintAndShade?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangefontdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangefontdata.yml new file mode 100644 index 0000000000..cfa586b840 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangefontdata.yml @@ -0,0 +1,188 @@ +### YamlMime:TSType +name: Excel.Interfaces.RangeFontData +uid: excel!Excel.Interfaces.RangeFontData:interface +package: excel! +fullName: Excel.Interfaces.RangeFontData +summary: >- + An interface describing the data returned by calling `rangeFont.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: bold + uid: excel!Excel.Interfaces.RangeFontData#bold:member + package: excel! + fullName: bold + summary: Represents the bold status of the font. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'bold?: boolean;' + return: + type: boolean + - name: color + uid: excel!Excel.Interfaces.RangeFontData#color:member + package: excel! + fullName: color + summary: >- + HTML color code representation of the text color (e.g., \#FF0000 + represents Red). + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: string;' + return: + type: string + - name: italic + uid: excel!Excel.Interfaces.RangeFontData#italic:member + package: excel! + fullName: italic + summary: Specifies the italic status of the font. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'italic?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.RangeFontData#name:member + package: excel! + fullName: name + summary: >- + Font name (e.g., "Calibri"). The name's length should not be greater than + 31 characters. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: size + uid: excel!Excel.Interfaces.RangeFontData#size:member + package: excel! + fullName: size + summary: Font size. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'size?: number;' + return: + type: number + - name: strikethrough + uid: excel!Excel.Interfaces.RangeFontData#strikethrough:member + package: excel! + fullName: strikethrough + summary: >- + Specifies the strikethrough status of font. A `null` value indicates that + the entire range doesn't have a uniform strikethrough setting. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'strikethrough?: boolean;' + return: + type: boolean + - name: subscript + uid: excel!Excel.Interfaces.RangeFontData#subscript:member + package: excel! + fullName: subscript + summary: >- + Specifies the subscript status of font. Returns `true` if all the fonts of + the range are subscript. Returns `false` if all the fonts of the range are + superscript or normal (neither superscript, nor subscript). Returns `null` + otherwise. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'subscript?: boolean;' + return: + type: boolean + - name: superscript + uid: excel!Excel.Interfaces.RangeFontData#superscript:member + package: excel! + fullName: superscript + summary: >- + Specifies the superscript status of font. Returns `true` if all the fonts + of the range are superscript. Returns `false` if all the fonts of the + range are subscript or normal (neither superscript, nor subscript). + Returns `null` otherwise. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'superscript?: boolean;' + return: + type: boolean + - name: tintAndShade + uid: excel!Excel.Interfaces.RangeFontData#tintAndShade:member + package: excel! + fullName: tintAndShade + summary: >- + Specifies a double that lightens or darkens a color for the range font. + The value is between -1 (darkest) and 1 (brightest), with 0 for the + original color. A `null` value indicates that the entire range doesn't + have a uniform font `tintAndShade` setting. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tintAndShade?: number;' + return: + type: number + - name: underline + uid: excel!Excel.Interfaces.RangeFontData#underline:member + package: excel! + fullName: underline + summary: >- + Type of underline applied to the font. See `Excel.RangeUnderlineStyle` for + details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + underline?: Excel.RangeUnderlineStyle | "None" | "Single" | "Double" | + "SingleAccountant" | "DoubleAccountant"; + return: + type: >- + | "None" | + "Single" | "Double" | "SingleAccountant" | "DoubleAccountant" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangefontloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangefontloadoptions.yml new file mode 100644 index 0000000000..2a4f50319f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangefontloadoptions.yml @@ -0,0 +1,202 @@ +### YamlMime:TSType +name: Excel.Interfaces.RangeFontLoadOptions +uid: excel!Excel.Interfaces.RangeFontLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.RangeFontLoadOptions +summary: >- + This object represents the font attributes (font name, font size, color, etc.) + for an object. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.RangeFontLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: bold + uid: excel!Excel.Interfaces.RangeFontLoadOptions#bold:member + package: excel! + fullName: bold + summary: Represents the bold status of the font. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'bold?: boolean;' + return: + type: boolean + - name: color + uid: excel!Excel.Interfaces.RangeFontLoadOptions#color:member + package: excel! + fullName: color + summary: >- + HTML color code representation of the text color (e.g., \#FF0000 + represents Red). + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: boolean;' + return: + type: boolean + - name: italic + uid: excel!Excel.Interfaces.RangeFontLoadOptions#italic:member + package: excel! + fullName: italic + summary: Specifies the italic status of the font. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'italic?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.RangeFontLoadOptions#name:member + package: excel! + fullName: name + summary: >- + Font name (e.g., "Calibri"). The name's length should not be greater than + 31 characters. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: size + uid: excel!Excel.Interfaces.RangeFontLoadOptions#size:member + package: excel! + fullName: size + summary: Font size. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'size?: boolean;' + return: + type: boolean + - name: strikethrough + uid: excel!Excel.Interfaces.RangeFontLoadOptions#strikethrough:member + package: excel! + fullName: strikethrough + summary: >- + Specifies the strikethrough status of font. A `null` value indicates that + the entire range doesn't have a uniform strikethrough setting. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'strikethrough?: boolean;' + return: + type: boolean + - name: subscript + uid: excel!Excel.Interfaces.RangeFontLoadOptions#subscript:member + package: excel! + fullName: subscript + summary: >- + Specifies the subscript status of font. Returns `true` if all the fonts of + the range are subscript. Returns `false` if all the fonts of the range are + superscript or normal (neither superscript, nor subscript). Returns `null` + otherwise. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'subscript?: boolean;' + return: + type: boolean + - name: superscript + uid: excel!Excel.Interfaces.RangeFontLoadOptions#superscript:member + package: excel! + fullName: superscript + summary: >- + Specifies the superscript status of font. Returns `true` if all the fonts + of the range are superscript. Returns `false` if all the fonts of the + range are subscript or normal (neither superscript, nor subscript). + Returns `null` otherwise. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'superscript?: boolean;' + return: + type: boolean + - name: tintAndShade + uid: excel!Excel.Interfaces.RangeFontLoadOptions#tintAndShade:member + package: excel! + fullName: tintAndShade + summary: >- + Specifies a double that lightens or darkens a color for the range font. + The value is between -1 (darkest) and 1 (brightest), with 0 for the + original color. A `null` value indicates that the entire range doesn't + have a uniform font `tintAndShade` setting. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tintAndShade?: boolean;' + return: + type: boolean + - name: underline + uid: excel!Excel.Interfaces.RangeFontLoadOptions#underline:member + package: excel! + fullName: underline + summary: >- + Type of underline applied to the font. See `Excel.RangeUnderlineStyle` for + details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'underline?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangefontupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangefontupdatedata.yml new file mode 100644 index 0000000000..c44c768c3f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangefontupdatedata.yml @@ -0,0 +1,188 @@ +### YamlMime:TSType +name: Excel.Interfaces.RangeFontUpdateData +uid: excel!Excel.Interfaces.RangeFontUpdateData:interface +package: excel! +fullName: Excel.Interfaces.RangeFontUpdateData +summary: >- + An interface for updating data on the `RangeFont` object, for use in + `rangeFont.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: bold + uid: excel!Excel.Interfaces.RangeFontUpdateData#bold:member + package: excel! + fullName: bold + summary: Represents the bold status of the font. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'bold?: boolean;' + return: + type: boolean + - name: color + uid: excel!Excel.Interfaces.RangeFontUpdateData#color:member + package: excel! + fullName: color + summary: >- + HTML color code representation of the text color (e.g., \#FF0000 + represents Red). + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: string;' + return: + type: string + - name: italic + uid: excel!Excel.Interfaces.RangeFontUpdateData#italic:member + package: excel! + fullName: italic + summary: Specifies the italic status of the font. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'italic?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.RangeFontUpdateData#name:member + package: excel! + fullName: name + summary: >- + Font name (e.g., "Calibri"). The name's length should not be greater than + 31 characters. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: size + uid: excel!Excel.Interfaces.RangeFontUpdateData#size:member + package: excel! + fullName: size + summary: Font size. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'size?: number;' + return: + type: number + - name: strikethrough + uid: excel!Excel.Interfaces.RangeFontUpdateData#strikethrough:member + package: excel! + fullName: strikethrough + summary: >- + Specifies the strikethrough status of font. A `null` value indicates that + the entire range doesn't have a uniform strikethrough setting. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'strikethrough?: boolean;' + return: + type: boolean + - name: subscript + uid: excel!Excel.Interfaces.RangeFontUpdateData#subscript:member + package: excel! + fullName: subscript + summary: >- + Specifies the subscript status of font. Returns `true` if all the fonts of + the range are subscript. Returns `false` if all the fonts of the range are + superscript or normal (neither superscript, nor subscript). Returns `null` + otherwise. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'subscript?: boolean;' + return: + type: boolean + - name: superscript + uid: excel!Excel.Interfaces.RangeFontUpdateData#superscript:member + package: excel! + fullName: superscript + summary: >- + Specifies the superscript status of font. Returns `true` if all the fonts + of the range are superscript. Returns `false` if all the fonts of the + range are subscript or normal (neither superscript, nor subscript). + Returns `null` otherwise. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'superscript?: boolean;' + return: + type: boolean + - name: tintAndShade + uid: excel!Excel.Interfaces.RangeFontUpdateData#tintAndShade:member + package: excel! + fullName: tintAndShade + summary: >- + Specifies a double that lightens or darkens a color for the range font. + The value is between -1 (darkest) and 1 (brightest), with 0 for the + original color. A `null` value indicates that the entire range doesn't + have a uniform font `tintAndShade` setting. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tintAndShade?: number;' + return: + type: number + - name: underline + uid: excel!Excel.Interfaces.RangeFontUpdateData#underline:member + package: excel! + fullName: underline + summary: >- + Type of underline applied to the font. See `Excel.RangeUnderlineStyle` for + details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + underline?: Excel.RangeUnderlineStyle | "None" | "Single" | "Double" | + "SingleAccountant" | "DoubleAccountant"; + return: + type: >- + | "None" | + "Single" | "Double" | "SingleAccountant" | "DoubleAccountant" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeformatdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeformatdata.yml new file mode 100644 index 0000000000..d8c71ddbe4 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeformatdata.yml @@ -0,0 +1,298 @@ +### YamlMime:TSType +name: Excel.Interfaces.RangeFormatData +uid: excel!Excel.Interfaces.RangeFormatData:interface +package: excel! +fullName: Excel.Interfaces.RangeFormatData +summary: >- + An interface describing the data returned by calling + `rangeFormat.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: autoIndent + uid: excel!Excel.Interfaces.RangeFormatData#autoIndent:member + package: excel! + fullName: autoIndent + summary: >- + Specifies if text is automatically indented when text alignment is set to + equal distribution. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'autoIndent?: boolean;' + return: + type: boolean + - name: borders + uid: excel!Excel.Interfaces.RangeFormatData#borders:member + package: excel! + fullName: borders + summary: Collection of border objects that apply to the overall range. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'borders?: Excel.Interfaces.RangeBorderData[];' + return: + type: [] + - name: columnWidth + uid: excel!Excel.Interfaces.RangeFormatData#columnWidth:member + package: excel! + fullName: columnWidth + summary: >- + Specifies the width of all columns within the range. If the column widths + are not uniform, `null` will be returned. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'columnWidth?: number;' + return: + type: number + - name: fill + uid: excel!Excel.Interfaces.RangeFormatData#fill:member + package: excel! + fullName: fill + summary: Returns the fill object defined on the overall range. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'fill?: Excel.Interfaces.RangeFillData;' + return: + type: + - name: font + uid: excel!Excel.Interfaces.RangeFormatData#font:member + package: excel! + fullName: font + summary: Returns the font object defined on the overall range. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.Interfaces.RangeFontData;' + return: + type: + - name: horizontalAlignment + uid: excel!Excel.Interfaces.RangeFormatData#horizontalAlignment:member + package: excel! + fullName: horizontalAlignment + summary: >- + Represents the horizontal alignment for the specified object. See + `Excel.HorizontalAlignment` for details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + horizontalAlignment?: Excel.HorizontalAlignment | "General" | "Left" | + "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | + "Distributed"; + return: + type: >- + | "General" | + "Left" | "Center" | "Right" | "Fill" | "Justify" | + "CenterAcrossSelection" | "Distributed" + - name: indentLevel + uid: excel!Excel.Interfaces.RangeFormatData#indentLevel:member + package: excel! + fullName: indentLevel + summary: An integer from 0 to 250 that indicates the indent level. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'indentLevel?: number;' + return: + type: number + - name: protection + uid: excel!Excel.Interfaces.RangeFormatData#protection:member + package: excel! + fullName: protection + summary: Returns the format protection object for a range. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'protection?: Excel.Interfaces.FormatProtectionData;' + return: + type: + - name: readingOrder + uid: excel!Excel.Interfaces.RangeFormatData#readingOrder:member + package: excel! + fullName: readingOrder + summary: The reading order for the range. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readingOrder?: Excel.ReadingOrder | "Context" | "LeftToRight" | + "RightToLeft"; + return: + type: >- + | "Context" | + "LeftToRight" | "RightToLeft" + - name: rowHeight + uid: excel!Excel.Interfaces.RangeFormatData#rowHeight:member + package: excel! + fullName: rowHeight + summary: >- + The height of all rows in the range. If the row heights are not uniform, + `null` will be returned. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rowHeight?: number;' + return: + type: number + - name: shrinkToFit + uid: excel!Excel.Interfaces.RangeFormatData#shrinkToFit:member + package: excel! + fullName: shrinkToFit + summary: >- + Specifies if text automatically shrinks to fit in the available column + width. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'shrinkToFit?: boolean;' + return: + type: boolean + - name: textOrientation + uid: excel!Excel.Interfaces.RangeFormatData#textOrientation:member + package: excel! + fullName: textOrientation + summary: >- + The text orientation of all the cells within the range. The text + orientation should be an integer either from -90 to 90, or 180 for + vertically-oriented text. If the orientation within a range are not + uniform, then `null` will be returned. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textOrientation?: number;' + return: + type: number + - name: useStandardHeight + uid: excel!Excel.Interfaces.RangeFormatData#useStandardHeight:member + package: excel! + fullName: useStandardHeight + summary: >- + Determines if the row height of the `Range` object equals the standard + height of the sheet. Returns `true` if the row height of the `Range` + object equals the standard height of the sheet. Returns `null` if the + range contains more than one row and the rows aren't all the same height. + Returns `false` otherwise. Note: This property is only intended to be set + to `true`. Setting it to `false` has no effect. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'useStandardHeight?: boolean;' + return: + type: boolean + - name: useStandardWidth + uid: excel!Excel.Interfaces.RangeFormatData#useStandardWidth:member + package: excel! + fullName: useStandardWidth + summary: >- + Specifies if the column width of the `Range` object equals the standard + width of the sheet. Returns `true` if the column width of the `Range` + object equals the standard width of the sheet. Returns `null` if the range + contains more than one column and the columns aren't all the same height. + Returns `false` otherwise. Note: This property is only intended to be set + to `true`. Setting it to `false` has no effect. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'useStandardWidth?: boolean;' + return: + type: boolean + - name: verticalAlignment + uid: excel!Excel.Interfaces.RangeFormatData#verticalAlignment:member + package: excel! + fullName: verticalAlignment + summary: >- + Represents the vertical alignment for the specified object. See + `Excel.VerticalAlignment` for details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + verticalAlignment?: Excel.VerticalAlignment | "Top" | "Center" | + "Bottom" | "Justify" | "Distributed"; + return: + type: >- + | "Top" | "Center" | + "Bottom" | "Justify" | "Distributed" + - name: wrapText + uid: excel!Excel.Interfaces.RangeFormatData#wrapText:member + package: excel! + fullName: wrapText + summary: >- + Specifies if Excel wraps the text in the object. A `null` value indicates + that the entire range doesn't have a uniform wrap setting + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'wrapText?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeformatloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeformatloadoptions.yml new file mode 100644 index 0000000000..ea87b4d4a0 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeformatloadoptions.yml @@ -0,0 +1,307 @@ +### YamlMime:TSType +name: Excel.Interfaces.RangeFormatLoadOptions +uid: excel!Excel.Interfaces.RangeFormatLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.RangeFormatLoadOptions +summary: >- + A format object encapsulating the range's font, fill, borders, alignment, and + other properties. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.RangeFormatLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: autoIndent + uid: excel!Excel.Interfaces.RangeFormatLoadOptions#autoIndent:member + package: excel! + fullName: autoIndent + summary: >- + Specifies if text is automatically indented when text alignment is set to + equal distribution. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'autoIndent?: boolean;' + return: + type: boolean + - name: borders + uid: excel!Excel.Interfaces.RangeFormatLoadOptions#borders:member + package: excel! + fullName: borders + summary: Collection of border objects that apply to the overall range. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'borders?: Excel.Interfaces.RangeBorderCollectionLoadOptions;' + return: + type: >- + + - name: columnWidth + uid: excel!Excel.Interfaces.RangeFormatLoadOptions#columnWidth:member + package: excel! + fullName: columnWidth + summary: >- + Specifies the width of all columns within the range. If the column widths + are not uniform, `null` will be returned. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'columnWidth?: boolean;' + return: + type: boolean + - name: fill + uid: excel!Excel.Interfaces.RangeFormatLoadOptions#fill:member + package: excel! + fullName: fill + summary: Returns the fill object defined on the overall range. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'fill?: Excel.Interfaces.RangeFillLoadOptions;' + return: + type: + - name: font + uid: excel!Excel.Interfaces.RangeFormatLoadOptions#font:member + package: excel! + fullName: font + summary: Returns the font object defined on the overall range. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.Interfaces.RangeFontLoadOptions;' + return: + type: + - name: horizontalAlignment + uid: excel!Excel.Interfaces.RangeFormatLoadOptions#horizontalAlignment:member + package: excel! + fullName: horizontalAlignment + summary: >- + Represents the horizontal alignment for the specified object. See + `Excel.HorizontalAlignment` for details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'horizontalAlignment?: boolean;' + return: + type: boolean + - name: indentLevel + uid: excel!Excel.Interfaces.RangeFormatLoadOptions#indentLevel:member + package: excel! + fullName: indentLevel + summary: An integer from 0 to 250 that indicates the indent level. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'indentLevel?: boolean;' + return: + type: boolean + - name: protection + uid: excel!Excel.Interfaces.RangeFormatLoadOptions#protection:member + package: excel! + fullName: protection + summary: Returns the format protection object for a range. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'protection?: Excel.Interfaces.FormatProtectionLoadOptions;' + return: + type: >- + + - name: readingOrder + uid: excel!Excel.Interfaces.RangeFormatLoadOptions#readingOrder:member + package: excel! + fullName: readingOrder + summary: The reading order for the range. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readingOrder?: boolean;' + return: + type: boolean + - name: rowHeight + uid: excel!Excel.Interfaces.RangeFormatLoadOptions#rowHeight:member + package: excel! + fullName: rowHeight + summary: >- + The height of all rows in the range. If the row heights are not uniform, + `null` will be returned. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rowHeight?: boolean;' + return: + type: boolean + - name: shrinkToFit + uid: excel!Excel.Interfaces.RangeFormatLoadOptions#shrinkToFit:member + package: excel! + fullName: shrinkToFit + summary: >- + Specifies if text automatically shrinks to fit in the available column + width. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'shrinkToFit?: boolean;' + return: + type: boolean + - name: textOrientation + uid: excel!Excel.Interfaces.RangeFormatLoadOptions#textOrientation:member + package: excel! + fullName: textOrientation + summary: >- + The text orientation of all the cells within the range. The text + orientation should be an integer either from -90 to 90, or 180 for + vertically-oriented text. If the orientation within a range are not + uniform, then `null` will be returned. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textOrientation?: boolean;' + return: + type: boolean + - name: useStandardHeight + uid: excel!Excel.Interfaces.RangeFormatLoadOptions#useStandardHeight:member + package: excel! + fullName: useStandardHeight + summary: >- + Determines if the row height of the `Range` object equals the standard + height of the sheet. Returns `true` if the row height of the `Range` + object equals the standard height of the sheet. Returns `null` if the + range contains more than one row and the rows aren't all the same height. + Returns `false` otherwise. Note: This property is only intended to be set + to `true`. Setting it to `false` has no effect. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'useStandardHeight?: boolean;' + return: + type: boolean + - name: useStandardWidth + uid: excel!Excel.Interfaces.RangeFormatLoadOptions#useStandardWidth:member + package: excel! + fullName: useStandardWidth + summary: >- + Specifies if the column width of the `Range` object equals the standard + width of the sheet. Returns `true` if the column width of the `Range` + object equals the standard width of the sheet. Returns `null` if the range + contains more than one column and the columns aren't all the same height. + Returns `false` otherwise. Note: This property is only intended to be set + to `true`. Setting it to `false` has no effect. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'useStandardWidth?: boolean;' + return: + type: boolean + - name: verticalAlignment + uid: excel!Excel.Interfaces.RangeFormatLoadOptions#verticalAlignment:member + package: excel! + fullName: verticalAlignment + summary: >- + Represents the vertical alignment for the specified object. See + `Excel.VerticalAlignment` for details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'verticalAlignment?: boolean;' + return: + type: boolean + - name: wrapText + uid: excel!Excel.Interfaces.RangeFormatLoadOptions#wrapText:member + package: excel! + fullName: wrapText + summary: >- + Specifies if Excel wraps the text in the object. A `null` value indicates + that the entire range doesn't have a uniform wrap setting + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'wrapText?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeformatupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeformatupdatedata.yml new file mode 100644 index 0000000000..c181711027 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeformatupdatedata.yml @@ -0,0 +1,303 @@ +### YamlMime:TSType +name: Excel.Interfaces.RangeFormatUpdateData +uid: excel!Excel.Interfaces.RangeFormatUpdateData:interface +package: excel! +fullName: Excel.Interfaces.RangeFormatUpdateData +summary: >- + An interface for updating data on the `RangeFormat` object, for use in + `rangeFormat.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: autoIndent + uid: excel!Excel.Interfaces.RangeFormatUpdateData#autoIndent:member + package: excel! + fullName: autoIndent + summary: >- + Specifies if text is automatically indented when text alignment is set to + equal distribution. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'autoIndent?: boolean;' + return: + type: boolean + - name: borders + uid: excel!Excel.Interfaces.RangeFormatUpdateData#borders:member + package: excel! + fullName: borders + summary: Collection of border objects that apply to the overall range. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'borders?: Excel.Interfaces.RangeBorderCollectionUpdateData;' + return: + type: >- + + - name: columnWidth + uid: excel!Excel.Interfaces.RangeFormatUpdateData#columnWidth:member + package: excel! + fullName: columnWidth + summary: >- + Specifies the width of all columns within the range. If the column widths + are not uniform, `null` will be returned. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'columnWidth?: number;' + return: + type: number + - name: fill + uid: excel!Excel.Interfaces.RangeFormatUpdateData#fill:member + package: excel! + fullName: fill + summary: Returns the fill object defined on the overall range. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'fill?: Excel.Interfaces.RangeFillUpdateData;' + return: + type: + - name: font + uid: excel!Excel.Interfaces.RangeFormatUpdateData#font:member + package: excel! + fullName: font + summary: Returns the font object defined on the overall range. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.Interfaces.RangeFontUpdateData;' + return: + type: + - name: horizontalAlignment + uid: excel!Excel.Interfaces.RangeFormatUpdateData#horizontalAlignment:member + package: excel! + fullName: horizontalAlignment + summary: >- + Represents the horizontal alignment for the specified object. See + `Excel.HorizontalAlignment` for details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + horizontalAlignment?: Excel.HorizontalAlignment | "General" | "Left" | + "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | + "Distributed"; + return: + type: >- + | "General" | + "Left" | "Center" | "Right" | "Fill" | "Justify" | + "CenterAcrossSelection" | "Distributed" + - name: indentLevel + uid: excel!Excel.Interfaces.RangeFormatUpdateData#indentLevel:member + package: excel! + fullName: indentLevel + summary: An integer from 0 to 250 that indicates the indent level. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'indentLevel?: number;' + return: + type: number + - name: protection + uid: excel!Excel.Interfaces.RangeFormatUpdateData#protection:member + package: excel! + fullName: protection + summary: Returns the format protection object for a range. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'protection?: Excel.Interfaces.FormatProtectionUpdateData;' + return: + type: >- + + - name: readingOrder + uid: excel!Excel.Interfaces.RangeFormatUpdateData#readingOrder:member + package: excel! + fullName: readingOrder + summary: The reading order for the range. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readingOrder?: Excel.ReadingOrder | "Context" | "LeftToRight" | + "RightToLeft"; + return: + type: >- + | "Context" | + "LeftToRight" | "RightToLeft" + - name: rowHeight + uid: excel!Excel.Interfaces.RangeFormatUpdateData#rowHeight:member + package: excel! + fullName: rowHeight + summary: >- + The height of all rows in the range. If the row heights are not uniform, + `null` will be returned. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rowHeight?: number;' + return: + type: number + - name: shrinkToFit + uid: excel!Excel.Interfaces.RangeFormatUpdateData#shrinkToFit:member + package: excel! + fullName: shrinkToFit + summary: >- + Specifies if text automatically shrinks to fit in the available column + width. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'shrinkToFit?: boolean;' + return: + type: boolean + - name: textOrientation + uid: excel!Excel.Interfaces.RangeFormatUpdateData#textOrientation:member + package: excel! + fullName: textOrientation + summary: >- + The text orientation of all the cells within the range. The text + orientation should be an integer either from -90 to 90, or 180 for + vertically-oriented text. If the orientation within a range are not + uniform, then `null` will be returned. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textOrientation?: number;' + return: + type: number + - name: useStandardHeight + uid: excel!Excel.Interfaces.RangeFormatUpdateData#useStandardHeight:member + package: excel! + fullName: useStandardHeight + summary: >- + Determines if the row height of the `Range` object equals the standard + height of the sheet. Returns `true` if the row height of the `Range` + object equals the standard height of the sheet. Returns `null` if the + range contains more than one row and the rows aren't all the same height. + Returns `false` otherwise. Note: This property is only intended to be set + to `true`. Setting it to `false` has no effect. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'useStandardHeight?: boolean;' + return: + type: boolean + - name: useStandardWidth + uid: excel!Excel.Interfaces.RangeFormatUpdateData#useStandardWidth:member + package: excel! + fullName: useStandardWidth + summary: >- + Specifies if the column width of the `Range` object equals the standard + width of the sheet. Returns `true` if the column width of the `Range` + object equals the standard width of the sheet. Returns `null` if the range + contains more than one column and the columns aren't all the same height. + Returns `false` otherwise. Note: This property is only intended to be set + to `true`. Setting it to `false` has no effect. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'useStandardWidth?: boolean;' + return: + type: boolean + - name: verticalAlignment + uid: excel!Excel.Interfaces.RangeFormatUpdateData#verticalAlignment:member + package: excel! + fullName: verticalAlignment + summary: >- + Represents the vertical alignment for the specified object. See + `Excel.VerticalAlignment` for details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + verticalAlignment?: Excel.VerticalAlignment | "Top" | "Center" | + "Bottom" | "Justify" | "Distributed"; + return: + type: >- + | "Top" | "Center" | + "Bottom" | "Justify" | "Distributed" + - name: wrapText + uid: excel!Excel.Interfaces.RangeFormatUpdateData#wrapText:member + package: excel! + fullName: wrapText + summary: >- + Specifies if Excel wraps the text in the object. A `null` value indicates + that the entire range doesn't have a uniform wrap setting + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'wrapText?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeloadoptions.yml new file mode 100644 index 0000000000..aa5461a4a8 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeloadoptions.yml @@ -0,0 +1,665 @@ +### YamlMime:TSType +name: Excel.Interfaces.RangeLoadOptions +uid: excel!Excel.Interfaces.RangeLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.RangeLoadOptions +summary: >- + Range represents a set of one or more contiguous cells such as a cell, a row, + a column, or a block of cells. To learn more about how ranges are used + throughout the API, start with [Ranges in the Excel JavaScript + API](https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-core-concepts#ranges). +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.RangeLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: address + uid: excel!Excel.Interfaces.RangeLoadOptions#address:member + package: excel! + fullName: address + summary: >- + Specifies the range reference in A1-style. Address value contains the + sheet reference (e.g., "Sheet1!A1:B4"). + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'address?: boolean;' + return: + type: boolean + - name: addressLocal + uid: excel!Excel.Interfaces.RangeLoadOptions#addressLocal:member + package: excel! + fullName: addressLocal + summary: >- + Represents the range reference for the specified range in the language of + the user. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'addressLocal?: boolean;' + return: + type: boolean + - name: cellCount + uid: excel!Excel.Interfaces.RangeLoadOptions#cellCount:member + package: excel! + fullName: cellCount + summary: >- + Specifies the number of cells in the range. This API will return -1 if the + cell count exceeds 2^31-1 (2,147,483,647). + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'cellCount?: boolean;' + return: + type: boolean + - name: columnCount + uid: excel!Excel.Interfaces.RangeLoadOptions#columnCount:member + package: excel! + fullName: columnCount + summary: Specifies the total number of columns in the range. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'columnCount?: boolean;' + return: + type: boolean + - name: columnHidden + uid: excel!Excel.Interfaces.RangeLoadOptions#columnHidden:member + package: excel! + fullName: columnHidden + summary: >- + Represents if all columns in the current range are hidden. Value is `true` + when all columns in a range are hidden. Value is `false` when no columns + in the range are hidden. Value is `null` when some columns in a range are + hidden and other columns in the same range are not hidden. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'columnHidden?: boolean;' + return: + type: boolean + - name: columnIndex + uid: excel!Excel.Interfaces.RangeLoadOptions#columnIndex:member + package: excel! + fullName: columnIndex + summary: Specifies the column number of the first cell in the range. Zero-indexed. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'columnIndex?: boolean;' + return: + type: boolean + - name: control + uid: excel!Excel.Interfaces.RangeLoadOptions#control:member + package: excel! + fullName: control + summary: >- + Accesses the cell control applied to this range. If the range has multiple + cell controls, this returns `EmptyCellControl`. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'control?: boolean;' + return: + type: boolean + - name: dataValidation + uid: excel!Excel.Interfaces.RangeLoadOptions#dataValidation:member + package: excel! + fullName: dataValidation + summary: Returns a data validation object. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'dataValidation?: Excel.Interfaces.DataValidationLoadOptions;' + return: + type: >- + + - name: format + uid: excel!Excel.Interfaces.RangeLoadOptions#format:member + package: excel! + fullName: format + summary: >- + Returns a format object, encapsulating the range's font, fill, borders, + alignment, and other properties. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.RangeFormatLoadOptions;' + return: + type: + - name: formulas + uid: excel!Excel.Interfaces.RangeLoadOptions#formulas:member + package: excel! + fullName: formulas + summary: >- + Represents the formula in A1-style notation. If a cell has no formula, its + value is returned instead. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulas?: boolean;' + return: + type: boolean + - name: formulasLocal + uid: excel!Excel.Interfaces.RangeLoadOptions#formulasLocal:member + package: excel! + fullName: formulasLocal + summary: >- + Represents the formula in A1-style notation, in the user's language and + number-formatting locale. For example, the English "=SUM(A1, 1.5)" formula + would become "=SUMME(A1; 1,5)" in German. If a cell has no formula, its + value is returned instead. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulasLocal?: boolean;' + return: + type: boolean + - name: formulasR1C1 + uid: excel!Excel.Interfaces.RangeLoadOptions#formulasR1C1:member + package: excel! + fullName: formulasR1C1 + summary: >- + Represents the formula in R1C1-style notation. If a cell has no formula, + its value is returned instead. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulasR1C1?: boolean;' + return: + type: boolean + - name: hasSpill + uid: excel!Excel.Interfaces.RangeLoadOptions#hasSpill:member + package: excel! + fullName: hasSpill + summary: >- + Represents if all cells have a spill border. Returns `true` if all cells + have a spill border, or `false` if all cells do not have a spill border. + Returns `null` if there are cells both with and without spill borders + within the range. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'hasSpill?: boolean;' + return: + type: boolean + - name: height + uid: excel!Excel.Interfaces.RangeLoadOptions#height:member + package: excel! + fullName: height + summary: >- + Returns the distance in points, for 100% zoom, from the top edge of the + range to the bottom edge of the range. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height?: boolean;' + return: + type: boolean + - name: hidden + uid: excel!Excel.Interfaces.RangeLoadOptions#hidden:member + package: excel! + fullName: hidden + summary: >- + Represents if all cells in the current range are hidden. Value is `true` + when all cells in a range are hidden. Value is `false` when no cells in + the range are hidden. Value is `null` when some cells in a range are + hidden and other cells in the same range are not hidden. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'hidden?: boolean;' + return: + type: boolean + - name: hyperlink + uid: excel!Excel.Interfaces.RangeLoadOptions#hyperlink:member + package: excel! + fullName: hyperlink + summary: Represents the hyperlink for the current range. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'hyperlink?: boolean;' + return: + type: boolean + - name: isEntireColumn + uid: excel!Excel.Interfaces.RangeLoadOptions#isEntireColumn:member + package: excel! + fullName: isEntireColumn + summary: Represents if the current range is an entire column. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'isEntireColumn?: boolean;' + return: + type: boolean + - name: isEntireRow + uid: excel!Excel.Interfaces.RangeLoadOptions#isEntireRow:member + package: excel! + fullName: isEntireRow + summary: Represents if the current range is an entire row. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'isEntireRow?: boolean;' + return: + type: boolean + - name: left + uid: excel!Excel.Interfaces.RangeLoadOptions#left:member + package: excel! + fullName: left + summary: >- + Returns the distance in points, for 100% zoom, from the left edge of the + worksheet to the left edge of the range. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: boolean;' + return: + type: boolean + - name: linkedDataTypeState + uid: excel!Excel.Interfaces.RangeLoadOptions#linkedDataTypeState:member + package: excel! + fullName: linkedDataTypeState + summary: Represents the data type state of each cell. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'linkedDataTypeState?: boolean;' + return: + type: boolean + - name: numberFormat + uid: excel!Excel.Interfaces.RangeLoadOptions#numberFormat:member + package: excel! + fullName: numberFormat + summary: >- + Represents Excel's number format code for the given range. For more + information about Excel number formatting, see [Number format + codes](https://support.microsoft.com/office/5026bbd6-04bc-48cd-bf33-80f18b4eae68). + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat?: boolean;' + return: + type: boolean + - name: numberFormatCategories + uid: excel!Excel.Interfaces.RangeLoadOptions#numberFormatCategories:member + package: excel! + fullName: numberFormatCategories + summary: Represents the category of number format of each cell. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormatCategories?: boolean;' + return: + type: boolean + - name: numberFormatLocal + uid: excel!Excel.Interfaces.RangeLoadOptions#numberFormatLocal:member + package: excel! + fullName: numberFormatLocal + summary: >- + Represents Excel's number format code for the given range, based on the + language settings of the user. Excel does not perform any language or + format coercion when getting or setting the `numberFormatLocal` property. + Any returned text uses the locally-formatted strings based on the language + specified in the system settings. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormatLocal?: boolean;' + return: + type: boolean + - name: rowCount + uid: excel!Excel.Interfaces.RangeLoadOptions#rowCount:member + package: excel! + fullName: rowCount + summary: Returns the total number of rows in the range. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rowCount?: boolean;' + return: + type: boolean + - name: rowHidden + uid: excel!Excel.Interfaces.RangeLoadOptions#rowHidden:member + package: excel! + fullName: rowHidden + summary: >- + Represents if all rows in the current range are hidden. Value is `true` + when all rows in a range are hidden. Value is `false` when no rows in the + range are hidden. Value is `null` when some rows in a range are hidden and + other rows in the same range are not hidden. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rowHidden?: boolean;' + return: + type: boolean + - name: rowIndex + uid: excel!Excel.Interfaces.RangeLoadOptions#rowIndex:member + package: excel! + fullName: rowIndex + summary: Returns the row number of the first cell in the range. Zero-indexed. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rowIndex?: boolean;' + return: + type: boolean + - name: savedAsArray + uid: excel!Excel.Interfaces.RangeLoadOptions#savedAsArray:member + package: excel! + fullName: savedAsArray + summary: >- + Represents if all the cells would be saved as an array formula. Returns + `true` if all cells would be saved as an array formula, or `false` if all + cells would not be saved as an array formula. Returns `null` if some cells + would be saved as an array formula and some would not be. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'savedAsArray?: boolean;' + return: + type: boolean + - name: style + uid: excel!Excel.Interfaces.RangeLoadOptions#style:member + package: excel! + fullName: style + summary: >- + Represents the style of the current range. If the styles of the cells are + inconsistent, `null` will be returned. For custom styles, the style name + will be returned. For built-in styles, a string representing a value in + the `BuiltInStyle` enum will be returned. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'style?: boolean;' + return: + type: boolean + - name: text + uid: excel!Excel.Interfaces.RangeLoadOptions#text:member + package: excel! + fullName: text + summary: >- + Text values of the specified range. The text value will not depend on the + cell width. The number sign (\#) substitution that happens in the Excel UI + will not affect the text value returned by the API. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'text?: boolean;' + return: + type: boolean + - name: top + uid: excel!Excel.Interfaces.RangeLoadOptions#top:member + package: excel! + fullName: top + summary: >- + Returns the distance in points, for 100% zoom, from the top edge of the + worksheet to the top edge of the range. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: boolean;' + return: + type: boolean + - name: values + uid: excel!Excel.Interfaces.RangeLoadOptions#values:member + package: excel! + fullName: values + summary: >- + Represents the raw values of the specified range. The data returned could + be a string, number, or boolean. Cells that contain an error will return + the error string. If the returned value starts with a plus ("+"), minus + ("-"), or equal sign ("="), Excel interprets this value as a formula. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'values?: boolean;' + return: + type: boolean + - name: valuesAsJson + uid: excel!Excel.Interfaces.RangeLoadOptions#valuesAsJson:member + package: excel! + fullName: valuesAsJson + summary: >- + A JSON representation of the values in the cells in this range. Unlike + `Range.values`, `Range.valuesAsJson` supports all data types which + can be in a cell. Examples include formatted number values and web images, + in addition to the standard boolean, number, and string values. Data + returned from this API always aligns with the en-US locale. To retrieve + data in the user's display locale, use `Range.valuesAsJsonLocal`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJson?: boolean;' + return: + type: boolean + - name: valuesAsJsonLocal + uid: excel!Excel.Interfaces.RangeLoadOptions#valuesAsJsonLocal:member + package: excel! + fullName: valuesAsJsonLocal + summary: >- + A JSON representation of the values in the cells in this range. Unlike + `Range.values`, `Range.valuesAsJsonLocal` supports all data types + which can be in a cell. Examples include formatted number values and web + images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the user's display locale. + To retrieve data independent of locale, use `Range.valuesAsJson`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJsonLocal?: boolean;' + return: + type: boolean + - name: valueTypes + uid: excel!Excel.Interfaces.RangeLoadOptions#valueTypes:member + package: excel! + fullName: valueTypes + summary: Specifies the type of data in each cell. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valueTypes?: boolean;' + return: + type: boolean + - name: width + uid: excel!Excel.Interfaces.RangeLoadOptions#width:member + package: excel! + fullName: width + summary: >- + Returns the distance in points, for 100% zoom, from the left edge of the + range to the right edge of the range. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width?: boolean;' + return: + type: boolean + - name: worksheet + uid: excel!Excel.Interfaces.RangeLoadOptions#worksheet:member + package: excel! + fullName: worksheet + summary: The worksheet containing the current range. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheet?: Excel.Interfaces.WorksheetLoadOptions;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeupdatedata.yml new file mode 100644 index 0000000000..e1ac04be4f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeupdatedata.yml @@ -0,0 +1,293 @@ +### YamlMime:TSType +name: Excel.Interfaces.RangeUpdateData +uid: excel!Excel.Interfaces.RangeUpdateData:interface +package: excel! +fullName: Excel.Interfaces.RangeUpdateData +summary: >- + An interface for updating data on the `Range` object, for use in `range.set({ + ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: columnHidden + uid: excel!Excel.Interfaces.RangeUpdateData#columnHidden:member + package: excel! + fullName: columnHidden + summary: >- + Represents if all columns in the current range are hidden. Value is `true` + when all columns in a range are hidden. Value is `false` when no columns + in the range are hidden. Value is `null` when some columns in a range are + hidden and other columns in the same range are not hidden. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'columnHidden?: boolean;' + return: + type: boolean + - name: control + uid: excel!Excel.Interfaces.RangeUpdateData#control:member + package: excel! + fullName: control + summary: >- + Accesses the cell control applied to this range. If the range has multiple + cell controls, this returns `EmptyCellControl`. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'control?: CellControl;' + return: + type: + - name: dataValidation + uid: excel!Excel.Interfaces.RangeUpdateData#dataValidation:member + package: excel! + fullName: dataValidation + summary: Returns a data validation object. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'dataValidation?: Excel.Interfaces.DataValidationUpdateData;' + return: + type: >- + + - name: format + uid: excel!Excel.Interfaces.RangeUpdateData#format:member + package: excel! + fullName: format + summary: >- + Returns a format object, encapsulating the range's font, fill, borders, + alignment, and other properties. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.RangeFormatUpdateData;' + return: + type: + - name: formulas + uid: excel!Excel.Interfaces.RangeUpdateData#formulas:member + package: excel! + fullName: formulas + summary: >- + Represents the formula in A1-style notation. If a cell has no formula, its + value is returned instead. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulas?: any[][];' + return: + type: any[][] + - name: formulasLocal + uid: excel!Excel.Interfaces.RangeUpdateData#formulasLocal:member + package: excel! + fullName: formulasLocal + summary: >- + Represents the formula in A1-style notation, in the user's language and + number-formatting locale. For example, the English "=SUM(A1, 1.5)" formula + would become "=SUMME(A1; 1,5)" in German. If a cell has no formula, its + value is returned instead. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulasLocal?: any[][];' + return: + type: any[][] + - name: formulasR1C1 + uid: excel!Excel.Interfaces.RangeUpdateData#formulasR1C1:member + package: excel! + fullName: formulasR1C1 + summary: >- + Represents the formula in R1C1-style notation. If a cell has no formula, + its value is returned instead. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulasR1C1?: any[][];' + return: + type: any[][] + - name: hyperlink + uid: excel!Excel.Interfaces.RangeUpdateData#hyperlink:member + package: excel! + fullName: hyperlink + summary: Represents the hyperlink for the current range. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'hyperlink?: Excel.RangeHyperlink;' + return: + type: + - name: numberFormat + uid: excel!Excel.Interfaces.RangeUpdateData#numberFormat:member + package: excel! + fullName: numberFormat + summary: >- + Represents Excel's number format code for the given range. For more + information about Excel number formatting, see [Number format + codes](https://support.microsoft.com/office/5026bbd6-04bc-48cd-bf33-80f18b4eae68). + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat?: any[][];' + return: + type: any[][] + - name: numberFormatLocal + uid: excel!Excel.Interfaces.RangeUpdateData#numberFormatLocal:member + package: excel! + fullName: numberFormatLocal + summary: >- + Represents Excel's number format code for the given range, based on the + language settings of the user. Excel does not perform any language or + format coercion when getting or setting the `numberFormatLocal` property. + Any returned text uses the locally-formatted strings based on the language + specified in the system settings. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormatLocal?: any[][];' + return: + type: any[][] + - name: rowHidden + uid: excel!Excel.Interfaces.RangeUpdateData#rowHidden:member + package: excel! + fullName: rowHidden + summary: >- + Represents if all rows in the current range are hidden. Value is `true` + when all rows in a range are hidden. Value is `false` when no rows in the + range are hidden. Value is `null` when some rows in a range are hidden and + other rows in the same range are not hidden. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rowHidden?: boolean;' + return: + type: boolean + - name: style + uid: excel!Excel.Interfaces.RangeUpdateData#style:member + package: excel! + fullName: style + summary: >- + Represents the style of the current range. If the styles of the cells are + inconsistent, `null` will be returned. For custom styles, the style name + will be returned. For built-in styles, a string representing a value in + the `BuiltInStyle` enum will be returned. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'style?: string;' + return: + type: string + - name: values + uid: excel!Excel.Interfaces.RangeUpdateData#values:member + package: excel! + fullName: values + summary: >- + Represents the raw values of the specified range. The data returned could + be a string, number, or boolean. Cells that contain an error will return + the error string. If the returned value starts with a plus ("+"), minus + ("-"), or equal sign ("="), Excel interprets this value as a formula. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'values?: any[][];' + return: + type: any[][] + - name: valuesAsJson + uid: excel!Excel.Interfaces.RangeUpdateData#valuesAsJson:member + package: excel! + fullName: valuesAsJson + summary: >- + A JSON representation of the values in the cells in this range. Unlike + `Range.values`, `Range.valuesAsJson` supports all data types which + can be in a cell. Examples include formatted number values and web images, + in addition to the standard boolean, number, and string values. Data + returned from this API always aligns with the en-US locale. To retrieve + data in the user's display locale, use `Range.valuesAsJsonLocal`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJson?: CellValue[][];' + return: + type: [][] + - name: valuesAsJsonLocal + uid: excel!Excel.Interfaces.RangeUpdateData#valuesAsJsonLocal:member + package: excel! + fullName: valuesAsJsonLocal + summary: >- + A JSON representation of the values in the cells in this range. Unlike + `Range.values`, `Range.valuesAsJsonLocal` supports all data types + which can be in a cell. Examples include formatted number values and web + images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the user's display locale. + To retrieve data independent of locale, use `Range.valuesAsJson`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJsonLocal?: CellValue[][];' + return: + type: [][] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeviewcollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeviewcollectiondata.yml new file mode 100644 index 0000000000..e9030fab6c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeviewcollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.RangeViewCollectionData +uid: excel!Excel.Interfaces.RangeViewCollectionData:interface +package: excel! +fullName: Excel.Interfaces.RangeViewCollectionData +summary: >- + An interface describing the data returned by calling + `rangeViewCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.RangeViewCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.RangeViewData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeviewcollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeviewcollectionloadoptions.yml new file mode 100644 index 0000000000..a2e3f16c46 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeviewcollectionloadoptions.yml @@ -0,0 +1,263 @@ +### YamlMime:TSType +name: Excel.Interfaces.RangeViewCollectionLoadOptions +uid: excel!Excel.Interfaces.RangeViewCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.RangeViewCollectionLoadOptions +summary: Represents a collection of `RangeView` objects. +remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.RangeViewCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: cellAddresses + uid: excel!Excel.Interfaces.RangeViewCollectionLoadOptions#cellAddresses:member + package: excel! + fullName: cellAddresses + summary: >- + For EACH ITEM in the collection: Represents the cell addresses of the + `RangeView`. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'cellAddresses?: boolean;' + return: + type: boolean + - name: columnCount + uid: excel!Excel.Interfaces.RangeViewCollectionLoadOptions#columnCount:member + package: excel! + fullName: columnCount + summary: 'For EACH ITEM in the collection: The number of visible columns.' + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'columnCount?: boolean;' + return: + type: boolean + - name: formulas + uid: excel!Excel.Interfaces.RangeViewCollectionLoadOptions#formulas:member + package: excel! + fullName: formulas + summary: >- + For EACH ITEM in the collection: Represents the formula in A1-style + notation. If a cell has no formula, its value is returned instead. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulas?: boolean;' + return: + type: boolean + - name: formulasLocal + uid: excel!Excel.Interfaces.RangeViewCollectionLoadOptions#formulasLocal:member + package: excel! + fullName: formulasLocal + summary: >- + For EACH ITEM in the collection: Represents the formula in A1-style + notation, in the user's language and number-formatting locale. For + example, the English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; + 1,5)" in German. If a cell has no formula, its value is returned instead. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulasLocal?: boolean;' + return: + type: boolean + - name: formulasR1C1 + uid: excel!Excel.Interfaces.RangeViewCollectionLoadOptions#formulasR1C1:member + package: excel! + fullName: formulasR1C1 + summary: >- + For EACH ITEM in the collection: Represents the formula in R1C1-style + notation. If a cell has no formula, its value is returned instead. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulasR1C1?: boolean;' + return: + type: boolean + - name: index + uid: excel!Excel.Interfaces.RangeViewCollectionLoadOptions#index:member + package: excel! + fullName: index + summary: >- + For EACH ITEM in the collection: Returns a value that represents the index + of the `RangeView`. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'index?: boolean;' + return: + type: boolean + - name: numberFormat + uid: excel!Excel.Interfaces.RangeViewCollectionLoadOptions#numberFormat:member + package: excel! + fullName: numberFormat + summary: >- + For EACH ITEM in the collection: Represents Excel's number format code for + the given cell. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat?: boolean;' + return: + type: boolean + - name: rowCount + uid: excel!Excel.Interfaces.RangeViewCollectionLoadOptions#rowCount:member + package: excel! + fullName: rowCount + summary: 'For EACH ITEM in the collection: The number of visible rows.' + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rowCount?: boolean;' + return: + type: boolean + - name: text + uid: excel!Excel.Interfaces.RangeViewCollectionLoadOptions#text:member + package: excel! + fullName: text + summary: >- + For EACH ITEM in the collection: Text values of the specified range. The + text value will not depend on the cell width. The \# sign substitution + that happens in Excel UI will not affect the text value returned by the + API. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'text?: boolean;' + return: + type: boolean + - name: values + uid: excel!Excel.Interfaces.RangeViewCollectionLoadOptions#values:member + package: excel! + fullName: values + summary: >- + For EACH ITEM in the collection: Represents the raw values of the + specified range view. The data returned could be of type string, number, + or a boolean. Cells that contain an error will return the error string. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'values?: boolean;' + return: + type: boolean + - name: valuesAsJson + uid: excel!Excel.Interfaces.RangeViewCollectionLoadOptions#valuesAsJson:member + package: excel! + fullName: valuesAsJson + summary: >- + For EACH ITEM in the collection: A JSON representation of the values in + the cells in this range. Unlike `RangeView.values`, + `RangeView.valuesAsJson` supports all data types which can be in a cell. + Examples include formatted number values and web images, in addition to + the standard boolean, number, and string values. Data returned from this + API always aligns with the en-US locale. To retrieve data in the user's + display locale, use `RangeView.valuesAsJsonLocal`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJson?: boolean;' + return: + type: boolean + - name: valuesAsJsonLocal + uid: >- + excel!Excel.Interfaces.RangeViewCollectionLoadOptions#valuesAsJsonLocal:member + package: excel! + fullName: valuesAsJsonLocal + summary: >- + For EACH ITEM in the collection: A JSON representation of the values in + the cells in this range. Unlike `RangeView.values`, + `RangeView.valuesAsJsonLocal` supports all data types which can be in a + cell. Examples include formatted number values and web images, in addition + to the standard boolean, number, and string values. Data returned from + this API always aligns with the user's display locale. To retrieve data + independent of locale, use `RangeView.valuesAsJson`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJsonLocal?: boolean;' + return: + type: boolean + - name: valueTypes + uid: excel!Excel.Interfaces.RangeViewCollectionLoadOptions#valueTypes:member + package: excel! + fullName: valueTypes + summary: 'For EACH ITEM in the collection: Represents the type of data of each cell.' + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valueTypes?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeviewcollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeviewcollectionupdatedata.yml new file mode 100644 index 0000000000..0392c75845 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeviewcollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.RangeViewCollectionUpdateData +uid: excel!Excel.Interfaces.RangeViewCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.RangeViewCollectionUpdateData +summary: >- + An interface for updating data on the `RangeViewCollection` object, for use in + `rangeViewCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.RangeViewCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.RangeViewData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeviewdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeviewdata.yml new file mode 100644 index 0000000000..8990b5348f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeviewdata.yml @@ -0,0 +1,254 @@ +### YamlMime:TSType +name: Excel.Interfaces.RangeViewData +uid: excel!Excel.Interfaces.RangeViewData:interface +package: excel! +fullName: Excel.Interfaces.RangeViewData +summary: >- + An interface describing the data returned by calling `rangeView.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: cellAddresses + uid: excel!Excel.Interfaces.RangeViewData#cellAddresses:member + package: excel! + fullName: cellAddresses + summary: Represents the cell addresses of the `RangeView`. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'cellAddresses?: any[][];' + return: + type: any[][] + - name: columnCount + uid: excel!Excel.Interfaces.RangeViewData#columnCount:member + package: excel! + fullName: columnCount + summary: The number of visible columns. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'columnCount?: number;' + return: + type: number + - name: formulas + uid: excel!Excel.Interfaces.RangeViewData#formulas:member + package: excel! + fullName: formulas + summary: >- + Represents the formula in A1-style notation. If a cell has no formula, its + value is returned instead. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulas?: any[][];' + return: + type: any[][] + - name: formulasLocal + uid: excel!Excel.Interfaces.RangeViewData#formulasLocal:member + package: excel! + fullName: formulasLocal + summary: >- + Represents the formula in A1-style notation, in the user's language and + number-formatting locale. For example, the English "=SUM(A1, 1.5)" formula + would become "=SUMME(A1; 1,5)" in German. If a cell has no formula, its + value is returned instead. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulasLocal?: any[][];' + return: + type: any[][] + - name: formulasR1C1 + uid: excel!Excel.Interfaces.RangeViewData#formulasR1C1:member + package: excel! + fullName: formulasR1C1 + summary: >- + Represents the formula in R1C1-style notation. If a cell has no formula, + its value is returned instead. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulasR1C1?: any[][];' + return: + type: any[][] + - name: index + uid: excel!Excel.Interfaces.RangeViewData#index:member + package: excel! + fullName: index + summary: Returns a value that represents the index of the `RangeView`. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'index?: number;' + return: + type: number + - name: numberFormat + uid: excel!Excel.Interfaces.RangeViewData#numberFormat:member + package: excel! + fullName: numberFormat + summary: Represents Excel's number format code for the given cell. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat?: any[][];' + return: + type: any[][] + - name: rowCount + uid: excel!Excel.Interfaces.RangeViewData#rowCount:member + package: excel! + fullName: rowCount + summary: The number of visible rows. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rowCount?: number;' + return: + type: number + - name: rows + uid: excel!Excel.Interfaces.RangeViewData#rows:member + package: excel! + fullName: rows + summary: Represents a collection of range views associated with the range. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rows?: Excel.Interfaces.RangeViewData[];' + return: + type: [] + - name: text + uid: excel!Excel.Interfaces.RangeViewData#text:member + package: excel! + fullName: text + summary: >- + Text values of the specified range. The text value will not depend on the + cell width. The \# sign substitution that happens in Excel UI will not + affect the text value returned by the API. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'text?: string[][];' + return: + type: string[][] + - name: values + uid: excel!Excel.Interfaces.RangeViewData#values:member + package: excel! + fullName: values + summary: >- + Represents the raw values of the specified range view. The data returned + could be of type string, number, or a boolean. Cells that contain an error + will return the error string. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'values?: any[][];' + return: + type: any[][] + - name: valuesAsJson + uid: excel!Excel.Interfaces.RangeViewData#valuesAsJson:member + package: excel! + fullName: valuesAsJson + summary: >- + A JSON representation of the values in the cells in this range. Unlike + `RangeView.values`, `RangeView.valuesAsJson` supports all data + types which can be in a cell. Examples include formatted number values and + web images, in addition to the standard boolean, number, and string + values. Data returned from this API always aligns with the en-US locale. + To retrieve data in the user's display locale, use + `RangeView.valuesAsJsonLocal`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJson?: CellValue[][];' + return: + type: [][] + - name: valuesAsJsonLocal + uid: excel!Excel.Interfaces.RangeViewData#valuesAsJsonLocal:member + package: excel! + fullName: valuesAsJsonLocal + summary: >- + A JSON representation of the values in the cells in this range. Unlike + `RangeView.values`, `RangeView.valuesAsJsonLocal` supports all + data types which can be in a cell. Examples include formatted number + values and web images, in addition to the standard boolean, number, and + string values. Data returned from this API always aligns with the user's + display locale. To retrieve data independent of locale, use + `RangeView.valuesAsJson`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJsonLocal?: CellValue[][];' + return: + type: [][] + - name: valueTypes + uid: excel!Excel.Interfaces.RangeViewData#valueTypes:member + package: excel! + fullName: valueTypes + summary: Represents the type of data of each cell. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valueTypes?: Excel.RangeValueType[][];' + return: + type: [][] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeviewloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeviewloadoptions.yml new file mode 100644 index 0000000000..be1c95189b --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeviewloadoptions.yml @@ -0,0 +1,255 @@ +### YamlMime:TSType +name: Excel.Interfaces.RangeViewLoadOptions +uid: excel!Excel.Interfaces.RangeViewLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.RangeViewLoadOptions +summary: RangeView represents a set of visible cells of the parent range. +remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.RangeViewLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: cellAddresses + uid: excel!Excel.Interfaces.RangeViewLoadOptions#cellAddresses:member + package: excel! + fullName: cellAddresses + summary: Represents the cell addresses of the `RangeView`. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'cellAddresses?: boolean;' + return: + type: boolean + - name: columnCount + uid: excel!Excel.Interfaces.RangeViewLoadOptions#columnCount:member + package: excel! + fullName: columnCount + summary: The number of visible columns. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'columnCount?: boolean;' + return: + type: boolean + - name: formulas + uid: excel!Excel.Interfaces.RangeViewLoadOptions#formulas:member + package: excel! + fullName: formulas + summary: >- + Represents the formula in A1-style notation. If a cell has no formula, its + value is returned instead. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulas?: boolean;' + return: + type: boolean + - name: formulasLocal + uid: excel!Excel.Interfaces.RangeViewLoadOptions#formulasLocal:member + package: excel! + fullName: formulasLocal + summary: >- + Represents the formula in A1-style notation, in the user's language and + number-formatting locale. For example, the English "=SUM(A1, 1.5)" formula + would become "=SUMME(A1; 1,5)" in German. If a cell has no formula, its + value is returned instead. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulasLocal?: boolean;' + return: + type: boolean + - name: formulasR1C1 + uid: excel!Excel.Interfaces.RangeViewLoadOptions#formulasR1C1:member + package: excel! + fullName: formulasR1C1 + summary: >- + Represents the formula in R1C1-style notation. If a cell has no formula, + its value is returned instead. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulasR1C1?: boolean;' + return: + type: boolean + - name: index + uid: excel!Excel.Interfaces.RangeViewLoadOptions#index:member + package: excel! + fullName: index + summary: Returns a value that represents the index of the `RangeView`. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'index?: boolean;' + return: + type: boolean + - name: numberFormat + uid: excel!Excel.Interfaces.RangeViewLoadOptions#numberFormat:member + package: excel! + fullName: numberFormat + summary: Represents Excel's number format code for the given cell. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat?: boolean;' + return: + type: boolean + - name: rowCount + uid: excel!Excel.Interfaces.RangeViewLoadOptions#rowCount:member + package: excel! + fullName: rowCount + summary: The number of visible rows. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rowCount?: boolean;' + return: + type: boolean + - name: text + uid: excel!Excel.Interfaces.RangeViewLoadOptions#text:member + package: excel! + fullName: text + summary: >- + Text values of the specified range. The text value will not depend on the + cell width. The \# sign substitution that happens in Excel UI will not + affect the text value returned by the API. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'text?: boolean;' + return: + type: boolean + - name: values + uid: excel!Excel.Interfaces.RangeViewLoadOptions#values:member + package: excel! + fullName: values + summary: >- + Represents the raw values of the specified range view. The data returned + could be of type string, number, or a boolean. Cells that contain an error + will return the error string. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'values?: boolean;' + return: + type: boolean + - name: valuesAsJson + uid: excel!Excel.Interfaces.RangeViewLoadOptions#valuesAsJson:member + package: excel! + fullName: valuesAsJson + summary: >- + A JSON representation of the values in the cells in this range. Unlike + `RangeView.values`, `RangeView.valuesAsJson` supports all data + types which can be in a cell. Examples include formatted number values and + web images, in addition to the standard boolean, number, and string + values. Data returned from this API always aligns with the en-US locale. + To retrieve data in the user's display locale, use + `RangeView.valuesAsJsonLocal`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJson?: boolean;' + return: + type: boolean + - name: valuesAsJsonLocal + uid: excel!Excel.Interfaces.RangeViewLoadOptions#valuesAsJsonLocal:member + package: excel! + fullName: valuesAsJsonLocal + summary: >- + A JSON representation of the values in the cells in this range. Unlike + `RangeView.values`, `RangeView.valuesAsJsonLocal` supports all + data types which can be in a cell. Examples include formatted number + values and web images, in addition to the standard boolean, number, and + string values. Data returned from this API always aligns with the user's + display locale. To retrieve data independent of locale, use + `RangeView.valuesAsJson`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJsonLocal?: boolean;' + return: + type: boolean + - name: valueTypes + uid: excel!Excel.Interfaces.RangeViewLoadOptions#valueTypes:member + package: excel! + fullName: valueTypes + summary: Represents the type of data of each cell. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valueTypes?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeviewupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeviewupdatedata.yml new file mode 100644 index 0000000000..cae6183ef7 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rangeviewupdatedata.yml @@ -0,0 +1,146 @@ +### YamlMime:TSType +name: Excel.Interfaces.RangeViewUpdateData +uid: excel!Excel.Interfaces.RangeViewUpdateData:interface +package: excel! +fullName: Excel.Interfaces.RangeViewUpdateData +summary: >- + An interface for updating data on the `RangeView` object, for use in + `rangeView.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: formulas + uid: excel!Excel.Interfaces.RangeViewUpdateData#formulas:member + package: excel! + fullName: formulas + summary: >- + Represents the formula in A1-style notation. If a cell has no formula, its + value is returned instead. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulas?: any[][];' + return: + type: any[][] + - name: formulasLocal + uid: excel!Excel.Interfaces.RangeViewUpdateData#formulasLocal:member + package: excel! + fullName: formulasLocal + summary: >- + Represents the formula in A1-style notation, in the user's language and + number-formatting locale. For example, the English "=SUM(A1, 1.5)" formula + would become "=SUMME(A1; 1,5)" in German. If a cell has no formula, its + value is returned instead. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulasLocal?: any[][];' + return: + type: any[][] + - name: formulasR1C1 + uid: excel!Excel.Interfaces.RangeViewUpdateData#formulasR1C1:member + package: excel! + fullName: formulasR1C1 + summary: >- + Represents the formula in R1C1-style notation. If a cell has no formula, + its value is returned instead. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulasR1C1?: any[][];' + return: + type: any[][] + - name: numberFormat + uid: excel!Excel.Interfaces.RangeViewUpdateData#numberFormat:member + package: excel! + fullName: numberFormat + summary: Represents Excel's number format code for the given cell. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat?: any[][];' + return: + type: any[][] + - name: values + uid: excel!Excel.Interfaces.RangeViewUpdateData#values:member + package: excel! + fullName: values + summary: >- + Represents the raw values of the specified range view. The data returned + could be of type string, number, or a boolean. Cells that contain an error + will return the error string. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'values?: any[][];' + return: + type: any[][] + - name: valuesAsJson + uid: excel!Excel.Interfaces.RangeViewUpdateData#valuesAsJson:member + package: excel! + fullName: valuesAsJson + summary: >- + A JSON representation of the values in the cells in this range. Unlike + `RangeView.values`, `RangeView.valuesAsJson` supports all data + types which can be in a cell. Examples include formatted number values and + web images, in addition to the standard boolean, number, and string + values. Data returned from this API always aligns with the en-US locale. + To retrieve data in the user's display locale, use + `RangeView.valuesAsJsonLocal`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJson?: CellValue[][];' + return: + type: [][] + - name: valuesAsJsonLocal + uid: excel!Excel.Interfaces.RangeViewUpdateData#valuesAsJsonLocal:member + package: excel! + fullName: valuesAsJsonLocal + summary: >- + A JSON representation of the values in the cells in this range. Unlike + `RangeView.values`, `RangeView.valuesAsJsonLocal` supports all + data types which can be in a cell. Examples include formatted number + values and web images, in addition to the standard boolean, number, and + string values. Data returned from this API always aligns with the user's + display locale. To retrieve data independent of locale, use + `RangeView.valuesAsJson`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJsonLocal?: CellValue[][];' + return: + type: [][] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.removeduplicatesresultdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.removeduplicatesresultdata.yml new file mode 100644 index 0000000000..bf3b70b62c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.removeduplicatesresultdata.yml @@ -0,0 +1,44 @@ +### YamlMime:TSType +name: Excel.Interfaces.RemoveDuplicatesResultData +uid: excel!Excel.Interfaces.RemoveDuplicatesResultData:interface +package: excel! +fullName: Excel.Interfaces.RemoveDuplicatesResultData +summary: >- + An interface describing the data returned by calling + `removeDuplicatesResult.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: removed + uid: excel!Excel.Interfaces.RemoveDuplicatesResultData#removed:member + package: excel! + fullName: removed + summary: Number of duplicated rows removed by the operation. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'removed?: number;' + return: + type: number + - name: uniqueRemaining + uid: excel!Excel.Interfaces.RemoveDuplicatesResultData#uniqueRemaining:member + package: excel! + fullName: uniqueRemaining + summary: Number of remaining unique rows present in the resulting range. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'uniqueRemaining?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.removeduplicatesresultloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.removeduplicatesresultloadoptions.yml new file mode 100644 index 0000000000..dacabe3cf6 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.removeduplicatesresultloadoptions.yml @@ -0,0 +1,61 @@ +### YamlMime:TSType +name: Excel.Interfaces.RemoveDuplicatesResultLoadOptions +uid: excel!Excel.Interfaces.RemoveDuplicatesResultLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.RemoveDuplicatesResultLoadOptions +summary: Represents the results from `Range.removeDuplicates`. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.RemoveDuplicatesResultLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: removed + uid: excel!Excel.Interfaces.RemoveDuplicatesResultLoadOptions#removed:member + package: excel! + fullName: removed + summary: Number of duplicated rows removed by the operation. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'removed?: boolean;' + return: + type: boolean + - name: uniqueRemaining + uid: >- + excel!Excel.Interfaces.RemoveDuplicatesResultLoadOptions#uniqueRemaining:member + package: excel! + fullName: uniqueRemaining + summary: Number of remaining unique rows present in the resulting range. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'uniqueRemaining?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rowcolumnpivothierarchycollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rowcolumnpivothierarchycollectiondata.yml new file mode 100644 index 0000000000..310b1c23f7 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rowcolumnpivothierarchycollectiondata.yml @@ -0,0 +1,30 @@ +### YamlMime:TSType +name: Excel.Interfaces.RowColumnPivotHierarchyCollectionData +uid: excel!Excel.Interfaces.RowColumnPivotHierarchyCollectionData:interface +package: excel! +fullName: Excel.Interfaces.RowColumnPivotHierarchyCollectionData +summary: >- + An interface describing the data returned by calling + `rowColumnPivotHierarchyCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.RowColumnPivotHierarchyCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.RowColumnPivotHierarchyData[];' + return: + type: >- + [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rowcolumnpivothierarchycollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rowcolumnpivothierarchycollectionloadoptions.yml new file mode 100644 index 0000000000..0f50e010da --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rowcolumnpivothierarchycollectionloadoptions.yml @@ -0,0 +1,81 @@ +### YamlMime:TSType +name: Excel.Interfaces.RowColumnPivotHierarchyCollectionLoadOptions +uid: excel!Excel.Interfaces.RowColumnPivotHierarchyCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.RowColumnPivotHierarchyCollectionLoadOptions +summary: >- + Represents a collection of RowColumnPivotHierarchy items associated with the + PivotTable. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: >- + excel!Excel.Interfaces.RowColumnPivotHierarchyCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: id + uid: >- + excel!Excel.Interfaces.RowColumnPivotHierarchyCollectionLoadOptions#id:member + package: excel! + fullName: id + summary: 'For EACH ITEM in the collection: ID of the RowColumnPivotHierarchy.' + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: name + uid: >- + excel!Excel.Interfaces.RowColumnPivotHierarchyCollectionLoadOptions#name:member + package: excel! + fullName: name + summary: 'For EACH ITEM in the collection: Name of the RowColumnPivotHierarchy.' + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: position + uid: >- + excel!Excel.Interfaces.RowColumnPivotHierarchyCollectionLoadOptions#position:member + package: excel! + fullName: position + summary: 'For EACH ITEM in the collection: Position of the RowColumnPivotHierarchy.' + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'position?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rowcolumnpivothierarchycollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rowcolumnpivothierarchycollectionupdatedata.yml new file mode 100644 index 0000000000..9952afd824 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rowcolumnpivothierarchycollectionupdatedata.yml @@ -0,0 +1,31 @@ +### YamlMime:TSType +name: Excel.Interfaces.RowColumnPivotHierarchyCollectionUpdateData +uid: excel!Excel.Interfaces.RowColumnPivotHierarchyCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.RowColumnPivotHierarchyCollectionUpdateData +summary: >- + An interface for updating data on the `RowColumnPivotHierarchyCollection` + object, for use in `rowColumnPivotHierarchyCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: >- + excel!Excel.Interfaces.RowColumnPivotHierarchyCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.RowColumnPivotHierarchyData[];' + return: + type: >- + [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rowcolumnpivothierarchydata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rowcolumnpivothierarchydata.yml new file mode 100644 index 0000000000..719d041bac --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rowcolumnpivothierarchydata.yml @@ -0,0 +1,74 @@ +### YamlMime:TSType +name: Excel.Interfaces.RowColumnPivotHierarchyData +uid: excel!Excel.Interfaces.RowColumnPivotHierarchyData:interface +package: excel! +fullName: Excel.Interfaces.RowColumnPivotHierarchyData +summary: >- + An interface describing the data returned by calling + `rowColumnPivotHierarchy.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: fields + uid: excel!Excel.Interfaces.RowColumnPivotHierarchyData#fields:member + package: excel! + fullName: fields + summary: Returns the PivotFields associated with the RowColumnPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'fields?: Excel.Interfaces.PivotFieldData[];' + return: + type: [] + - name: id + uid: excel!Excel.Interfaces.RowColumnPivotHierarchyData#id:member + package: excel! + fullName: id + summary: ID of the RowColumnPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: string;' + return: + type: string + - name: name + uid: excel!Excel.Interfaces.RowColumnPivotHierarchyData#name:member + package: excel! + fullName: name + summary: Name of the RowColumnPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: position + uid: excel!Excel.Interfaces.RowColumnPivotHierarchyData#position:member + package: excel! + fullName: position + summary: Position of the RowColumnPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'position?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rowcolumnpivothierarchyloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rowcolumnpivothierarchyloadoptions.yml new file mode 100644 index 0000000000..d21ae3e289 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rowcolumnpivothierarchyloadoptions.yml @@ -0,0 +1,75 @@ +### YamlMime:TSType +name: Excel.Interfaces.RowColumnPivotHierarchyLoadOptions +uid: excel!Excel.Interfaces.RowColumnPivotHierarchyLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.RowColumnPivotHierarchyLoadOptions +summary: Represents the Excel RowColumnPivotHierarchy. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.RowColumnPivotHierarchyLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.RowColumnPivotHierarchyLoadOptions#id:member + package: excel! + fullName: id + summary: ID of the RowColumnPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.RowColumnPivotHierarchyLoadOptions#name:member + package: excel! + fullName: name + summary: Name of the RowColumnPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: position + uid: excel!Excel.Interfaces.RowColumnPivotHierarchyLoadOptions#position:member + package: excel! + fullName: position + summary: Position of the RowColumnPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'position?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rowcolumnpivothierarchyupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rowcolumnpivothierarchyupdatedata.yml new file mode 100644 index 0000000000..36146fb459 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.rowcolumnpivothierarchyupdatedata.yml @@ -0,0 +1,44 @@ +### YamlMime:TSType +name: Excel.Interfaces.RowColumnPivotHierarchyUpdateData +uid: excel!Excel.Interfaces.RowColumnPivotHierarchyUpdateData:interface +package: excel! +fullName: Excel.Interfaces.RowColumnPivotHierarchyUpdateData +summary: >- + An interface for updating data on the `RowColumnPivotHierarchy` object, for + use in `rowColumnPivotHierarchy.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: name + uid: excel!Excel.Interfaces.RowColumnPivotHierarchyUpdateData#name:member + package: excel! + fullName: name + summary: Name of the RowColumnPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: position + uid: excel!Excel.Interfaces.RowColumnPivotHierarchyUpdateData#position:member + package: excel! + fullName: position + summary: Position of the RowColumnPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'position?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.runtimedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.runtimedata.yml new file mode 100644 index 0000000000..ce0a2143b7 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.runtimedata.yml @@ -0,0 +1,29 @@ +### YamlMime:TSType +name: Excel.Interfaces.RuntimeData +uid: excel!Excel.Interfaces.RuntimeData:interface +package: excel! +fullName: Excel.Interfaces.RuntimeData +summary: >- + An interface describing the data returned by calling `runtime.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: enableEvents + uid: excel!Excel.Interfaces.RuntimeData#enableEvents:member + package: excel! + fullName: enableEvents + summary: Toggle JavaScript events in the current task pane or content add-in. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'enableEvents?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.runtimeloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.runtimeloadoptions.yml new file mode 100644 index 0000000000..5e76d2b0e2 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.runtimeloadoptions.yml @@ -0,0 +1,45 @@ +### YamlMime:TSType +name: Excel.Interfaces.RuntimeLoadOptions +uid: excel!Excel.Interfaces.RuntimeLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.RuntimeLoadOptions +summary: Represents the Excel Runtime class. +remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.RuntimeLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: enableEvents + uid: excel!Excel.Interfaces.RuntimeLoadOptions#enableEvents:member + package: excel! + fullName: enableEvents + summary: Toggle JavaScript events in the current task pane or content add-in. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'enableEvents?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.runtimeupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.runtimeupdatedata.yml new file mode 100644 index 0000000000..46c0aaf132 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.runtimeupdatedata.yml @@ -0,0 +1,29 @@ +### YamlMime:TSType +name: Excel.Interfaces.RuntimeUpdateData +uid: excel!Excel.Interfaces.RuntimeUpdateData:interface +package: excel! +fullName: Excel.Interfaces.RuntimeUpdateData +summary: >- + An interface for updating data on the `Runtime` object, for use in + `runtime.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: enableEvents + uid: excel!Excel.Interfaces.RuntimeUpdateData#enableEvents:member + package: excel! + fullName: enableEvents + summary: Toggle JavaScript events in the current task pane or content add-in. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'enableEvents?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.settingcollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.settingcollectiondata.yml new file mode 100644 index 0000000000..57ae196bc4 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.settingcollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.SettingCollectionData +uid: excel!Excel.Interfaces.SettingCollectionData:interface +package: excel! +fullName: Excel.Interfaces.SettingCollectionData +summary: >- + An interface describing the data returned by calling + `settingCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.SettingCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.SettingData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.settingcollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.settingcollectionloadoptions.yml new file mode 100644 index 0000000000..a9ef133155 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.settingcollectionloadoptions.yml @@ -0,0 +1,67 @@ +### YamlMime:TSType +name: Excel.Interfaces.SettingCollectionLoadOptions +uid: excel!Excel.Interfaces.SettingCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.SettingCollectionLoadOptions +summary: >- + Represents a collection of key-value pair setting objects that are part of the + workbook. The scope is limited to per file and add-in (task-pane or content) + combination. +remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.SettingCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: key + uid: excel!Excel.Interfaces.SettingCollectionLoadOptions#key:member + package: excel! + fullName: key + summary: >- + For EACH ITEM in the collection: The key that represents the ID of the + setting. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'key?: boolean;' + return: + type: boolean + - name: value + uid: excel!Excel.Interfaces.SettingCollectionLoadOptions#value:member + package: excel! + fullName: value + summary: >- + For EACH ITEM in the collection: Represents the value stored for this + setting. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'value?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.settingcollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.settingcollectionupdatedata.yml new file mode 100644 index 0000000000..22fe15850f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.settingcollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.SettingCollectionUpdateData +uid: excel!Excel.Interfaces.SettingCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.SettingCollectionUpdateData +summary: >- + An interface for updating data on the `SettingCollection` object, for use in + `settingCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.SettingCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.SettingData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.settingdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.settingdata.yml new file mode 100644 index 0000000000..bd137c1a9c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.settingdata.yml @@ -0,0 +1,44 @@ +### YamlMime:TSType +name: Excel.Interfaces.SettingData +uid: excel!Excel.Interfaces.SettingData:interface +package: excel! +fullName: Excel.Interfaces.SettingData +summary: >- + An interface describing the data returned by calling `setting.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: key + uid: excel!Excel.Interfaces.SettingData#key:member + package: excel! + fullName: key + summary: The key that represents the ID of the setting. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'key?: string;' + return: + type: string + - name: value + uid: excel!Excel.Interfaces.SettingData#value:member + package: excel! + fullName: value + summary: Represents the value stored for this setting. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'value?: any;' + return: + type: any diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.settingloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.settingloadoptions.yml new file mode 100644 index 0000000000..0800286f5f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.settingloadoptions.yml @@ -0,0 +1,65 @@ +### YamlMime:TSType +name: Excel.Interfaces.SettingLoadOptions +uid: excel!Excel.Interfaces.SettingLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.SettingLoadOptions +summary: >- + Setting represents a key-value pair of a setting persisted to the document + (per file, per add-in). These custom key-value pair can be used to store state + or lifecycle information needed by the content or task-pane add-in. Note that + settings are persisted in the document and hence it is not a place to store + any sensitive or protected information such as user information and password. +remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.SettingLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: key + uid: excel!Excel.Interfaces.SettingLoadOptions#key:member + package: excel! + fullName: key + summary: The key that represents the ID of the setting. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'key?: boolean;' + return: + type: boolean + - name: value + uid: excel!Excel.Interfaces.SettingLoadOptions#value:member + package: excel! + fullName: value + summary: Represents the value stored for this setting. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'value?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.settingupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.settingupdatedata.yml new file mode 100644 index 0000000000..e6be1be24f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.settingupdatedata.yml @@ -0,0 +1,29 @@ +### YamlMime:TSType +name: Excel.Interfaces.SettingUpdateData +uid: excel!Excel.Interfaces.SettingUpdateData:interface +package: excel! +fullName: Excel.Interfaces.SettingUpdateData +summary: >- + An interface for updating data on the `Setting` object, for use in + `setting.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: value + uid: excel!Excel.Interfaces.SettingUpdateData#value:member + package: excel! + fullName: value + summary: Represents the value stored for this setting. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'value?: any;' + return: + type: any diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapecollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapecollectiondata.yml new file mode 100644 index 0000000000..9d922d6188 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapecollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.ShapeCollectionData +uid: excel!Excel.Interfaces.ShapeCollectionData:interface +package: excel! +fullName: Excel.Interfaces.ShapeCollectionData +summary: >- + An interface describing the data returned by calling + `shapeCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.ShapeCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.ShapeData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapecollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapecollectionloadoptions.yml new file mode 100644 index 0000000000..d2e0c7aa38 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapecollectionloadoptions.yml @@ -0,0 +1,483 @@ +### YamlMime:TSType +name: Excel.Interfaces.ShapeCollectionLoadOptions +uid: excel!Excel.Interfaces.ShapeCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ShapeCollectionLoadOptions +summary: Represents a collection of all the shapes in the worksheet. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ShapeCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: altTextDescription + uid: >- + excel!Excel.Interfaces.ShapeCollectionLoadOptions#altTextDescription:member + package: excel! + fullName: altTextDescription + summary: >- + For EACH ITEM in the collection: Specifies the alternative description + text for a `Shape` object. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'altTextDescription?: boolean;' + return: + type: boolean + - name: altTextTitle + uid: excel!Excel.Interfaces.ShapeCollectionLoadOptions#altTextTitle:member + package: excel! + fullName: altTextTitle + summary: >- + For EACH ITEM in the collection: Specifies the alternative title text for + a `Shape` object. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'altTextTitle?: boolean;' + return: + type: boolean + - name: connectionSiteCount + uid: >- + excel!Excel.Interfaces.ShapeCollectionLoadOptions#connectionSiteCount:member + package: excel! + fullName: connectionSiteCount + summary: >- + For EACH ITEM in the collection: Returns the number of connection sites on + this shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'connectionSiteCount?: boolean;' + return: + type: boolean + - name: displayName + uid: excel!Excel.Interfaces.ShapeCollectionLoadOptions#displayName:member + package: excel! + fullName: displayName + summary: >- + For EACH ITEM in the collection: Gets the display name of the shape. A + newly created shape has a generated name that is localized and may not + match its `name`. In this scenario, you can use this API to get + the name that is displayed in the UI. + remarks: >- + \[ [API set: ExcelApi + 1.15](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'displayName?: boolean;' + return: + type: boolean + - name: fill + uid: excel!Excel.Interfaces.ShapeCollectionLoadOptions#fill:member + package: excel! + fullName: fill + summary: >- + For EACH ITEM in the collection: Returns the fill formatting of this + shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'fill?: Excel.Interfaces.ShapeFillLoadOptions;' + return: + type: + - name: geometricShape + uid: excel!Excel.Interfaces.ShapeCollectionLoadOptions#geometricShape:member + package: excel! + fullName: geometricShape + summary: >- + For EACH ITEM in the collection: Returns the geometric shape associated + with the shape. An error will be thrown if the shape type is not + "GeometricShape". + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'geometricShape?: Excel.Interfaces.GeometricShapeLoadOptions;' + return: + type: >- + + - name: geometricShapeType + uid: >- + excel!Excel.Interfaces.ShapeCollectionLoadOptions#geometricShapeType:member + package: excel! + fullName: geometricShapeType + summary: >- + For EACH ITEM in the collection: Specifies the geometric shape type of + this geometric shape. See `Excel.GeometricShapeType` for details. Returns + `null` if the shape type is not "GeometricShape". + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'geometricShapeType?: boolean;' + return: + type: boolean + - name: group + uid: excel!Excel.Interfaces.ShapeCollectionLoadOptions#group:member + package: excel! + fullName: group + summary: >- + For EACH ITEM in the collection: Returns the shape group associated with + the shape. An error will be thrown if the shape type is not "GroupShape". + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'group?: Excel.Interfaces.ShapeGroupLoadOptions;' + return: + type: + - name: height + uid: excel!Excel.Interfaces.ShapeCollectionLoadOptions#height:member + package: excel! + fullName: height + summary: >- + For EACH ITEM in the collection: Specifies the height, in points, of the + shape. Throws an `InvalidArgument` exception when set with a negative + value or zero as an input. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.ShapeCollectionLoadOptions#id:member + package: excel! + fullName: id + summary: 'For EACH ITEM in the collection: Specifies the shape identifier.' + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: image + uid: excel!Excel.Interfaces.ShapeCollectionLoadOptions#image:member + package: excel! + fullName: image + summary: >- + For EACH ITEM in the collection: Returns the image associated with the + shape. An error will be thrown if the shape type is not "Image". + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'image?: Excel.Interfaces.ImageLoadOptions;' + return: + type: + - name: left + uid: excel!Excel.Interfaces.ShapeCollectionLoadOptions#left:member + package: excel! + fullName: left + summary: >- + For EACH ITEM in the collection: The distance, in points, from the left + side of the shape to the left side of the worksheet. Throws an + `InvalidArgument` exception when set with a negative value as an input. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: boolean;' + return: + type: boolean + - name: level + uid: excel!Excel.Interfaces.ShapeCollectionLoadOptions#level:member + package: excel! + fullName: level + summary: >- + For EACH ITEM in the collection: Specifies the level of the specified + shape. For example, a level of 0 means that the shape is not part of any + groups, a level of 1 means the shape is part of a top-level group, and a + level of 2 means the shape is part of a sub-group of the top level. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'level?: boolean;' + return: + type: boolean + - name: line + uid: excel!Excel.Interfaces.ShapeCollectionLoadOptions#line:member + package: excel! + fullName: line + summary: >- + For EACH ITEM in the collection: Returns the line associated with the + shape. An error will be thrown if the shape type is not "Line". + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'line?: Excel.Interfaces.LineLoadOptions;' + return: + type: + - name: lineFormat + uid: excel!Excel.Interfaces.ShapeCollectionLoadOptions#lineFormat:member + package: excel! + fullName: lineFormat + summary: >- + For EACH ITEM in the collection: Returns the line formatting of this + shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'lineFormat?: Excel.Interfaces.ShapeLineFormatLoadOptions;' + return: + type: >- + + - name: lockAspectRatio + uid: excel!Excel.Interfaces.ShapeCollectionLoadOptions#lockAspectRatio:member + package: excel! + fullName: lockAspectRatio + summary: >- + For EACH ITEM in the collection: Specifies if the aspect ratio of this + shape is locked. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'lockAspectRatio?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.ShapeCollectionLoadOptions#name:member + package: excel! + fullName: name + summary: 'For EACH ITEM in the collection: Specifies the name of the shape.' + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: parentGroup + uid: excel!Excel.Interfaces.ShapeCollectionLoadOptions#parentGroup:member + package: excel! + fullName: parentGroup + summary: 'For EACH ITEM in the collection: Specifies the parent group of this shape.' + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'parentGroup?: Excel.Interfaces.ShapeLoadOptions;' + return: + type: + - name: placement + uid: excel!Excel.Interfaces.ShapeCollectionLoadOptions#placement:member + package: excel! + fullName: placement + summary: >- + For EACH ITEM in the collection: Represents how the object is attached to + the cells below it. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'placement?: boolean;' + return: + type: boolean + - name: rotation + uid: excel!Excel.Interfaces.ShapeCollectionLoadOptions#rotation:member + package: excel! + fullName: rotation + summary: >- + For EACH ITEM in the collection: Specifies the rotation, in degrees, of + the shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rotation?: boolean;' + return: + type: boolean + - name: textFrame + uid: excel!Excel.Interfaces.ShapeCollectionLoadOptions#textFrame:member + package: excel! + fullName: textFrame + summary: >- + For EACH ITEM in the collection: Returns the text frame object of this + shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textFrame?: Excel.Interfaces.TextFrameLoadOptions;' + return: + type: + - name: top + uid: excel!Excel.Interfaces.ShapeCollectionLoadOptions#top:member + package: excel! + fullName: top + summary: >- + For EACH ITEM in the collection: The distance, in points, from the top + edge of the shape to the top edge of the worksheet. Throws an + `InvalidArgument` exception when set with a negative value as an input. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: boolean;' + return: + type: boolean + - name: type + uid: excel!Excel.Interfaces.ShapeCollectionLoadOptions#type:member + package: excel! + fullName: type + summary: >- + For EACH ITEM in the collection: Returns the type of this shape. See + `Excel.ShapeType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type?: boolean;' + return: + type: boolean + - name: visible + uid: excel!Excel.Interfaces.ShapeCollectionLoadOptions#visible:member + package: excel! + fullName: visible + summary: 'For EACH ITEM in the collection: Specifies if the shape is visible.' + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean + - name: width + uid: excel!Excel.Interfaces.ShapeCollectionLoadOptions#width:member + package: excel! + fullName: width + summary: >- + For EACH ITEM in the collection: Specifies the width, in points, of the + shape. Throws an `InvalidArgument` exception when set with a negative + value or zero as an input. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width?: boolean;' + return: + type: boolean + - name: zOrderPosition + uid: excel!Excel.Interfaces.ShapeCollectionLoadOptions#zOrderPosition:member + package: excel! + fullName: zOrderPosition + summary: >- + For EACH ITEM in the collection: Returns the position of the specified + shape in the z-order, with 0 representing the bottom of the order stack. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'zOrderPosition?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapecollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapecollectionupdatedata.yml new file mode 100644 index 0000000000..a5c55abf07 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapecollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.ShapeCollectionUpdateData +uid: excel!Excel.Interfaces.ShapeCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ShapeCollectionUpdateData +summary: >- + An interface for updating data on the `ShapeCollection` object, for use in + `shapeCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.ShapeCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.ShapeData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapedata.yml new file mode 100644 index 0000000000..657a88e9dc --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapedata.yml @@ -0,0 +1,445 @@ +### YamlMime:TSType +name: Excel.Interfaces.ShapeData +uid: excel!Excel.Interfaces.ShapeData:interface +package: excel! +fullName: Excel.Interfaces.ShapeData +summary: An interface describing the data returned by calling `shape.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: altTextDescription + uid: excel!Excel.Interfaces.ShapeData#altTextDescription:member + package: excel! + fullName: altTextDescription + summary: Specifies the alternative description text for a `Shape` object. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'altTextDescription?: string;' + return: + type: string + - name: altTextTitle + uid: excel!Excel.Interfaces.ShapeData#altTextTitle:member + package: excel! + fullName: altTextTitle + summary: Specifies the alternative title text for a `Shape` object. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'altTextTitle?: string;' + return: + type: string + - name: connectionSiteCount + uid: excel!Excel.Interfaces.ShapeData#connectionSiteCount:member + package: excel! + fullName: connectionSiteCount + summary: Returns the number of connection sites on this shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'connectionSiteCount?: number;' + return: + type: number + - name: displayName + uid: excel!Excel.Interfaces.ShapeData#displayName:member + package: excel! + fullName: displayName + summary: >- + Gets the display name of the shape. A newly created shape has a generated + name that is localized and may not match its `name`. In this + scenario, you can use this API to get the name that is displayed in the + UI. + remarks: >- + \[ [API set: ExcelApi + 1.15](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'displayName?: string;' + return: + type: string + - name: fill + uid: excel!Excel.Interfaces.ShapeData#fill:member + package: excel! + fullName: fill + summary: Returns the fill formatting of this shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'fill?: Excel.Interfaces.ShapeFillData;' + return: + type: + - name: geometricShapeType + uid: excel!Excel.Interfaces.ShapeData#geometricShapeType:member + package: excel! + fullName: geometricShapeType + summary: >- + Specifies the geometric shape type of this geometric shape. See + `Excel.GeometricShapeType` for details. Returns `null` if the shape type + is not "GeometricShape". + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + geometricShapeType?: Excel.GeometricShapeType | "LineInverse" | + "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" + | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | + "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | + "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" + | "Star32" | "RoundRectangle" | "Round1Rectangle" | + "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" + | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | + "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" + | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | + "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | + "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | + "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | + "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | + "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | + "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | + "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | + "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | + "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | + "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" + | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | + "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | + "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | + "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | + "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | + "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" + | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | + "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | + "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | + "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" + | "FlowChartDecision" | "FlowChartInputOutput" | + "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | + "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | + "FlowChartPreparation" | "FlowChartManualInput" | + "FlowChartManualOperation" | "FlowChartConnector" | + "FlowChartPunchedCard" | "FlowChartPunchedTape" | + "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | + "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | + "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | + "FlowChartMagneticTape" | "FlowChartMagneticDisk" | + "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | + "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | + "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | + "ActionButtonInformation" | "ActionButtonForwardNext" | + "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" + | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | + "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | + "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | + "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | + "ChartStar" | "ChartPlus"; + return: + type: >- + | "LineInverse" | + "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | + "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | + "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" + | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | + "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" + | "Round2SameRectangle" | "Round2DiagonalRectangle" | + "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | + "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | + "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | + "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | + "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | + "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" + | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | + "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | + "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" + | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | + "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | + "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | + "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | + "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | + "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | + "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | + "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" + | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | + "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | + "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | + "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" + | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | + "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | + "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | + "FlowChartInputOutput" | "FlowChartPredefinedProcess" | + "FlowChartInternalStorage" | "FlowChartDocument" | + "FlowChartMultidocument" | "FlowChartTerminator" | + "FlowChartPreparation" | "FlowChartManualInput" | + "FlowChartManualOperation" | "FlowChartConnector" | + "FlowChartPunchedCard" | "FlowChartPunchedTape" | + "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | + "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | + "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | + "FlowChartMagneticTape" | "FlowChartMagneticDisk" | + "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | + "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | + "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | + "ActionButtonInformation" | "ActionButtonForwardNext" | + "ActionButtonBackPrevious" | "ActionButtonEnd" | + "ActionButtonBeginning" | "ActionButtonReturn" | + "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | + "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | + "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | + "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | + "ChartPlus" + - name: height + uid: excel!Excel.Interfaces.ShapeData#height:member + package: excel! + fullName: height + summary: >- + Specifies the height, in points, of the shape. Throws an `InvalidArgument` + exception when set with a negative value or zero as an input. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height?: number;' + return: + type: number + - name: id + uid: excel!Excel.Interfaces.ShapeData#id:member + package: excel! + fullName: id + summary: Specifies the shape identifier. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: string;' + return: + type: string + - name: left + uid: excel!Excel.Interfaces.ShapeData#left:member + package: excel! + fullName: left + summary: >- + The distance, in points, from the left side of the shape to the left side + of the worksheet. Throws an `InvalidArgument` exception when set with a + negative value as an input. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: number;' + return: + type: number + - name: level + uid: excel!Excel.Interfaces.ShapeData#level:member + package: excel! + fullName: level + summary: >- + Specifies the level of the specified shape. For example, a level of 0 + means that the shape is not part of any groups, a level of 1 means the + shape is part of a top-level group, and a level of 2 means the shape is + part of a sub-group of the top level. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'level?: number;' + return: + type: number + - name: lineFormat + uid: excel!Excel.Interfaces.ShapeData#lineFormat:member + package: excel! + fullName: lineFormat + summary: Returns the line formatting of this shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'lineFormat?: Excel.Interfaces.ShapeLineFormatData;' + return: + type: + - name: lockAspectRatio + uid: excel!Excel.Interfaces.ShapeData#lockAspectRatio:member + package: excel! + fullName: lockAspectRatio + summary: Specifies if the aspect ratio of this shape is locked. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'lockAspectRatio?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.ShapeData#name:member + package: excel! + fullName: name + summary: Specifies the name of the shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: placement + uid: excel!Excel.Interfaces.ShapeData#placement:member + package: excel! + fullName: placement + summary: Represents how the object is attached to the cells below it. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'placement?: Excel.Placement | "TwoCell" | "OneCell" | "Absolute";' + return: + type: >- + | "TwoCell" | "OneCell" | + "Absolute" + - name: rotation + uid: excel!Excel.Interfaces.ShapeData#rotation:member + package: excel! + fullName: rotation + summary: Specifies the rotation, in degrees, of the shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rotation?: number;' + return: + type: number + - name: top + uid: excel!Excel.Interfaces.ShapeData#top:member + package: excel! + fullName: top + summary: >- + The distance, in points, from the top edge of the shape to the top edge of + the worksheet. Throws an `InvalidArgument` exception when set with a + negative value as an input. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: number;' + return: + type: number + - name: type + uid: excel!Excel.Interfaces.ShapeData#type:member + package: excel! + fullName: type + summary: Returns the type of this shape. See `Excel.ShapeType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + type?: Excel.ShapeType | "Unsupported" | "Image" | "GeometricShape" | + "Group" | "Line"; + return: + type: >- + | "Unsupported" | "Image" | + "GeometricShape" | "Group" | "Line" + - name: visible + uid: excel!Excel.Interfaces.ShapeData#visible:member + package: excel! + fullName: visible + summary: Specifies if the shape is visible. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean + - name: width + uid: excel!Excel.Interfaces.ShapeData#width:member + package: excel! + fullName: width + summary: >- + Specifies the width, in points, of the shape. Throws an `InvalidArgument` + exception when set with a negative value or zero as an input. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width?: number;' + return: + type: number + - name: zOrderPosition + uid: excel!Excel.Interfaces.ShapeData#zOrderPosition:member + package: excel! + fullName: zOrderPosition + summary: >- + Returns the position of the specified shape in the z-order, with 0 + representing the bottom of the order stack. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'zOrderPosition?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapefilldata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapefilldata.yml new file mode 100644 index 0000000000..8437dd0d6a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapefilldata.yml @@ -0,0 +1,69 @@ +### YamlMime:TSType +name: Excel.Interfaces.ShapeFillData +uid: excel!Excel.Interfaces.ShapeFillData:interface +package: excel! +fullName: Excel.Interfaces.ShapeFillData +summary: >- + An interface describing the data returned by calling `shapeFill.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: foregroundColor + uid: excel!Excel.Interfaces.ShapeFillData#foregroundColor:member + package: excel! + fullName: foregroundColor + summary: >- + Represents the shape fill foreground color in HTML color format, in the + form \#RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange") + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'foregroundColor?: string;' + return: + type: string + - name: transparency + uid: excel!Excel.Interfaces.ShapeFillData#transparency:member + package: excel! + fullName: transparency + summary: >- + Specifies the transparency percentage of the fill as a value from 0.0 + (opaque) through 1.0 (clear). Returns `null` if the shape type does not + support transparency or the shape fill has inconsistent transparency, such + as with a gradient fill type. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'transparency?: number;' + return: + type: number + - name: type + uid: excel!Excel.Interfaces.ShapeFillData#type:member + package: excel! + fullName: type + summary: Returns the fill type of the shape. See `Excel.ShapeFillType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + type?: Excel.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" + | "PictureAndTexture" | "Mixed"; + return: + type: >- + | "NoFill" | "Solid" | + "Gradient" | "Pattern" | "PictureAndTexture" | "Mixed" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapefillloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapefillloadoptions.yml new file mode 100644 index 0000000000..e08f3235b2 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapefillloadoptions.yml @@ -0,0 +1,81 @@ +### YamlMime:TSType +name: Excel.Interfaces.ShapeFillLoadOptions +uid: excel!Excel.Interfaces.ShapeFillLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ShapeFillLoadOptions +summary: Represents the fill formatting of a shape object. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ShapeFillLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: foregroundColor + uid: excel!Excel.Interfaces.ShapeFillLoadOptions#foregroundColor:member + package: excel! + fullName: foregroundColor + summary: >- + Represents the shape fill foreground color in HTML color format, in the + form \#RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange") + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'foregroundColor?: boolean;' + return: + type: boolean + - name: transparency + uid: excel!Excel.Interfaces.ShapeFillLoadOptions#transparency:member + package: excel! + fullName: transparency + summary: >- + Specifies the transparency percentage of the fill as a value from 0.0 + (opaque) through 1.0 (clear). Returns `null` if the shape type does not + support transparency or the shape fill has inconsistent transparency, such + as with a gradient fill type. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'transparency?: boolean;' + return: + type: boolean + - name: type + uid: excel!Excel.Interfaces.ShapeFillLoadOptions#type:member + package: excel! + fullName: type + summary: Returns the fill type of the shape. See `Excel.ShapeFillType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapefillupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapefillupdatedata.yml new file mode 100644 index 0000000000..7e1666d307 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapefillupdatedata.yml @@ -0,0 +1,50 @@ +### YamlMime:TSType +name: Excel.Interfaces.ShapeFillUpdateData +uid: excel!Excel.Interfaces.ShapeFillUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ShapeFillUpdateData +summary: >- + An interface for updating data on the `ShapeFill` object, for use in + `shapeFill.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: foregroundColor + uid: excel!Excel.Interfaces.ShapeFillUpdateData#foregroundColor:member + package: excel! + fullName: foregroundColor + summary: >- + Represents the shape fill foreground color in HTML color format, in the + form \#RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange") + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'foregroundColor?: string;' + return: + type: string + - name: transparency + uid: excel!Excel.Interfaces.ShapeFillUpdateData#transparency:member + package: excel! + fullName: transparency + summary: >- + Specifies the transparency percentage of the fill as a value from 0.0 + (opaque) through 1.0 (clear). Returns `null` if the shape type does not + support transparency or the shape fill has inconsistent transparency, such + as with a gradient fill type. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'transparency?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapefontdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapefontdata.yml new file mode 100644 index 0000000000..9f0ffef4f4 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapefontdata.yml @@ -0,0 +1,128 @@ +### YamlMime:TSType +name: Excel.Interfaces.ShapeFontData +uid: excel!Excel.Interfaces.ShapeFontData:interface +package: excel! +fullName: Excel.Interfaces.ShapeFontData +summary: >- + An interface describing the data returned by calling `shapeFont.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: bold + uid: excel!Excel.Interfaces.ShapeFontData#bold:member + package: excel! + fullName: bold + summary: >- + Represents the bold status of font. Returns `null` if the `TextRange` + includes both bold and non-bold text fragments. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'bold?: boolean;' + return: + type: boolean + - name: color + uid: excel!Excel.Interfaces.ShapeFontData#color:member + package: excel! + fullName: color + summary: >- + HTML color code representation of the text color (e.g., "\#FF0000" + represents red). Returns `null` if the `TextRange` includes text fragments + with different colors. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: string;' + return: + type: string + - name: italic + uid: excel!Excel.Interfaces.ShapeFontData#italic:member + package: excel! + fullName: italic + summary: >- + Represents the italic status of font. Returns `null` if the `TextRange` + includes both italic and non-italic text fragments. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'italic?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.ShapeFontData#name:member + package: excel! + fullName: name + summary: >- + Represents font name (e.g., "Calibri"). If the text is a Complex Script or + East Asian language, this is the corresponding font name; otherwise it is + the Latin font name. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: size + uid: excel!Excel.Interfaces.ShapeFontData#size:member + package: excel! + fullName: size + summary: >- + Represents font size in points (e.g., 11). Returns `null` if the + `TextRange` includes text fragments with different font sizes. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'size?: number;' + return: + type: number + - name: underline + uid: excel!Excel.Interfaces.ShapeFontData#underline:member + package: excel! + fullName: underline + summary: >- + Type of underline applied to the font. Returns `null` if the `TextRange` + includes text fragments with different underline styles. See + `Excel.ShapeFontUnderlineStyle` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + underline?: Excel.ShapeFontUnderlineStyle | "None" | "Single" | "Double" + | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" + | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | + "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble"; + return: + type: >- + | "None" | + "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | + "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | + "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | + "WavyHeavy" | "WavyDouble" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapefontloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapefontloadoptions.yml new file mode 100644 index 0000000000..0ebb6bbb33 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapefontloadoptions.yml @@ -0,0 +1,137 @@ +### YamlMime:TSType +name: Excel.Interfaces.ShapeFontLoadOptions +uid: excel!Excel.Interfaces.ShapeFontLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ShapeFontLoadOptions +summary: >- + Represents the font attributes, such as font name, font size, and color, for a + shape's `TextRange` object. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ShapeFontLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: bold + uid: excel!Excel.Interfaces.ShapeFontLoadOptions#bold:member + package: excel! + fullName: bold + summary: >- + Represents the bold status of font. Returns `null` if the `TextRange` + includes both bold and non-bold text fragments. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'bold?: boolean;' + return: + type: boolean + - name: color + uid: excel!Excel.Interfaces.ShapeFontLoadOptions#color:member + package: excel! + fullName: color + summary: >- + HTML color code representation of the text color (e.g., "\#FF0000" + represents red). Returns `null` if the `TextRange` includes text fragments + with different colors. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: boolean;' + return: + type: boolean + - name: italic + uid: excel!Excel.Interfaces.ShapeFontLoadOptions#italic:member + package: excel! + fullName: italic + summary: >- + Represents the italic status of font. Returns `null` if the `TextRange` + includes both italic and non-italic text fragments. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'italic?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.ShapeFontLoadOptions#name:member + package: excel! + fullName: name + summary: >- + Represents font name (e.g., "Calibri"). If the text is a Complex Script or + East Asian language, this is the corresponding font name; otherwise it is + the Latin font name. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: size + uid: excel!Excel.Interfaces.ShapeFontLoadOptions#size:member + package: excel! + fullName: size + summary: >- + Represents font size in points (e.g., 11). Returns `null` if the + `TextRange` includes text fragments with different font sizes. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'size?: boolean;' + return: + type: boolean + - name: underline + uid: excel!Excel.Interfaces.ShapeFontLoadOptions#underline:member + package: excel! + fullName: underline + summary: >- + Type of underline applied to the font. Returns `null` if the `TextRange` + includes text fragments with different underline styles. See + `Excel.ShapeFontUnderlineStyle` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'underline?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapefontupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapefontupdatedata.yml new file mode 100644 index 0000000000..c1ffd7dc68 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapefontupdatedata.yml @@ -0,0 +1,128 @@ +### YamlMime:TSType +name: Excel.Interfaces.ShapeFontUpdateData +uid: excel!Excel.Interfaces.ShapeFontUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ShapeFontUpdateData +summary: >- + An interface for updating data on the `ShapeFont` object, for use in + `shapeFont.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: bold + uid: excel!Excel.Interfaces.ShapeFontUpdateData#bold:member + package: excel! + fullName: bold + summary: >- + Represents the bold status of font. Returns `null` if the `TextRange` + includes both bold and non-bold text fragments. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'bold?: boolean;' + return: + type: boolean + - name: color + uid: excel!Excel.Interfaces.ShapeFontUpdateData#color:member + package: excel! + fullName: color + summary: >- + HTML color code representation of the text color (e.g., "\#FF0000" + represents red). Returns `null` if the `TextRange` includes text fragments + with different colors. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: string;' + return: + type: string + - name: italic + uid: excel!Excel.Interfaces.ShapeFontUpdateData#italic:member + package: excel! + fullName: italic + summary: >- + Represents the italic status of font. Returns `null` if the `TextRange` + includes both italic and non-italic text fragments. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'italic?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.ShapeFontUpdateData#name:member + package: excel! + fullName: name + summary: >- + Represents font name (e.g., "Calibri"). If the text is a Complex Script or + East Asian language, this is the corresponding font name; otherwise it is + the Latin font name. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: size + uid: excel!Excel.Interfaces.ShapeFontUpdateData#size:member + package: excel! + fullName: size + summary: >- + Represents font size in points (e.g., 11). Returns `null` if the + `TextRange` includes text fragments with different font sizes. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'size?: number;' + return: + type: number + - name: underline + uid: excel!Excel.Interfaces.ShapeFontUpdateData#underline:member + package: excel! + fullName: underline + summary: >- + Type of underline applied to the font. Returns `null` if the `TextRange` + includes text fragments with different underline styles. See + `Excel.ShapeFontUnderlineStyle` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + underline?: Excel.ShapeFontUnderlineStyle | "None" | "Single" | "Double" + | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" + | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | + "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble"; + return: + type: >- + | "None" | + "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | + "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | + "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | + "WavyHeavy" | "WavyDouble" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapegroupdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapegroupdata.yml new file mode 100644 index 0000000000..e63037d0ca --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapegroupdata.yml @@ -0,0 +1,44 @@ +### YamlMime:TSType +name: Excel.Interfaces.ShapeGroupData +uid: excel!Excel.Interfaces.ShapeGroupData:interface +package: excel! +fullName: Excel.Interfaces.ShapeGroupData +summary: >- + An interface describing the data returned by calling `shapeGroup.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: id + uid: excel!Excel.Interfaces.ShapeGroupData#id:member + package: excel! + fullName: id + summary: Specifies the shape identifier. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: string;' + return: + type: string + - name: shapes + uid: excel!Excel.Interfaces.ShapeGroupData#shapes:member + package: excel! + fullName: shapes + summary: Returns the collection of `Shape` objects. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'shapes?: Excel.Interfaces.ShapeData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapegrouploadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapegrouploadoptions.yml new file mode 100644 index 0000000000..12eea3b081 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapegrouploadoptions.yml @@ -0,0 +1,62 @@ +### YamlMime:TSType +name: Excel.Interfaces.ShapeGroupLoadOptions +uid: excel!Excel.Interfaces.ShapeGroupLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ShapeGroupLoadOptions +summary: >- + Represents a shape group inside a worksheet. To get the corresponding `Shape` + object, use `ShapeGroup.shape`. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ShapeGroupLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.ShapeGroupLoadOptions#id:member + package: excel! + fullName: id + summary: Specifies the shape identifier. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: shape + uid: excel!Excel.Interfaces.ShapeGroupLoadOptions#shape:member + package: excel! + fullName: shape + summary: Returns the `Shape` object associated with the group. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'shape?: Excel.Interfaces.ShapeLoadOptions;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapelineformatdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapelineformatdata.yml new file mode 100644 index 0000000000..825a6daaac --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapelineformatdata.yml @@ -0,0 +1,130 @@ +### YamlMime:TSType +name: Excel.Interfaces.ShapeLineFormatData +uid: excel!Excel.Interfaces.ShapeLineFormatData:interface +package: excel! +fullName: Excel.Interfaces.ShapeLineFormatData +summary: >- + An interface describing the data returned by calling + `shapeLineFormat.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: color + uid: excel!Excel.Interfaces.ShapeLineFormatData#color:member + package: excel! + fullName: color + summary: >- + Represents the line color in HTML color format, in the form \#RRGGBB + (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: string;' + return: + type: string + - name: dashStyle + uid: excel!Excel.Interfaces.ShapeLineFormatData#dashStyle:member + package: excel! + fullName: dashStyle + summary: >- + Represents the line style of the shape. Returns `null` when the line is + not visible or there are inconsistent dash styles. See + `Excel.ShapeLineDashStyle` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + dashStyle?: Excel.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" + | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | + "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot"; + return: + type: >- + | "Dash" | + "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | + "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" + | "SystemDashDot" + - name: style + uid: excel!Excel.Interfaces.ShapeLineFormatData#style:member + package: excel! + fullName: style + summary: >- + Represents the line style of the shape. Returns `null` when the line is + not visible or there are inconsistent styles. See `Excel.ShapeLineStyle` + for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + style?: Excel.ShapeLineStyle | "Single" | "ThickBetweenThin" | + "ThickThin" | "ThinThick" | "ThinThin"; + return: + type: >- + | "Single" | + "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin" + - name: transparency + uid: excel!Excel.Interfaces.ShapeLineFormatData#transparency:member + package: excel! + fullName: transparency + summary: >- + Represents the degree of transparency of the specified line as a value + from 0.0 (opaque) through 1.0 (clear). Returns `null` when the shape has + inconsistent transparencies. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'transparency?: number;' + return: + type: number + - name: visible + uid: excel!Excel.Interfaces.ShapeLineFormatData#visible:member + package: excel! + fullName: visible + summary: >- + Specifies if the line formatting of a shape element is visible. Returns + `null` when the shape has inconsistent visibilities. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean + - name: weight + uid: excel!Excel.Interfaces.ShapeLineFormatData#weight:member + package: excel! + fullName: weight + summary: >- + Represents the weight of the line, in points. Returns `null` when the line + is not visible or there are inconsistent line weights. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'weight?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapelineformatloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapelineformatloadoptions.yml new file mode 100644 index 0000000000..406f504c22 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapelineformatloadoptions.yml @@ -0,0 +1,137 @@ +### YamlMime:TSType +name: Excel.Interfaces.ShapeLineFormatLoadOptions +uid: excel!Excel.Interfaces.ShapeLineFormatLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ShapeLineFormatLoadOptions +summary: >- + Represents the line formatting for the shape object. For images and geometric + shapes, line formatting represents the border of the shape. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ShapeLineFormatLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: color + uid: excel!Excel.Interfaces.ShapeLineFormatLoadOptions#color:member + package: excel! + fullName: color + summary: >- + Represents the line color in HTML color format, in the form \#RRGGBB + (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: boolean;' + return: + type: boolean + - name: dashStyle + uid: excel!Excel.Interfaces.ShapeLineFormatLoadOptions#dashStyle:member + package: excel! + fullName: dashStyle + summary: >- + Represents the line style of the shape. Returns `null` when the line is + not visible or there are inconsistent dash styles. See + `Excel.ShapeLineDashStyle` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'dashStyle?: boolean;' + return: + type: boolean + - name: style + uid: excel!Excel.Interfaces.ShapeLineFormatLoadOptions#style:member + package: excel! + fullName: style + summary: >- + Represents the line style of the shape. Returns `null` when the line is + not visible or there are inconsistent styles. See `Excel.ShapeLineStyle` + for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'style?: boolean;' + return: + type: boolean + - name: transparency + uid: excel!Excel.Interfaces.ShapeLineFormatLoadOptions#transparency:member + package: excel! + fullName: transparency + summary: >- + Represents the degree of transparency of the specified line as a value + from 0.0 (opaque) through 1.0 (clear). Returns `null` when the shape has + inconsistent transparencies. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'transparency?: boolean;' + return: + type: boolean + - name: visible + uid: excel!Excel.Interfaces.ShapeLineFormatLoadOptions#visible:member + package: excel! + fullName: visible + summary: >- + Specifies if the line formatting of a shape element is visible. Returns + `null` when the shape has inconsistent visibilities. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean + - name: weight + uid: excel!Excel.Interfaces.ShapeLineFormatLoadOptions#weight:member + package: excel! + fullName: weight + summary: >- + Represents the weight of the line, in points. Returns `null` when the line + is not visible or there are inconsistent line weights. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'weight?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapelineformatupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapelineformatupdatedata.yml new file mode 100644 index 0000000000..69bba240d9 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapelineformatupdatedata.yml @@ -0,0 +1,130 @@ +### YamlMime:TSType +name: Excel.Interfaces.ShapeLineFormatUpdateData +uid: excel!Excel.Interfaces.ShapeLineFormatUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ShapeLineFormatUpdateData +summary: >- + An interface for updating data on the `ShapeLineFormat` object, for use in + `shapeLineFormat.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: color + uid: excel!Excel.Interfaces.ShapeLineFormatUpdateData#color:member + package: excel! + fullName: color + summary: >- + Represents the line color in HTML color format, in the form \#RRGGBB + (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: string;' + return: + type: string + - name: dashStyle + uid: excel!Excel.Interfaces.ShapeLineFormatUpdateData#dashStyle:member + package: excel! + fullName: dashStyle + summary: >- + Represents the line style of the shape. Returns `null` when the line is + not visible or there are inconsistent dash styles. See + `Excel.ShapeLineDashStyle` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + dashStyle?: Excel.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" + | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | + "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot"; + return: + type: >- + | "Dash" | + "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | + "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" + | "SystemDashDot" + - name: style + uid: excel!Excel.Interfaces.ShapeLineFormatUpdateData#style:member + package: excel! + fullName: style + summary: >- + Represents the line style of the shape. Returns `null` when the line is + not visible or there are inconsistent styles. See `Excel.ShapeLineStyle` + for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + style?: Excel.ShapeLineStyle | "Single" | "ThickBetweenThin" | + "ThickThin" | "ThinThick" | "ThinThin"; + return: + type: >- + | "Single" | + "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin" + - name: transparency + uid: excel!Excel.Interfaces.ShapeLineFormatUpdateData#transparency:member + package: excel! + fullName: transparency + summary: >- + Represents the degree of transparency of the specified line as a value + from 0.0 (opaque) through 1.0 (clear). Returns `null` when the shape has + inconsistent transparencies. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'transparency?: number;' + return: + type: number + - name: visible + uid: excel!Excel.Interfaces.ShapeLineFormatUpdateData#visible:member + package: excel! + fullName: visible + summary: >- + Specifies if the line formatting of a shape element is visible. Returns + `null` when the shape has inconsistent visibilities. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean + - name: weight + uid: excel!Excel.Interfaces.ShapeLineFormatUpdateData#weight:member + package: excel! + fullName: weight + summary: >- + Represents the weight of the line, in points. Returns `null` when the line + is not visible or there are inconsistent line weights. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'weight?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapeloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapeloadoptions.yml new file mode 100644 index 0000000000..efb2df8dba --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapeloadoptions.yml @@ -0,0 +1,462 @@ +### YamlMime:TSType +name: Excel.Interfaces.ShapeLoadOptions +uid: excel!Excel.Interfaces.ShapeLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.ShapeLoadOptions +summary: >- + Represents a generic shape object in the worksheet. A shape could be a + geometric shape, a line, a group of shapes, etc. To learn more about the shape + object model, read [Work with shapes using the Excel JavaScript + API](https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-shapes). +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.ShapeLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: altTextDescription + uid: excel!Excel.Interfaces.ShapeLoadOptions#altTextDescription:member + package: excel! + fullName: altTextDescription + summary: Specifies the alternative description text for a `Shape` object. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'altTextDescription?: boolean;' + return: + type: boolean + - name: altTextTitle + uid: excel!Excel.Interfaces.ShapeLoadOptions#altTextTitle:member + package: excel! + fullName: altTextTitle + summary: Specifies the alternative title text for a `Shape` object. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'altTextTitle?: boolean;' + return: + type: boolean + - name: connectionSiteCount + uid: excel!Excel.Interfaces.ShapeLoadOptions#connectionSiteCount:member + package: excel! + fullName: connectionSiteCount + summary: Returns the number of connection sites on this shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'connectionSiteCount?: boolean;' + return: + type: boolean + - name: displayName + uid: excel!Excel.Interfaces.ShapeLoadOptions#displayName:member + package: excel! + fullName: displayName + summary: >- + Gets the display name of the shape. A newly created shape has a generated + name that is localized and may not match its `name`. In this + scenario, you can use this API to get the name that is displayed in the + UI. + remarks: >- + \[ [API set: ExcelApi + 1.15](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'displayName?: boolean;' + return: + type: boolean + - name: fill + uid: excel!Excel.Interfaces.ShapeLoadOptions#fill:member + package: excel! + fullName: fill + summary: Returns the fill formatting of this shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'fill?: Excel.Interfaces.ShapeFillLoadOptions;' + return: + type: + - name: geometricShape + uid: excel!Excel.Interfaces.ShapeLoadOptions#geometricShape:member + package: excel! + fullName: geometricShape + summary: >- + Returns the geometric shape associated with the shape. An error will be + thrown if the shape type is not "GeometricShape". + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'geometricShape?: Excel.Interfaces.GeometricShapeLoadOptions;' + return: + type: >- + + - name: geometricShapeType + uid: excel!Excel.Interfaces.ShapeLoadOptions#geometricShapeType:member + package: excel! + fullName: geometricShapeType + summary: >- + Specifies the geometric shape type of this geometric shape. See + `Excel.GeometricShapeType` for details. Returns `null` if the shape type + is not "GeometricShape". + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'geometricShapeType?: boolean;' + return: + type: boolean + - name: group + uid: excel!Excel.Interfaces.ShapeLoadOptions#group:member + package: excel! + fullName: group + summary: >- + Returns the shape group associated with the shape. An error will be thrown + if the shape type is not "GroupShape". + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'group?: Excel.Interfaces.ShapeGroupLoadOptions;' + return: + type: + - name: height + uid: excel!Excel.Interfaces.ShapeLoadOptions#height:member + package: excel! + fullName: height + summary: >- + Specifies the height, in points, of the shape. Throws an `InvalidArgument` + exception when set with a negative value or zero as an input. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.ShapeLoadOptions#id:member + package: excel! + fullName: id + summary: Specifies the shape identifier. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: image + uid: excel!Excel.Interfaces.ShapeLoadOptions#image:member + package: excel! + fullName: image + summary: >- + Returns the image associated with the shape. An error will be thrown if + the shape type is not "Image". + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'image?: Excel.Interfaces.ImageLoadOptions;' + return: + type: + - name: left + uid: excel!Excel.Interfaces.ShapeLoadOptions#left:member + package: excel! + fullName: left + summary: >- + The distance, in points, from the left side of the shape to the left side + of the worksheet. Throws an `InvalidArgument` exception when set with a + negative value as an input. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: boolean;' + return: + type: boolean + - name: level + uid: excel!Excel.Interfaces.ShapeLoadOptions#level:member + package: excel! + fullName: level + summary: >- + Specifies the level of the specified shape. For example, a level of 0 + means that the shape is not part of any groups, a level of 1 means the + shape is part of a top-level group, and a level of 2 means the shape is + part of a sub-group of the top level. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'level?: boolean;' + return: + type: boolean + - name: line + uid: excel!Excel.Interfaces.ShapeLoadOptions#line:member + package: excel! + fullName: line + summary: >- + Returns the line associated with the shape. An error will be thrown if the + shape type is not "Line". + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'line?: Excel.Interfaces.LineLoadOptions;' + return: + type: + - name: lineFormat + uid: excel!Excel.Interfaces.ShapeLoadOptions#lineFormat:member + package: excel! + fullName: lineFormat + summary: Returns the line formatting of this shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'lineFormat?: Excel.Interfaces.ShapeLineFormatLoadOptions;' + return: + type: >- + + - name: lockAspectRatio + uid: excel!Excel.Interfaces.ShapeLoadOptions#lockAspectRatio:member + package: excel! + fullName: lockAspectRatio + summary: Specifies if the aspect ratio of this shape is locked. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'lockAspectRatio?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.ShapeLoadOptions#name:member + package: excel! + fullName: name + summary: Specifies the name of the shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: parentGroup + uid: excel!Excel.Interfaces.ShapeLoadOptions#parentGroup:member + package: excel! + fullName: parentGroup + summary: Specifies the parent group of this shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'parentGroup?: Excel.Interfaces.ShapeLoadOptions;' + return: + type: + - name: placement + uid: excel!Excel.Interfaces.ShapeLoadOptions#placement:member + package: excel! + fullName: placement + summary: Represents how the object is attached to the cells below it. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'placement?: boolean;' + return: + type: boolean + - name: rotation + uid: excel!Excel.Interfaces.ShapeLoadOptions#rotation:member + package: excel! + fullName: rotation + summary: Specifies the rotation, in degrees, of the shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rotation?: boolean;' + return: + type: boolean + - name: textFrame + uid: excel!Excel.Interfaces.ShapeLoadOptions#textFrame:member + package: excel! + fullName: textFrame + summary: Returns the text frame object of this shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textFrame?: Excel.Interfaces.TextFrameLoadOptions;' + return: + type: + - name: top + uid: excel!Excel.Interfaces.ShapeLoadOptions#top:member + package: excel! + fullName: top + summary: >- + The distance, in points, from the top edge of the shape to the top edge of + the worksheet. Throws an `InvalidArgument` exception when set with a + negative value as an input. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: boolean;' + return: + type: boolean + - name: type + uid: excel!Excel.Interfaces.ShapeLoadOptions#type:member + package: excel! + fullName: type + summary: Returns the type of this shape. See `Excel.ShapeType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type?: boolean;' + return: + type: boolean + - name: visible + uid: excel!Excel.Interfaces.ShapeLoadOptions#visible:member + package: excel! + fullName: visible + summary: Specifies if the shape is visible. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean + - name: width + uid: excel!Excel.Interfaces.ShapeLoadOptions#width:member + package: excel! + fullName: width + summary: >- + Specifies the width, in points, of the shape. Throws an `InvalidArgument` + exception when set with a negative value or zero as an input. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width?: boolean;' + return: + type: boolean + - name: zOrderPosition + uid: excel!Excel.Interfaces.ShapeLoadOptions#zOrderPosition:member + package: excel! + fullName: zOrderPosition + summary: >- + Returns the position of the specified shape in the z-order, with 0 + representing the bottom of the order stack. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'zOrderPosition?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapeupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapeupdatedata.yml new file mode 100644 index 0000000000..1dc4df8924 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.shapeupdatedata.yml @@ -0,0 +1,344 @@ +### YamlMime:TSType +name: Excel.Interfaces.ShapeUpdateData +uid: excel!Excel.Interfaces.ShapeUpdateData:interface +package: excel! +fullName: Excel.Interfaces.ShapeUpdateData +summary: >- + An interface for updating data on the `Shape` object, for use in `shape.set({ + ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: altTextDescription + uid: excel!Excel.Interfaces.ShapeUpdateData#altTextDescription:member + package: excel! + fullName: altTextDescription + summary: Specifies the alternative description text for a `Shape` object. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'altTextDescription?: string;' + return: + type: string + - name: altTextTitle + uid: excel!Excel.Interfaces.ShapeUpdateData#altTextTitle:member + package: excel! + fullName: altTextTitle + summary: Specifies the alternative title text for a `Shape` object. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'altTextTitle?: string;' + return: + type: string + - name: fill + uid: excel!Excel.Interfaces.ShapeUpdateData#fill:member + package: excel! + fullName: fill + summary: Returns the fill formatting of this shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'fill?: Excel.Interfaces.ShapeFillUpdateData;' + return: + type: + - name: geometricShapeType + uid: excel!Excel.Interfaces.ShapeUpdateData#geometricShapeType:member + package: excel! + fullName: geometricShapeType + summary: >- + Specifies the geometric shape type of this geometric shape. See + `Excel.GeometricShapeType` for details. Returns `null` if the shape type + is not "GeometricShape". + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + geometricShapeType?: Excel.GeometricShapeType | "LineInverse" | + "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" + | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | + "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | + "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" + | "Star32" | "RoundRectangle" | "Round1Rectangle" | + "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" + | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | + "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" + | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | + "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | + "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | + "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | + "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | + "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | + "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | + "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | + "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | + "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | + "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" + | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | + "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | + "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | + "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | + "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | + "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" + | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | + "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | + "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | + "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" + | "FlowChartDecision" | "FlowChartInputOutput" | + "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | + "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | + "FlowChartPreparation" | "FlowChartManualInput" | + "FlowChartManualOperation" | "FlowChartConnector" | + "FlowChartPunchedCard" | "FlowChartPunchedTape" | + "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | + "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | + "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | + "FlowChartMagneticTape" | "FlowChartMagneticDisk" | + "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | + "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | + "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | + "ActionButtonInformation" | "ActionButtonForwardNext" | + "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" + | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | + "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | + "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | + "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | + "ChartStar" | "ChartPlus"; + return: + type: >- + | "LineInverse" | + "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | + "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | + "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" + | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | + "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" + | "Round2SameRectangle" | "Round2DiagonalRectangle" | + "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | + "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | + "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | + "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | + "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | + "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" + | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | + "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | + "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" + | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | + "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | + "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | + "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | + "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | + "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | + "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | + "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" + | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | + "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | + "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | + "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" + | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | + "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | + "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | + "FlowChartInputOutput" | "FlowChartPredefinedProcess" | + "FlowChartInternalStorage" | "FlowChartDocument" | + "FlowChartMultidocument" | "FlowChartTerminator" | + "FlowChartPreparation" | "FlowChartManualInput" | + "FlowChartManualOperation" | "FlowChartConnector" | + "FlowChartPunchedCard" | "FlowChartPunchedTape" | + "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | + "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | + "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | + "FlowChartMagneticTape" | "FlowChartMagneticDisk" | + "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | + "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | + "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | + "ActionButtonInformation" | "ActionButtonForwardNext" | + "ActionButtonBackPrevious" | "ActionButtonEnd" | + "ActionButtonBeginning" | "ActionButtonReturn" | + "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | + "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | + "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | + "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | + "ChartPlus" + - name: height + uid: excel!Excel.Interfaces.ShapeUpdateData#height:member + package: excel! + fullName: height + summary: >- + Specifies the height, in points, of the shape. Throws an `InvalidArgument` + exception when set with a negative value or zero as an input. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height?: number;' + return: + type: number + - name: left + uid: excel!Excel.Interfaces.ShapeUpdateData#left:member + package: excel! + fullName: left + summary: >- + The distance, in points, from the left side of the shape to the left side + of the worksheet. Throws an `InvalidArgument` exception when set with a + negative value as an input. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: number;' + return: + type: number + - name: lineFormat + uid: excel!Excel.Interfaces.ShapeUpdateData#lineFormat:member + package: excel! + fullName: lineFormat + summary: Returns the line formatting of this shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'lineFormat?: Excel.Interfaces.ShapeLineFormatUpdateData;' + return: + type: >- + + - name: lockAspectRatio + uid: excel!Excel.Interfaces.ShapeUpdateData#lockAspectRatio:member + package: excel! + fullName: lockAspectRatio + summary: Specifies if the aspect ratio of this shape is locked. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'lockAspectRatio?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.ShapeUpdateData#name:member + package: excel! + fullName: name + summary: Specifies the name of the shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: placement + uid: excel!Excel.Interfaces.ShapeUpdateData#placement:member + package: excel! + fullName: placement + summary: Represents how the object is attached to the cells below it. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'placement?: Excel.Placement | "TwoCell" | "OneCell" | "Absolute";' + return: + type: >- + | "TwoCell" | "OneCell" | + "Absolute" + - name: rotation + uid: excel!Excel.Interfaces.ShapeUpdateData#rotation:member + package: excel! + fullName: rotation + summary: Specifies the rotation, in degrees, of the shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rotation?: number;' + return: + type: number + - name: top + uid: excel!Excel.Interfaces.ShapeUpdateData#top:member + package: excel! + fullName: top + summary: >- + The distance, in points, from the top edge of the shape to the top edge of + the worksheet. Throws an `InvalidArgument` exception when set with a + negative value as an input. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: number;' + return: + type: number + - name: visible + uid: excel!Excel.Interfaces.ShapeUpdateData#visible:member + package: excel! + fullName: visible + summary: Specifies if the shape is visible. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible?: boolean;' + return: + type: boolean + - name: width + uid: excel!Excel.Interfaces.ShapeUpdateData#width:member + package: excel! + fullName: width + summary: >- + Specifies the width, in points, of the shape. Throws an `InvalidArgument` + exception when set with a negative value or zero as an input. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.slicercollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.slicercollectiondata.yml new file mode 100644 index 0000000000..8a877eb1c0 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.slicercollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.SlicerCollectionData +uid: excel!Excel.Interfaces.SlicerCollectionData:interface +package: excel! +fullName: Excel.Interfaces.SlicerCollectionData +summary: >- + An interface describing the data returned by calling + `slicerCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.SlicerCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.SlicerData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.slicercollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.slicercollectionloadoptions.yml new file mode 100644 index 0000000000..0e1636bf59 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.slicercollectionloadoptions.yml @@ -0,0 +1,232 @@ +### YamlMime:TSType +name: Excel.Interfaces.SlicerCollectionLoadOptions +uid: excel!Excel.Interfaces.SlicerCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.SlicerCollectionLoadOptions +summary: >- + Represents a collection of all the slicer objects in the workbook or a + worksheet. +remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.SlicerCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: caption + uid: excel!Excel.Interfaces.SlicerCollectionLoadOptions#caption:member + package: excel! + fullName: caption + summary: 'For EACH ITEM in the collection: Represents the caption of the slicer.' + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'caption?: boolean;' + return: + type: boolean + - name: height + uid: excel!Excel.Interfaces.SlicerCollectionLoadOptions#height:member + package: excel! + fullName: height + summary: >- + For EACH ITEM in the collection: Specifies the height, in points, of the + slicer. Throws an `InvalidArgument` exception when set with a negative + value or zero as an input. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.SlicerCollectionLoadOptions#id:member + package: excel! + fullName: id + summary: 'For EACH ITEM in the collection: Represents the unique ID of the slicer.' + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: isFilterCleared + uid: excel!Excel.Interfaces.SlicerCollectionLoadOptions#isFilterCleared:member + package: excel! + fullName: isFilterCleared + summary: >- + For EACH ITEM in the collection: Value is `true` if all filters currently + applied on the slicer are cleared. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'isFilterCleared?: boolean;' + return: + type: boolean + - name: left + uid: excel!Excel.Interfaces.SlicerCollectionLoadOptions#left:member + package: excel! + fullName: left + summary: >- + For EACH ITEM in the collection: Represents the distance, in points, from + the left side of the slicer to the left of the worksheet. Throws an + `InvalidArgument` error when set with a negative value as an input. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.SlicerCollectionLoadOptions#name:member + package: excel! + fullName: name + summary: 'For EACH ITEM in the collection: Represents the name of the slicer.' + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: sortBy + uid: excel!Excel.Interfaces.SlicerCollectionLoadOptions#sortBy:member + package: excel! + fullName: sortBy + summary: >- + For EACH ITEM in the collection: Specifies the sort order of the items in + the slicer. Possible values are: "DataSourceOrder", "Ascending", + "Descending". + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'sortBy?: boolean;' + return: + type: boolean + - name: style + uid: excel!Excel.Interfaces.SlicerCollectionLoadOptions#style:member + package: excel! + fullName: style + summary: >- + For EACH ITEM in the collection: Constant value that represents the slicer + style. Possible values are: "SlicerStyleLight1" through + "SlicerStyleLight6", "TableStyleOther1" through "TableStyleOther2", + "SlicerStyleDark1" through "SlicerStyleDark6". A custom user-defined style + present in the workbook can also be specified. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'style?: boolean;' + return: + type: boolean + - name: top + uid: excel!Excel.Interfaces.SlicerCollectionLoadOptions#top:member + package: excel! + fullName: top + summary: >- + For EACH ITEM in the collection: Represents the distance, in points, from + the top edge of the slicer to the top of the worksheet. Throws an + `InvalidArgument` error when set with a negative value as an input. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: boolean;' + return: + type: boolean + - name: width + uid: excel!Excel.Interfaces.SlicerCollectionLoadOptions#width:member + package: excel! + fullName: width + summary: >- + For EACH ITEM in the collection: Represents the width, in points, of the + slicer. Throws an `InvalidArgument` error when set with a negative value + or zero as an input. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width?: boolean;' + return: + type: boolean + - name: worksheet + uid: excel!Excel.Interfaces.SlicerCollectionLoadOptions#worksheet:member + package: excel! + fullName: worksheet + summary: >- + For EACH ITEM in the collection: Represents the worksheet containing the + slicer. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheet?: Excel.Interfaces.WorksheetLoadOptions;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.slicercollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.slicercollectionupdatedata.yml new file mode 100644 index 0000000000..bfa72e8e53 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.slicercollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.SlicerCollectionUpdateData +uid: excel!Excel.Interfaces.SlicerCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.SlicerCollectionUpdateData +summary: >- + An interface for updating data on the `SlicerCollection` object, for use in + `slicerCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.SlicerCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.SlicerData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.slicerdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.slicerdata.yml new file mode 100644 index 0000000000..938f6336d0 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.slicerdata.yml @@ -0,0 +1,230 @@ +### YamlMime:TSType +name: Excel.Interfaces.SlicerData +uid: excel!Excel.Interfaces.SlicerData:interface +package: excel! +fullName: Excel.Interfaces.SlicerData +summary: >- + An interface describing the data returned by calling `slicer.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: caption + uid: excel!Excel.Interfaces.SlicerData#caption:member + package: excel! + fullName: caption + summary: Represents the caption of the slicer. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'caption?: string;' + return: + type: string + - name: height + uid: excel!Excel.Interfaces.SlicerData#height:member + package: excel! + fullName: height + summary: >- + Specifies the height, in points, of the slicer. Throws an + `InvalidArgument` exception when set with a negative value or zero as an + input. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height?: number;' + return: + type: number + - name: id + uid: excel!Excel.Interfaces.SlicerData#id:member + package: excel! + fullName: id + summary: Represents the unique ID of the slicer. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: string;' + return: + type: string + - name: isFilterCleared + uid: excel!Excel.Interfaces.SlicerData#isFilterCleared:member + package: excel! + fullName: isFilterCleared + summary: >- + Value is `true` if all filters currently applied on the slicer are + cleared. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'isFilterCleared?: boolean;' + return: + type: boolean + - name: left + uid: excel!Excel.Interfaces.SlicerData#left:member + package: excel! + fullName: left + summary: >- + Represents the distance, in points, from the left side of the slicer to + the left of the worksheet. Throws an `InvalidArgument` error when set with + a negative value as an input. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: number;' + return: + type: number + - name: name + uid: excel!Excel.Interfaces.SlicerData#name:member + package: excel! + fullName: name + summary: Represents the name of the slicer. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: slicerItems + uid: excel!Excel.Interfaces.SlicerData#slicerItems:member + package: excel! + fullName: slicerItems + summary: Represents the collection of slicer items that are part of the slicer. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'slicerItems?: Excel.Interfaces.SlicerItemData[];' + return: + type: [] + - name: sortBy + uid: excel!Excel.Interfaces.SlicerData#sortBy:member + package: excel! + fullName: sortBy + summary: >- + Specifies the sort order of the items in the slicer. Possible values are: + "DataSourceOrder", "Ascending", "Descending". + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + sortBy?: Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | + "Descending"; + return: + type: >- + | "DataSourceOrder" | + "Ascending" | "Descending" + - name: style + uid: excel!Excel.Interfaces.SlicerData#style:member + package: excel! + fullName: style + summary: >- + Constant value that represents the slicer style. Possible values are: + "SlicerStyleLight1" through "SlicerStyleLight6", "TableStyleOther1" + through "TableStyleOther2", "SlicerStyleDark1" through "SlicerStyleDark6". + A custom user-defined style present in the workbook can also be specified. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'style?: string;' + return: + type: string + - name: top + uid: excel!Excel.Interfaces.SlicerData#top:member + package: excel! + fullName: top + summary: >- + Represents the distance, in points, from the top edge of the slicer to the + top of the worksheet. Throws an `InvalidArgument` error when set with a + negative value as an input. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: number;' + return: + type: number + - name: width + uid: excel!Excel.Interfaces.SlicerData#width:member + package: excel! + fullName: width + summary: >- + Represents the width, in points, of the slicer. Throws an + `InvalidArgument` error when set with a negative value or zero as an + input. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width?: number;' + return: + type: number + - name: worksheet + uid: excel!Excel.Interfaces.SlicerData#worksheet:member + package: excel! + fullName: worksheet + summary: Represents the worksheet containing the slicer. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheet?: Excel.Interfaces.WorksheetData;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.sliceritemcollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.sliceritemcollectiondata.yml new file mode 100644 index 0000000000..8486ade69f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.sliceritemcollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.SlicerItemCollectionData +uid: excel!Excel.Interfaces.SlicerItemCollectionData:interface +package: excel! +fullName: Excel.Interfaces.SlicerItemCollectionData +summary: >- + An interface describing the data returned by calling + `slicerItemCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.SlicerItemCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.SlicerItemData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.sliceritemcollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.sliceritemcollectionloadoptions.yml new file mode 100644 index 0000000000..f62196b330 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.sliceritemcollectionloadoptions.yml @@ -0,0 +1,104 @@ +### YamlMime:TSType +name: Excel.Interfaces.SlicerItemCollectionLoadOptions +uid: excel!Excel.Interfaces.SlicerItemCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.SlicerItemCollectionLoadOptions +summary: Represents a collection of all the slicer item objects in the slicer. +remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.SlicerItemCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: hasData + uid: excel!Excel.Interfaces.SlicerItemCollectionLoadOptions#hasData:member + package: excel! + fullName: hasData + summary: >- + For EACH ITEM in the collection: Value is `true` if the slicer item has + data. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'hasData?: boolean;' + return: + type: boolean + - name: isSelected + uid: excel!Excel.Interfaces.SlicerItemCollectionLoadOptions#isSelected:member + package: excel! + fullName: isSelected + summary: >- + For EACH ITEM in the collection: Value is `true` if the slicer item is + selected. Setting this value will not clear the selected state of other + slicer items. By default, if the slicer item is the only one selected, + when it is deselected, all items will be selected. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'isSelected?: boolean;' + return: + type: boolean + - name: key + uid: excel!Excel.Interfaces.SlicerItemCollectionLoadOptions#key:member + package: excel! + fullName: key + summary: >- + For EACH ITEM in the collection: Represents the unique value representing + the slicer item. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'key?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.SlicerItemCollectionLoadOptions#name:member + package: excel! + fullName: name + summary: >- + For EACH ITEM in the collection: Represents the title displayed in the + Excel UI. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.sliceritemcollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.sliceritemcollectionupdatedata.yml new file mode 100644 index 0000000000..cbbda094be --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.sliceritemcollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.SlicerItemCollectionUpdateData +uid: excel!Excel.Interfaces.SlicerItemCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.SlicerItemCollectionUpdateData +summary: >- + An interface for updating data on the `SlicerItemCollection` object, for use + in `slicerItemCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.SlicerItemCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.SlicerItemData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.sliceritemdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.sliceritemdata.yml new file mode 100644 index 0000000000..89bbf55944 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.sliceritemdata.yml @@ -0,0 +1,82 @@ +### YamlMime:TSType +name: Excel.Interfaces.SlicerItemData +uid: excel!Excel.Interfaces.SlicerItemData:interface +package: excel! +fullName: Excel.Interfaces.SlicerItemData +summary: >- + An interface describing the data returned by calling `slicerItem.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: hasData + uid: excel!Excel.Interfaces.SlicerItemData#hasData:member + package: excel! + fullName: hasData + summary: Value is `true` if the slicer item has data. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'hasData?: boolean;' + return: + type: boolean + - name: isSelected + uid: excel!Excel.Interfaces.SlicerItemData#isSelected:member + package: excel! + fullName: isSelected + summary: >- + Value is `true` if the slicer item is selected. Setting this value will + not clear the selected state of other slicer items. By default, if the + slicer item is the only one selected, when it is deselected, all items + will be selected. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'isSelected?: boolean;' + return: + type: boolean + - name: key + uid: excel!Excel.Interfaces.SlicerItemData#key:member + package: excel! + fullName: key + summary: Represents the unique value representing the slicer item. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'key?: string;' + return: + type: string + - name: name + uid: excel!Excel.Interfaces.SlicerItemData#name:member + package: excel! + fullName: name + summary: Represents the title displayed in the Excel UI. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.sliceritemloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.sliceritemloadoptions.yml new file mode 100644 index 0000000000..973ad1a2da --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.sliceritemloadoptions.yml @@ -0,0 +1,98 @@ +### YamlMime:TSType +name: Excel.Interfaces.SlicerItemLoadOptions +uid: excel!Excel.Interfaces.SlicerItemLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.SlicerItemLoadOptions +summary: Represents a slicer item in a slicer. +remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.SlicerItemLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: hasData + uid: excel!Excel.Interfaces.SlicerItemLoadOptions#hasData:member + package: excel! + fullName: hasData + summary: Value is `true` if the slicer item has data. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'hasData?: boolean;' + return: + type: boolean + - name: isSelected + uid: excel!Excel.Interfaces.SlicerItemLoadOptions#isSelected:member + package: excel! + fullName: isSelected + summary: >- + Value is `true` if the slicer item is selected. Setting this value will + not clear the selected state of other slicer items. By default, if the + slicer item is the only one selected, when it is deselected, all items + will be selected. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'isSelected?: boolean;' + return: + type: boolean + - name: key + uid: excel!Excel.Interfaces.SlicerItemLoadOptions#key:member + package: excel! + fullName: key + summary: Represents the unique value representing the slicer item. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'key?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.SlicerItemLoadOptions#name:member + package: excel! + fullName: name + summary: Represents the title displayed in the Excel UI. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.sliceritemupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.sliceritemupdatedata.yml new file mode 100644 index 0000000000..1c513389b5 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.sliceritemupdatedata.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: Excel.Interfaces.SlicerItemUpdateData +uid: excel!Excel.Interfaces.SlicerItemUpdateData:interface +package: excel! +fullName: Excel.Interfaces.SlicerItemUpdateData +summary: >- + An interface for updating data on the `SlicerItem` object, for use in + `slicerItem.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: isSelected + uid: excel!Excel.Interfaces.SlicerItemUpdateData#isSelected:member + package: excel! + fullName: isSelected + summary: >- + Value is `true` if the slicer item is selected. Setting this value will + not clear the selected state of other slicer items. By default, if the + slicer item is the only one selected, when it is deselected, all items + will be selected. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'isSelected?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.slicerloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.slicerloadoptions.yml new file mode 100644 index 0000000000..0b0037864e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.slicerloadoptions.yml @@ -0,0 +1,226 @@ +### YamlMime:TSType +name: Excel.Interfaces.SlicerLoadOptions +uid: excel!Excel.Interfaces.SlicerLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.SlicerLoadOptions +summary: Represents a `Slicer` object in the workbook. +remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.SlicerLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: caption + uid: excel!Excel.Interfaces.SlicerLoadOptions#caption:member + package: excel! + fullName: caption + summary: Represents the caption of the slicer. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'caption?: boolean;' + return: + type: boolean + - name: height + uid: excel!Excel.Interfaces.SlicerLoadOptions#height:member + package: excel! + fullName: height + summary: >- + Specifies the height, in points, of the slicer. Throws an + `InvalidArgument` exception when set with a negative value or zero as an + input. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.SlicerLoadOptions#id:member + package: excel! + fullName: id + summary: Represents the unique ID of the slicer. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: isFilterCleared + uid: excel!Excel.Interfaces.SlicerLoadOptions#isFilterCleared:member + package: excel! + fullName: isFilterCleared + summary: >- + Value is `true` if all filters currently applied on the slicer are + cleared. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'isFilterCleared?: boolean;' + return: + type: boolean + - name: left + uid: excel!Excel.Interfaces.SlicerLoadOptions#left:member + package: excel! + fullName: left + summary: >- + Represents the distance, in points, from the left side of the slicer to + the left of the worksheet. Throws an `InvalidArgument` error when set with + a negative value as an input. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.SlicerLoadOptions#name:member + package: excel! + fullName: name + summary: Represents the name of the slicer. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: sortBy + uid: excel!Excel.Interfaces.SlicerLoadOptions#sortBy:member + package: excel! + fullName: sortBy + summary: >- + Specifies the sort order of the items in the slicer. Possible values are: + "DataSourceOrder", "Ascending", "Descending". + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'sortBy?: boolean;' + return: + type: boolean + - name: style + uid: excel!Excel.Interfaces.SlicerLoadOptions#style:member + package: excel! + fullName: style + summary: >- + Constant value that represents the slicer style. Possible values are: + "SlicerStyleLight1" through "SlicerStyleLight6", "TableStyleOther1" + through "TableStyleOther2", "SlicerStyleDark1" through "SlicerStyleDark6". + A custom user-defined style present in the workbook can also be specified. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'style?: boolean;' + return: + type: boolean + - name: top + uid: excel!Excel.Interfaces.SlicerLoadOptions#top:member + package: excel! + fullName: top + summary: >- + Represents the distance, in points, from the top edge of the slicer to the + top of the worksheet. Throws an `InvalidArgument` error when set with a + negative value as an input. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: boolean;' + return: + type: boolean + - name: width + uid: excel!Excel.Interfaces.SlicerLoadOptions#width:member + package: excel! + fullName: width + summary: >- + Represents the width, in points, of the slicer. Throws an + `InvalidArgument` error when set with a negative value or zero as an + input. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width?: boolean;' + return: + type: boolean + - name: worksheet + uid: excel!Excel.Interfaces.SlicerLoadOptions#worksheet:member + package: excel! + fullName: worksheet + summary: Represents the worksheet containing the slicer. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheet?: Excel.Interfaces.WorksheetLoadOptions;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.slicerstylecollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.slicerstylecollectiondata.yml new file mode 100644 index 0000000000..3425fb0075 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.slicerstylecollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.SlicerStyleCollectionData +uid: excel!Excel.Interfaces.SlicerStyleCollectionData:interface +package: excel! +fullName: Excel.Interfaces.SlicerStyleCollectionData +summary: >- + An interface describing the data returned by calling + `slicerStyleCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.SlicerStyleCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.SlicerStyleData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.slicerstylecollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.slicerstylecollectionloadoptions.yml new file mode 100644 index 0000000000..a6e1e81fcf --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.slicerstylecollectionloadoptions.yml @@ -0,0 +1,64 @@ +### YamlMime:TSType +name: Excel.Interfaces.SlicerStyleCollectionLoadOptions +uid: excel!Excel.Interfaces.SlicerStyleCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.SlicerStyleCollectionLoadOptions +summary: Represents a collection of `SlicerStyle` objects. +remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.SlicerStyleCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.SlicerStyleCollectionLoadOptions#name:member + package: excel! + fullName: name + summary: 'For EACH ITEM in the collection: Specifies the name of the slicer style.' + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: readOnly + uid: excel!Excel.Interfaces.SlicerStyleCollectionLoadOptions#readOnly:member + package: excel! + fullName: readOnly + summary: >- + For EACH ITEM in the collection: Specifies if this `SlicerStyle` object is + read-only. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readOnly?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.slicerstylecollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.slicerstylecollectionupdatedata.yml new file mode 100644 index 0000000000..940887f5d5 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.slicerstylecollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.SlicerStyleCollectionUpdateData +uid: excel!Excel.Interfaces.SlicerStyleCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.SlicerStyleCollectionUpdateData +summary: >- + An interface for updating data on the `SlicerStyleCollection` object, for use + in `slicerStyleCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.SlicerStyleCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.SlicerStyleData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.slicerstyledata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.slicerstyledata.yml new file mode 100644 index 0000000000..2270b08ce2 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.slicerstyledata.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: Excel.Interfaces.SlicerStyleData +uid: excel!Excel.Interfaces.SlicerStyleData:interface +package: excel! +fullName: Excel.Interfaces.SlicerStyleData +summary: >- + An interface describing the data returned by calling + `slicerStyle.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: name + uid: excel!Excel.Interfaces.SlicerStyleData#name:member + package: excel! + fullName: name + summary: Specifies the name of the slicer style. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: readOnly + uid: excel!Excel.Interfaces.SlicerStyleData#readOnly:member + package: excel! + fullName: readOnly + summary: Specifies if this `SlicerStyle` object is read-only. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readOnly?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.slicerstyleloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.slicerstyleloadoptions.yml new file mode 100644 index 0000000000..fb6b661640 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.slicerstyleloadoptions.yml @@ -0,0 +1,64 @@ +### YamlMime:TSType +name: Excel.Interfaces.SlicerStyleLoadOptions +uid: excel!Excel.Interfaces.SlicerStyleLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.SlicerStyleLoadOptions +summary: >- + Represents a slicer style, which defines style elements by region of the + slicer. +remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.SlicerStyleLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.SlicerStyleLoadOptions#name:member + package: excel! + fullName: name + summary: Specifies the name of the slicer style. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: readOnly + uid: excel!Excel.Interfaces.SlicerStyleLoadOptions#readOnly:member + package: excel! + fullName: readOnly + summary: Specifies if this `SlicerStyle` object is read-only. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readOnly?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.slicerstyleupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.slicerstyleupdatedata.yml new file mode 100644 index 0000000000..002a918fcc --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.slicerstyleupdatedata.yml @@ -0,0 +1,30 @@ +### YamlMime:TSType +name: Excel.Interfaces.SlicerStyleUpdateData +uid: excel!Excel.Interfaces.SlicerStyleUpdateData:interface +package: excel! +fullName: Excel.Interfaces.SlicerStyleUpdateData +summary: >- + An interface for updating data on the `SlicerStyle` object, for use in + `slicerStyle.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: name + uid: excel!Excel.Interfaces.SlicerStyleUpdateData#name:member + package: excel! + fullName: name + summary: Specifies the name of the slicer style. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.slicerupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.slicerupdatedata.yml new file mode 100644 index 0000000000..37c49626e1 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.slicerupdatedata.yml @@ -0,0 +1,180 @@ +### YamlMime:TSType +name: Excel.Interfaces.SlicerUpdateData +uid: excel!Excel.Interfaces.SlicerUpdateData:interface +package: excel! +fullName: Excel.Interfaces.SlicerUpdateData +summary: >- + An interface for updating data on the `Slicer` object, for use in + `slicer.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: caption + uid: excel!Excel.Interfaces.SlicerUpdateData#caption:member + package: excel! + fullName: caption + summary: Represents the caption of the slicer. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'caption?: string;' + return: + type: string + - name: height + uid: excel!Excel.Interfaces.SlicerUpdateData#height:member + package: excel! + fullName: height + summary: >- + Specifies the height, in points, of the slicer. Throws an + `InvalidArgument` exception when set with a negative value or zero as an + input. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height?: number;' + return: + type: number + - name: left + uid: excel!Excel.Interfaces.SlicerUpdateData#left:member + package: excel! + fullName: left + summary: >- + Represents the distance, in points, from the left side of the slicer to + the left of the worksheet. Throws an `InvalidArgument` error when set with + a negative value as an input. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: number;' + return: + type: number + - name: name + uid: excel!Excel.Interfaces.SlicerUpdateData#name:member + package: excel! + fullName: name + summary: Represents the name of the slicer. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: sortBy + uid: excel!Excel.Interfaces.SlicerUpdateData#sortBy:member + package: excel! + fullName: sortBy + summary: >- + Specifies the sort order of the items in the slicer. Possible values are: + "DataSourceOrder", "Ascending", "Descending". + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + sortBy?: Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | + "Descending"; + return: + type: >- + | "DataSourceOrder" | + "Ascending" | "Descending" + - name: style + uid: excel!Excel.Interfaces.SlicerUpdateData#style:member + package: excel! + fullName: style + summary: >- + Constant value that represents the slicer style. Possible values are: + "SlicerStyleLight1" through "SlicerStyleLight6", "TableStyleOther1" + through "TableStyleOther2", "SlicerStyleDark1" through "SlicerStyleDark6". + A custom user-defined style present in the workbook can also be specified. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'style?: string;' + return: + type: string + - name: top + uid: excel!Excel.Interfaces.SlicerUpdateData#top:member + package: excel! + fullName: top + summary: >- + Represents the distance, in points, from the top edge of the slicer to the + top of the worksheet. Throws an `InvalidArgument` error when set with a + negative value as an input. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: number;' + return: + type: number + - name: width + uid: excel!Excel.Interfaces.SlicerUpdateData#width:member + package: excel! + fullName: width + summary: >- + Represents the width, in points, of the slicer. Throws an + `InvalidArgument` error when set with a negative value or zero as an + input. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width?: number;' + return: + type: number + - name: worksheet + uid: excel!Excel.Interfaces.SlicerUpdateData#worksheet:member + package: excel! + fullName: worksheet + summary: Represents the worksheet containing the slicer. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheet?: Excel.Interfaces.WorksheetUpdateData;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.stylecollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.stylecollectiondata.yml new file mode 100644 index 0000000000..3ea5477bb8 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.stylecollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.StyleCollectionData +uid: excel!Excel.Interfaces.StyleCollectionData:interface +package: excel! +fullName: Excel.Interfaces.StyleCollectionData +summary: >- + An interface describing the data returned by calling + `styleCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.StyleCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.StyleData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.stylecollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.stylecollectionloadoptions.yml new file mode 100644 index 0000000000..df1bdb1da8 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.stylecollectionloadoptions.yml @@ -0,0 +1,420 @@ +### YamlMime:TSType +name: Excel.Interfaces.StyleCollectionLoadOptions +uid: excel!Excel.Interfaces.StyleCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.StyleCollectionLoadOptions +summary: Represents a collection of all the styles. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.StyleCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: autoIndent + uid: excel!Excel.Interfaces.StyleCollectionLoadOptions#autoIndent:member + package: excel! + fullName: autoIndent + summary: >- + For EACH ITEM in the collection: Specifies if text is automatically + indented when the text alignment in a cell is set to equal distribution. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'autoIndent?: boolean;' + return: + type: boolean + - name: borders + uid: excel!Excel.Interfaces.StyleCollectionLoadOptions#borders:member + package: excel! + fullName: borders + summary: >- + For EACH ITEM in the collection: A collection of four border objects that + represent the style of the four borders. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'borders?: Excel.Interfaces.RangeBorderCollectionLoadOptions;' + return: + type: >- + + - name: builtIn + uid: excel!Excel.Interfaces.StyleCollectionLoadOptions#builtIn:member + package: excel! + fullName: builtIn + summary: >- + For EACH ITEM in the collection: Specifies if the style is a built-in + style. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'builtIn?: boolean;' + return: + type: boolean + - name: fill + uid: excel!Excel.Interfaces.StyleCollectionLoadOptions#fill:member + package: excel! + fullName: fill + summary: 'For EACH ITEM in the collection: The fill of the style.' + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'fill?: Excel.Interfaces.RangeFillLoadOptions;' + return: + type: + - name: font + uid: excel!Excel.Interfaces.StyleCollectionLoadOptions#font:member + package: excel! + fullName: font + summary: >- + For EACH ITEM in the collection: A `Font` object that represents the font + of the style. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.Interfaces.RangeFontLoadOptions;' + return: + type: + - name: formulaHidden + uid: excel!Excel.Interfaces.StyleCollectionLoadOptions#formulaHidden:member + package: excel! + fullName: formulaHidden + summary: >- + For EACH ITEM in the collection: Specifies if the formula will be hidden + when the worksheet is protected. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulaHidden?: boolean;' + return: + type: boolean + - name: horizontalAlignment + uid: >- + excel!Excel.Interfaces.StyleCollectionLoadOptions#horizontalAlignment:member + package: excel! + fullName: horizontalAlignment + summary: >- + For EACH ITEM in the collection: Represents the horizontal alignment for + the style. See `Excel.HorizontalAlignment` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'horizontalAlignment?: boolean;' + return: + type: boolean + - name: includeAlignment + uid: excel!Excel.Interfaces.StyleCollectionLoadOptions#includeAlignment:member + package: excel! + fullName: includeAlignment + summary: >- + For EACH ITEM in the collection: Specifies if the style includes the auto + indent, horizontal alignment, vertical alignment, wrap text, indent level, + and text orientation properties. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'includeAlignment?: boolean;' + return: + type: boolean + - name: includeBorder + uid: excel!Excel.Interfaces.StyleCollectionLoadOptions#includeBorder:member + package: excel! + fullName: includeBorder + summary: >- + For EACH ITEM in the collection: Specifies if the style includes the + color, color index, line style, and weight border properties. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'includeBorder?: boolean;' + return: + type: boolean + - name: includeFont + uid: excel!Excel.Interfaces.StyleCollectionLoadOptions#includeFont:member + package: excel! + fullName: includeFont + summary: >- + For EACH ITEM in the collection: Specifies if the style includes the + background, bold, color, color index, font style, italic, name, size, + strikethrough, subscript, superscript, and underline font properties. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'includeFont?: boolean;' + return: + type: boolean + - name: includeNumber + uid: excel!Excel.Interfaces.StyleCollectionLoadOptions#includeNumber:member + package: excel! + fullName: includeNumber + summary: >- + For EACH ITEM in the collection: Specifies if the style includes the + number format property. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'includeNumber?: boolean;' + return: + type: boolean + - name: includePatterns + uid: excel!Excel.Interfaces.StyleCollectionLoadOptions#includePatterns:member + package: excel! + fullName: includePatterns + summary: >- + For EACH ITEM in the collection: Specifies if the style includes the + color, color index, invert if negative, pattern, pattern color, and + pattern color index interior properties. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'includePatterns?: boolean;' + return: + type: boolean + - name: includeProtection + uid: excel!Excel.Interfaces.StyleCollectionLoadOptions#includeProtection:member + package: excel! + fullName: includeProtection + summary: >- + For EACH ITEM in the collection: Specifies if the style includes the + formula hidden and locked protection properties. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'includeProtection?: boolean;' + return: + type: boolean + - name: indentLevel + uid: excel!Excel.Interfaces.StyleCollectionLoadOptions#indentLevel:member + package: excel! + fullName: indentLevel + summary: >- + For EACH ITEM in the collection: An integer from 0 to 250 that indicates + the indent level for the style. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'indentLevel?: boolean;' + return: + type: boolean + - name: locked + uid: excel!Excel.Interfaces.StyleCollectionLoadOptions#locked:member + package: excel! + fullName: locked + summary: >- + For EACH ITEM in the collection: Specifies if the object is locked when + the worksheet is protected. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'locked?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.StyleCollectionLoadOptions#name:member + package: excel! + fullName: name + summary: 'For EACH ITEM in the collection: The name of the style.' + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: numberFormat + uid: excel!Excel.Interfaces.StyleCollectionLoadOptions#numberFormat:member + package: excel! + fullName: numberFormat + summary: >- + For EACH ITEM in the collection: The format code of the number format for + the style. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat?: boolean;' + return: + type: boolean + - name: numberFormatLocal + uid: excel!Excel.Interfaces.StyleCollectionLoadOptions#numberFormatLocal:member + package: excel! + fullName: numberFormatLocal + summary: >- + For EACH ITEM in the collection: The localized format code of the number + format for the style. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormatLocal?: boolean;' + return: + type: boolean + - name: readingOrder + uid: excel!Excel.Interfaces.StyleCollectionLoadOptions#readingOrder:member + package: excel! + fullName: readingOrder + summary: 'For EACH ITEM in the collection: The reading order for the style.' + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readingOrder?: boolean;' + return: + type: boolean + - name: shrinkToFit + uid: excel!Excel.Interfaces.StyleCollectionLoadOptions#shrinkToFit:member + package: excel! + fullName: shrinkToFit + summary: >- + For EACH ITEM in the collection: Specifies if text automatically shrinks + to fit in the available column width. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'shrinkToFit?: boolean;' + return: + type: boolean + - name: textOrientation + uid: excel!Excel.Interfaces.StyleCollectionLoadOptions#textOrientation:member + package: excel! + fullName: textOrientation + summary: 'For EACH ITEM in the collection: The text orientation for the style.' + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textOrientation?: boolean;' + return: + type: boolean + - name: verticalAlignment + uid: excel!Excel.Interfaces.StyleCollectionLoadOptions#verticalAlignment:member + package: excel! + fullName: verticalAlignment + summary: >- + For EACH ITEM in the collection: Specifies the vertical alignment for the + style. See `Excel.VerticalAlignment` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'verticalAlignment?: boolean;' + return: + type: boolean + - name: wrapText + uid: excel!Excel.Interfaces.StyleCollectionLoadOptions#wrapText:member + package: excel! + fullName: wrapText + summary: >- + For EACH ITEM in the collection: Specifies if Excel wraps the text in the + object. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'wrapText?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.stylecollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.stylecollectionupdatedata.yml new file mode 100644 index 0000000000..95fb192e92 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.stylecollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.StyleCollectionUpdateData +uid: excel!Excel.Interfaces.StyleCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.StyleCollectionUpdateData +summary: >- + An interface for updating data on the `StyleCollection` object, for use in + `styleCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.StyleCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.StyleData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.styledata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.styledata.yml new file mode 100644 index 0000000000..1d5aeaaf34 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.styledata.yml @@ -0,0 +1,394 @@ +### YamlMime:TSType +name: Excel.Interfaces.StyleData +uid: excel!Excel.Interfaces.StyleData:interface +package: excel! +fullName: Excel.Interfaces.StyleData +summary: An interface describing the data returned by calling `style.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: autoIndent + uid: excel!Excel.Interfaces.StyleData#autoIndent:member + package: excel! + fullName: autoIndent + summary: >- + Specifies if text is automatically indented when the text alignment in a + cell is set to equal distribution. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'autoIndent?: boolean;' + return: + type: boolean + - name: borders + uid: excel!Excel.Interfaces.StyleData#borders:member + package: excel! + fullName: borders + summary: >- + A collection of four border objects that represent the style of the four + borders. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'borders?: Excel.Interfaces.RangeBorderData[];' + return: + type: [] + - name: builtIn + uid: excel!Excel.Interfaces.StyleData#builtIn:member + package: excel! + fullName: builtIn + summary: Specifies if the style is a built-in style. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'builtIn?: boolean;' + return: + type: boolean + - name: fill + uid: excel!Excel.Interfaces.StyleData#fill:member + package: excel! + fullName: fill + summary: The fill of the style. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'fill?: Excel.Interfaces.RangeFillData;' + return: + type: + - name: font + uid: excel!Excel.Interfaces.StyleData#font:member + package: excel! + fullName: font + summary: A `Font` object that represents the font of the style. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.Interfaces.RangeFontData;' + return: + type: + - name: formulaHidden + uid: excel!Excel.Interfaces.StyleData#formulaHidden:member + package: excel! + fullName: formulaHidden + summary: Specifies if the formula will be hidden when the worksheet is protected. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulaHidden?: boolean;' + return: + type: boolean + - name: horizontalAlignment + uid: excel!Excel.Interfaces.StyleData#horizontalAlignment:member + package: excel! + fullName: horizontalAlignment + summary: >- + Represents the horizontal alignment for the style. See + `Excel.HorizontalAlignment` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + horizontalAlignment?: Excel.HorizontalAlignment | "General" | "Left" | + "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | + "Distributed"; + return: + type: >- + | "General" | + "Left" | "Center" | "Right" | "Fill" | "Justify" | + "CenterAcrossSelection" | "Distributed" + - name: includeAlignment + uid: excel!Excel.Interfaces.StyleData#includeAlignment:member + package: excel! + fullName: includeAlignment + summary: >- + Specifies if the style includes the auto indent, horizontal alignment, + vertical alignment, wrap text, indent level, and text orientation + properties. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'includeAlignment?: boolean;' + return: + type: boolean + - name: includeBorder + uid: excel!Excel.Interfaces.StyleData#includeBorder:member + package: excel! + fullName: includeBorder + summary: >- + Specifies if the style includes the color, color index, line style, and + weight border properties. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'includeBorder?: boolean;' + return: + type: boolean + - name: includeFont + uid: excel!Excel.Interfaces.StyleData#includeFont:member + package: excel! + fullName: includeFont + summary: >- + Specifies if the style includes the background, bold, color, color index, + font style, italic, name, size, strikethrough, subscript, superscript, and + underline font properties. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'includeFont?: boolean;' + return: + type: boolean + - name: includeNumber + uid: excel!Excel.Interfaces.StyleData#includeNumber:member + package: excel! + fullName: includeNumber + summary: Specifies if the style includes the number format property. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'includeNumber?: boolean;' + return: + type: boolean + - name: includePatterns + uid: excel!Excel.Interfaces.StyleData#includePatterns:member + package: excel! + fullName: includePatterns + summary: >- + Specifies if the style includes the color, color index, invert if + negative, pattern, pattern color, and pattern color index interior + properties. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'includePatterns?: boolean;' + return: + type: boolean + - name: includeProtection + uid: excel!Excel.Interfaces.StyleData#includeProtection:member + package: excel! + fullName: includeProtection + summary: >- + Specifies if the style includes the formula hidden and locked protection + properties. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'includeProtection?: boolean;' + return: + type: boolean + - name: indentLevel + uid: excel!Excel.Interfaces.StyleData#indentLevel:member + package: excel! + fullName: indentLevel + summary: An integer from 0 to 250 that indicates the indent level for the style. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'indentLevel?: number;' + return: + type: number + - name: locked + uid: excel!Excel.Interfaces.StyleData#locked:member + package: excel! + fullName: locked + summary: Specifies if the object is locked when the worksheet is protected. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'locked?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.StyleData#name:member + package: excel! + fullName: name + summary: The name of the style. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: numberFormat + uid: excel!Excel.Interfaces.StyleData#numberFormat:member + package: excel! + fullName: numberFormat + summary: The format code of the number format for the style. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat?: string;' + return: + type: string + - name: numberFormatLocal + uid: excel!Excel.Interfaces.StyleData#numberFormatLocal:member + package: excel! + fullName: numberFormatLocal + summary: The localized format code of the number format for the style. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormatLocal?: string;' + return: + type: string + - name: readingOrder + uid: excel!Excel.Interfaces.StyleData#readingOrder:member + package: excel! + fullName: readingOrder + summary: The reading order for the style. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readingOrder?: Excel.ReadingOrder | "Context" | "LeftToRight" | + "RightToLeft"; + return: + type: >- + | "Context" | + "LeftToRight" | "RightToLeft" + - name: shrinkToFit + uid: excel!Excel.Interfaces.StyleData#shrinkToFit:member + package: excel! + fullName: shrinkToFit + summary: >- + Specifies if text automatically shrinks to fit in the available column + width. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'shrinkToFit?: boolean;' + return: + type: boolean + - name: textOrientation + uid: excel!Excel.Interfaces.StyleData#textOrientation:member + package: excel! + fullName: textOrientation + summary: The text orientation for the style. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textOrientation?: number;' + return: + type: number + - name: verticalAlignment + uid: excel!Excel.Interfaces.StyleData#verticalAlignment:member + package: excel! + fullName: verticalAlignment + summary: >- + Specifies the vertical alignment for the style. See + `Excel.VerticalAlignment` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + verticalAlignment?: Excel.VerticalAlignment | "Top" | "Center" | + "Bottom" | "Justify" | "Distributed"; + return: + type: >- + | "Top" | "Center" | + "Bottom" | "Justify" | "Distributed" + - name: wrapText + uid: excel!Excel.Interfaces.StyleData#wrapText:member + package: excel! + fullName: wrapText + summary: Specifies if Excel wraps the text in the object. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'wrapText?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.styleloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.styleloadoptions.yml new file mode 100644 index 0000000000..ae3a6365ab --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.styleloadoptions.yml @@ -0,0 +1,401 @@ +### YamlMime:TSType +name: Excel.Interfaces.StyleLoadOptions +uid: excel!Excel.Interfaces.StyleLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.StyleLoadOptions +summary: An object encapsulating a style's format and other properties. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.StyleLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: autoIndent + uid: excel!Excel.Interfaces.StyleLoadOptions#autoIndent:member + package: excel! + fullName: autoIndent + summary: >- + Specifies if text is automatically indented when the text alignment in a + cell is set to equal distribution. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'autoIndent?: boolean;' + return: + type: boolean + - name: borders + uid: excel!Excel.Interfaces.StyleLoadOptions#borders:member + package: excel! + fullName: borders + summary: >- + A collection of four border objects that represent the style of the four + borders. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'borders?: Excel.Interfaces.RangeBorderCollectionLoadOptions;' + return: + type: >- + + - name: builtIn + uid: excel!Excel.Interfaces.StyleLoadOptions#builtIn:member + package: excel! + fullName: builtIn + summary: Specifies if the style is a built-in style. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'builtIn?: boolean;' + return: + type: boolean + - name: fill + uid: excel!Excel.Interfaces.StyleLoadOptions#fill:member + package: excel! + fullName: fill + summary: The fill of the style. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'fill?: Excel.Interfaces.RangeFillLoadOptions;' + return: + type: + - name: font + uid: excel!Excel.Interfaces.StyleLoadOptions#font:member + package: excel! + fullName: font + summary: A `Font` object that represents the font of the style. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.Interfaces.RangeFontLoadOptions;' + return: + type: + - name: formulaHidden + uid: excel!Excel.Interfaces.StyleLoadOptions#formulaHidden:member + package: excel! + fullName: formulaHidden + summary: Specifies if the formula will be hidden when the worksheet is protected. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulaHidden?: boolean;' + return: + type: boolean + - name: horizontalAlignment + uid: excel!Excel.Interfaces.StyleLoadOptions#horizontalAlignment:member + package: excel! + fullName: horizontalAlignment + summary: >- + Represents the horizontal alignment for the style. See + `Excel.HorizontalAlignment` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'horizontalAlignment?: boolean;' + return: + type: boolean + - name: includeAlignment + uid: excel!Excel.Interfaces.StyleLoadOptions#includeAlignment:member + package: excel! + fullName: includeAlignment + summary: >- + Specifies if the style includes the auto indent, horizontal alignment, + vertical alignment, wrap text, indent level, and text orientation + properties. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'includeAlignment?: boolean;' + return: + type: boolean + - name: includeBorder + uid: excel!Excel.Interfaces.StyleLoadOptions#includeBorder:member + package: excel! + fullName: includeBorder + summary: >- + Specifies if the style includes the color, color index, line style, and + weight border properties. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'includeBorder?: boolean;' + return: + type: boolean + - name: includeFont + uid: excel!Excel.Interfaces.StyleLoadOptions#includeFont:member + package: excel! + fullName: includeFont + summary: >- + Specifies if the style includes the background, bold, color, color index, + font style, italic, name, size, strikethrough, subscript, superscript, and + underline font properties. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'includeFont?: boolean;' + return: + type: boolean + - name: includeNumber + uid: excel!Excel.Interfaces.StyleLoadOptions#includeNumber:member + package: excel! + fullName: includeNumber + summary: Specifies if the style includes the number format property. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'includeNumber?: boolean;' + return: + type: boolean + - name: includePatterns + uid: excel!Excel.Interfaces.StyleLoadOptions#includePatterns:member + package: excel! + fullName: includePatterns + summary: >- + Specifies if the style includes the color, color index, invert if + negative, pattern, pattern color, and pattern color index interior + properties. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'includePatterns?: boolean;' + return: + type: boolean + - name: includeProtection + uid: excel!Excel.Interfaces.StyleLoadOptions#includeProtection:member + package: excel! + fullName: includeProtection + summary: >- + Specifies if the style includes the formula hidden and locked protection + properties. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'includeProtection?: boolean;' + return: + type: boolean + - name: indentLevel + uid: excel!Excel.Interfaces.StyleLoadOptions#indentLevel:member + package: excel! + fullName: indentLevel + summary: An integer from 0 to 250 that indicates the indent level for the style. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'indentLevel?: boolean;' + return: + type: boolean + - name: locked + uid: excel!Excel.Interfaces.StyleLoadOptions#locked:member + package: excel! + fullName: locked + summary: Specifies if the object is locked when the worksheet is protected. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'locked?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.StyleLoadOptions#name:member + package: excel! + fullName: name + summary: The name of the style. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: numberFormat + uid: excel!Excel.Interfaces.StyleLoadOptions#numberFormat:member + package: excel! + fullName: numberFormat + summary: The format code of the number format for the style. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat?: boolean;' + return: + type: boolean + - name: numberFormatLocal + uid: excel!Excel.Interfaces.StyleLoadOptions#numberFormatLocal:member + package: excel! + fullName: numberFormatLocal + summary: The localized format code of the number format for the style. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormatLocal?: boolean;' + return: + type: boolean + - name: readingOrder + uid: excel!Excel.Interfaces.StyleLoadOptions#readingOrder:member + package: excel! + fullName: readingOrder + summary: The reading order for the style. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readingOrder?: boolean;' + return: + type: boolean + - name: shrinkToFit + uid: excel!Excel.Interfaces.StyleLoadOptions#shrinkToFit:member + package: excel! + fullName: shrinkToFit + summary: >- + Specifies if text automatically shrinks to fit in the available column + width. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'shrinkToFit?: boolean;' + return: + type: boolean + - name: textOrientation + uid: excel!Excel.Interfaces.StyleLoadOptions#textOrientation:member + package: excel! + fullName: textOrientation + summary: The text orientation for the style. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textOrientation?: boolean;' + return: + type: boolean + - name: verticalAlignment + uid: excel!Excel.Interfaces.StyleLoadOptions#verticalAlignment:member + package: excel! + fullName: verticalAlignment + summary: >- + Specifies the vertical alignment for the style. See + `Excel.VerticalAlignment` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'verticalAlignment?: boolean;' + return: + type: boolean + - name: wrapText + uid: excel!Excel.Interfaces.StyleLoadOptions#wrapText:member + package: excel! + fullName: wrapText + summary: Specifies if Excel wraps the text in the object. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'wrapText?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.styleupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.styleupdatedata.yml new file mode 100644 index 0000000000..ea800e0e01 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.styleupdatedata.yml @@ -0,0 +1,369 @@ +### YamlMime:TSType +name: Excel.Interfaces.StyleUpdateData +uid: excel!Excel.Interfaces.StyleUpdateData:interface +package: excel! +fullName: Excel.Interfaces.StyleUpdateData +summary: >- + An interface for updating data on the `Style` object, for use in `style.set({ + ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: autoIndent + uid: excel!Excel.Interfaces.StyleUpdateData#autoIndent:member + package: excel! + fullName: autoIndent + summary: >- + Specifies if text is automatically indented when the text alignment in a + cell is set to equal distribution. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'autoIndent?: boolean;' + return: + type: boolean + - name: borders + uid: excel!Excel.Interfaces.StyleUpdateData#borders:member + package: excel! + fullName: borders + summary: >- + A collection of four border objects that represent the style of the four + borders. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'borders?: Excel.Interfaces.RangeBorderCollectionUpdateData;' + return: + type: >- + + - name: fill + uid: excel!Excel.Interfaces.StyleUpdateData#fill:member + package: excel! + fullName: fill + summary: The fill of the style. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'fill?: Excel.Interfaces.RangeFillUpdateData;' + return: + type: + - name: font + uid: excel!Excel.Interfaces.StyleUpdateData#font:member + package: excel! + fullName: font + summary: A `Font` object that represents the font of the style. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.Interfaces.RangeFontUpdateData;' + return: + type: + - name: formulaHidden + uid: excel!Excel.Interfaces.StyleUpdateData#formulaHidden:member + package: excel! + fullName: formulaHidden + summary: Specifies if the formula will be hidden when the worksheet is protected. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulaHidden?: boolean;' + return: + type: boolean + - name: horizontalAlignment + uid: excel!Excel.Interfaces.StyleUpdateData#horizontalAlignment:member + package: excel! + fullName: horizontalAlignment + summary: >- + Represents the horizontal alignment for the style. See + `Excel.HorizontalAlignment` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + horizontalAlignment?: Excel.HorizontalAlignment | "General" | "Left" | + "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | + "Distributed"; + return: + type: >- + | "General" | + "Left" | "Center" | "Right" | "Fill" | "Justify" | + "CenterAcrossSelection" | "Distributed" + - name: includeAlignment + uid: excel!Excel.Interfaces.StyleUpdateData#includeAlignment:member + package: excel! + fullName: includeAlignment + summary: >- + Specifies if the style includes the auto indent, horizontal alignment, + vertical alignment, wrap text, indent level, and text orientation + properties. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'includeAlignment?: boolean;' + return: + type: boolean + - name: includeBorder + uid: excel!Excel.Interfaces.StyleUpdateData#includeBorder:member + package: excel! + fullName: includeBorder + summary: >- + Specifies if the style includes the color, color index, line style, and + weight border properties. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'includeBorder?: boolean;' + return: + type: boolean + - name: includeFont + uid: excel!Excel.Interfaces.StyleUpdateData#includeFont:member + package: excel! + fullName: includeFont + summary: >- + Specifies if the style includes the background, bold, color, color index, + font style, italic, name, size, strikethrough, subscript, superscript, and + underline font properties. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'includeFont?: boolean;' + return: + type: boolean + - name: includeNumber + uid: excel!Excel.Interfaces.StyleUpdateData#includeNumber:member + package: excel! + fullName: includeNumber + summary: Specifies if the style includes the number format property. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'includeNumber?: boolean;' + return: + type: boolean + - name: includePatterns + uid: excel!Excel.Interfaces.StyleUpdateData#includePatterns:member + package: excel! + fullName: includePatterns + summary: >- + Specifies if the style includes the color, color index, invert if + negative, pattern, pattern color, and pattern color index interior + properties. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'includePatterns?: boolean;' + return: + type: boolean + - name: includeProtection + uid: excel!Excel.Interfaces.StyleUpdateData#includeProtection:member + package: excel! + fullName: includeProtection + summary: >- + Specifies if the style includes the formula hidden and locked protection + properties. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'includeProtection?: boolean;' + return: + type: boolean + - name: indentLevel + uid: excel!Excel.Interfaces.StyleUpdateData#indentLevel:member + package: excel! + fullName: indentLevel + summary: An integer from 0 to 250 that indicates the indent level for the style. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'indentLevel?: number;' + return: + type: number + - name: locked + uid: excel!Excel.Interfaces.StyleUpdateData#locked:member + package: excel! + fullName: locked + summary: Specifies if the object is locked when the worksheet is protected. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'locked?: boolean;' + return: + type: boolean + - name: numberFormat + uid: excel!Excel.Interfaces.StyleUpdateData#numberFormat:member + package: excel! + fullName: numberFormat + summary: The format code of the number format for the style. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat?: string;' + return: + type: string + - name: numberFormatLocal + uid: excel!Excel.Interfaces.StyleUpdateData#numberFormatLocal:member + package: excel! + fullName: numberFormatLocal + summary: The localized format code of the number format for the style. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormatLocal?: string;' + return: + type: string + - name: readingOrder + uid: excel!Excel.Interfaces.StyleUpdateData#readingOrder:member + package: excel! + fullName: readingOrder + summary: The reading order for the style. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readingOrder?: Excel.ReadingOrder | "Context" | "LeftToRight" | + "RightToLeft"; + return: + type: >- + | "Context" | + "LeftToRight" | "RightToLeft" + - name: shrinkToFit + uid: excel!Excel.Interfaces.StyleUpdateData#shrinkToFit:member + package: excel! + fullName: shrinkToFit + summary: >- + Specifies if text automatically shrinks to fit in the available column + width. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'shrinkToFit?: boolean;' + return: + type: boolean + - name: textOrientation + uid: excel!Excel.Interfaces.StyleUpdateData#textOrientation:member + package: excel! + fullName: textOrientation + summary: The text orientation for the style. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textOrientation?: number;' + return: + type: number + - name: verticalAlignment + uid: excel!Excel.Interfaces.StyleUpdateData#verticalAlignment:member + package: excel! + fullName: verticalAlignment + summary: >- + Specifies the vertical alignment for the style. See + `Excel.VerticalAlignment` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + verticalAlignment?: Excel.VerticalAlignment | "Top" | "Center" | + "Bottom" | "Justify" | "Distributed"; + return: + type: >- + | "Top" | "Center" | + "Bottom" | "Justify" | "Distributed" + - name: wrapText + uid: excel!Excel.Interfaces.StyleUpdateData#wrapText:member + package: excel! + fullName: wrapText + summary: Specifies if Excel wraps the text in the object. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'wrapText?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablecollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablecollectiondata.yml new file mode 100644 index 0000000000..9e591e43a2 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablecollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.TableCollectionData +uid: excel!Excel.Interfaces.TableCollectionData:interface +package: excel! +fullName: Excel.Interfaces.TableCollectionData +summary: >- + An interface describing the data returned by calling + `tableCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.TableCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.TableData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablecollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablecollectionloadoptions.yml new file mode 100644 index 0000000000..3c4260b9c4 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablecollectionloadoptions.yml @@ -0,0 +1,320 @@ +### YamlMime:TSType +name: Excel.Interfaces.TableCollectionLoadOptions +uid: excel!Excel.Interfaces.TableCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.TableCollectionLoadOptions +summary: >- + Represents a collection of all the tables that are part of the workbook or + worksheet, depending on how it was reached. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.TableCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: autoFilter + uid: excel!Excel.Interfaces.TableCollectionLoadOptions#autoFilter:member + package: excel! + fullName: autoFilter + summary: >- + For EACH ITEM in the collection: Represents the `AutoFilter` object of the + table. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'autoFilter?: Excel.Interfaces.AutoFilterLoadOptions;' + return: + type: + - name: columns + uid: excel!Excel.Interfaces.TableCollectionLoadOptions#columns:member + package: excel! + fullName: columns + summary: >- + For EACH ITEM in the collection: Represents a collection of all the + columns in the table. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'columns?: Excel.Interfaces.TableColumnCollectionLoadOptions;' + return: + type: >- + + - name: highlightFirstColumn + uid: >- + excel!Excel.Interfaces.TableCollectionLoadOptions#highlightFirstColumn:member + package: excel! + fullName: highlightFirstColumn + summary: >- + For EACH ITEM in the collection: Specifies if the first column contains + special formatting. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'highlightFirstColumn?: boolean;' + return: + type: boolean + - name: highlightLastColumn + uid: >- + excel!Excel.Interfaces.TableCollectionLoadOptions#highlightLastColumn:member + package: excel! + fullName: highlightLastColumn + summary: >- + For EACH ITEM in the collection: Specifies if the last column contains + special formatting. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'highlightLastColumn?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.TableCollectionLoadOptions#id:member + package: excel! + fullName: id + summary: >- + For EACH ITEM in the collection: Returns a value that uniquely identifies + the table in a given workbook. The value of the identifier remains the + same even when the table is renamed. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: legacyId + uid: excel!Excel.Interfaces.TableCollectionLoadOptions#legacyId:member + package: excel! + fullName: legacyId + summary: 'For EACH ITEM in the collection: Returns a numeric ID.' + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'legacyId?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.TableCollectionLoadOptions#name:member + package: excel! + fullName: name + summary: >- + For EACH ITEM in the collection: Name of the table. + + + The set name of the table must follow the guidelines specified in the + [Rename an Excel + table](https://support.microsoft.com/office/fbf49a4f-82a3-43eb-8ba2-44d21233b114) + article. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: rows + uid: excel!Excel.Interfaces.TableCollectionLoadOptions#rows:member + package: excel! + fullName: rows + summary: >- + For EACH ITEM in the collection: Represents a collection of all the rows + in the table. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rows?: Excel.Interfaces.TableRowCollectionLoadOptions;' + return: + type: >- + + - name: showBandedColumns + uid: excel!Excel.Interfaces.TableCollectionLoadOptions#showBandedColumns:member + package: excel! + fullName: showBandedColumns + summary: >- + For EACH ITEM in the collection: Specifies if the columns show banded + formatting in which odd columns are highlighted differently from even + ones, to make reading the table easier. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showBandedColumns?: boolean;' + return: + type: boolean + - name: showBandedRows + uid: excel!Excel.Interfaces.TableCollectionLoadOptions#showBandedRows:member + package: excel! + fullName: showBandedRows + summary: >- + For EACH ITEM in the collection: Specifies if the rows show banded + formatting in which odd rows are highlighted differently from even ones, + to make reading the table easier. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showBandedRows?: boolean;' + return: + type: boolean + - name: showFilterButton + uid: excel!Excel.Interfaces.TableCollectionLoadOptions#showFilterButton:member + package: excel! + fullName: showFilterButton + summary: >- + For EACH ITEM in the collection: Specifies if the filter buttons are + visible at the top of each column header. Setting this is only allowed if + the table contains a header row. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showFilterButton?: boolean;' + return: + type: boolean + - name: showHeaders + uid: excel!Excel.Interfaces.TableCollectionLoadOptions#showHeaders:member + package: excel! + fullName: showHeaders + summary: >- + For EACH ITEM in the collection: Specifies if the header row is visible. + This value can be set to show or remove the header row. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showHeaders?: boolean;' + return: + type: boolean + - name: showTotals + uid: excel!Excel.Interfaces.TableCollectionLoadOptions#showTotals:member + package: excel! + fullName: showTotals + summary: >- + For EACH ITEM in the collection: Specifies if the total row is visible. + This value can be set to show or remove the total row. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showTotals?: boolean;' + return: + type: boolean + - name: sort + uid: excel!Excel.Interfaces.TableCollectionLoadOptions#sort:member + package: excel! + fullName: sort + summary: 'For EACH ITEM in the collection: Represents the sorting for the table.' + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'sort?: Excel.Interfaces.TableSortLoadOptions;' + return: + type: + - name: style + uid: excel!Excel.Interfaces.TableCollectionLoadOptions#style:member + package: excel! + fullName: style + summary: >- + For EACH ITEM in the collection: Constant value that represents the table + style. Possible values are: "TableStyleLight1" through + "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", + "TableStyleDark1" through "TableStyleDark11". A custom user-defined style + present in the workbook can also be specified. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'style?: boolean;' + return: + type: boolean + - name: worksheet + uid: excel!Excel.Interfaces.TableCollectionLoadOptions#worksheet:member + package: excel! + fullName: worksheet + summary: >- + For EACH ITEM in the collection: The worksheet containing the current + table. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheet?: Excel.Interfaces.WorksheetLoadOptions;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablecollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablecollectionupdatedata.yml new file mode 100644 index 0000000000..b190af0a55 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablecollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.TableCollectionUpdateData +uid: excel!Excel.Interfaces.TableCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.TableCollectionUpdateData +summary: >- + An interface for updating data on the `TableCollection` object, for use in + `tableCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.TableCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.TableData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablecolumncollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablecolumncollectiondata.yml new file mode 100644 index 0000000000..0db79c0652 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablecolumncollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.TableColumnCollectionData +uid: excel!Excel.Interfaces.TableColumnCollectionData:interface +package: excel! +fullName: Excel.Interfaces.TableColumnCollectionData +summary: >- + An interface describing the data returned by calling + `tableColumnCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.TableColumnCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.TableColumnData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablecolumncollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablecolumncollectionloadoptions.yml new file mode 100644 index 0000000000..139b153d29 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablecolumncollectionloadoptions.yml @@ -0,0 +1,164 @@ +### YamlMime:TSType +name: Excel.Interfaces.TableColumnCollectionLoadOptions +uid: excel!Excel.Interfaces.TableColumnCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.TableColumnCollectionLoadOptions +summary: Represents a collection of all the columns that are part of the table. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.TableColumnCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: filter + uid: excel!Excel.Interfaces.TableColumnCollectionLoadOptions#filter:member + package: excel! + fullName: filter + summary: >- + For EACH ITEM in the collection: Retrieves the filter applied to the + column. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'filter?: Excel.Interfaces.FilterLoadOptions;' + return: + type: + - name: id + uid: excel!Excel.Interfaces.TableColumnCollectionLoadOptions#id:member + package: excel! + fullName: id + summary: >- + For EACH ITEM in the collection: Returns a unique key that identifies the + column within the table. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: index + uid: excel!Excel.Interfaces.TableColumnCollectionLoadOptions#index:member + package: excel! + fullName: index + summary: >- + For EACH ITEM in the collection: Returns the index number of the column + within the columns collection of the table. Zero-indexed. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'index?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.TableColumnCollectionLoadOptions#name:member + package: excel! + fullName: name + summary: 'For EACH ITEM in the collection: Specifies the name of the table column.' + remarks: >- + \[ [API set: ExcelApi 1.1 for getting the name; 1.4 for setting + it.](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: values + uid: excel!Excel.Interfaces.TableColumnCollectionLoadOptions#values:member + package: excel! + fullName: values + summary: >- + For EACH ITEM in the collection: Represents the raw values of the + specified range. The data returned could be a string, number, or boolean. + Cells that contain an error will return the error string. If the returned + value starts with a plus ("+"), minus ("-"), or equal sign ("="), Excel + interprets this value as a formula. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'values?: boolean;' + return: + type: boolean + - name: valuesAsJson + uid: >- + excel!Excel.Interfaces.TableColumnCollectionLoadOptions#valuesAsJson:member + package: excel! + fullName: valuesAsJson + summary: >- + For EACH ITEM in the collection: A JSON representation of the values in + the cells in this table column. Unlike `TableColumn.values`, + `TableColumn.valuesAsJson` supports all data types which can be in a cell. + Examples include formatted number values and web images, in addition to + the standard boolean, number, and string values. Data returned from this + API always aligns with the en-US locale. To retrieve data in the user's + display locale, use `TableColumn.valuesAsJsonLocal`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJson?: boolean;' + return: + type: boolean + - name: valuesAsJsonLocal + uid: >- + excel!Excel.Interfaces.TableColumnCollectionLoadOptions#valuesAsJsonLocal:member + package: excel! + fullName: valuesAsJsonLocal + summary: >- + For EACH ITEM in the collection: A JSON representation of the values in + the cells in this table column. Unlike `TableColumn.values`, + `TableColumn.valuesAsJsonLocal` supports all data types which can be in a + cell. Examples include formatted number values and web images, in addition + to the standard boolean, number, and string values. Data returned from + this API always aligns with the user's display locale. To retrieve data + independent of locale, use `TableColumn.valuesAsJson`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJsonLocal?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablecolumncollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablecolumncollectionupdatedata.yml new file mode 100644 index 0000000000..70a9304627 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablecolumncollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.TableColumnCollectionUpdateData +uid: excel!Excel.Interfaces.TableColumnCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.TableColumnCollectionUpdateData +summary: >- + An interface for updating data on the `TableColumnCollection` object, for use + in `tableColumnCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.TableColumnCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.TableColumnData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablecolumndata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablecolumndata.yml new file mode 100644 index 0000000000..b625d76407 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablecolumndata.yml @@ -0,0 +1,141 @@ +### YamlMime:TSType +name: Excel.Interfaces.TableColumnData +uid: excel!Excel.Interfaces.TableColumnData:interface +package: excel! +fullName: Excel.Interfaces.TableColumnData +summary: >- + An interface describing the data returned by calling + `tableColumn.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: filter + uid: excel!Excel.Interfaces.TableColumnData#filter:member + package: excel! + fullName: filter + summary: Retrieves the filter applied to the column. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'filter?: Excel.Interfaces.FilterData;' + return: + type: + - name: id + uid: excel!Excel.Interfaces.TableColumnData#id:member + package: excel! + fullName: id + summary: Returns a unique key that identifies the column within the table. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: number;' + return: + type: number + - name: index + uid: excel!Excel.Interfaces.TableColumnData#index:member + package: excel! + fullName: index + summary: >- + Returns the index number of the column within the columns collection of + the table. Zero-indexed. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'index?: number;' + return: + type: number + - name: name + uid: excel!Excel.Interfaces.TableColumnData#name:member + package: excel! + fullName: name + summary: Specifies the name of the table column. + remarks: >- + \[ [API set: ExcelApi 1.1 for getting the name; 1.4 for setting + it.](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: values + uid: excel!Excel.Interfaces.TableColumnData#values:member + package: excel! + fullName: values + summary: >- + Represents the raw values of the specified range. The data returned could + be a string, number, or boolean. Cells that contain an error will return + the error string. If the returned value starts with a plus ("+"), minus + ("-"), or equal sign ("="), Excel interprets this value as a formula. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'values?: any[][];' + return: + type: any[][] + - name: valuesAsJson + uid: excel!Excel.Interfaces.TableColumnData#valuesAsJson:member + package: excel! + fullName: valuesAsJson + summary: >- + A JSON representation of the values in the cells in this table column. + Unlike `TableColumn.values`, `TableColumn.valuesAsJson` supports + all data types which can be in a cell. Examples include formatted number + values and web images, in addition to the standard boolean, number, and + string values. Data returned from this API always aligns with the en-US + locale. To retrieve data in the user's display locale, use + `TableColumn.valuesAsJsonLocal`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJson?: CellValue[][];' + return: + type: [][] + - name: valuesAsJsonLocal + uid: excel!Excel.Interfaces.TableColumnData#valuesAsJsonLocal:member + package: excel! + fullName: valuesAsJsonLocal + summary: >- + A JSON representation of the values in the cells in this table column. + Unlike `TableColumn.values`, `TableColumn.valuesAsJsonLocal` + supports all data types which can be in a cell. Examples include formatted + number values and web images, in addition to the standard boolean, number, + and string values. Data returned from this API always aligns with the + user's display locale. To retrieve data independent of locale, use + `TableColumn.valuesAsJson`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJsonLocal?: CellValue[][];' + return: + type: [][] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablecolumnloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablecolumnloadoptions.yml new file mode 100644 index 0000000000..aeba43aaef --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablecolumnloadoptions.yml @@ -0,0 +1,157 @@ +### YamlMime:TSType +name: Excel.Interfaces.TableColumnLoadOptions +uid: excel!Excel.Interfaces.TableColumnLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.TableColumnLoadOptions +summary: Represents a column in a table. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.TableColumnLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: filter + uid: excel!Excel.Interfaces.TableColumnLoadOptions#filter:member + package: excel! + fullName: filter + summary: Retrieves the filter applied to the column. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'filter?: Excel.Interfaces.FilterLoadOptions;' + return: + type: + - name: id + uid: excel!Excel.Interfaces.TableColumnLoadOptions#id:member + package: excel! + fullName: id + summary: Returns a unique key that identifies the column within the table. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: index + uid: excel!Excel.Interfaces.TableColumnLoadOptions#index:member + package: excel! + fullName: index + summary: >- + Returns the index number of the column within the columns collection of + the table. Zero-indexed. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'index?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.TableColumnLoadOptions#name:member + package: excel! + fullName: name + summary: Specifies the name of the table column. + remarks: >- + \[ [API set: ExcelApi 1.1 for getting the name; 1.4 for setting + it.](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: values + uid: excel!Excel.Interfaces.TableColumnLoadOptions#values:member + package: excel! + fullName: values + summary: >- + Represents the raw values of the specified range. The data returned could + be a string, number, or boolean. Cells that contain an error will return + the error string. If the returned value starts with a plus ("+"), minus + ("-"), or equal sign ("="), Excel interprets this value as a formula. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'values?: boolean;' + return: + type: boolean + - name: valuesAsJson + uid: excel!Excel.Interfaces.TableColumnLoadOptions#valuesAsJson:member + package: excel! + fullName: valuesAsJson + summary: >- + A JSON representation of the values in the cells in this table column. + Unlike `TableColumn.values`, `TableColumn.valuesAsJson` supports + all data types which can be in a cell. Examples include formatted number + values and web images, in addition to the standard boolean, number, and + string values. Data returned from this API always aligns with the en-US + locale. To retrieve data in the user's display locale, use + `TableColumn.valuesAsJsonLocal`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJson?: boolean;' + return: + type: boolean + - name: valuesAsJsonLocal + uid: excel!Excel.Interfaces.TableColumnLoadOptions#valuesAsJsonLocal:member + package: excel! + fullName: valuesAsJsonLocal + summary: >- + A JSON representation of the values in the cells in this table column. + Unlike `TableColumn.values`, `TableColumn.valuesAsJsonLocal` + supports all data types which can be in a cell. Examples include formatted + number values and web images, in addition to the standard boolean, number, + and string values. Data returned from this API always aligns with the + user's display locale. To retrieve data independent of locale, use + `TableColumn.valuesAsJson`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJsonLocal?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablecolumnupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablecolumnupdatedata.yml new file mode 100644 index 0000000000..4b1cd9ca6b --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablecolumnupdatedata.yml @@ -0,0 +1,94 @@ +### YamlMime:TSType +name: Excel.Interfaces.TableColumnUpdateData +uid: excel!Excel.Interfaces.TableColumnUpdateData:interface +package: excel! +fullName: Excel.Interfaces.TableColumnUpdateData +summary: >- + An interface for updating data on the `TableColumn` object, for use in + `tableColumn.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: name + uid: excel!Excel.Interfaces.TableColumnUpdateData#name:member + package: excel! + fullName: name + summary: Specifies the name of the table column. + remarks: >- + \[ [API set: ExcelApi 1.1 for getting the name; 1.4 for setting + it.](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: values + uid: excel!Excel.Interfaces.TableColumnUpdateData#values:member + package: excel! + fullName: values + summary: >- + Represents the raw values of the specified range. The data returned could + be a string, number, or boolean. Cells that contain an error will return + the error string. If the returned value starts with a plus ("+"), minus + ("-"), or equal sign ("="), Excel interprets this value as a formula. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'values?: any[][];' + return: + type: any[][] + - name: valuesAsJson + uid: excel!Excel.Interfaces.TableColumnUpdateData#valuesAsJson:member + package: excel! + fullName: valuesAsJson + summary: >- + A JSON representation of the values in the cells in this table column. + Unlike `TableColumn.values`, `TableColumn.valuesAsJson` supports + all data types which can be in a cell. Examples include formatted number + values and web images, in addition to the standard boolean, number, and + string values. Data returned from this API always aligns with the en-US + locale. To retrieve data in the user's display locale, use + `TableColumn.valuesAsJsonLocal`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJson?: CellValue[][];' + return: + type: [][] + - name: valuesAsJsonLocal + uid: excel!Excel.Interfaces.TableColumnUpdateData#valuesAsJsonLocal:member + package: excel! + fullName: valuesAsJsonLocal + summary: >- + A JSON representation of the values in the cells in this table column. + Unlike `TableColumn.values`, `TableColumn.valuesAsJsonLocal` + supports all data types which can be in a cell. Examples include formatted + number values and web images, in addition to the standard boolean, number, + and string values. Data returned from this API always aligns with the + user's display locale. To retrieve data independent of locale, use + `TableColumn.valuesAsJson`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJsonLocal?: CellValue[][];' + return: + type: [][] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tabledata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tabledata.yml new file mode 100644 index 0000000000..c864cd4b6b --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tabledata.yml @@ -0,0 +1,262 @@ +### YamlMime:TSType +name: Excel.Interfaces.TableData +uid: excel!Excel.Interfaces.TableData:interface +package: excel! +fullName: Excel.Interfaces.TableData +summary: An interface describing the data returned by calling `table.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: autoFilter + uid: excel!Excel.Interfaces.TableData#autoFilter:member + package: excel! + fullName: autoFilter + summary: Represents the `AutoFilter` object of the table. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'autoFilter?: Excel.Interfaces.AutoFilterData;' + return: + type: + - name: columns + uid: excel!Excel.Interfaces.TableData#columns:member + package: excel! + fullName: columns + summary: Represents a collection of all the columns in the table. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'columns?: Excel.Interfaces.TableColumnData[];' + return: + type: [] + - name: highlightFirstColumn + uid: excel!Excel.Interfaces.TableData#highlightFirstColumn:member + package: excel! + fullName: highlightFirstColumn + summary: Specifies if the first column contains special formatting. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'highlightFirstColumn?: boolean;' + return: + type: boolean + - name: highlightLastColumn + uid: excel!Excel.Interfaces.TableData#highlightLastColumn:member + package: excel! + fullName: highlightLastColumn + summary: Specifies if the last column contains special formatting. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'highlightLastColumn?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.TableData#id:member + package: excel! + fullName: id + summary: >- + Returns a value that uniquely identifies the table in a given workbook. + The value of the identifier remains the same even when the table is + renamed. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: string;' + return: + type: string + - name: legacyId + uid: excel!Excel.Interfaces.TableData#legacyId:member + package: excel! + fullName: legacyId + summary: Returns a numeric ID. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'legacyId?: string;' + return: + type: string + - name: name + uid: excel!Excel.Interfaces.TableData#name:member + package: excel! + fullName: name + summary: >- + Name of the table. + + + The set name of the table must follow the guidelines specified in the + [Rename an Excel + table](https://support.microsoft.com/office/fbf49a4f-82a3-43eb-8ba2-44d21233b114) + article. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: rows + uid: excel!Excel.Interfaces.TableData#rows:member + package: excel! + fullName: rows + summary: Represents a collection of all the rows in the table. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rows?: Excel.Interfaces.TableRowData[];' + return: + type: [] + - name: showBandedColumns + uid: excel!Excel.Interfaces.TableData#showBandedColumns:member + package: excel! + fullName: showBandedColumns + summary: >- + Specifies if the columns show banded formatting in which odd columns are + highlighted differently from even ones, to make reading the table easier. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showBandedColumns?: boolean;' + return: + type: boolean + - name: showBandedRows + uid: excel!Excel.Interfaces.TableData#showBandedRows:member + package: excel! + fullName: showBandedRows + summary: >- + Specifies if the rows show banded formatting in which odd rows are + highlighted differently from even ones, to make reading the table easier. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showBandedRows?: boolean;' + return: + type: boolean + - name: showFilterButton + uid: excel!Excel.Interfaces.TableData#showFilterButton:member + package: excel! + fullName: showFilterButton + summary: >- + Specifies if the filter buttons are visible at the top of each column + header. Setting this is only allowed if the table contains a header row. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showFilterButton?: boolean;' + return: + type: boolean + - name: showHeaders + uid: excel!Excel.Interfaces.TableData#showHeaders:member + package: excel! + fullName: showHeaders + summary: >- + Specifies if the header row is visible. This value can be set to show or + remove the header row. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showHeaders?: boolean;' + return: + type: boolean + - name: showTotals + uid: excel!Excel.Interfaces.TableData#showTotals:member + package: excel! + fullName: showTotals + summary: >- + Specifies if the total row is visible. This value can be set to show or + remove the total row. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showTotals?: boolean;' + return: + type: boolean + - name: sort + uid: excel!Excel.Interfaces.TableData#sort:member + package: excel! + fullName: sort + summary: Represents the sorting for the table. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'sort?: Excel.Interfaces.TableSortData;' + return: + type: + - name: style + uid: excel!Excel.Interfaces.TableData#style:member + package: excel! + fullName: style + summary: >- + Constant value that represents the table style. Possible values are: + "TableStyleLight1" through "TableStyleLight21", "TableStyleMedium1" + through "TableStyleMedium28", "TableStyleDark1" through + "TableStyleDark11". A custom user-defined style present in the workbook + can also be specified. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'style?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tableloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tableloadoptions.yml new file mode 100644 index 0000000000..0773866076 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tableloadoptions.yml @@ -0,0 +1,305 @@ +### YamlMime:TSType +name: Excel.Interfaces.TableLoadOptions +uid: excel!Excel.Interfaces.TableLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.TableLoadOptions +summary: >- + Represents an Excel table. To learn more about the table object model, read + [Work with tables using the Excel JavaScript + API](https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-tables). +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.TableLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: autoFilter + uid: excel!Excel.Interfaces.TableLoadOptions#autoFilter:member + package: excel! + fullName: autoFilter + summary: Represents the `AutoFilter` object of the table. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'autoFilter?: Excel.Interfaces.AutoFilterLoadOptions;' + return: + type: + - name: columns + uid: excel!Excel.Interfaces.TableLoadOptions#columns:member + package: excel! + fullName: columns + summary: Represents a collection of all the columns in the table. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'columns?: Excel.Interfaces.TableColumnCollectionLoadOptions;' + return: + type: >- + + - name: highlightFirstColumn + uid: excel!Excel.Interfaces.TableLoadOptions#highlightFirstColumn:member + package: excel! + fullName: highlightFirstColumn + summary: Specifies if the first column contains special formatting. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'highlightFirstColumn?: boolean;' + return: + type: boolean + - name: highlightLastColumn + uid: excel!Excel.Interfaces.TableLoadOptions#highlightLastColumn:member + package: excel! + fullName: highlightLastColumn + summary: Specifies if the last column contains special formatting. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'highlightLastColumn?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.TableLoadOptions#id:member + package: excel! + fullName: id + summary: >- + Returns a value that uniquely identifies the table in a given workbook. + The value of the identifier remains the same even when the table is + renamed. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: legacyId + uid: excel!Excel.Interfaces.TableLoadOptions#legacyId:member + package: excel! + fullName: legacyId + summary: Returns a numeric ID. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'legacyId?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.TableLoadOptions#name:member + package: excel! + fullName: name + summary: >- + Name of the table. + + + The set name of the table must follow the guidelines specified in the + [Rename an Excel + table](https://support.microsoft.com/office/fbf49a4f-82a3-43eb-8ba2-44d21233b114) + article. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: rows + uid: excel!Excel.Interfaces.TableLoadOptions#rows:member + package: excel! + fullName: rows + summary: Represents a collection of all the rows in the table. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rows?: Excel.Interfaces.TableRowCollectionLoadOptions;' + return: + type: >- + + - name: showBandedColumns + uid: excel!Excel.Interfaces.TableLoadOptions#showBandedColumns:member + package: excel! + fullName: showBandedColumns + summary: >- + Specifies if the columns show banded formatting in which odd columns are + highlighted differently from even ones, to make reading the table easier. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showBandedColumns?: boolean;' + return: + type: boolean + - name: showBandedRows + uid: excel!Excel.Interfaces.TableLoadOptions#showBandedRows:member + package: excel! + fullName: showBandedRows + summary: >- + Specifies if the rows show banded formatting in which odd rows are + highlighted differently from even ones, to make reading the table easier. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showBandedRows?: boolean;' + return: + type: boolean + - name: showFilterButton + uid: excel!Excel.Interfaces.TableLoadOptions#showFilterButton:member + package: excel! + fullName: showFilterButton + summary: >- + Specifies if the filter buttons are visible at the top of each column + header. Setting this is only allowed if the table contains a header row. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showFilterButton?: boolean;' + return: + type: boolean + - name: showHeaders + uid: excel!Excel.Interfaces.TableLoadOptions#showHeaders:member + package: excel! + fullName: showHeaders + summary: >- + Specifies if the header row is visible. This value can be set to show or + remove the header row. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showHeaders?: boolean;' + return: + type: boolean + - name: showTotals + uid: excel!Excel.Interfaces.TableLoadOptions#showTotals:member + package: excel! + fullName: showTotals + summary: >- + Specifies if the total row is visible. This value can be set to show or + remove the total row. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showTotals?: boolean;' + return: + type: boolean + - name: sort + uid: excel!Excel.Interfaces.TableLoadOptions#sort:member + package: excel! + fullName: sort + summary: Represents the sorting for the table. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'sort?: Excel.Interfaces.TableSortLoadOptions;' + return: + type: + - name: style + uid: excel!Excel.Interfaces.TableLoadOptions#style:member + package: excel! + fullName: style + summary: >- + Constant value that represents the table style. Possible values are: + "TableStyleLight1" through "TableStyleLight21", "TableStyleMedium1" + through "TableStyleMedium28", "TableStyleDark1" through + "TableStyleDark11". A custom user-defined style present in the workbook + can also be specified. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'style?: boolean;' + return: + type: boolean + - name: worksheet + uid: excel!Excel.Interfaces.TableLoadOptions#worksheet:member + package: excel! + fullName: worksheet + summary: The worksheet containing the current table. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheet?: Excel.Interfaces.WorksheetLoadOptions;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablerowcollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablerowcollectiondata.yml new file mode 100644 index 0000000000..6223c97cc4 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablerowcollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.TableRowCollectionData +uid: excel!Excel.Interfaces.TableRowCollectionData:interface +package: excel! +fullName: Excel.Interfaces.TableRowCollectionData +summary: >- + An interface describing the data returned by calling + `tableRowCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.TableRowCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.TableRowData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablerowcollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablerowcollectionloadoptions.yml new file mode 100644 index 0000000000..8b4e391957 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablerowcollectionloadoptions.yml @@ -0,0 +1,122 @@ +### YamlMime:TSType +name: Excel.Interfaces.TableRowCollectionLoadOptions +uid: excel!Excel.Interfaces.TableRowCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.TableRowCollectionLoadOptions +summary: >- + Represents a collection of all the rows that are part of the table. + + + Note that unlike ranges or columns, which will adjust if new rows or columns + are added before them, a `TableRow` object represents the physical location of + the table row, but not the data. That is, if the data is sorted or if new rows + are added, a table row will continue to point at the index for which it was + created. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.TableRowCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: index + uid: excel!Excel.Interfaces.TableRowCollectionLoadOptions#index:member + package: excel! + fullName: index + summary: >- + For EACH ITEM in the collection: Returns the index number of the row + within the rows collection of the table. Zero-indexed. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'index?: boolean;' + return: + type: boolean + - name: values + uid: excel!Excel.Interfaces.TableRowCollectionLoadOptions#values:member + package: excel! + fullName: values + summary: >- + For EACH ITEM in the collection: Represents the raw values of the + specified range. The data returned could be a string, number, or boolean. + Cells that contain an error will return the error string. If the returned + value starts with a plus ("+"), minus ("-"), or equal sign ("="), Excel + interprets this value as a formula. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'values?: boolean;' + return: + type: boolean + - name: valuesAsJson + uid: excel!Excel.Interfaces.TableRowCollectionLoadOptions#valuesAsJson:member + package: excel! + fullName: valuesAsJson + summary: >- + For EACH ITEM in the collection: A JSON representation of the values in + the cells in this table row. Unlike `TableRow.values`, + `TableRow.valuesAsJson` supports all data types which can be in a cell. + Examples include formatted number values and web images, in addition to + the standard boolean, number, and string values. Data returned from this + API always aligns with the en-US locale. To retrieve data in the user's + display locale, use `TableRow.valuesAsJsonLocal`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJson?: boolean;' + return: + type: boolean + - name: valuesAsJsonLocal + uid: >- + excel!Excel.Interfaces.TableRowCollectionLoadOptions#valuesAsJsonLocal:member + package: excel! + fullName: valuesAsJsonLocal + summary: >- + For EACH ITEM in the collection: A JSON representation of the values in + the cells in this table row. Unlike `TableRow.values`, + `TableRow.valuesAsJsonLocal` supports all data types which can be in a + cell. Examples include formatted number values and web images, in addition + to the standard boolean, number, and string values. Data returned from + this API always aligns with the user's display locale. To retrieve data + independent of locale, use `TableRow.valuesAsJson`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJsonLocal?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablerowcollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablerowcollectionupdatedata.yml new file mode 100644 index 0000000000..31ba09140a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablerowcollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.TableRowCollectionUpdateData +uid: excel!Excel.Interfaces.TableRowCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.TableRowCollectionUpdateData +summary: >- + An interface for updating data on the `TableRowCollection` object, for use in + `tableRowCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.TableRowCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.TableRowData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablerowdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablerowdata.yml new file mode 100644 index 0000000000..789cfcf672 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablerowdata.yml @@ -0,0 +1,96 @@ +### YamlMime:TSType +name: Excel.Interfaces.TableRowData +uid: excel!Excel.Interfaces.TableRowData:interface +package: excel! +fullName: Excel.Interfaces.TableRowData +summary: >- + An interface describing the data returned by calling `tableRow.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: index + uid: excel!Excel.Interfaces.TableRowData#index:member + package: excel! + fullName: index + summary: >- + Returns the index number of the row within the rows collection of the + table. Zero-indexed. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'index?: number;' + return: + type: number + - name: values + uid: excel!Excel.Interfaces.TableRowData#values:member + package: excel! + fullName: values + summary: >- + Represents the raw values of the specified range. The data returned could + be a string, number, or boolean. Cells that contain an error will return + the error string. If the returned value starts with a plus ("+"), minus + ("-"), or equal sign ("="), Excel interprets this value as a formula. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'values?: any[][];' + return: + type: any[][] + - name: valuesAsJson + uid: excel!Excel.Interfaces.TableRowData#valuesAsJson:member + package: excel! + fullName: valuesAsJson + summary: >- + A JSON representation of the values in the cells in this table row. Unlike + `TableRow.values`, `TableRow.valuesAsJson` supports all data types + which can be in a cell. Examples include formatted number values and web + images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the en-US locale. To + retrieve data in the user's display locale, use + `TableRow.valuesAsJsonLocal`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJson?: CellValue[][];' + return: + type: [][] + - name: valuesAsJsonLocal + uid: excel!Excel.Interfaces.TableRowData#valuesAsJsonLocal:member + package: excel! + fullName: valuesAsJsonLocal + summary: >- + A JSON representation of the values in the cells in this table row. Unlike + `TableRow.values`, `TableRow.valuesAsJsonLocal` supports all data + types which can be in a cell. Examples include formatted number values and + web images, in addition to the standard boolean, number, and string + values. Data returned from this API always aligns with the user's display + locale. To retrieve data independent of locale, use + `TableRow.valuesAsJson`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJsonLocal?: CellValue[][];' + return: + type: [][] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablerowloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablerowloadoptions.yml new file mode 100644 index 0000000000..83c3d4293f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablerowloadoptions.yml @@ -0,0 +1,120 @@ +### YamlMime:TSType +name: Excel.Interfaces.TableRowLoadOptions +uid: excel!Excel.Interfaces.TableRowLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.TableRowLoadOptions +summary: >- + Represents a row in a table. + + + Note that unlike ranges or columns, which will adjust if new rows or columns + are added before them, a `TableRow` object represents the physical location of + the table row, but not the data. That is, if the data is sorted or if new rows + are added, a table row will continue to point at the index for which it was + created. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.TableRowLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: index + uid: excel!Excel.Interfaces.TableRowLoadOptions#index:member + package: excel! + fullName: index + summary: >- + Returns the index number of the row within the rows collection of the + table. Zero-indexed. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'index?: boolean;' + return: + type: boolean + - name: values + uid: excel!Excel.Interfaces.TableRowLoadOptions#values:member + package: excel! + fullName: values + summary: >- + Represents the raw values of the specified range. The data returned could + be a string, number, or boolean. Cells that contain an error will return + the error string. If the returned value starts with a plus ("+"), minus + ("-"), or equal sign ("="), Excel interprets this value as a formula. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'values?: boolean;' + return: + type: boolean + - name: valuesAsJson + uid: excel!Excel.Interfaces.TableRowLoadOptions#valuesAsJson:member + package: excel! + fullName: valuesAsJson + summary: >- + A JSON representation of the values in the cells in this table row. Unlike + `TableRow.values`, `TableRow.valuesAsJson` supports all data types + which can be in a cell. Examples include formatted number values and web + images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the en-US locale. To + retrieve data in the user's display locale, use + `TableRow.valuesAsJsonLocal`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJson?: boolean;' + return: + type: boolean + - name: valuesAsJsonLocal + uid: excel!Excel.Interfaces.TableRowLoadOptions#valuesAsJsonLocal:member + package: excel! + fullName: valuesAsJsonLocal + summary: >- + A JSON representation of the values in the cells in this table row. Unlike + `TableRow.values`, `TableRow.valuesAsJsonLocal` supports all data + types which can be in a cell. Examples include formatted number values and + web images, in addition to the standard boolean, number, and string + values. Data returned from this API always aligns with the user's display + locale. To retrieve data independent of locale, use + `TableRow.valuesAsJson`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJsonLocal?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablerowupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablerowupdatedata.yml new file mode 100644 index 0000000000..024b7c909f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablerowupdatedata.yml @@ -0,0 +1,79 @@ +### YamlMime:TSType +name: Excel.Interfaces.TableRowUpdateData +uid: excel!Excel.Interfaces.TableRowUpdateData:interface +package: excel! +fullName: Excel.Interfaces.TableRowUpdateData +summary: >- + An interface for updating data on the `TableRow` object, for use in + `tableRow.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: values + uid: excel!Excel.Interfaces.TableRowUpdateData#values:member + package: excel! + fullName: values + summary: >- + Represents the raw values of the specified range. The data returned could + be a string, number, or boolean. Cells that contain an error will return + the error string. If the returned value starts with a plus ("+"), minus + ("-"), or equal sign ("="), Excel interprets this value as a formula. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'values?: any[][];' + return: + type: any[][] + - name: valuesAsJson + uid: excel!Excel.Interfaces.TableRowUpdateData#valuesAsJson:member + package: excel! + fullName: valuesAsJson + summary: >- + A JSON representation of the values in the cells in this table row. Unlike + `TableRow.values`, `TableRow.valuesAsJson` supports all data types + which can be in a cell. Examples include formatted number values and web + images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the en-US locale. To + retrieve data in the user's display locale, use + `TableRow.valuesAsJsonLocal`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJson?: CellValue[][];' + return: + type: [][] + - name: valuesAsJsonLocal + uid: excel!Excel.Interfaces.TableRowUpdateData#valuesAsJsonLocal:member + package: excel! + fullName: valuesAsJsonLocal + summary: >- + A JSON representation of the values in the cells in this table row. Unlike + `TableRow.values`, `TableRow.valuesAsJsonLocal` supports all data + types which can be in a cell. Examples include formatted number values and + web images, in addition to the standard boolean, number, and string + values. Data returned from this API always aligns with the user's display + locale. To retrieve data independent of locale, use + `TableRow.valuesAsJson`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJsonLocal?: CellValue[][];' + return: + type: [][] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablescopedcollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablescopedcollectiondata.yml new file mode 100644 index 0000000000..3e24817be6 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablescopedcollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.TableScopedCollectionData +uid: excel!Excel.Interfaces.TableScopedCollectionData:interface +package: excel! +fullName: Excel.Interfaces.TableScopedCollectionData +summary: >- + An interface describing the data returned by calling + `tableScopedCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.TableScopedCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.TableData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablescopedcollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablescopedcollectionloadoptions.yml new file mode 100644 index 0000000000..9d1b323612 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablescopedcollectionloadoptions.yml @@ -0,0 +1,324 @@ +### YamlMime:TSType +name: Excel.Interfaces.TableScopedCollectionLoadOptions +uid: excel!Excel.Interfaces.TableScopedCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.TableScopedCollectionLoadOptions +summary: >- + Represents a scoped collection of tables. For each table its top-left corner + is considered its anchor location, and the tables are sorted top-to-bottom and + then left-to-right. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.TableScopedCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: autoFilter + uid: excel!Excel.Interfaces.TableScopedCollectionLoadOptions#autoFilter:member + package: excel! + fullName: autoFilter + summary: >- + For EACH ITEM in the collection: Represents the `AutoFilter` object of the + table. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'autoFilter?: Excel.Interfaces.AutoFilterLoadOptions;' + return: + type: + - name: columns + uid: excel!Excel.Interfaces.TableScopedCollectionLoadOptions#columns:member + package: excel! + fullName: columns + summary: >- + For EACH ITEM in the collection: Represents a collection of all the + columns in the table. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'columns?: Excel.Interfaces.TableColumnCollectionLoadOptions;' + return: + type: >- + + - name: highlightFirstColumn + uid: >- + excel!Excel.Interfaces.TableScopedCollectionLoadOptions#highlightFirstColumn:member + package: excel! + fullName: highlightFirstColumn + summary: >- + For EACH ITEM in the collection: Specifies if the first column contains + special formatting. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'highlightFirstColumn?: boolean;' + return: + type: boolean + - name: highlightLastColumn + uid: >- + excel!Excel.Interfaces.TableScopedCollectionLoadOptions#highlightLastColumn:member + package: excel! + fullName: highlightLastColumn + summary: >- + For EACH ITEM in the collection: Specifies if the last column contains + special formatting. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'highlightLastColumn?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.TableScopedCollectionLoadOptions#id:member + package: excel! + fullName: id + summary: >- + For EACH ITEM in the collection: Returns a value that uniquely identifies + the table in a given workbook. The value of the identifier remains the + same even when the table is renamed. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: legacyId + uid: excel!Excel.Interfaces.TableScopedCollectionLoadOptions#legacyId:member + package: excel! + fullName: legacyId + summary: 'For EACH ITEM in the collection: Returns a numeric ID.' + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'legacyId?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.TableScopedCollectionLoadOptions#name:member + package: excel! + fullName: name + summary: >- + For EACH ITEM in the collection: Name of the table. + + + The set name of the table must follow the guidelines specified in the + [Rename an Excel + table](https://support.microsoft.com/office/fbf49a4f-82a3-43eb-8ba2-44d21233b114) + article. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: rows + uid: excel!Excel.Interfaces.TableScopedCollectionLoadOptions#rows:member + package: excel! + fullName: rows + summary: >- + For EACH ITEM in the collection: Represents a collection of all the rows + in the table. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rows?: Excel.Interfaces.TableRowCollectionLoadOptions;' + return: + type: >- + + - name: showBandedColumns + uid: >- + excel!Excel.Interfaces.TableScopedCollectionLoadOptions#showBandedColumns:member + package: excel! + fullName: showBandedColumns + summary: >- + For EACH ITEM in the collection: Specifies if the columns show banded + formatting in which odd columns are highlighted differently from even + ones, to make reading the table easier. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showBandedColumns?: boolean;' + return: + type: boolean + - name: showBandedRows + uid: >- + excel!Excel.Interfaces.TableScopedCollectionLoadOptions#showBandedRows:member + package: excel! + fullName: showBandedRows + summary: >- + For EACH ITEM in the collection: Specifies if the rows show banded + formatting in which odd rows are highlighted differently from even ones, + to make reading the table easier. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showBandedRows?: boolean;' + return: + type: boolean + - name: showFilterButton + uid: >- + excel!Excel.Interfaces.TableScopedCollectionLoadOptions#showFilterButton:member + package: excel! + fullName: showFilterButton + summary: >- + For EACH ITEM in the collection: Specifies if the filter buttons are + visible at the top of each column header. Setting this is only allowed if + the table contains a header row. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showFilterButton?: boolean;' + return: + type: boolean + - name: showHeaders + uid: excel!Excel.Interfaces.TableScopedCollectionLoadOptions#showHeaders:member + package: excel! + fullName: showHeaders + summary: >- + For EACH ITEM in the collection: Specifies if the header row is visible. + This value can be set to show or remove the header row. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showHeaders?: boolean;' + return: + type: boolean + - name: showTotals + uid: excel!Excel.Interfaces.TableScopedCollectionLoadOptions#showTotals:member + package: excel! + fullName: showTotals + summary: >- + For EACH ITEM in the collection: Specifies if the total row is visible. + This value can be set to show or remove the total row. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showTotals?: boolean;' + return: + type: boolean + - name: sort + uid: excel!Excel.Interfaces.TableScopedCollectionLoadOptions#sort:member + package: excel! + fullName: sort + summary: 'For EACH ITEM in the collection: Represents the sorting for the table.' + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'sort?: Excel.Interfaces.TableSortLoadOptions;' + return: + type: + - name: style + uid: excel!Excel.Interfaces.TableScopedCollectionLoadOptions#style:member + package: excel! + fullName: style + summary: >- + For EACH ITEM in the collection: Constant value that represents the table + style. Possible values are: "TableStyleLight1" through + "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", + "TableStyleDark1" through "TableStyleDark11". A custom user-defined style + present in the workbook can also be specified. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'style?: boolean;' + return: + type: boolean + - name: worksheet + uid: excel!Excel.Interfaces.TableScopedCollectionLoadOptions#worksheet:member + package: excel! + fullName: worksheet + summary: >- + For EACH ITEM in the collection: The worksheet containing the current + table. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheet?: Excel.Interfaces.WorksheetLoadOptions;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablescopedcollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablescopedcollectionupdatedata.yml new file mode 100644 index 0000000000..cb00f79283 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablescopedcollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.TableScopedCollectionUpdateData +uid: excel!Excel.Interfaces.TableScopedCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.TableScopedCollectionUpdateData +summary: >- + An interface for updating data on the `TableScopedCollection` object, for use + in `tableScopedCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.TableScopedCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.TableData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablesortdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablesortdata.yml new file mode 100644 index 0000000000..0e4f41fbd4 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablesortdata.yml @@ -0,0 +1,61 @@ +### YamlMime:TSType +name: Excel.Interfaces.TableSortData +uid: excel!Excel.Interfaces.TableSortData:interface +package: excel! +fullName: Excel.Interfaces.TableSortData +summary: >- + An interface describing the data returned by calling `tableSort.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: fields + uid: excel!Excel.Interfaces.TableSortData#fields:member + package: excel! + fullName: fields + summary: Specifies the current conditions used to last sort the table. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'fields?: Excel.SortField[];' + return: + type: [] + - name: matchCase + uid: excel!Excel.Interfaces.TableSortData#matchCase:member + package: excel! + fullName: matchCase + summary: Specifies if the casing impacts the last sort of the table. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'matchCase?: boolean;' + return: + type: boolean + - name: method + uid: excel!Excel.Interfaces.TableSortData#method:member + package: excel! + fullName: method + summary: >- + Represents the Chinese character ordering method last used to sort the + table. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'method?: Excel.SortMethod | "PinYin" | "StrokeCount";' + return: + type: | "PinYin" | "StrokeCount" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablesortloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablesortloadoptions.yml new file mode 100644 index 0000000000..3f87f5f8cc --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablesortloadoptions.yml @@ -0,0 +1,77 @@ +### YamlMime:TSType +name: Excel.Interfaces.TableSortLoadOptions +uid: excel!Excel.Interfaces.TableSortLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.TableSortLoadOptions +summary: Manages sorting operations on `Table` objects. +remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.TableSortLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: fields + uid: excel!Excel.Interfaces.TableSortLoadOptions#fields:member + package: excel! + fullName: fields + summary: Specifies the current conditions used to last sort the table. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'fields?: boolean;' + return: + type: boolean + - name: matchCase + uid: excel!Excel.Interfaces.TableSortLoadOptions#matchCase:member + package: excel! + fullName: matchCase + summary: Specifies if the casing impacts the last sort of the table. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'matchCase?: boolean;' + return: + type: boolean + - name: method + uid: excel!Excel.Interfaces.TableSortLoadOptions#method:member + package: excel! + fullName: method + summary: >- + Represents the Chinese character ordering method last used to sort the + table. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'method?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablestylecollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablestylecollectiondata.yml new file mode 100644 index 0000000000..27c0e1ef1e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablestylecollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.TableStyleCollectionData +uid: excel!Excel.Interfaces.TableStyleCollectionData:interface +package: excel! +fullName: Excel.Interfaces.TableStyleCollectionData +summary: >- + An interface describing the data returned by calling + `tableStyleCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.TableStyleCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.TableStyleData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablestylecollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablestylecollectionloadoptions.yml new file mode 100644 index 0000000000..0dda21ab9c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablestylecollectionloadoptions.yml @@ -0,0 +1,64 @@ +### YamlMime:TSType +name: Excel.Interfaces.TableStyleCollectionLoadOptions +uid: excel!Excel.Interfaces.TableStyleCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.TableStyleCollectionLoadOptions +summary: Represents a collection of table styles. +remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.TableStyleCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.TableStyleCollectionLoadOptions#name:member + package: excel! + fullName: name + summary: 'For EACH ITEM in the collection: Specifies the name of the table style.' + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: readOnly + uid: excel!Excel.Interfaces.TableStyleCollectionLoadOptions#readOnly:member + package: excel! + fullName: readOnly + summary: >- + For EACH ITEM in the collection: Specifies if this `TableStyle` object is + read-only. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readOnly?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablestylecollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablestylecollectionupdatedata.yml new file mode 100644 index 0000000000..46e925aec5 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablestylecollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.TableStyleCollectionUpdateData +uid: excel!Excel.Interfaces.TableStyleCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.TableStyleCollectionUpdateData +summary: >- + An interface for updating data on the `TableStyleCollection` object, for use + in `tableStyleCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.TableStyleCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.TableStyleData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablestyledata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablestyledata.yml new file mode 100644 index 0000000000..956f720790 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablestyledata.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: Excel.Interfaces.TableStyleData +uid: excel!Excel.Interfaces.TableStyleData:interface +package: excel! +fullName: Excel.Interfaces.TableStyleData +summary: >- + An interface describing the data returned by calling `tableStyle.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: name + uid: excel!Excel.Interfaces.TableStyleData#name:member + package: excel! + fullName: name + summary: Specifies the name of the table style. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: readOnly + uid: excel!Excel.Interfaces.TableStyleData#readOnly:member + package: excel! + fullName: readOnly + summary: Specifies if this `TableStyle` object is read-only. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readOnly?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablestyleloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablestyleloadoptions.yml new file mode 100644 index 0000000000..442932792d --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablestyleloadoptions.yml @@ -0,0 +1,64 @@ +### YamlMime:TSType +name: Excel.Interfaces.TableStyleLoadOptions +uid: excel!Excel.Interfaces.TableStyleLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.TableStyleLoadOptions +summary: >- + Represents a table style, which defines the style elements by region of the + table. +remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.TableStyleLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.TableStyleLoadOptions#name:member + package: excel! + fullName: name + summary: Specifies the name of the table style. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: readOnly + uid: excel!Excel.Interfaces.TableStyleLoadOptions#readOnly:member + package: excel! + fullName: readOnly + summary: Specifies if this `TableStyle` object is read-only. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readOnly?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablestyleupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablestyleupdatedata.yml new file mode 100644 index 0000000000..537e9bb7fc --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tablestyleupdatedata.yml @@ -0,0 +1,30 @@ +### YamlMime:TSType +name: Excel.Interfaces.TableStyleUpdateData +uid: excel!Excel.Interfaces.TableStyleUpdateData:interface +package: excel! +fullName: Excel.Interfaces.TableStyleUpdateData +summary: >- + An interface for updating data on the `TableStyle` object, for use in + `tableStyle.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: name + uid: excel!Excel.Interfaces.TableStyleUpdateData#name:member + package: excel! + fullName: name + summary: Specifies the name of the table style. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tableupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tableupdatedata.yml new file mode 100644 index 0000000000..4b4bb19efa --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.tableupdatedata.yml @@ -0,0 +1,171 @@ +### YamlMime:TSType +name: Excel.Interfaces.TableUpdateData +uid: excel!Excel.Interfaces.TableUpdateData:interface +package: excel! +fullName: Excel.Interfaces.TableUpdateData +summary: >- + An interface for updating data on the `Table` object, for use in `table.set({ + ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: highlightFirstColumn + uid: excel!Excel.Interfaces.TableUpdateData#highlightFirstColumn:member + package: excel! + fullName: highlightFirstColumn + summary: Specifies if the first column contains special formatting. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'highlightFirstColumn?: boolean;' + return: + type: boolean + - name: highlightLastColumn + uid: excel!Excel.Interfaces.TableUpdateData#highlightLastColumn:member + package: excel! + fullName: highlightLastColumn + summary: Specifies if the last column contains special formatting. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'highlightLastColumn?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.TableUpdateData#name:member + package: excel! + fullName: name + summary: >- + Name of the table. + + + The set name of the table must follow the guidelines specified in the + [Rename an Excel + table](https://support.microsoft.com/office/fbf49a4f-82a3-43eb-8ba2-44d21233b114) + article. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: showBandedColumns + uid: excel!Excel.Interfaces.TableUpdateData#showBandedColumns:member + package: excel! + fullName: showBandedColumns + summary: >- + Specifies if the columns show banded formatting in which odd columns are + highlighted differently from even ones, to make reading the table easier. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showBandedColumns?: boolean;' + return: + type: boolean + - name: showBandedRows + uid: excel!Excel.Interfaces.TableUpdateData#showBandedRows:member + package: excel! + fullName: showBandedRows + summary: >- + Specifies if the rows show banded formatting in which odd rows are + highlighted differently from even ones, to make reading the table easier. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showBandedRows?: boolean;' + return: + type: boolean + - name: showFilterButton + uid: excel!Excel.Interfaces.TableUpdateData#showFilterButton:member + package: excel! + fullName: showFilterButton + summary: >- + Specifies if the filter buttons are visible at the top of each column + header. Setting this is only allowed if the table contains a header row. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showFilterButton?: boolean;' + return: + type: boolean + - name: showHeaders + uid: excel!Excel.Interfaces.TableUpdateData#showHeaders:member + package: excel! + fullName: showHeaders + summary: >- + Specifies if the header row is visible. This value can be set to show or + remove the header row. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showHeaders?: boolean;' + return: + type: boolean + - name: showTotals + uid: excel!Excel.Interfaces.TableUpdateData#showTotals:member + package: excel! + fullName: showTotals + summary: >- + Specifies if the total row is visible. This value can be set to show or + remove the total row. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showTotals?: boolean;' + return: + type: boolean + - name: style + uid: excel!Excel.Interfaces.TableUpdateData#style:member + package: excel! + fullName: style + summary: >- + Constant value that represents the table style. Possible values are: + "TableStyleLight1" through "TableStyleLight21", "TableStyleMedium1" + through "TableStyleMedium28", "TableStyleDark1" through + "TableStyleDark11". A custom user-defined style present in the workbook + can also be specified. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'style?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.textconditionalformatdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.textconditionalformatdata.yml new file mode 100644 index 0000000000..cb6739ba91 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.textconditionalformatdata.yml @@ -0,0 +1,48 @@ +### YamlMime:TSType +name: Excel.Interfaces.TextConditionalFormatData +uid: excel!Excel.Interfaces.TextConditionalFormatData:interface +package: excel! +fullName: Excel.Interfaces.TextConditionalFormatData +summary: >- + An interface describing the data returned by calling + `textConditionalFormat.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: format + uid: excel!Excel.Interfaces.TextConditionalFormatData#format:member + package: excel! + fullName: format + summary: >- + Returns a format object, encapsulating the conditional format's font, + fill, borders, and other properties. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ConditionalRangeFormatData;' + return: + type: >- + + - name: rule + uid: excel!Excel.Interfaces.TextConditionalFormatData#rule:member + package: excel! + fullName: rule + summary: The rule of the conditional format. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rule?: Excel.ConditionalTextComparisonRule;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.textconditionalformatloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.textconditionalformatloadoptions.yml new file mode 100644 index 0000000000..1449311e51 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.textconditionalformatloadoptions.yml @@ -0,0 +1,65 @@ +### YamlMime:TSType +name: Excel.Interfaces.TextConditionalFormatLoadOptions +uid: excel!Excel.Interfaces.TextConditionalFormatLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.TextConditionalFormatLoadOptions +summary: Represents a specific text conditional format. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.TextConditionalFormatLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: format + uid: excel!Excel.Interfaces.TextConditionalFormatLoadOptions#format:member + package: excel! + fullName: format + summary: >- + Returns a format object, encapsulating the conditional format's font, + fill, borders, and other properties. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ConditionalRangeFormatLoadOptions;' + return: + type: >- + + - name: rule + uid: excel!Excel.Interfaces.TextConditionalFormatLoadOptions#rule:member + package: excel! + fullName: rule + summary: The rule of the conditional format. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rule?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.textconditionalformatupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.textconditionalformatupdatedata.yml new file mode 100644 index 0000000000..ceacf2c81b --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.textconditionalformatupdatedata.yml @@ -0,0 +1,49 @@ +### YamlMime:TSType +name: Excel.Interfaces.TextConditionalFormatUpdateData +uid: excel!Excel.Interfaces.TextConditionalFormatUpdateData:interface +package: excel! +fullName: Excel.Interfaces.TextConditionalFormatUpdateData +summary: >- + An interface for updating data on the `TextConditionalFormat` object, for use + in `textConditionalFormat.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: format + uid: excel!Excel.Interfaces.TextConditionalFormatUpdateData#format:member + package: excel! + fullName: format + summary: >- + Returns a format object, encapsulating the conditional format's font, + fill, borders, and other properties. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ConditionalRangeFormatUpdateData;' + return: + type: >- + + - name: rule + uid: excel!Excel.Interfaces.TextConditionalFormatUpdateData#rule:member + package: excel! + fullName: rule + summary: The rule of the conditional format. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rule?: Excel.ConditionalTextComparisonRule;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.textframedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.textframedata.yml new file mode 100644 index 0000000000..dc901f9178 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.textframedata.yml @@ -0,0 +1,241 @@ +### YamlMime:TSType +name: Excel.Interfaces.TextFrameData +uid: excel!Excel.Interfaces.TextFrameData:interface +package: excel! +fullName: Excel.Interfaces.TextFrameData +summary: >- + An interface describing the data returned by calling `textFrame.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: autoSizeSetting + uid: excel!Excel.Interfaces.TextFrameData#autoSizeSetting:member + package: excel! + fullName: autoSizeSetting + summary: >- + The automatic sizing settings for the text frame. A text frame can be set + to automatically fit the text to the text frame, to automatically fit the + text frame to the text, or not perform any automatic sizing. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + autoSizeSetting?: Excel.ShapeAutoSize | "AutoSizeNone" | + "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed"; + return: + type: >- + | "AutoSizeNone" | + "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed" + - name: bottomMargin + uid: excel!Excel.Interfaces.TextFrameData#bottomMargin:member + package: excel! + fullName: bottomMargin + summary: Represents the bottom margin, in points, of the text frame. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'bottomMargin?: number;' + return: + type: number + - name: hasText + uid: excel!Excel.Interfaces.TextFrameData#hasText:member + package: excel! + fullName: hasText + summary: Specifies if the text frame contains text. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'hasText?: boolean;' + return: + type: boolean + - name: horizontalAlignment + uid: excel!Excel.Interfaces.TextFrameData#horizontalAlignment:member + package: excel! + fullName: horizontalAlignment + summary: >- + Represents the horizontal alignment of the text frame. See + `Excel.ShapeTextHorizontalAlignment` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + horizontalAlignment?: Excel.ShapeTextHorizontalAlignment | "Left" | + "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | + "ThaiDistributed"; + return: + type: >- + | "Left" + | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | + "ThaiDistributed" + - name: horizontalOverflow + uid: excel!Excel.Interfaces.TextFrameData#horizontalOverflow:member + package: excel! + fullName: horizontalOverflow + summary: >- + Represents the horizontal overflow behavior of the text frame. See + `Excel.ShapeTextHorizontalOverflow` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + horizontalOverflow?: Excel.ShapeTextHorizontalOverflow | "Overflow" | + "Clip"; + return: + type: >- + | + "Overflow" | "Clip" + - name: leftMargin + uid: excel!Excel.Interfaces.TextFrameData#leftMargin:member + package: excel! + fullName: leftMargin + summary: Represents the left margin, in points, of the text frame. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'leftMargin?: number;' + return: + type: number + - name: orientation + uid: excel!Excel.Interfaces.TextFrameData#orientation:member + package: excel! + fullName: orientation + summary: >- + Represents the angle to which the text is oriented for the text frame. See + `Excel.ShapeTextOrientation` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + orientation?: Excel.ShapeTextOrientation | "Horizontal" | "Vertical" | + "Vertical270" | "WordArtVertical" | "EastAsianVertical" | + "MongolianVertical" | "WordArtVerticalRTL"; + return: + type: >- + | "Horizontal" | + "Vertical" | "Vertical270" | "WordArtVertical" | "EastAsianVertical" | + "MongolianVertical" | "WordArtVerticalRTL" + - name: readingOrder + uid: excel!Excel.Interfaces.TextFrameData#readingOrder:member + package: excel! + fullName: readingOrder + summary: >- + Represents the reading order of the text frame, either left-to-right or + right-to-left. See `Excel.ShapeTextReadingOrder` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readingOrder?: Excel.ShapeTextReadingOrder | "LeftToRight" | + "RightToLeft"; + return: + type: >- + | "LeftToRight" + | "RightToLeft" + - name: rightMargin + uid: excel!Excel.Interfaces.TextFrameData#rightMargin:member + package: excel! + fullName: rightMargin + summary: Represents the right margin, in points, of the text frame. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rightMargin?: number;' + return: + type: number + - name: topMargin + uid: excel!Excel.Interfaces.TextFrameData#topMargin:member + package: excel! + fullName: topMargin + summary: Represents the top margin, in points, of the text frame. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'topMargin?: number;' + return: + type: number + - name: verticalAlignment + uid: excel!Excel.Interfaces.TextFrameData#verticalAlignment:member + package: excel! + fullName: verticalAlignment + summary: >- + Represents the vertical alignment of the text frame. See + `Excel.ShapeTextVerticalAlignment` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + verticalAlignment?: Excel.ShapeTextVerticalAlignment | "Top" | "Middle" + | "Bottom" | "Justified" | "Distributed"; + return: + type: >- + | "Top" | + "Middle" | "Bottom" | "Justified" | "Distributed" + - name: verticalOverflow + uid: excel!Excel.Interfaces.TextFrameData#verticalOverflow:member + package: excel! + fullName: verticalOverflow + summary: >- + Represents the vertical overflow behavior of the text frame. See + `Excel.ShapeTextVerticalOverflow` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + verticalOverflow?: Excel.ShapeTextVerticalOverflow | "Overflow" | + "Ellipsis" | "Clip"; + return: + type: >- + | "Overflow" + | "Ellipsis" | "Clip" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.textframeloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.textframeloadoptions.yml new file mode 100644 index 0000000000..dcebc8cadf --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.textframeloadoptions.yml @@ -0,0 +1,243 @@ +### YamlMime:TSType +name: Excel.Interfaces.TextFrameLoadOptions +uid: excel!Excel.Interfaces.TextFrameLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.TextFrameLoadOptions +summary: Represents the text frame of a shape object. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.TextFrameLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: autoSizeSetting + uid: excel!Excel.Interfaces.TextFrameLoadOptions#autoSizeSetting:member + package: excel! + fullName: autoSizeSetting + summary: >- + The automatic sizing settings for the text frame. A text frame can be set + to automatically fit the text to the text frame, to automatically fit the + text frame to the text, or not perform any automatic sizing. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'autoSizeSetting?: boolean;' + return: + type: boolean + - name: bottomMargin + uid: excel!Excel.Interfaces.TextFrameLoadOptions#bottomMargin:member + package: excel! + fullName: bottomMargin + summary: Represents the bottom margin, in points, of the text frame. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'bottomMargin?: boolean;' + return: + type: boolean + - name: hasText + uid: excel!Excel.Interfaces.TextFrameLoadOptions#hasText:member + package: excel! + fullName: hasText + summary: Specifies if the text frame contains text. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'hasText?: boolean;' + return: + type: boolean + - name: horizontalAlignment + uid: excel!Excel.Interfaces.TextFrameLoadOptions#horizontalAlignment:member + package: excel! + fullName: horizontalAlignment + summary: >- + Represents the horizontal alignment of the text frame. See + `Excel.ShapeTextHorizontalAlignment` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'horizontalAlignment?: boolean;' + return: + type: boolean + - name: horizontalOverflow + uid: excel!Excel.Interfaces.TextFrameLoadOptions#horizontalOverflow:member + package: excel! + fullName: horizontalOverflow + summary: >- + Represents the horizontal overflow behavior of the text frame. See + `Excel.ShapeTextHorizontalOverflow` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'horizontalOverflow?: boolean;' + return: + type: boolean + - name: leftMargin + uid: excel!Excel.Interfaces.TextFrameLoadOptions#leftMargin:member + package: excel! + fullName: leftMargin + summary: Represents the left margin, in points, of the text frame. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'leftMargin?: boolean;' + return: + type: boolean + - name: orientation + uid: excel!Excel.Interfaces.TextFrameLoadOptions#orientation:member + package: excel! + fullName: orientation + summary: >- + Represents the angle to which the text is oriented for the text frame. See + `Excel.ShapeTextOrientation` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'orientation?: boolean;' + return: + type: boolean + - name: readingOrder + uid: excel!Excel.Interfaces.TextFrameLoadOptions#readingOrder:member + package: excel! + fullName: readingOrder + summary: >- + Represents the reading order of the text frame, either left-to-right or + right-to-left. See `Excel.ShapeTextReadingOrder` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readingOrder?: boolean;' + return: + type: boolean + - name: rightMargin + uid: excel!Excel.Interfaces.TextFrameLoadOptions#rightMargin:member + package: excel! + fullName: rightMargin + summary: Represents the right margin, in points, of the text frame. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rightMargin?: boolean;' + return: + type: boolean + - name: textRange + uid: excel!Excel.Interfaces.TextFrameLoadOptions#textRange:member + package: excel! + fullName: textRange + summary: >- + Represents the text that is attached to a shape in the text frame, and + properties and methods for manipulating the text. See `Excel.TextRange` + for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textRange?: Excel.Interfaces.TextRangeLoadOptions;' + return: + type: + - name: topMargin + uid: excel!Excel.Interfaces.TextFrameLoadOptions#topMargin:member + package: excel! + fullName: topMargin + summary: Represents the top margin, in points, of the text frame. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'topMargin?: boolean;' + return: + type: boolean + - name: verticalAlignment + uid: excel!Excel.Interfaces.TextFrameLoadOptions#verticalAlignment:member + package: excel! + fullName: verticalAlignment + summary: >- + Represents the vertical alignment of the text frame. See + `Excel.ShapeTextVerticalAlignment` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'verticalAlignment?: boolean;' + return: + type: boolean + - name: verticalOverflow + uid: excel!Excel.Interfaces.TextFrameLoadOptions#verticalOverflow:member + package: excel! + fullName: verticalOverflow + summary: >- + Represents the vertical overflow behavior of the text frame. See + `Excel.ShapeTextVerticalOverflow` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'verticalOverflow?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.textframeupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.textframeupdatedata.yml new file mode 100644 index 0000000000..e3eb44c015 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.textframeupdatedata.yml @@ -0,0 +1,226 @@ +### YamlMime:TSType +name: Excel.Interfaces.TextFrameUpdateData +uid: excel!Excel.Interfaces.TextFrameUpdateData:interface +package: excel! +fullName: Excel.Interfaces.TextFrameUpdateData +summary: >- + An interface for updating data on the `TextFrame` object, for use in + `textFrame.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: autoSizeSetting + uid: excel!Excel.Interfaces.TextFrameUpdateData#autoSizeSetting:member + package: excel! + fullName: autoSizeSetting + summary: >- + The automatic sizing settings for the text frame. A text frame can be set + to automatically fit the text to the text frame, to automatically fit the + text frame to the text, or not perform any automatic sizing. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + autoSizeSetting?: Excel.ShapeAutoSize | "AutoSizeNone" | + "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed"; + return: + type: >- + | "AutoSizeNone" | + "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed" + - name: bottomMargin + uid: excel!Excel.Interfaces.TextFrameUpdateData#bottomMargin:member + package: excel! + fullName: bottomMargin + summary: Represents the bottom margin, in points, of the text frame. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'bottomMargin?: number;' + return: + type: number + - name: horizontalAlignment + uid: excel!Excel.Interfaces.TextFrameUpdateData#horizontalAlignment:member + package: excel! + fullName: horizontalAlignment + summary: >- + Represents the horizontal alignment of the text frame. See + `Excel.ShapeTextHorizontalAlignment` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + horizontalAlignment?: Excel.ShapeTextHorizontalAlignment | "Left" | + "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | + "ThaiDistributed"; + return: + type: >- + | "Left" + | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | + "ThaiDistributed" + - name: horizontalOverflow + uid: excel!Excel.Interfaces.TextFrameUpdateData#horizontalOverflow:member + package: excel! + fullName: horizontalOverflow + summary: >- + Represents the horizontal overflow behavior of the text frame. See + `Excel.ShapeTextHorizontalOverflow` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + horizontalOverflow?: Excel.ShapeTextHorizontalOverflow | "Overflow" | + "Clip"; + return: + type: >- + | + "Overflow" | "Clip" + - name: leftMargin + uid: excel!Excel.Interfaces.TextFrameUpdateData#leftMargin:member + package: excel! + fullName: leftMargin + summary: Represents the left margin, in points, of the text frame. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'leftMargin?: number;' + return: + type: number + - name: orientation + uid: excel!Excel.Interfaces.TextFrameUpdateData#orientation:member + package: excel! + fullName: orientation + summary: >- + Represents the angle to which the text is oriented for the text frame. See + `Excel.ShapeTextOrientation` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + orientation?: Excel.ShapeTextOrientation | "Horizontal" | "Vertical" | + "Vertical270" | "WordArtVertical" | "EastAsianVertical" | + "MongolianVertical" | "WordArtVerticalRTL"; + return: + type: >- + | "Horizontal" | + "Vertical" | "Vertical270" | "WordArtVertical" | "EastAsianVertical" | + "MongolianVertical" | "WordArtVerticalRTL" + - name: readingOrder + uid: excel!Excel.Interfaces.TextFrameUpdateData#readingOrder:member + package: excel! + fullName: readingOrder + summary: >- + Represents the reading order of the text frame, either left-to-right or + right-to-left. See `Excel.ShapeTextReadingOrder` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readingOrder?: Excel.ShapeTextReadingOrder | "LeftToRight" | + "RightToLeft"; + return: + type: >- + | "LeftToRight" + | "RightToLeft" + - name: rightMargin + uid: excel!Excel.Interfaces.TextFrameUpdateData#rightMargin:member + package: excel! + fullName: rightMargin + summary: Represents the right margin, in points, of the text frame. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rightMargin?: number;' + return: + type: number + - name: topMargin + uid: excel!Excel.Interfaces.TextFrameUpdateData#topMargin:member + package: excel! + fullName: topMargin + summary: Represents the top margin, in points, of the text frame. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'topMargin?: number;' + return: + type: number + - name: verticalAlignment + uid: excel!Excel.Interfaces.TextFrameUpdateData#verticalAlignment:member + package: excel! + fullName: verticalAlignment + summary: >- + Represents the vertical alignment of the text frame. See + `Excel.ShapeTextVerticalAlignment` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + verticalAlignment?: Excel.ShapeTextVerticalAlignment | "Top" | "Middle" + | "Bottom" | "Justified" | "Distributed"; + return: + type: >- + | "Top" | + "Middle" | "Bottom" | "Justified" | "Distributed" + - name: verticalOverflow + uid: excel!Excel.Interfaces.TextFrameUpdateData#verticalOverflow:member + package: excel! + fullName: verticalOverflow + summary: >- + Represents the vertical overflow behavior of the text frame. See + `Excel.ShapeTextVerticalOverflow` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + verticalOverflow?: Excel.ShapeTextVerticalOverflow | "Overflow" | + "Ellipsis" | "Clip"; + return: + type: >- + | "Overflow" + | "Ellipsis" | "Clip" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.textrangedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.textrangedata.yml new file mode 100644 index 0000000000..0a9f4cb600 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.textrangedata.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: Excel.Interfaces.TextRangeData +uid: excel!Excel.Interfaces.TextRangeData:interface +package: excel! +fullName: Excel.Interfaces.TextRangeData +summary: >- + An interface describing the data returned by calling `textRange.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: font + uid: excel!Excel.Interfaces.TextRangeData#font:member + package: excel! + fullName: font + summary: >- + Returns a `ShapeFont` object that represents the font attributes for the + text range. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.Interfaces.ShapeFontData;' + return: + type: + - name: text + uid: excel!Excel.Interfaces.TextRangeData#text:member + package: excel! + fullName: text + summary: Represents the plain text content of the text range. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'text?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.textrangeloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.textrangeloadoptions.yml new file mode 100644 index 0000000000..ada11f027f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.textrangeloadoptions.yml @@ -0,0 +1,64 @@ +### YamlMime:TSType +name: Excel.Interfaces.TextRangeLoadOptions +uid: excel!Excel.Interfaces.TextRangeLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.TextRangeLoadOptions +summary: >- + Contains the text that is attached to a shape, in addition to properties and + methods for manipulating the text. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.TextRangeLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: font + uid: excel!Excel.Interfaces.TextRangeLoadOptions#font:member + package: excel! + fullName: font + summary: >- + Returns a `ShapeFont` object that represents the font attributes for the + text range. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.Interfaces.ShapeFontLoadOptions;' + return: + type: + - name: text + uid: excel!Excel.Interfaces.TextRangeLoadOptions#text:member + package: excel! + fullName: text + summary: Represents the plain text content of the text range. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'text?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.textrangeupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.textrangeupdatedata.yml new file mode 100644 index 0000000000..32623590bb --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.textrangeupdatedata.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: Excel.Interfaces.TextRangeUpdateData +uid: excel!Excel.Interfaces.TextRangeUpdateData:interface +package: excel! +fullName: Excel.Interfaces.TextRangeUpdateData +summary: >- + An interface for updating data on the `TextRange` object, for use in + `textRange.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: font + uid: excel!Excel.Interfaces.TextRangeUpdateData#font:member + package: excel! + fullName: font + summary: >- + Returns a `ShapeFont` object that represents the font attributes for the + text range. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.Interfaces.ShapeFontUpdateData;' + return: + type: + - name: text + uid: excel!Excel.Interfaces.TextRangeUpdateData#text:member + package: excel! + fullName: text + summary: Represents the plain text content of the text range. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'text?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.timelinestylecollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.timelinestylecollectiondata.yml new file mode 100644 index 0000000000..2b0fdcafc6 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.timelinestylecollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.TimelineStyleCollectionData +uid: excel!Excel.Interfaces.TimelineStyleCollectionData:interface +package: excel! +fullName: Excel.Interfaces.TimelineStyleCollectionData +summary: >- + An interface describing the data returned by calling + `timelineStyleCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.TimelineStyleCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.TimelineStyleData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.timelinestylecollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.timelinestylecollectionloadoptions.yml new file mode 100644 index 0000000000..bd9781a39e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.timelinestylecollectionloadoptions.yml @@ -0,0 +1,64 @@ +### YamlMime:TSType +name: Excel.Interfaces.TimelineStyleCollectionLoadOptions +uid: excel!Excel.Interfaces.TimelineStyleCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.TimelineStyleCollectionLoadOptions +summary: Represents a collection of timeline styles. +remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.TimelineStyleCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.TimelineStyleCollectionLoadOptions#name:member + package: excel! + fullName: name + summary: 'For EACH ITEM in the collection: Specifies the name of the timeline style.' + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: readOnly + uid: excel!Excel.Interfaces.TimelineStyleCollectionLoadOptions#readOnly:member + package: excel! + fullName: readOnly + summary: >- + For EACH ITEM in the collection: Specifies if this `TimelineStyle` object + is read-only. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readOnly?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.timelinestylecollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.timelinestylecollectionupdatedata.yml new file mode 100644 index 0000000000..51fc90415c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.timelinestylecollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.TimelineStyleCollectionUpdateData +uid: excel!Excel.Interfaces.TimelineStyleCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.TimelineStyleCollectionUpdateData +summary: >- + An interface for updating data on the `TimelineStyleCollection` object, for + use in `timelineStyleCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.TimelineStyleCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.TimelineStyleData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.timelinestyledata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.timelinestyledata.yml new file mode 100644 index 0000000000..fc45a94349 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.timelinestyledata.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: Excel.Interfaces.TimelineStyleData +uid: excel!Excel.Interfaces.TimelineStyleData:interface +package: excel! +fullName: Excel.Interfaces.TimelineStyleData +summary: >- + An interface describing the data returned by calling + `timelineStyle.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: name + uid: excel!Excel.Interfaces.TimelineStyleData#name:member + package: excel! + fullName: name + summary: Specifies the name of the timeline style. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: readOnly + uid: excel!Excel.Interfaces.TimelineStyleData#readOnly:member + package: excel! + fullName: readOnly + summary: Specifies if this `TimelineStyle` object is read-only. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readOnly?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.timelinestyleloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.timelinestyleloadoptions.yml new file mode 100644 index 0000000000..f65f9903d0 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.timelinestyleloadoptions.yml @@ -0,0 +1,64 @@ +### YamlMime:TSType +name: Excel.Interfaces.TimelineStyleLoadOptions +uid: excel!Excel.Interfaces.TimelineStyleLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.TimelineStyleLoadOptions +summary: >- + Represents a `TimelineStyle`, which defines style elements by region + in the timeline. +remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.TimelineStyleLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.TimelineStyleLoadOptions#name:member + package: excel! + fullName: name + summary: Specifies the name of the timeline style. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: readOnly + uid: excel!Excel.Interfaces.TimelineStyleLoadOptions#readOnly:member + package: excel! + fullName: readOnly + summary: Specifies if this `TimelineStyle` object is read-only. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readOnly?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.timelinestyleupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.timelinestyleupdatedata.yml new file mode 100644 index 0000000000..695c2dc05d --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.timelinestyleupdatedata.yml @@ -0,0 +1,30 @@ +### YamlMime:TSType +name: Excel.Interfaces.TimelineStyleUpdateData +uid: excel!Excel.Interfaces.TimelineStyleUpdateData:interface +package: excel! +fullName: Excel.Interfaces.TimelineStyleUpdateData +summary: >- + An interface for updating data on the `TimelineStyle` object, for use in + `timelineStyle.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: name + uid: excel!Excel.Interfaces.TimelineStyleUpdateData#name:member + package: excel! + fullName: name + summary: Specifies the name of the timeline style. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.topbottomconditionalformatdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.topbottomconditionalformatdata.yml new file mode 100644 index 0000000000..e17096645a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.topbottomconditionalformatdata.yml @@ -0,0 +1,48 @@ +### YamlMime:TSType +name: Excel.Interfaces.TopBottomConditionalFormatData +uid: excel!Excel.Interfaces.TopBottomConditionalFormatData:interface +package: excel! +fullName: Excel.Interfaces.TopBottomConditionalFormatData +summary: >- + An interface describing the data returned by calling + `topBottomConditionalFormat.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: format + uid: excel!Excel.Interfaces.TopBottomConditionalFormatData#format:member + package: excel! + fullName: format + summary: >- + Returns a format object, encapsulating the conditional format's font, + fill, borders, and other properties. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ConditionalRangeFormatData;' + return: + type: >- + + - name: rule + uid: excel!Excel.Interfaces.TopBottomConditionalFormatData#rule:member + package: excel! + fullName: rule + summary: The criteria of the top/bottom conditional format. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rule?: Excel.ConditionalTopBottomRule;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.topbottomconditionalformatloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.topbottomconditionalformatloadoptions.yml new file mode 100644 index 0000000000..2830271d73 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.topbottomconditionalformatloadoptions.yml @@ -0,0 +1,65 @@ +### YamlMime:TSType +name: Excel.Interfaces.TopBottomConditionalFormatLoadOptions +uid: excel!Excel.Interfaces.TopBottomConditionalFormatLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.TopBottomConditionalFormatLoadOptions +summary: Represents a top/bottom conditional format. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.TopBottomConditionalFormatLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: format + uid: excel!Excel.Interfaces.TopBottomConditionalFormatLoadOptions#format:member + package: excel! + fullName: format + summary: >- + Returns a format object, encapsulating the conditional format's font, + fill, borders, and other properties. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ConditionalRangeFormatLoadOptions;' + return: + type: >- + + - name: rule + uid: excel!Excel.Interfaces.TopBottomConditionalFormatLoadOptions#rule:member + package: excel! + fullName: rule + summary: The criteria of the top/bottom conditional format. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rule?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.topbottomconditionalformatupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.topbottomconditionalformatupdatedata.yml new file mode 100644 index 0000000000..3d9a25dabf --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.topbottomconditionalformatupdatedata.yml @@ -0,0 +1,49 @@ +### YamlMime:TSType +name: Excel.Interfaces.TopBottomConditionalFormatUpdateData +uid: excel!Excel.Interfaces.TopBottomConditionalFormatUpdateData:interface +package: excel! +fullName: Excel.Interfaces.TopBottomConditionalFormatUpdateData +summary: >- + An interface for updating data on the `TopBottomConditionalFormat` object, for + use in `topBottomConditionalFormat.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: format + uid: excel!Excel.Interfaces.TopBottomConditionalFormatUpdateData#format:member + package: excel! + fullName: format + summary: >- + Returns a format object, encapsulating the conditional format's font, + fill, borders, and other properties. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.Interfaces.ConditionalRangeFormatUpdateData;' + return: + type: >- + + - name: rule + uid: excel!Excel.Interfaces.TopBottomConditionalFormatUpdateData#rule:member + package: excel! + fullName: rule + summary: The criteria of the top/bottom conditional format. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rule?: Excel.ConditionalTopBottomRule;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.workbookcreateddata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.workbookcreateddata.yml new file mode 100644 index 0000000000..164fa0064e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.workbookcreateddata.yml @@ -0,0 +1,13 @@ +### YamlMime:TSType +name: Excel.Interfaces.WorkbookCreatedData +uid: excel!Excel.Interfaces.WorkbookCreatedData:interface +package: excel! +fullName: Excel.Interfaces.WorkbookCreatedData +summary: >- + An interface describing the data returned by calling + `workbookCreated.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.workbookdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.workbookdata.yml new file mode 100644 index 0000000000..1c73da9d41 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.workbookdata.yml @@ -0,0 +1,407 @@ +### YamlMime:TSType +name: Excel.Interfaces.WorkbookData +uid: excel!Excel.Interfaces.WorkbookData:interface +package: excel! +fullName: Excel.Interfaces.WorkbookData +summary: >- + An interface describing the data returned by calling `workbook.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: autoSave + uid: excel!Excel.Interfaces.WorkbookData#autoSave:member + package: excel! + fullName: autoSave + summary: Specifies if the workbook is in AutoSave mode. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'autoSave?: boolean;' + return: + type: boolean + - name: bindings + uid: excel!Excel.Interfaces.WorkbookData#bindings:member + package: excel! + fullName: bindings + summary: Represents a collection of bindings that are part of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'bindings?: Excel.Interfaces.BindingData[];' + return: + type: [] + - name: calculationEngineVersion + uid: excel!Excel.Interfaces.WorkbookData#calculationEngineVersion:member + package: excel! + fullName: calculationEngineVersion + summary: Returns a number about the version of Excel Calculation Engine. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'calculationEngineVersion?: number;' + return: + type: number + - name: chartDataPointTrack + uid: excel!Excel.Interfaces.WorkbookData#chartDataPointTrack:member + package: excel! + fullName: chartDataPointTrack + summary: >- + True if all charts in the workbook are tracking the actual data points to + which they are attached. False if the charts track the index of the data + points. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'chartDataPointTrack?: boolean;' + return: + type: boolean + - name: comments + uid: excel!Excel.Interfaces.WorkbookData#comments:member + package: excel! + fullName: comments + summary: Represents a collection of comments associated with the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'comments?: Excel.Interfaces.CommentData[];' + return: + type: [] + - name: customXmlParts + uid: excel!Excel.Interfaces.WorkbookData#customXmlParts:member + package: excel! + fullName: customXmlParts + summary: Represents the collection of custom XML parts contained by this workbook. + remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'customXmlParts?: Excel.Interfaces.CustomXmlPartData[];' + return: + type: [] + - name: isDirty + uid: excel!Excel.Interfaces.WorkbookData#isDirty:member + package: excel! + fullName: isDirty + summary: >- + Specifies if changes have been made since the workbook was last saved. You + can set this property to `true` if you want to close a modified workbook + without either saving it or being prompted to save it. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'isDirty?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.WorkbookData#name:member + package: excel! + fullName: name + summary: Gets the workbook name. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: names + uid: excel!Excel.Interfaces.WorkbookData#names:member + package: excel! + fullName: names + summary: >- + Represents a collection of workbook-scoped named items (named ranges and + constants). + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'names?: Excel.Interfaces.NamedItemData[];' + return: + type: [] + - name: notes + uid: excel!Excel.Interfaces.WorkbookData#notes:member + package: excel! + fullName: notes + summary: Returns a collection of all the notes objects in the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'notes?: Excel.Interfaces.NoteData[];' + return: + type: [] + - name: pivotTables + uid: excel!Excel.Interfaces.WorkbookData#pivotTables:member + package: excel! + fullName: pivotTables + summary: Represents a collection of PivotTables associated with the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'pivotTables?: Excel.Interfaces.PivotTableData[];' + return: + type: [] + - name: pivotTableStyles + uid: excel!Excel.Interfaces.WorkbookData#pivotTableStyles:member + package: excel! + fullName: pivotTableStyles + summary: Represents a collection of PivotTableStyles associated with the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'pivotTableStyles?: Excel.Interfaces.PivotTableStyleData[];' + return: + type: [] + - name: previouslySaved + uid: excel!Excel.Interfaces.WorkbookData#previouslySaved:member + package: excel! + fullName: previouslySaved + summary: Specifies if the workbook has ever been saved locally or online. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'previouslySaved?: boolean;' + return: + type: boolean + - name: properties + uid: excel!Excel.Interfaces.WorkbookData#properties:member + package: excel! + fullName: properties + summary: Gets the workbook properties. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'properties?: Excel.Interfaces.DocumentPropertiesData;' + return: + type: + - name: protection + uid: excel!Excel.Interfaces.WorkbookData#protection:member + package: excel! + fullName: protection + summary: Returns the protection object for a workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'protection?: Excel.Interfaces.WorkbookProtectionData;' + return: + type: + - name: readOnly + uid: excel!Excel.Interfaces.WorkbookData#readOnly:member + package: excel! + fullName: readOnly + summary: Returns `true` if the workbook is open in read-only mode. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readOnly?: boolean;' + return: + type: boolean + - name: settings + uid: excel!Excel.Interfaces.WorkbookData#settings:member + package: excel! + fullName: settings + summary: Represents a collection of settings associated with the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'settings?: Excel.Interfaces.SettingData[];' + return: + type: [] + - name: slicers + uid: excel!Excel.Interfaces.WorkbookData#slicers:member + package: excel! + fullName: slicers + summary: Represents a collection of slicers associated with the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'slicers?: Excel.Interfaces.SlicerData[];' + return: + type: [] + - name: slicerStyles + uid: excel!Excel.Interfaces.WorkbookData#slicerStyles:member + package: excel! + fullName: slicerStyles + summary: Represents a collection of SlicerStyles associated with the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'slicerStyles?: Excel.Interfaces.SlicerStyleData[];' + return: + type: [] + - name: styles + uid: excel!Excel.Interfaces.WorkbookData#styles:member + package: excel! + fullName: styles + summary: Represents a collection of styles associated with the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'styles?: Excel.Interfaces.StyleData[];' + return: + type: [] + - name: tables + uid: excel!Excel.Interfaces.WorkbookData#tables:member + package: excel! + fullName: tables + summary: Represents a collection of tables associated with the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tables?: Excel.Interfaces.TableData[];' + return: + type: [] + - name: tableStyles + uid: excel!Excel.Interfaces.WorkbookData#tableStyles:member + package: excel! + fullName: tableStyles + summary: Represents a collection of TableStyles associated with the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tableStyles?: Excel.Interfaces.TableStyleData[];' + return: + type: [] + - name: timelineStyles + uid: excel!Excel.Interfaces.WorkbookData#timelineStyles:member + package: excel! + fullName: timelineStyles + summary: Represents a collection of TimelineStyles associated with the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'timelineStyles?: Excel.Interfaces.TimelineStyleData[];' + return: + type: [] + - name: usePrecisionAsDisplayed + uid: excel!Excel.Interfaces.WorkbookData#usePrecisionAsDisplayed:member + package: excel! + fullName: usePrecisionAsDisplayed + summary: >- + True if calculations in this workbook will be done using only the + precision of the numbers as they're displayed. Data will permanently lose + accuracy when switching this property from `false` to `true`. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'usePrecisionAsDisplayed?: boolean;' + return: + type: boolean + - name: worksheets + uid: excel!Excel.Interfaces.WorkbookData#worksheets:member + package: excel! + fullName: worksheets + summary: Represents a collection of worksheets associated with the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheets?: Excel.Interfaces.WorksheetData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.workbookloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.workbookloadoptions.yml new file mode 100644 index 0000000000..956e145ec8 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.workbookloadoptions.yml @@ -0,0 +1,249 @@ +### YamlMime:TSType +name: Excel.Interfaces.WorkbookLoadOptions +uid: excel!Excel.Interfaces.WorkbookLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.WorkbookLoadOptions +summary: >- + Workbook is the top level object which contains related workbook objects such + as worksheets, tables, and ranges. To learn more about the workbook object + model, read [Work with workbooks using the Excel JavaScript + API](https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-workbooks). +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.WorkbookLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: application + uid: excel!Excel.Interfaces.WorkbookLoadOptions#application:member + package: excel! + fullName: application + summary: Represents the Excel application instance that contains this workbook. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'application?: Excel.Interfaces.ApplicationLoadOptions;' + return: + type: + - name: autoSave + uid: excel!Excel.Interfaces.WorkbookLoadOptions#autoSave:member + package: excel! + fullName: autoSave + summary: Specifies if the workbook is in AutoSave mode. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'autoSave?: boolean;' + return: + type: boolean + - name: bindings + uid: excel!Excel.Interfaces.WorkbookLoadOptions#bindings:member + package: excel! + fullName: bindings + summary: Represents a collection of bindings that are part of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'bindings?: Excel.Interfaces.BindingCollectionLoadOptions;' + return: + type: >- + + - name: calculationEngineVersion + uid: excel!Excel.Interfaces.WorkbookLoadOptions#calculationEngineVersion:member + package: excel! + fullName: calculationEngineVersion + summary: Returns a number about the version of Excel Calculation Engine. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'calculationEngineVersion?: boolean;' + return: + type: boolean + - name: chartDataPointTrack + uid: excel!Excel.Interfaces.WorkbookLoadOptions#chartDataPointTrack:member + package: excel! + fullName: chartDataPointTrack + summary: >- + True if all charts in the workbook are tracking the actual data points to + which they are attached. False if the charts track the index of the data + points. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'chartDataPointTrack?: boolean;' + return: + type: boolean + - name: isDirty + uid: excel!Excel.Interfaces.WorkbookLoadOptions#isDirty:member + package: excel! + fullName: isDirty + summary: >- + Specifies if changes have been made since the workbook was last saved. You + can set this property to `true` if you want to close a modified workbook + without either saving it or being prompted to save it. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'isDirty?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.WorkbookLoadOptions#name:member + package: excel! + fullName: name + summary: Gets the workbook name. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: previouslySaved + uid: excel!Excel.Interfaces.WorkbookLoadOptions#previouslySaved:member + package: excel! + fullName: previouslySaved + summary: Specifies if the workbook has ever been saved locally or online. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'previouslySaved?: boolean;' + return: + type: boolean + - name: properties + uid: excel!Excel.Interfaces.WorkbookLoadOptions#properties:member + package: excel! + fullName: properties + summary: Gets the workbook properties. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'properties?: Excel.Interfaces.DocumentPropertiesLoadOptions;' + return: + type: >- + + - name: protection + uid: excel!Excel.Interfaces.WorkbookLoadOptions#protection:member + package: excel! + fullName: protection + summary: Returns the protection object for a workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'protection?: Excel.Interfaces.WorkbookProtectionLoadOptions;' + return: + type: >- + + - name: readOnly + uid: excel!Excel.Interfaces.WorkbookLoadOptions#readOnly:member + package: excel! + fullName: readOnly + summary: Returns `true` if the workbook is open in read-only mode. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readOnly?: boolean;' + return: + type: boolean + - name: tables + uid: excel!Excel.Interfaces.WorkbookLoadOptions#tables:member + package: excel! + fullName: tables + summary: Represents a collection of tables associated with the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tables?: Excel.Interfaces.TableCollectionLoadOptions;' + return: + type: >- + + - name: usePrecisionAsDisplayed + uid: excel!Excel.Interfaces.WorkbookLoadOptions#usePrecisionAsDisplayed:member + package: excel! + fullName: usePrecisionAsDisplayed + summary: >- + True if calculations in this workbook will be done using only the + precision of the numbers as they're displayed. Data will permanently lose + accuracy when switching this property from `false` to `true`. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'usePrecisionAsDisplayed?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.workbookprotectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.workbookprotectiondata.yml new file mode 100644 index 0000000000..82e06116ca --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.workbookprotectiondata.yml @@ -0,0 +1,29 @@ +### YamlMime:TSType +name: Excel.Interfaces.WorkbookProtectionData +uid: excel!Excel.Interfaces.WorkbookProtectionData:interface +package: excel! +fullName: Excel.Interfaces.WorkbookProtectionData +summary: >- + An interface describing the data returned by calling + `workbookProtection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: protected + uid: excel!Excel.Interfaces.WorkbookProtectionData#protected:member + package: excel! + fullName: protected + summary: Specifies if the workbook is protected. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'protected?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.workbookprotectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.workbookprotectionloadoptions.yml new file mode 100644 index 0000000000..6aed3f5b4e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.workbookprotectionloadoptions.yml @@ -0,0 +1,45 @@ +### YamlMime:TSType +name: Excel.Interfaces.WorkbookProtectionLoadOptions +uid: excel!Excel.Interfaces.WorkbookProtectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.WorkbookProtectionLoadOptions +summary: Represents the protection of a workbook object. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.WorkbookProtectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: protected + uid: excel!Excel.Interfaces.WorkbookProtectionLoadOptions#protected:member + package: excel! + fullName: protected + summary: Specifies if the workbook is protected. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'protected?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.workbookrangeareasdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.workbookrangeareasdata.yml new file mode 100644 index 0000000000..2136bcc2ab --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.workbookrangeareasdata.yml @@ -0,0 +1,67 @@ +### YamlMime:TSType +name: Excel.Interfaces.WorkbookRangeAreasData +uid: excel!Excel.Interfaces.WorkbookRangeAreasData:interface +package: excel! +fullName: Excel.Interfaces.WorkbookRangeAreasData +summary: >- + An interface describing the data returned by calling + `workbookRangeAreas.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: addresses + uid: excel!Excel.Interfaces.WorkbookRangeAreasData#addresses:member + package: excel! + fullName: addresses + summary: >- + Returns an array of addresses in A1-style. Address values contain the + worksheet name for each rectangular block of cells (e.g., "Sheet1!A1:B4, + Sheet1!D1:D4"). Read-only. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'addresses?: string[];' + return: + type: string[] + - name: areas + uid: excel!Excel.Interfaces.WorkbookRangeAreasData#areas:member + package: excel! + fullName: areas + summary: >- + Returns the `RangeAreasCollection` object. Each `RangeAreas` in the + collection represent one or more rectangle ranges in one worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'areas?: Excel.Interfaces.RangeAreasData[];' + return: + type: [] + - name: ranges + uid: excel!Excel.Interfaces.WorkbookRangeAreasData#ranges:member + package: excel! + fullName: ranges + summary: Returns ranges that comprise this object in a `RangeCollection` object. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'ranges?: Excel.Interfaces.RangeData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.workbookrangeareasloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.workbookrangeareasloadoptions.yml new file mode 100644 index 0000000000..f172973d06 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.workbookrangeareasloadoptions.yml @@ -0,0 +1,51 @@ +### YamlMime:TSType +name: Excel.Interfaces.WorkbookRangeAreasLoadOptions +uid: excel!Excel.Interfaces.WorkbookRangeAreasLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.WorkbookRangeAreasLoadOptions +summary: >- + Represents a collection of one or more rectangular ranges in multiple + worksheets. +remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.WorkbookRangeAreasLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: addresses + uid: excel!Excel.Interfaces.WorkbookRangeAreasLoadOptions#addresses:member + package: excel! + fullName: addresses + summary: >- + Returns an array of addresses in A1-style. Address values contain the + worksheet name for each rectangular block of cells (e.g., "Sheet1!A1:B4, + Sheet1!D1:D4"). Read-only. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'addresses?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.workbookupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.workbookupdatedata.yml new file mode 100644 index 0000000000..88a20d192a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.workbookupdatedata.yml @@ -0,0 +1,85 @@ +### YamlMime:TSType +name: Excel.Interfaces.WorkbookUpdateData +uid: excel!Excel.Interfaces.WorkbookUpdateData:interface +package: excel! +fullName: Excel.Interfaces.WorkbookUpdateData +summary: >- + An interface for updating data on the `Workbook` object, for use in + `workbook.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: chartDataPointTrack + uid: excel!Excel.Interfaces.WorkbookUpdateData#chartDataPointTrack:member + package: excel! + fullName: chartDataPointTrack + summary: >- + True if all charts in the workbook are tracking the actual data points to + which they are attached. False if the charts track the index of the data + points. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'chartDataPointTrack?: boolean;' + return: + type: boolean + - name: isDirty + uid: excel!Excel.Interfaces.WorkbookUpdateData#isDirty:member + package: excel! + fullName: isDirty + summary: >- + Specifies if changes have been made since the workbook was last saved. You + can set this property to `true` if you want to close a modified workbook + without either saving it or being prompted to save it. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'isDirty?: boolean;' + return: + type: boolean + - name: properties + uid: excel!Excel.Interfaces.WorkbookUpdateData#properties:member + package: excel! + fullName: properties + summary: Gets the workbook properties. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'properties?: Excel.Interfaces.DocumentPropertiesUpdateData;' + return: + type: >- + + - name: usePrecisionAsDisplayed + uid: excel!Excel.Interfaces.WorkbookUpdateData#usePrecisionAsDisplayed:member + package: excel! + fullName: usePrecisionAsDisplayed + summary: >- + True if calculations in this workbook will be done using only the + precision of the numbers as they're displayed. Data will permanently lose + accuracy when switching this property from `false` to `true`. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'usePrecisionAsDisplayed?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetcollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetcollectiondata.yml new file mode 100644 index 0000000000..2c11dc19b3 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetcollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.WorksheetCollectionData +uid: excel!Excel.Interfaces.WorksheetCollectionData:interface +package: excel! +fullName: Excel.Interfaces.WorksheetCollectionData +summary: >- + An interface describing the data returned by calling + `worksheetCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.WorksheetCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.WorksheetData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetcollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetcollectionloadoptions.yml new file mode 100644 index 0000000000..78537e455c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetcollectionloadoptions.yml @@ -0,0 +1,340 @@ +### YamlMime:TSType +name: Excel.Interfaces.WorksheetCollectionLoadOptions +uid: excel!Excel.Interfaces.WorksheetCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.WorksheetCollectionLoadOptions +summary: Represents a collection of worksheet objects that are part of the workbook. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.WorksheetCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: autoFilter + uid: excel!Excel.Interfaces.WorksheetCollectionLoadOptions#autoFilter:member + package: excel! + fullName: autoFilter + summary: >- + For EACH ITEM in the collection: Represents the `AutoFilter` object of the + worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'autoFilter?: Excel.Interfaces.AutoFilterLoadOptions;' + return: + type: + - name: charts + uid: excel!Excel.Interfaces.WorksheetCollectionLoadOptions#charts:member + package: excel! + fullName: charts + summary: >- + For EACH ITEM in the collection: Returns a collection of charts that are + part of the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'charts?: Excel.Interfaces.ChartCollectionLoadOptions;' + return: + type: >- + + - name: enableCalculation + uid: >- + excel!Excel.Interfaces.WorksheetCollectionLoadOptions#enableCalculation:member + package: excel! + fullName: enableCalculation + summary: >- + For EACH ITEM in the collection: Determines if Excel should recalculate + the worksheet when necessary. True if Excel recalculates the worksheet + when necessary. False if Excel doesn't recalculate the sheet. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'enableCalculation?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.WorksheetCollectionLoadOptions#id:member + package: excel! + fullName: id + summary: >- + For EACH ITEM in the collection: Returns a value that uniquely identifies + the worksheet in a given workbook. The value of the identifier remains the + same even when the worksheet is renamed or moved. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.WorksheetCollectionLoadOptions#name:member + package: excel! + fullName: name + summary: >- + For EACH ITEM in the collection: The display name of the worksheet. The + name must be fewer than 32 characters. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: pageLayout + uid: excel!Excel.Interfaces.WorksheetCollectionLoadOptions#pageLayout:member + package: excel! + fullName: pageLayout + summary: >- + For EACH ITEM in the collection: Gets the `PageLayout` object of the + worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'pageLayout?: Excel.Interfaces.PageLayoutLoadOptions;' + return: + type: + - name: position + uid: excel!Excel.Interfaces.WorksheetCollectionLoadOptions#position:member + package: excel! + fullName: position + summary: >- + For EACH ITEM in the collection: The zero-based position of the worksheet + within the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'position?: boolean;' + return: + type: boolean + - name: protection + uid: excel!Excel.Interfaces.WorksheetCollectionLoadOptions#protection:member + package: excel! + fullName: protection + summary: >- + For EACH ITEM in the collection: Returns the sheet protection object for a + worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'protection?: Excel.Interfaces.WorksheetProtectionLoadOptions;' + return: + type: >- + + - name: showDataTypeIcons + uid: >- + excel!Excel.Interfaces.WorksheetCollectionLoadOptions#showDataTypeIcons:member + package: excel! + fullName: showDataTypeIcons + summary: >- + For EACH ITEM in the collection: Specifies if data type icons are visible + on the worksheet. By default, data type icons are visible. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showDataTypeIcons?: boolean;' + return: + type: boolean + - name: showGridlines + uid: excel!Excel.Interfaces.WorksheetCollectionLoadOptions#showGridlines:member + package: excel! + fullName: showGridlines + summary: >- + For EACH ITEM in the collection: Specifies if gridlines are visible to the + user. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showGridlines?: boolean;' + return: + type: boolean + - name: showHeadings + uid: excel!Excel.Interfaces.WorksheetCollectionLoadOptions#showHeadings:member + package: excel! + fullName: showHeadings + summary: >- + For EACH ITEM in the collection: Specifies if headings are visible to the + user. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showHeadings?: boolean;' + return: + type: boolean + - name: standardHeight + uid: >- + excel!Excel.Interfaces.WorksheetCollectionLoadOptions#standardHeight:member + package: excel! + fullName: standardHeight + summary: >- + For EACH ITEM in the collection: Returns the standard (default) height of + all the rows in the worksheet, in points. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'standardHeight?: boolean;' + return: + type: boolean + - name: standardWidth + uid: excel!Excel.Interfaces.WorksheetCollectionLoadOptions#standardWidth:member + package: excel! + fullName: standardWidth + summary: >- + For EACH ITEM in the collection: Specifies the standard (default) width of + all the columns in the worksheet. One unit of column width is equal to the + width of one character in the Normal style. For proportional fonts, the + width of the character 0 (zero) is used. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'standardWidth?: boolean;' + return: + type: boolean + - name: tabColor + uid: excel!Excel.Interfaces.WorksheetCollectionLoadOptions#tabColor:member + package: excel! + fullName: tabColor + summary: >- + For EACH ITEM in the collection: The tab color of the worksheet. When + retrieving the tab color, if the worksheet is invisible, the value will be + `null`. If the worksheet is visible but the tab color is set to + auto, an empty string will be returned. Otherwise, the property will be + set to a color, in the form \#RRGGBB (e.g., "FFA500"). When setting the + color, use an empty-string to set an "auto" color, or a real color + otherwise. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tabColor?: boolean;' + return: + type: boolean + - name: tabId + uid: excel!Excel.Interfaces.WorksheetCollectionLoadOptions#tabId:member + package: excel! + fullName: tabId + summary: >- + For EACH ITEM in the collection: Returns a value representing this + worksheet that can be read by Open Office XML. This is an integer value, + which is different from `worksheet.id` (which returns a globally unique + identifier) and `worksheet.name` (which returns a value such as "Sheet1"). + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tabId?: boolean;' + return: + type: boolean + - name: tables + uid: excel!Excel.Interfaces.WorksheetCollectionLoadOptions#tables:member + package: excel! + fullName: tables + summary: >- + For EACH ITEM in the collection: Collection of tables that are part of the + worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tables?: Excel.Interfaces.TableCollectionLoadOptions;' + return: + type: >- + + - name: visibility + uid: excel!Excel.Interfaces.WorksheetCollectionLoadOptions#visibility:member + package: excel! + fullName: visibility + summary: 'For EACH ITEM in the collection: The visibility of the worksheet.' + remarks: >- + \[ [API set: ExcelApi 1.1 for reading visibility; 1.2 for setting + it.](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visibility?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetcollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetcollectionupdatedata.yml new file mode 100644 index 0000000000..64cf753324 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetcollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Excel.Interfaces.WorksheetCollectionUpdateData +uid: excel!Excel.Interfaces.WorksheetCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.WorksheetCollectionUpdateData +summary: >- + An interface for updating data on the `WorksheetCollection` object, for use in + `worksheetCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.WorksheetCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.WorksheetData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetcustompropertycollectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetcustompropertycollectiondata.yml new file mode 100644 index 0000000000..16a6f88681 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetcustompropertycollectiondata.yml @@ -0,0 +1,30 @@ +### YamlMime:TSType +name: Excel.Interfaces.WorksheetCustomPropertyCollectionData +uid: excel!Excel.Interfaces.WorksheetCustomPropertyCollectionData:interface +package: excel! +fullName: Excel.Interfaces.WorksheetCustomPropertyCollectionData +summary: >- + An interface describing the data returned by calling + `worksheetCustomPropertyCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: excel!Excel.Interfaces.WorksheetCustomPropertyCollectionData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.WorksheetCustomPropertyData[];' + return: + type: >- + [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetcustompropertycollectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetcustompropertycollectionloadoptions.yml new file mode 100644 index 0000000000..8e4a77c66b --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetcustompropertycollectionloadoptions.yml @@ -0,0 +1,71 @@ +### YamlMime:TSType +name: Excel.Interfaces.WorksheetCustomPropertyCollectionLoadOptions +uid: excel!Excel.Interfaces.WorksheetCustomPropertyCollectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.WorksheetCustomPropertyCollectionLoadOptions +summary: Contains the collection of worksheet-level custom property. +remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: >- + excel!Excel.Interfaces.WorksheetCustomPropertyCollectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: key + uid: >- + excel!Excel.Interfaces.WorksheetCustomPropertyCollectionLoadOptions#key:member + package: excel! + fullName: key + summary: >- + For EACH ITEM in the collection: Gets the key of the custom property. + Custom property keys are case-insensitive. The key is limited to 255 + characters (larger values will cause an `InvalidArgument` error to be + thrown.) + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'key?: boolean;' + return: + type: boolean + - name: value + uid: >- + excel!Excel.Interfaces.WorksheetCustomPropertyCollectionLoadOptions#value:member + package: excel! + fullName: value + summary: >- + For EACH ITEM in the collection: Gets or sets the value of the custom + property. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'value?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetcustompropertycollectionupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetcustompropertycollectionupdatedata.yml new file mode 100644 index 0000000000..36d766859c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetcustompropertycollectionupdatedata.yml @@ -0,0 +1,31 @@ +### YamlMime:TSType +name: Excel.Interfaces.WorksheetCustomPropertyCollectionUpdateData +uid: excel!Excel.Interfaces.WorksheetCustomPropertyCollectionUpdateData:interface +package: excel! +fullName: Excel.Interfaces.WorksheetCustomPropertyCollectionUpdateData +summary: >- + An interface for updating data on the `WorksheetCustomPropertyCollection` + object, for use in `worksheetCustomPropertyCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: >- + excel!Excel.Interfaces.WorksheetCustomPropertyCollectionUpdateData#items:member + package: excel! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Excel.Interfaces.WorksheetCustomPropertyData[];' + return: + type: >- + [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetcustompropertydata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetcustompropertydata.yml new file mode 100644 index 0000000000..717b537468 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetcustompropertydata.yml @@ -0,0 +1,49 @@ +### YamlMime:TSType +name: Excel.Interfaces.WorksheetCustomPropertyData +uid: excel!Excel.Interfaces.WorksheetCustomPropertyData:interface +package: excel! +fullName: Excel.Interfaces.WorksheetCustomPropertyData +summary: >- + An interface describing the data returned by calling + `worksheetCustomProperty.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: key + uid: excel!Excel.Interfaces.WorksheetCustomPropertyData#key:member + package: excel! + fullName: key + summary: >- + Gets the key of the custom property. Custom property keys are + case-insensitive. The key is limited to 255 characters (larger values will + cause an `InvalidArgument` error to be thrown.) + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'key?: string;' + return: + type: string + - name: value + uid: excel!Excel.Interfaces.WorksheetCustomPropertyData#value:member + package: excel! + fullName: value + summary: Gets or sets the value of the custom property. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'value?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetcustompropertyloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetcustompropertyloadoptions.yml new file mode 100644 index 0000000000..1674fe4e02 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetcustompropertyloadoptions.yml @@ -0,0 +1,65 @@ +### YamlMime:TSType +name: Excel.Interfaces.WorksheetCustomPropertyLoadOptions +uid: excel!Excel.Interfaces.WorksheetCustomPropertyLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.WorksheetCustomPropertyLoadOptions +summary: Represents a worksheet-level custom property. +remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.WorksheetCustomPropertyLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: key + uid: excel!Excel.Interfaces.WorksheetCustomPropertyLoadOptions#key:member + package: excel! + fullName: key + summary: >- + Gets the key of the custom property. Custom property keys are + case-insensitive. The key is limited to 255 characters (larger values will + cause an `InvalidArgument` error to be thrown.) + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'key?: boolean;' + return: + type: boolean + - name: value + uid: excel!Excel.Interfaces.WorksheetCustomPropertyLoadOptions#value:member + package: excel! + fullName: value + summary: Gets or sets the value of the custom property. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'value?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetcustompropertyupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetcustompropertyupdatedata.yml new file mode 100644 index 0000000000..20a653ed08 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetcustompropertyupdatedata.yml @@ -0,0 +1,30 @@ +### YamlMime:TSType +name: Excel.Interfaces.WorksheetCustomPropertyUpdateData +uid: excel!Excel.Interfaces.WorksheetCustomPropertyUpdateData:interface +package: excel! +fullName: Excel.Interfaces.WorksheetCustomPropertyUpdateData +summary: >- + An interface for updating data on the `WorksheetCustomProperty` object, for + use in `worksheetCustomProperty.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: value + uid: excel!Excel.Interfaces.WorksheetCustomPropertyUpdateData#value:member + package: excel! + fullName: value + summary: Gets or sets the value of the custom property. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'value?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetdata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetdata.yml new file mode 100644 index 0000000000..c8434a93f3 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetdata.yml @@ -0,0 +1,449 @@ +### YamlMime:TSType +name: Excel.Interfaces.WorksheetData +uid: excel!Excel.Interfaces.WorksheetData:interface +package: excel! +fullName: Excel.Interfaces.WorksheetData +summary: >- + An interface describing the data returned by calling `worksheet.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: autoFilter + uid: excel!Excel.Interfaces.WorksheetData#autoFilter:member + package: excel! + fullName: autoFilter + summary: Represents the `AutoFilter` object of the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'autoFilter?: Excel.Interfaces.AutoFilterData;' + return: + type: + - name: charts + uid: excel!Excel.Interfaces.WorksheetData#charts:member + package: excel! + fullName: charts + summary: Returns a collection of charts that are part of the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'charts?: Excel.Interfaces.ChartData[];' + return: + type: [] + - name: comments + uid: excel!Excel.Interfaces.WorksheetData#comments:member + package: excel! + fullName: comments + summary: Returns a collection of all the Comments objects on the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'comments?: Excel.Interfaces.CommentData[];' + return: + type: [] + - name: customProperties + uid: excel!Excel.Interfaces.WorksheetData#customProperties:member + package: excel! + fullName: customProperties + summary: Gets a collection of worksheet-level custom properties. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'customProperties?: Excel.Interfaces.WorksheetCustomPropertyData[];' + return: + type: >- + [] + - name: enableCalculation + uid: excel!Excel.Interfaces.WorksheetData#enableCalculation:member + package: excel! + fullName: enableCalculation + summary: >- + Determines if Excel should recalculate the worksheet when necessary. True + if Excel recalculates the worksheet when necessary. False if Excel doesn't + recalculate the sheet. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'enableCalculation?: boolean;' + return: + type: boolean + - name: horizontalPageBreaks + uid: excel!Excel.Interfaces.WorksheetData#horizontalPageBreaks:member + package: excel! + fullName: horizontalPageBreaks + summary: >- + Gets the horizontal page break collection for the worksheet. This + collection only contains manual page breaks. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'horizontalPageBreaks?: Excel.Interfaces.PageBreakData[];' + return: + type: [] + - name: id + uid: excel!Excel.Interfaces.WorksheetData#id:member + package: excel! + fullName: id + summary: >- + Returns a value that uniquely identifies the worksheet in a given + workbook. The value of the identifier remains the same even when the + worksheet is renamed or moved. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: string;' + return: + type: string + - name: name + uid: excel!Excel.Interfaces.WorksheetData#name:member + package: excel! + fullName: name + summary: >- + The display name of the worksheet. The name must be fewer than 32 + characters. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: names + uid: excel!Excel.Interfaces.WorksheetData#names:member + package: excel! + fullName: names + summary: Collection of names scoped to the current worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'names?: Excel.Interfaces.NamedItemData[];' + return: + type: [] + - name: notes + uid: excel!Excel.Interfaces.WorksheetData#notes:member + package: excel! + fullName: notes + summary: Returns a collection of all the notes objects in the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'notes?: Excel.Interfaces.NoteData[];' + return: + type: [] + - name: pageLayout + uid: excel!Excel.Interfaces.WorksheetData#pageLayout:member + package: excel! + fullName: pageLayout + summary: Gets the `PageLayout` object of the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'pageLayout?: Excel.Interfaces.PageLayoutData;' + return: + type: + - name: pivotTables + uid: excel!Excel.Interfaces.WorksheetData#pivotTables:member + package: excel! + fullName: pivotTables + summary: Collection of PivotTables that are part of the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'pivotTables?: Excel.Interfaces.PivotTableData[];' + return: + type: [] + - name: position + uid: excel!Excel.Interfaces.WorksheetData#position:member + package: excel! + fullName: position + summary: The zero-based position of the worksheet within the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'position?: number;' + return: + type: number + - name: protection + uid: excel!Excel.Interfaces.WorksheetData#protection:member + package: excel! + fullName: protection + summary: Returns the sheet protection object for a worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'protection?: Excel.Interfaces.WorksheetProtectionData;' + return: + type: >- + + - name: shapes + uid: excel!Excel.Interfaces.WorksheetData#shapes:member + package: excel! + fullName: shapes + summary: Returns the collection of all the Shape objects on the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'shapes?: Excel.Interfaces.ShapeData[];' + return: + type: [] + - name: showDataTypeIcons + uid: excel!Excel.Interfaces.WorksheetData#showDataTypeIcons:member + package: excel! + fullName: showDataTypeIcons + summary: >- + Specifies if data type icons are visible on the worksheet. By default, + data type icons are visible. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showDataTypeIcons?: boolean;' + return: + type: boolean + - name: showGridlines + uid: excel!Excel.Interfaces.WorksheetData#showGridlines:member + package: excel! + fullName: showGridlines + summary: Specifies if gridlines are visible to the user. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showGridlines?: boolean;' + return: + type: boolean + - name: showHeadings + uid: excel!Excel.Interfaces.WorksheetData#showHeadings:member + package: excel! + fullName: showHeadings + summary: Specifies if headings are visible to the user. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showHeadings?: boolean;' + return: + type: boolean + - name: slicers + uid: excel!Excel.Interfaces.WorksheetData#slicers:member + package: excel! + fullName: slicers + summary: Returns a collection of slicers that are part of the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'slicers?: Excel.Interfaces.SlicerData[];' + return: + type: [] + - name: standardHeight + uid: excel!Excel.Interfaces.WorksheetData#standardHeight:member + package: excel! + fullName: standardHeight + summary: >- + Returns the standard (default) height of all the rows in the worksheet, in + points. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'standardHeight?: number;' + return: + type: number + - name: standardWidth + uid: excel!Excel.Interfaces.WorksheetData#standardWidth:member + package: excel! + fullName: standardWidth + summary: >- + Specifies the standard (default) width of all the columns in the + worksheet. One unit of column width is equal to the width of one character + in the Normal style. For proportional fonts, the width of the character 0 + (zero) is used. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'standardWidth?: number;' + return: + type: number + - name: tabColor + uid: excel!Excel.Interfaces.WorksheetData#tabColor:member + package: excel! + fullName: tabColor + summary: >- + The tab color of the worksheet. When retrieving the tab color, if the + worksheet is invisible, the value will be `null`. If the worksheet + is visible but the tab color is set to auto, an empty string will be + returned. Otherwise, the property will be set to a color, in the form + \#RRGGBB (e.g., "FFA500"). When setting the color, use an empty-string to + set an "auto" color, or a real color otherwise. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tabColor?: string;' + return: + type: string + - name: tabId + uid: excel!Excel.Interfaces.WorksheetData#tabId:member + package: excel! + fullName: tabId + summary: >- + Returns a value representing this worksheet that can be read by Open + Office XML. This is an integer value, which is different from + `worksheet.id` (which returns a globally unique identifier) and + `worksheet.name` (which returns a value such as "Sheet1"). + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tabId?: number;' + return: + type: number + - name: tables + uid: excel!Excel.Interfaces.WorksheetData#tables:member + package: excel! + fullName: tables + summary: Collection of tables that are part of the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tables?: Excel.Interfaces.TableData[];' + return: + type: [] + - name: verticalPageBreaks + uid: excel!Excel.Interfaces.WorksheetData#verticalPageBreaks:member + package: excel! + fullName: verticalPageBreaks + summary: >- + Gets the vertical page break collection for the worksheet. This collection + only contains manual page breaks. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'verticalPageBreaks?: Excel.Interfaces.PageBreakData[];' + return: + type: [] + - name: visibility + uid: excel!Excel.Interfaces.WorksheetData#visibility:member + package: excel! + fullName: visibility + summary: The visibility of the worksheet. + remarks: >- + \[ [API set: ExcelApi 1.1 for reading visibility; 1.2 for setting + it.](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + visibility?: Excel.SheetVisibility | "Visible" | "Hidden" | + "VeryHidden"; + return: + type: >- + | "Visible" | "Hidden" + | "VeryHidden" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetloadoptions.yml new file mode 100644 index 0000000000..6062092d2e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetloadoptions.yml @@ -0,0 +1,325 @@ +### YamlMime:TSType +name: Excel.Interfaces.WorksheetLoadOptions +uid: excel!Excel.Interfaces.WorksheetLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.WorksheetLoadOptions +summary: >- + An Excel worksheet is a grid of cells. It can contain data, tables, charts, + etc. To learn more about the worksheet object model, read [Work with + worksheets using the Excel JavaScript + API](https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-worksheets). +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.WorksheetLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: autoFilter + uid: excel!Excel.Interfaces.WorksheetLoadOptions#autoFilter:member + package: excel! + fullName: autoFilter + summary: Represents the `AutoFilter` object of the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'autoFilter?: Excel.Interfaces.AutoFilterLoadOptions;' + return: + type: + - name: charts + uid: excel!Excel.Interfaces.WorksheetLoadOptions#charts:member + package: excel! + fullName: charts + summary: Returns a collection of charts that are part of the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'charts?: Excel.Interfaces.ChartCollectionLoadOptions;' + return: + type: >- + + - name: enableCalculation + uid: excel!Excel.Interfaces.WorksheetLoadOptions#enableCalculation:member + package: excel! + fullName: enableCalculation + summary: >- + Determines if Excel should recalculate the worksheet when necessary. True + if Excel recalculates the worksheet when necessary. False if Excel doesn't + recalculate the sheet. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'enableCalculation?: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Interfaces.WorksheetLoadOptions#id:member + package: excel! + fullName: id + summary: >- + Returns a value that uniquely identifies the worksheet in a given + workbook. The value of the identifier remains the same even when the + worksheet is renamed or moved. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.WorksheetLoadOptions#name:member + package: excel! + fullName: name + summary: >- + The display name of the worksheet. The name must be fewer than 32 + characters. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: pageLayout + uid: excel!Excel.Interfaces.WorksheetLoadOptions#pageLayout:member + package: excel! + fullName: pageLayout + summary: Gets the `PageLayout` object of the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'pageLayout?: Excel.Interfaces.PageLayoutLoadOptions;' + return: + type: + - name: position + uid: excel!Excel.Interfaces.WorksheetLoadOptions#position:member + package: excel! + fullName: position + summary: The zero-based position of the worksheet within the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'position?: boolean;' + return: + type: boolean + - name: protection + uid: excel!Excel.Interfaces.WorksheetLoadOptions#protection:member + package: excel! + fullName: protection + summary: Returns the sheet protection object for a worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'protection?: Excel.Interfaces.WorksheetProtectionLoadOptions;' + return: + type: >- + + - name: showDataTypeIcons + uid: excel!Excel.Interfaces.WorksheetLoadOptions#showDataTypeIcons:member + package: excel! + fullName: showDataTypeIcons + summary: >- + Specifies if data type icons are visible on the worksheet. By default, + data type icons are visible. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showDataTypeIcons?: boolean;' + return: + type: boolean + - name: showGridlines + uid: excel!Excel.Interfaces.WorksheetLoadOptions#showGridlines:member + package: excel! + fullName: showGridlines + summary: Specifies if gridlines are visible to the user. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showGridlines?: boolean;' + return: + type: boolean + - name: showHeadings + uid: excel!Excel.Interfaces.WorksheetLoadOptions#showHeadings:member + package: excel! + fullName: showHeadings + summary: Specifies if headings are visible to the user. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showHeadings?: boolean;' + return: + type: boolean + - name: standardHeight + uid: excel!Excel.Interfaces.WorksheetLoadOptions#standardHeight:member + package: excel! + fullName: standardHeight + summary: >- + Returns the standard (default) height of all the rows in the worksheet, in + points. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'standardHeight?: boolean;' + return: + type: boolean + - name: standardWidth + uid: excel!Excel.Interfaces.WorksheetLoadOptions#standardWidth:member + package: excel! + fullName: standardWidth + summary: >- + Specifies the standard (default) width of all the columns in the + worksheet. One unit of column width is equal to the width of one character + in the Normal style. For proportional fonts, the width of the character 0 + (zero) is used. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'standardWidth?: boolean;' + return: + type: boolean + - name: tabColor + uid: excel!Excel.Interfaces.WorksheetLoadOptions#tabColor:member + package: excel! + fullName: tabColor + summary: >- + The tab color of the worksheet. When retrieving the tab color, if the + worksheet is invisible, the value will be `null`. If the worksheet + is visible but the tab color is set to auto, an empty string will be + returned. Otherwise, the property will be set to a color, in the form + \#RRGGBB (e.g., "FFA500"). When setting the color, use an empty-string to + set an "auto" color, or a real color otherwise. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tabColor?: boolean;' + return: + type: boolean + - name: tabId + uid: excel!Excel.Interfaces.WorksheetLoadOptions#tabId:member + package: excel! + fullName: tabId + summary: >- + Returns a value representing this worksheet that can be read by Open + Office XML. This is an integer value, which is different from + `worksheet.id` (which returns a globally unique identifier) and + `worksheet.name` (which returns a value such as "Sheet1"). + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tabId?: boolean;' + return: + type: boolean + - name: tables + uid: excel!Excel.Interfaces.WorksheetLoadOptions#tables:member + package: excel! + fullName: tables + summary: Collection of tables that are part of the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tables?: Excel.Interfaces.TableCollectionLoadOptions;' + return: + type: >- + + - name: visibility + uid: excel!Excel.Interfaces.WorksheetLoadOptions#visibility:member + package: excel! + fullName: visibility + summary: The visibility of the worksheet. + remarks: >- + \[ [API set: ExcelApi 1.1 for reading visibility; 1.2 for setting + it.](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visibility?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetprotectiondata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetprotectiondata.yml new file mode 100644 index 0000000000..4024987260 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetprotectiondata.yml @@ -0,0 +1,44 @@ +### YamlMime:TSType +name: Excel.Interfaces.WorksheetProtectionData +uid: excel!Excel.Interfaces.WorksheetProtectionData:interface +package: excel! +fullName: Excel.Interfaces.WorksheetProtectionData +summary: >- + An interface describing the data returned by calling + `worksheetProtection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: options + uid: excel!Excel.Interfaces.WorksheetProtectionData#options:member + package: excel! + fullName: options + summary: Specifies the protection options for the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'options?: Excel.WorksheetProtectionOptions;' + return: + type: + - name: protected + uid: excel!Excel.Interfaces.WorksheetProtectionData#protected:member + package: excel! + fullName: protected + summary: Specifies if the worksheet is protected. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'protected?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetprotectionloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetprotectionloadoptions.yml new file mode 100644 index 0000000000..6f3b6b0cb6 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetprotectionloadoptions.yml @@ -0,0 +1,60 @@ +### YamlMime:TSType +name: Excel.Interfaces.WorksheetProtectionLoadOptions +uid: excel!Excel.Interfaces.WorksheetProtectionLoadOptions:interface +package: excel! +fullName: Excel.Interfaces.WorksheetProtectionLoadOptions +summary: Represents the protection of a worksheet object. +remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: excel!Excel.Interfaces.WorksheetProtectionLoadOptions#$all:member + package: excel! + fullName: $all + summary: >- + Specifying `$all` for the load options loads all the scalar properties + (such as `Range.address`) but not the navigational properties + (such as `Range.format.fill.color`). + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: options + uid: excel!Excel.Interfaces.WorksheetProtectionLoadOptions#options:member + package: excel! + fullName: options + summary: Specifies the protection options for the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'options?: boolean;' + return: + type: boolean + - name: protected + uid: excel!Excel.Interfaces.WorksheetProtectionLoadOptions#protected:member + package: excel! + fullName: protected + summary: Specifies if the worksheet is protected. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'protected?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetupdatedata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetupdatedata.yml new file mode 100644 index 0000000000..aad7355167 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.interfaces.worksheetupdatedata.yml @@ -0,0 +1,186 @@ +### YamlMime:TSType +name: Excel.Interfaces.WorksheetUpdateData +uid: excel!Excel.Interfaces.WorksheetUpdateData:interface +package: excel! +fullName: Excel.Interfaces.WorksheetUpdateData +summary: >- + An interface for updating data on the `Worksheet` object, for use in + `worksheet.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: enableCalculation + uid: excel!Excel.Interfaces.WorksheetUpdateData#enableCalculation:member + package: excel! + fullName: enableCalculation + summary: >- + Determines if Excel should recalculate the worksheet when necessary. True + if Excel recalculates the worksheet when necessary. False if Excel doesn't + recalculate the sheet. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'enableCalculation?: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Interfaces.WorksheetUpdateData#name:member + package: excel! + fullName: name + summary: >- + The display name of the worksheet. The name must be fewer than 32 + characters. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: pageLayout + uid: excel!Excel.Interfaces.WorksheetUpdateData#pageLayout:member + package: excel! + fullName: pageLayout + summary: Gets the `PageLayout` object of the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'pageLayout?: Excel.Interfaces.PageLayoutUpdateData;' + return: + type: + - name: position + uid: excel!Excel.Interfaces.WorksheetUpdateData#position:member + package: excel! + fullName: position + summary: The zero-based position of the worksheet within the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'position?: number;' + return: + type: number + - name: showDataTypeIcons + uid: excel!Excel.Interfaces.WorksheetUpdateData#showDataTypeIcons:member + package: excel! + fullName: showDataTypeIcons + summary: >- + Specifies if data type icons are visible on the worksheet. By default, + data type icons are visible. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showDataTypeIcons?: boolean;' + return: + type: boolean + - name: showGridlines + uid: excel!Excel.Interfaces.WorksheetUpdateData#showGridlines:member + package: excel! + fullName: showGridlines + summary: Specifies if gridlines are visible to the user. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showGridlines?: boolean;' + return: + type: boolean + - name: showHeadings + uid: excel!Excel.Interfaces.WorksheetUpdateData#showHeadings:member + package: excel! + fullName: showHeadings + summary: Specifies if headings are visible to the user. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showHeadings?: boolean;' + return: + type: boolean + - name: standardWidth + uid: excel!Excel.Interfaces.WorksheetUpdateData#standardWidth:member + package: excel! + fullName: standardWidth + summary: >- + Specifies the standard (default) width of all the columns in the + worksheet. One unit of column width is equal to the width of one character + in the Normal style. For proportional fonts, the width of the character 0 + (zero) is used. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'standardWidth?: number;' + return: + type: number + - name: tabColor + uid: excel!Excel.Interfaces.WorksheetUpdateData#tabColor:member + package: excel! + fullName: tabColor + summary: >- + The tab color of the worksheet. When retrieving the tab color, if the + worksheet is invisible, the value will be `null`. If the worksheet + is visible but the tab color is set to auto, an empty string will be + returned. Otherwise, the property will be set to a color, in the form + \#RRGGBB (e.g., "FFA500"). When setting the color, use an empty-string to + set an "auto" color, or a real color otherwise. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tabColor?: string;' + return: + type: string + - name: visibility + uid: excel!Excel.Interfaces.WorksheetUpdateData#visibility:member + package: excel! + fullName: visibility + summary: The visibility of the worksheet. + remarks: >- + \[ [API set: ExcelApi 1.1 for reading visibility; 1.2 for setting + it.](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + visibility?: Excel.SheetVisibility | "Visible" | "Hidden" | + "VeryHidden"; + return: + type: >- + | "Visible" | "Hidden" + | "VeryHidden" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.iterativecalculation.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.iterativecalculation.yml new file mode 100644 index 0000000000..551506700b --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.iterativecalculation.yml @@ -0,0 +1,237 @@ +### YamlMime:TSType +name: Excel.IterativeCalculation +uid: excel!Excel.IterativeCalculation:class +package: excel! +fullName: Excel.IterativeCalculation +summary: Represents the iterative calculation settings. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.IterativeCalculation#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: enabled + uid: excel!Excel.IterativeCalculation#enabled:member + package: excel! + fullName: enabled + summary: True if Excel will use iteration to resolve circular references. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'enabled: boolean;' + return: + type: boolean + - name: maxChange + uid: excel!Excel.IterativeCalculation#maxChange:member + package: excel! + fullName: maxChange + summary: >- + Specifies the maximum amount of change between each iteration as Excel + resolves circular references. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'maxChange: number;' + return: + type: number + - name: maxIteration + uid: excel!Excel.IterativeCalculation#maxIteration:member + package: excel! + fullName: maxIteration + summary: >- + Specifies the maximum number of iterations that Excel can use to resolve a + circular reference. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'maxIteration: number;' + return: + type: number +methods: + - name: load(options) + uid: excel!Excel.IterativeCalculation#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.IterativeCalculationLoadOptions): + Excel.IterativeCalculation; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.IterativeCalculation#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.IterativeCalculation;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.IterativeCalculation#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.IterativeCalculation; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.IterativeCalculation#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.IterativeCalculationUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.IterativeCalculation#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.IterativeCalculation): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.IterativeCalculation#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.IterativeCalculation` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.IterativeCalculationData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.IterativeCalculationData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.javascriptcustomfunctionreferencecellvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.javascriptcustomfunctionreferencecellvalue.yml new file mode 100644 index 0000000000..b83d217eb5 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.javascriptcustomfunctionreferencecellvalue.yml @@ -0,0 +1,130 @@ +### YamlMime:TSType +name: Excel.JavaScriptCustomFunctionReferenceCellValue +uid: excel!Excel.JavaScriptCustomFunctionReferenceCellValue:interface +package: excel! +fullName: Excel.JavaScriptCustomFunctionReferenceCellValue +summary: Represents a reference to a JavaScript custom function. +remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: basicType + uid: excel!Excel.JavaScriptCustomFunctionReferenceCellValue#basicType:member + package: excel! + fullName: basicType + summary: >- + Represents the value that would be returned by `Range.valueTypes` for a + cell with this value. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicType?: RangeValueType.error | "Error";' + return: + type: | "Error" + - name: basicValue + uid: excel!Excel.JavaScriptCustomFunctionReferenceCellValue#basicValue:member + package: excel! + fullName: basicValue + summary: >- + Represents the value that would be returned by `Range.values` for a cell + with this value. When accessed through a `valuesAsJson` property, this + string value aligns with the en-US locale. When accessed through a + `valuesAsJsonLocal` property, this string value aligns with the user's + display locale. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicValue?: "#VALUE!" | string;' + return: + type: '"#VALUE!" | string' + - name: functionType + uid: excel!Excel.JavaScriptCustomFunctionReferenceCellValue#functionType:member + package: excel! + fullName: functionType + summary: Represents the type of `FunctionCellValue`. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + functionType: FunctionCellValueType.javaScriptReference | + "JavaScriptReference"; + return: + type: >- + + | "JavaScriptReference" + - name: id + uid: excel!Excel.JavaScriptCustomFunctionReferenceCellValue#id:member + package: excel! + fullName: id + summary: >- + Represents the ID of the custom function. For more information, see + [Autogenerate JSON metadata for custom functions: + ID](https://learn.microsoft.com/office/dev/add-ins/excel/custom-functions-json-autogeneration#id). + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id: string;' + return: + type: string + - name: namespace + uid: excel!Excel.JavaScriptCustomFunctionReferenceCellValue#namespace:member + package: excel! + fullName: namespace + summary: >- + Represents the namespace used by the custom function. For more + information, see [Manifest reference: + Namespace](https://learn.microsoft.com/javascript/api/manifest/namespace). + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'namespace: string;' + return: + type: string + - name: type + uid: excel!Excel.JavaScriptCustomFunctionReferenceCellValue#type:member + package: excel! + fullName: type + summary: Represents the type of this cell value. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: CellValueType.function | "Function";' + return: + type: | "Function" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.keyboarddirection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.keyboarddirection.yml new file mode 100644 index 0000000000..f9c0787c46 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.keyboarddirection.yml @@ -0,0 +1,78 @@ +### YamlMime:TSEnum +name: Excel.KeyboardDirection +uid: excel!Excel.KeyboardDirection:enum +package: excel! +fullName: Excel.KeyboardDirection +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-get-range-edge.yaml + + + await Excel.run(async (context) => { + // Get the selected range. + const range = context.workbook.getSelectedRange(); + + // Specify the direction with the `KeyboardDirection` enum. + const direction = Excel.KeyboardDirection.up; + + // Get the active cell in the workbook. + const activeCell = context.workbook.getActiveCell(); + + // Get the top-most cell of the current used range. + // This method acts like the Ctrl+Arrow key keyboard shortcut while a range is selected. + const rangeEdge = range.getRangeEdge( + direction, + activeCell // If the selected range contains more than one cell, the active cell must be defined. + ); + rangeEdge.select(); + + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: down + uid: excel!Excel.KeyboardDirection.down:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Down"' + - name: left + uid: excel!Excel.KeyboardDirection.left:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Left"' + - name: right + uid: excel!Excel.KeyboardDirection.right:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Right"' + - name: up + uid: excel!Excel.KeyboardDirection.up:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Up"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.labelfiltercondition.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.labelfiltercondition.yml new file mode 100644 index 0000000000..1d3bfb3ce4 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.labelfiltercondition.yml @@ -0,0 +1,193 @@ +### YamlMime:TSEnum +name: Excel.LabelFilterCondition +uid: excel!Excel.LabelFilterCondition:enum +package: excel! +fullName: Excel.LabelFilterCondition +summary: >- + Enum representing all accepted conditions by which a label filter can be + applied. Used to configure the type of PivotFilter that is applied to the + field. `PivotFilter.criteria.exclusive` can be set to `true` to invert many of + these conditions. +remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotfilters.yaml + + + await Excel.run(async (context) => { + // Add a PivotFilter to filter based on the strings of item labels. + + // Get the PivotTable. + const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales"); + + // Get the "Type" field. + const field = pivotTable.hierarchies.getItem("Type").fields.getItem("Type"); + + // Filter out any types that start with "L" ("Lemons" and "Limes" in this case). + const filter: Excel.PivotLabelFilter = { + condition: Excel.LabelFilterCondition.beginsWith, + substring: "L", + exclusive: true + }; + + // Apply the label filter to the field. + field.applyFilter({ labelFilter: filter }); + + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: beginsWith + uid: excel!Excel.LabelFilterCondition.beginsWith:member + package: excel! + summary: >- + Label begins with substring criterion. + + + Required Criteria: {`substring`}. Optional Criteria: + {`exclusive`}. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"BeginsWith"' + - name: between + uid: excel!Excel.LabelFilterCondition.between:member + package: excel! + summary: >- + Between `lowerBound` and `upperBound` criteria. + + + Required Criteria: {`lowerBound`, `upperBound`}. + Optional Criteria: {`exclusive`}. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Between"' + - name: contains + uid: excel!Excel.LabelFilterCondition.contains:member + package: excel! + summary: >- + Label contains substring criterion. + + + Required Criteria: {`substring`}. Optional Criteria: + {`exclusive`}. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Contains"' + - name: endsWith + uid: excel!Excel.LabelFilterCondition.endsWith:member + package: excel! + summary: >- + Label ends with substring criterion. + + + Required Criteria: {`substring`}. Optional Criteria: + {`exclusive`}. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"EndsWith"' + - name: equals + uid: excel!Excel.LabelFilterCondition.equals:member + package: excel! + summary: >- + Equals comparator criterion. + + + Required Criteria: {`comparator`}. Optional Criteria: + {`exclusive`}. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Equals"' + - name: greaterThan + uid: excel!Excel.LabelFilterCondition.greaterThan:member + package: excel! + summary: >- + Greater than comparator criterion. + + + Required Criteria: {`comparator`}. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"GreaterThan"' + - name: greaterThanOrEqualTo + uid: excel!Excel.LabelFilterCondition.greaterThanOrEqualTo:member + package: excel! + summary: >- + Greater than or equal to comparator criterion. + + + Required Criteria: {`comparator`}. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"GreaterThanOrEqualTo"' + - name: lessThan + uid: excel!Excel.LabelFilterCondition.lessThan:member + package: excel! + summary: >- + Less than comparator criterion. + + + Required Criteria: {`comparator`}. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"LessThan"' + - name: lessThanOrEqualTo + uid: excel!Excel.LabelFilterCondition.lessThanOrEqualTo:member + package: excel! + summary: >- + Less than or equal to comparator criterion. + + + Required Criteria: {`comparator`}. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"LessThanOrEqualTo"' + - name: unknown + uid: excel!Excel.LabelFilterCondition.unknown:member + package: excel! + summary: >- + `LabelFilterCondition` is unknown or unsupported. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Unknown"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.line.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.line.yml new file mode 100644 index 0000000000..c79f5c3538 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.line.yml @@ -0,0 +1,604 @@ +### YamlMime:TSType +name: Excel.Line +uid: excel!Excel.Line:class +package: excel! +fullName: Excel.Line +summary: >- + Represents a line inside a worksheet. To get the corresponding `Shape` object, + use `Line.shape`. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: beginArrowheadLength + uid: excel!Excel.Line#beginArrowheadLength:member + package: excel! + fullName: beginArrowheadLength + summary: >- + Represents the length of the arrowhead at the beginning of the specified + line. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + beginArrowheadLength: Excel.ArrowheadLength | "Short" | "Medium" | + "Long"; + return: + type: >- + | "Short" | "Medium" | + "Long" + - name: beginArrowheadStyle + uid: excel!Excel.Line#beginArrowheadStyle:member + package: excel! + fullName: beginArrowheadStyle + summary: >- + Represents the style of the arrowhead at the beginning of the specified + line. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + beginArrowheadStyle: Excel.ArrowheadStyle | "None" | "Triangle" | + "Stealth" | "Diamond" | "Oval" | "Open"; + return: + type: >- + | "None" | "Triangle" | + "Stealth" | "Diamond" | "Oval" | "Open" + - name: beginArrowheadWidth + uid: excel!Excel.Line#beginArrowheadWidth:member + package: excel! + fullName: beginArrowheadWidth + summary: >- + Represents the width of the arrowhead at the beginning of the specified + line. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + beginArrowheadWidth: Excel.ArrowheadWidth | "Narrow" | "Medium" | + "Wide"; + return: + type: >- + | "Narrow" | "Medium" | + "Wide" + - name: beginConnectedShape + uid: excel!Excel.Line#beginConnectedShape:member + package: excel! + fullName: beginConnectedShape + summary: >- + Represents the shape to which the beginning of the specified line is + attached. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly beginConnectedShape: Excel.Shape;' + return: + type: + - name: beginConnectedSite + uid: excel!Excel.Line#beginConnectedSite:member + package: excel! + fullName: beginConnectedSite + summary: >- + Represents the connection site to which the beginning of a connector is + connected. Returns `null` when the beginning of the line is not attached + to any shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly beginConnectedSite: number;' + return: + type: number + - name: connectorType + uid: excel!Excel.Line#connectorType:member + package: excel! + fullName: connectorType + summary: Represents the connector type for the line. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'connectorType: Excel.ConnectorType | "Straight" | "Elbow" | "Curve";' + return: + type: >- + | "Straight" | "Elbow" | + "Curve" + - name: context + uid: excel!Excel.Line#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: endArrowheadLength + uid: excel!Excel.Line#endArrowheadLength:member + package: excel! + fullName: endArrowheadLength + summary: Represents the length of the arrowhead at the end of the specified line. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'endArrowheadLength: Excel.ArrowheadLength | "Short" | "Medium" | "Long";' + return: + type: >- + | "Short" | "Medium" | + "Long" + - name: endArrowheadStyle + uid: excel!Excel.Line#endArrowheadStyle:member + package: excel! + fullName: endArrowheadStyle + summary: Represents the style of the arrowhead at the end of the specified line. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + endArrowheadStyle: Excel.ArrowheadStyle | "None" | "Triangle" | + "Stealth" | "Diamond" | "Oval" | "Open"; + return: + type: >- + | "None" | "Triangle" | + "Stealth" | "Diamond" | "Oval" | "Open" + - name: endArrowheadWidth + uid: excel!Excel.Line#endArrowheadWidth:member + package: excel! + fullName: endArrowheadWidth + summary: Represents the width of the arrowhead at the end of the specified line. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'endArrowheadWidth: Excel.ArrowheadWidth | "Narrow" | "Medium" | "Wide";' + return: + type: >- + | "Narrow" | "Medium" | + "Wide" + - name: endConnectedShape + uid: excel!Excel.Line#endConnectedShape:member + package: excel! + fullName: endConnectedShape + summary: Represents the shape to which the end of the specified line is attached. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly endConnectedShape: Excel.Shape;' + return: + type: + - name: endConnectedSite + uid: excel!Excel.Line#endConnectedSite:member + package: excel! + fullName: endConnectedSite + summary: >- + Represents the connection site to which the end of a connector is + connected. Returns `null` when the end of the line is not attached to any + shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly endConnectedSite: number;' + return: + type: number + - name: id + uid: excel!Excel.Line#id:member + package: excel! + fullName: id + summary: Specifies the shape identifier. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly id: string;' + return: + type: string + - name: isBeginConnected + uid: excel!Excel.Line#isBeginConnected:member + package: excel! + fullName: isBeginConnected + summary: Specifies if the beginning of the specified line is connected to a shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly isBeginConnected: boolean;' + return: + type: boolean + - name: isEndConnected + uid: excel!Excel.Line#isEndConnected:member + package: excel! + fullName: isEndConnected + summary: Specifies if the end of the specified line is connected to a shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly isEndConnected: boolean;' + return: + type: boolean + - name: shape + uid: excel!Excel.Line#shape:member + package: excel! + fullName: shape + summary: Returns the `Shape` object associated with the line. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly shape: Excel.Shape;' + return: + type: +methods: + - name: connectBeginShape(shape, connectionSite) + uid: excel!Excel.Line#connectBeginShape:member(1) + package: excel! + fullName: connectBeginShape(shape, connectionSite) + summary: Attaches the beginning of the specified connector to a specified shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-lines.yaml + + + await Excel.run(async (context) => { + const shapes = context.workbook.worksheets.getItem("Shapes").shapes; + const line = shapes.getItem("StraightLine").line; + line.connectBeginShape(shapes.getItem("Left"), 2); + line.connectEndShape(shapes.getItem("Right"), 0); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'connectBeginShape(shape: Excel.Shape, connectionSite: number): void;' + parameters: + - id: shape + description: The shape to connect. + type: + - id: connectionSite + description: >- + The connection site on the shape to which the beginning of the + connector is attached. Must be an integer between 0 (inclusive) and + the connection-site count of the specified shape (exclusive). + type: number + return: + type: void + description: '' + - name: connectEndShape(shape, connectionSite) + uid: excel!Excel.Line#connectEndShape:member(1) + package: excel! + fullName: connectEndShape(shape, connectionSite) + summary: Attaches the end of the specified connector to a specified shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-lines.yaml + + + await Excel.run(async (context) => { + const shapes = context.workbook.worksheets.getItem("Shapes").shapes; + const line = shapes.getItem("StraightLine").line; + line.connectBeginShape(shapes.getItem("Left"), 2); + line.connectEndShape(shapes.getItem("Right"), 0); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'connectEndShape(shape: Excel.Shape, connectionSite: number): void;' + parameters: + - id: shape + description: The shape to connect. + type: + - id: connectionSite + description: >- + The connection site on the shape to which the end of the connector + is attached. Must be an integer between 0 (inclusive) and the + connection-site count of the specified shape (exclusive). + type: number + return: + type: void + description: '' + - name: disconnectBeginShape() + uid: excel!Excel.Line#disconnectBeginShape:member(1) + package: excel! + fullName: disconnectBeginShape() + summary: Detaches the beginning of the specified connector from a shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-lines.yaml + + + await Excel.run(async (context) => { + const shapes = context.workbook.worksheets.getItem("Shapes").shapes; + const line = shapes.getItem("StraightLine").line; + line.disconnectBeginShape(); + line.disconnectEndShape(); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'disconnectBeginShape(): void;' + return: + type: void + description: '' + - name: disconnectEndShape() + uid: excel!Excel.Line#disconnectEndShape:member(1) + package: excel! + fullName: disconnectEndShape() + summary: Detaches the end of the specified connector from a shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-lines.yaml + + + await Excel.run(async (context) => { + const shapes = context.workbook.worksheets.getItem("Shapes").shapes; + const line = shapes.getItem("StraightLine").line; + line.disconnectBeginShape(); + line.disconnectEndShape(); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'disconnectEndShape(): void;' + return: + type: void + description: '' + - name: load(options) + uid: excel!Excel.Line#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(options?: Excel.Interfaces.LineLoadOptions): Excel.Line;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.Line#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.Line;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.Line#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.Line; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.Line#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.LineUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.Line#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.Line): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.Line#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.Line` object is + an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Excel.Interfaces.LineData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.LineData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.linkeddatatypestate.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.linkeddatatypestate.yml new file mode 100644 index 0000000000..f0f48d2895 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.linkeddatatypestate.yml @@ -0,0 +1,48 @@ +### YamlMime:TSEnum +name: Excel.LinkedDataTypeState +uid: excel!Excel.LinkedDataTypeState:enum +package: excel! +fullName: Excel.LinkedDataTypeState +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: brokenLinkedData + uid: excel!Excel.LinkedDataTypeState.brokenLinkedData:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"BrokenLinkedData"' + - name: disambiguationNeeded + uid: excel!Excel.LinkedDataTypeState.disambiguationNeeded:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"DisambiguationNeeded"' + - name: fetchingData + uid: excel!Excel.LinkedDataTypeState.fetchingData:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FetchingData"' + - name: none + uid: excel!Excel.LinkedDataTypeState.none:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"None"' + - name: validLinkedData + uid: excel!Excel.LinkedDataTypeState.validLinkedData:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ValidLinkedData"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.linkedentitycellvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.linkedentitycellvalue.yml new file mode 100644 index 0000000000..a7dfa2570a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.linkedentitycellvalue.yml @@ -0,0 +1,160 @@ +### YamlMime:TSType +name: Excel.LinkedEntityCellValue +uid: excel!Excel.LinkedEntityCellValue:interface +package: excel! +fullName: Excel.LinkedEntityCellValue +summary: Represents a value whose properties derive from a service. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: basicType + uid: excel!Excel.LinkedEntityCellValue#basicType:member + package: excel! + fullName: basicType + summary: >- + Represents the value that would be returned by `Range.valueTypes` for a + cell with this value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicType?: RangeValueType.error | "Error";' + return: + type: | "Error" + - name: basicValue + uid: excel!Excel.LinkedEntityCellValue#basicValue:member + package: excel! + fullName: basicValue + summary: >- + Represents the value that would be returned by `Range.values` for a cell + with this value. When accessed through a `valuesAsJson` property, this + string value aligns with the en-US locale. When accessed through a + `valuesAsJsonLocal` property, this string value aligns with the user's + display locale. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicValue?: "#VALUE!" | string;' + return: + type: '"#VALUE!" | string' + - name: id + uid: excel!Excel.LinkedEntityCellValue#id:member + package: excel! + fullName: id + summary: Represents the service source that provided the information in this value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'id: LinkedEntityId;' + return: + type: + - name: layouts + uid: excel!Excel.LinkedEntityCellValue#layouts:member + package: excel! + fullName: layouts + summary: Represents layout information for views of this linked entity. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'layouts?: EntityViewLayouts;' + return: + type: + - name: properties + uid: excel!Excel.LinkedEntityCellValue#properties:member + package: excel! + fullName: properties + summary: Represents the properties of this linked entity and their metadata. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: |- + properties?: { + [key: string]: EntityPropertyType; + }; + return: + type: |- + { + [key: string]: ; + } + - name: provider + uid: excel!Excel.LinkedEntityCellValue#provider:member + package: excel! + fullName: provider + summary: >- + Represents information that describes the service that provided data in + this `LinkedEntityCellValue`. This information can be used for + branding in entity cards. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'provider?: CellValueProviderAttributes;' + return: + type: + - name: text + uid: excel!Excel.LinkedEntityCellValue#text:member + package: excel! + fullName: text + summary: Represents the text shown when a cell with this value is rendered. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'text?: string;' + return: + type: string + - name: type + uid: excel!Excel.LinkedEntityCellValue#type:member + package: excel! + fullName: type + summary: Represents the type of this cell value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: CellValueType.linkedEntity | "LinkedEntity";' + return: + type: >- + | + "LinkedEntity" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.linkedentitydatadomain.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.linkedentitydatadomain.yml new file mode 100644 index 0000000000..5e42518756 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.linkedentitydatadomain.yml @@ -0,0 +1,402 @@ +### YamlMime:TSType +name: Excel.LinkedEntityDataDomain +uid: excel!Excel.LinkedEntityDataDomain:class +package: excel! +fullName: Excel.LinkedEntityDataDomain +summary: >- + Represents a specific category or field of information that shares some common + characteristics or attributes. A data domain is linked to a data provider, + that acts as the data source for `LinkedEntityCellValue` objects in the + workbook. A data domain is a category of data, such as stocks, geography, or + currencies. A data provider is a service, such as Bing, Power BI, or an Office + Add-in. +remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + This class isn't supported in Excel on the web. + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.LinkedEntityDataDomain#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: dataProvider + uid: excel!Excel.LinkedEntityDataDomain#dataProvider:member + package: excel! + fullName: dataProvider + summary: >- + Gets the name of the data provider for the linked entity data domain. This + name can change based on the information provided by the data provider. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly dataProvider: string;' + return: + type: string + - name: id + uid: excel!Excel.LinkedEntityDataDomain#id:member + package: excel! + fullName: id + summary: >- + Gets the ID of the linked entity data domain defined by Office Add-ins. + This ID is not applicable to linked entity data domains defined by service + data providers, such as Bing or Power BI. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly id: string;' + return: + type: string + - name: lastRefreshed + uid: excel!Excel.LinkedEntityDataDomain#lastRefreshed:member + package: excel! + fullName: lastRefreshed + summary: >- + Gets the date and time (in the local time zone) since the workbook was + opened and the `LinkedEntityCellValue` objects of this linked entity data + domain were last refreshed. Returns `undefined` if `LinkedEntityCellValue` + objects have not been refreshed since the workbook was opened. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly lastRefreshed: Date;' + return: + type: Date + - name: loadFunctionId + uid: excel!Excel.LinkedEntityDataDomain#loadFunctionId:member + package: excel! + fullName: loadFunctionId + summary: >- + Gets the ID of the custom function that is called on demand to resolve or + refresh the `LinkedEntityCellValue` objects of the linked entity data + domain defined by Office Add-ins. For further information, see + [Autogenerate JSON metadata for custom functions: + ID](https://learn.microsoft.com/office/dev/add-ins/excel/custom-functions-json-autogeneration#id). This ID is not applicable to linked entity data domains defined by + service data providers, such as Bing or Power BI. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly loadFunctionId: string;' + return: + type: string + - name: name + uid: excel!Excel.LinkedEntityDataDomain#name:member + package: excel! + fullName: name + summary: >- + Gets the name of the linked entity data domain. This name can change based + on the information provided by the data provider. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly name: string;' + return: + type: string + - name: periodicRefreshInterval + uid: excel!Excel.LinkedEntityDataDomain#periodicRefreshInterval:member + package: excel! + fullName: periodicRefreshInterval + summary: >- + Gets the frequency, in seconds, at which `LinkedEntityCellValue` objects + of this linked entity data domain are refreshed automatically. The refresh + interval only applies if the `refreshMode` is set to "Periodic". + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly periodicRefreshInterval: number;' + return: + type: number + - name: refreshMode + uid: excel!Excel.LinkedEntityDataDomain#refreshMode:member + package: excel! + fullName: refreshMode + summary: >- + Specifies the refresh mode that defines how and when the + `LinkedEntityCellValue` objects of this linked entity data domain are + refreshed. If the refresh mode being set is not supported by this linked + entity data domain, then the current refresh mode is not changed. If the + refresh mode is set to "Periodic", the refresh interval is set to the + `periodicRefreshInterval` of this linked entity data domain. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: >- + refreshMode: Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | + "Manual" | "OnLoad" | "Periodic"; + return: + type: >- + | + "Unknown" | "Manual" | "OnLoad" | "Periodic" + - name: serviceId + uid: excel!Excel.LinkedEntityDataDomain#serviceId:member + package: excel! + fullName: serviceId + summary: >- + Gets the service ID of the linked entity data domain. This ID is a + permanently reserved value for all linked entity data domains which are + defined by service data providers, such as Bing or Power BI, or defined by + Office Add-ins. This ID never changes across user sessions. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly serviceId: number;' + return: + type: number + - name: supportedRefreshModes + uid: excel!Excel.LinkedEntityDataDomain#supportedRefreshModes:member + package: excel! + fullName: supportedRefreshModes + summary: >- + Gets all the refresh modes supported by the linked entity data domain. + This array can change based on the information provided by the data + provider. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly supportedRefreshModes: + Excel.LinkedEntityDataDomainRefreshMode[]; + return: + type: [] +methods: + - name: delete() + uid: excel!Excel.LinkedEntityDataDomain#delete:member(1) + package: excel! + fullName: delete() + summary: >- + Deletes this object from the `LinkedEntityDataDomainCollection`. + Once the linked entity data domain is deleted, new `LinkedEntityCellValue` + objects of this linked entity data domain can't be created and existing + `LinkedEntityCellValue` objects can't be refreshed. An Office Add-in can + only delete linked entity data domains that it created. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This method isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'delete(): void;' + return: + type: void + description: '' + - name: load(options) + uid: excel!Excel.LinkedEntityDataDomain#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.LinkedEntityDataDomainLoadOptions): + Excel.LinkedEntityDataDomain; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.LinkedEntityDataDomain#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.LinkedEntityDataDomain;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.LinkedEntityDataDomain#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.LinkedEntityDataDomain; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: refresh() + uid: excel!Excel.LinkedEntityDataDomain#refresh:member(1) + package: excel! + fullName: refresh() + summary: >- + Refreshes all `LinkedEntityCellValue` objects of this linked entity data + domain. The refresh request can fail if the data provider is busy or + temporarily inaccessible. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This method isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'refresh(): void;' + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.LinkedEntityDataDomain#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.LinkedEntityDataDomain` object is an API object, the `toJSON` + method returns a plain JavaScript object (typed as + `Excel.Interfaces.LinkedEntityDataDomainData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.LinkedEntityDataDomainData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.linkedentitydatadomainaddedeventargs.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.linkedentitydatadomainaddedeventargs.yml new file mode 100644 index 0000000000..481c6a5073 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.linkedentitydatadomainaddedeventargs.yml @@ -0,0 +1,95 @@ +### YamlMime:TSType +name: Excel.LinkedEntityDataDomainAddedEventArgs +uid: excel!Excel.LinkedEntityDataDomainAddedEventArgs:interface +package: excel! +fullName: Excel.LinkedEntityDataDomainAddedEventArgs +summary: >- + Provides information about the identity of the linked entity data domain that + was just added to the workbook. +remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + This interface isn't supported in Excel on the web. + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: id + uid: excel!Excel.LinkedEntityDataDomainAddedEventArgs#id:member + package: excel! + fullName: id + summary: >- + Gets the ID of the linked entity data domain that was just added to the + workbook. This ID is defined by Office Add-ins. This ID is not applicable + to linked entity data domains defined by service data providers, such as + Bing or Power BI. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: string;' + return: + type: string + - name: serviceId + uid: excel!Excel.LinkedEntityDataDomainAddedEventArgs#serviceId:member + package: excel! + fullName: serviceId + summary: >- + Gets the service ID of the linked entity data domain that was just added + to the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'serviceId: number;' + return: + type: number + - name: source + uid: excel!Excel.LinkedEntityDataDomainAddedEventArgs#source:member + package: excel! + fullName: source + summary: Gets the source of the event. See `Excel.EventSource` for details. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'source: Excel.EventSource | "Local" | "Remote";' + return: + type: | "Local" | "Remote" + - name: type + uid: excel!Excel.LinkedEntityDataDomainAddedEventArgs#type:member + package: excel! + fullName: type + summary: Gets the type of the event. See `Excel.EventType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: "LinkedEntityDataDomainLinkedEntityDataDomainAdded";' + return: + type: '"LinkedEntityDataDomainLinkedEntityDataDomainAdded"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.linkedentitydatadomaincollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.linkedentitydatadomaincollection.yml new file mode 100644 index 0000000000..512a23249f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.linkedentitydatadomaincollection.yml @@ -0,0 +1,414 @@ +### YamlMime:TSType +name: Excel.LinkedEntityDataDomainCollection +uid: excel!Excel.LinkedEntityDataDomainCollection:class +package: excel! +fullName: Excel.LinkedEntityDataDomainCollection +summary: >- + Represents a collection of `LinkedEntityDataDomain` objects. The collection + can contain linked entity data domains such as stocks, geography, or + currencies defined by service data providers, such as Bing or Power BI, or + linked entity data domains defined by Office Add-ins. +remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.LinkedEntityDataDomainCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: excel!Excel.LinkedEntityDataDomainCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.LinkedEntityDataDomain[];' + return: + type: [] +methods: + - name: add(options) + uid: excel!Excel.LinkedEntityDataDomainCollection#add:member(1) + package: excel! + fullName: add(options) + summary: >- + Adds a linked entity data domain object defined by the Office Add-in to + the collection. Once the linked entity data domain is added, it can be + used to create `LinkedEntityCellValue` objects. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'add(options: Excel.LinkedEntityDataDomainCreateOptions): void;' + parameters: + - id: options + description: >- + Options that are used to create the linked entity data domain to be + added. + type: >- + + return: + type: void + description: '' + - name: getCount() + uid: excel!Excel.LinkedEntityDataDomainCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Gets the number of linked entity data domains in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getItem(id) + uid: excel!Excel.LinkedEntityDataDomainCollection#getItem:member(1) + package: excel! + fullName: getItem(id) + summary: Gets a linked entity data domain by its `id`. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItem(id: string): Excel.LinkedEntityDataDomain;' + parameters: + - id: id + description: The `id` of the `LinkedEntityDataDomain` object to be retrieved. + type: string + return: + type: + description: >- + The linked entity data domain with the given `id`. If there + are multiple linked entity data domains with the same `id`, + the one defined by this Office Add-in will be returned. + - name: getItemAt(index) + uid: excel!Excel.LinkedEntityDataDomainCollection#getItemAt:member(1) + package: excel! + fullName: getItemAt(index) + summary: Gets a linked entity data domain by its index in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemAt(index: number): Excel.LinkedEntityDataDomain;' + parameters: + - id: index + description: The index of the linked entity data domain in the collection. + type: number + return: + type: + description: The linked entity data domain at the given index. + - name: getItemByName(name) + uid: excel!Excel.LinkedEntityDataDomainCollection#getItemByName:member(1) + package: excel! + fullName: getItemByName(name) + summary: Gets a linked entity data domain by its `name`. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemByName(name: string): Excel.LinkedEntityDataDomain;' + parameters: + - id: name + description: The `name` of the `LinkedEntityDataDomain` object to be retrieved. + type: string + return: + type: + description: >- + The linked entity data domain with the given `name`. If there + are multiple linked entity data domains with the same `name`, + the one defined by this Office Add-in will be returned. + - name: getItemByNameOrNullObject(name) + uid: >- + excel!Excel.LinkedEntityDataDomainCollection#getItemByNameOrNullObject:member(1) + package: excel! + fullName: getItemByNameOrNullObject(name) + summary: >- + Gets a linked entity data domain by its `name`. If the linked + entity data domain does not exist, then this method returns an object with + its `isNullObject` property set to `true`. For further + information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemByNameOrNullObject(name: string): Excel.LinkedEntityDataDomain;' + parameters: + - id: name + description: The `name` of the `LinkedEntityDataDomain` object to be retrieved. + type: string + return: + type: + description: >- + The linked entity data domain with the given `name`. If there + are multiple linked entity data domains with the same `name`, + the one defined by this Office Add-in will be returned. + - name: getItemOrNullObject(id) + uid: excel!Excel.LinkedEntityDataDomainCollection#getItemOrNullObject:member(1) + package: excel! + fullName: getItemOrNullObject(id) + summary: >- + Gets a linked entity data domain by its `id`. If the linked entity + data domain does not exist, then this method returns an object with its + `isNullObject` property set to `true`. For further information, + see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemOrNullObject(id: string): Excel.LinkedEntityDataDomain;' + parameters: + - id: id + description: The `id` of the `LinkedEntityDataDomain` object to be retrieved. + type: string + return: + type: + description: >- + The linked entity data domain with the given `id`. If there + are multiple linked entity data domains with the same `id`, + the one defined by this Office Add-in will be returned. + - name: load(options) + uid: excel!Excel.LinkedEntityDataDomainCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: + Excel.Interfaces.LinkedEntityDataDomainCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): + Excel.LinkedEntityDataDomainCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.LinkedEntityDataDomainCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNames?: string | string[]): + Excel.LinkedEntityDataDomainCollection; + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.LinkedEntityDataDomainCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.LinkedEntityDataDomainCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: refreshAll() + uid: excel!Excel.LinkedEntityDataDomainCollection#refreshAll:member(1) + package: excel! + fullName: refreshAll() + summary: >- + Refreshes all `LinkedEntityCellValue` objects of all linked entity data + domains in this collection. The refresh request can fail if the data + providers are busy or temporarily inaccessible. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'refreshAll(): void;' + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.LinkedEntityDataDomainCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.LinkedEntityDataDomainCollection` object is an API object, the + `toJSON` method returns a plain JavaScript object (typed as + `Excel.Interfaces.LinkedEntityDataDomainCollectionData`) that + contains an "items" array with shallow copies of any loaded properties + from the collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.LinkedEntityDataDomainCollectionData;' + return: + type: >- + + description: '' +events: + - name: onLinkedEntityDataDomainAdded + uid: >- + excel!Excel.LinkedEntityDataDomainCollection#onLinkedEntityDataDomainAdded:member + package: excel! + fullName: onLinkedEntityDataDomainAdded + summary: Occurs when a new linked entity data domain is added to the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onLinkedEntityDataDomainAdded: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onRefreshCompleted + uid: excel!Excel.LinkedEntityDataDomainCollection#onRefreshCompleted:member + package: excel! + fullName: onRefreshCompleted + summary: >- + Occurs when the request to refresh `LinkedEntityCellValue` objects of a + linked entity data domain is completed. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onRefreshCompleted: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onRefreshModeChanged + uid: excel!Excel.LinkedEntityDataDomainCollection#onRefreshModeChanged:member + package: excel! + fullName: onRefreshModeChanged + summary: Occurs when the `refreshMode` of a linked entity data domain is changed. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onRefreshModeChanged: + OfficeExtension.EventHandlers; + return: + type: >- + <> +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.linkedentitydatadomaincreateoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.linkedentitydatadomaincreateoptions.yml new file mode 100644 index 0000000000..8a175065cc --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.linkedentitydatadomaincreateoptions.yml @@ -0,0 +1,161 @@ +### YamlMime:TSType +name: Excel.LinkedEntityDataDomainCreateOptions +uid: excel!Excel.LinkedEntityDataDomainCreateOptions:interface +package: excel! +fullName: Excel.LinkedEntityDataDomainCreateOptions +summary: >- + Represents options that are used to create the `LinkedEntityDataDomain` object + being added to the `LinkedEntityDataDomainCollection`. +remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + This interface isn't supported in Excel on the web. + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: dataProvider + uid: excel!Excel.LinkedEntityDataDomainCreateOptions#dataProvider:member + package: excel! + fullName: dataProvider + summary: Specifies the name of the data provider for the linked entity data domain. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'dataProvider: string;' + return: + type: string + - name: id + uid: excel!Excel.LinkedEntityDataDomainCreateOptions#id:member + package: excel! + fullName: id + summary: >- + Specifies the ID of the linked entity data domain. This ID must be unique + across all linked entity data domains defined by this Office Add-in. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'id: string;' + return: + type: string + - name: loadFunctionId + uid: excel!Excel.LinkedEntityDataDomainCreateOptions#loadFunctionId:member + package: excel! + fullName: loadFunctionId + summary: >- + Specifies the ID of the custom function that will be called on demand to + resolve or refresh the `LinkedEntityCellValue` objects of this linked + entity data domain. For further information, see [Autogenerate JSON + metadata for custom functions: + ID](https://learn.microsoft.com/office/dev/add-ins/excel/custom-functions-json-autogeneration#id). + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'loadFunctionId: string;' + return: + type: string + - name: name + uid: excel!Excel.LinkedEntityDataDomainCreateOptions#name:member + package: excel! + fullName: name + summary: >- + Specifies the name of the linked entity data domain. This name must be + unique across all linked entity data domains defined by this Office + Add-in. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'name: string;' + return: + type: string + - name: periodicRefreshInterval + uid: >- + excel!Excel.LinkedEntityDataDomainCreateOptions#periodicRefreshInterval:member + package: excel! + fullName: periodicRefreshInterval + summary: >- + Specifies the frequency, in seconds, at which `LinkedEntityCellValue` + objects of this linked entity data domain are refreshed automatically. The + minimum valid value is 300. This property is required if the + `supportedRefreshModes` array contains the value "Periodic". This property + only applies if the `refreshMode` of the linked entity data domain is set + to "Periodic". + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'periodicRefreshInterval?: number;' + return: + type: number + - name: supportedRefreshModes + uid: >- + excel!Excel.LinkedEntityDataDomainCreateOptions#supportedRefreshModes:member + package: excel! + fullName: supportedRefreshModes + summary: >- + Specifies all the refresh modes supported by the linked entity data + domain. The default value is `["Manual"]`, which is always + supported even if not specified. The refresh mode saved in the workbook is + loaded as the default refresh mode of the linked entity data domain on the + next workbook open. If the refresh mode was not saved in the workbook, the + first value in the array is set as the default refresh mode of the linked + entity data domain. If the array has the value "Periodic", the + `periodicRefreshInterval` property must also be set for the linked entity + data domain. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'supportedRefreshModes?: Excel.LinkedEntityDataDomainRefreshMode[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.linkedentitydatadomainrefreshcompletedeventargs.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.linkedentitydatadomainrefreshcompletedeventargs.yml new file mode 100644 index 0000000000..ce47955452 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.linkedentitydatadomainrefreshcompletedeventargs.yml @@ -0,0 +1,146 @@ +### YamlMime:TSType +name: Excel.LinkedEntityDataDomainRefreshCompletedEventArgs +uid: excel!Excel.LinkedEntityDataDomainRefreshCompletedEventArgs:interface +package: excel! +fullName: Excel.LinkedEntityDataDomainRefreshCompletedEventArgs +summary: >- + Provides information about the linked entity data domain whose + `LinkedEntityCellValue` objects were refreshed. +remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + This interface isn't supported in Excel on the web. + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: errors + uid: excel!Excel.LinkedEntityDataDomainRefreshCompletedEventArgs#errors:member + package: excel! + fullName: errors + summary: >- + Gets any errors encountered during the request to refresh + `LinkedEntityCellValue` objects of the linked entity data domain. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'errors?: string[];' + return: + type: string[] + - name: id + uid: excel!Excel.LinkedEntityDataDomainRefreshCompletedEventArgs#id:member + package: excel! + fullName: id + summary: >- + Gets the ID of the linked entity data domain whose `LinkedEntityCellValue` + objects were refreshed. This ID is defined by Office Add-ins. This ID is + not applicable to linked entity data domains defined by service data + providers, such as Bing or Power BI. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: string;' + return: + type: string + - name: refreshed + uid: >- + excel!Excel.LinkedEntityDataDomainRefreshCompletedEventArgs#refreshed:member + package: excel! + fullName: refreshed + summary: >- + Returns `true` if the `LinkedEntityCellValue` objects of the linked entity + data domain were refreshed successfully, otherwise returns `false`. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'refreshed: boolean;' + return: + type: boolean + - name: serviceId + uid: >- + excel!Excel.LinkedEntityDataDomainRefreshCompletedEventArgs#serviceId:member + package: excel! + fullName: serviceId + summary: >- + Gets the service ID of the linked entity data domain whose + `LinkedEntityCellValue` objects were refreshed. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'serviceId: number;' + return: + type: number + - name: source + uid: excel!Excel.LinkedEntityDataDomainRefreshCompletedEventArgs#source:member + package: excel! + fullName: source + summary: Gets the source of the event. See `Excel.EventSource` for details. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'source: Excel.EventSource | "Local" | "Remote";' + return: + type: | "Local" | "Remote" + - name: type + uid: excel!Excel.LinkedEntityDataDomainRefreshCompletedEventArgs#type:member + package: excel! + fullName: type + summary: Gets the type of the event. See `Excel.EventType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'type: "LinkedEntityDataDomainRefreshCompleted";' + return: + type: '"LinkedEntityDataDomainRefreshCompleted"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.linkedentitydatadomainrefreshmode.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.linkedentitydatadomainrefreshmode.yml new file mode 100644 index 0000000000..8dad66c0f6 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.linkedentitydatadomainrefreshmode.yml @@ -0,0 +1,66 @@ +### YamlMime:TSEnum +name: Excel.LinkedEntityDataDomainRefreshMode +uid: excel!Excel.LinkedEntityDataDomainRefreshMode:enum +package: excel! +fullName: Excel.LinkedEntityDataDomainRefreshMode +summary: >- + Represents the refresh mode setting for the `LinkedEntityCellValue` objects of + a `LinkedEntityDataDomain`. +remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: manual + uid: excel!Excel.LinkedEntityDataDomainRefreshMode.manual:member + package: excel! + summary: >- + Manual refresh by the user. Refresh is not triggered automatically. + + + * \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Manual"' + - name: onLoad + uid: excel!Excel.LinkedEntityDataDomainRefreshMode.onLoad:member + package: excel! + summary: >- + Refresh on workbook load, applicable to linked entity data domains defined + by service data providers, such as Bing or Power BI. Refresh on add-in + load, applicable to linked entity data domains defined by Office Add-ins. + + + * \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"OnLoad"' + - name: periodic + uid: excel!Excel.LinkedEntityDataDomainRefreshMode.periodic:member + package: excel! + summary: >- + Refresh automatically based on the frequency, in seconds, specified by + `periodicRefreshInterval`. For linked entity data domains defined + by service data providers, such as Bing or Power BI, this value also + initiates a refresh each time the workbook is opened. For linked entity + data domains defined by Office Add-ins, this value also initiates a + refresh each time the add-in loads. + + + * \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Periodic"' + - name: unknown + uid: excel!Excel.LinkedEntityDataDomainRefreshMode.unknown:member + package: excel! + summary: >- + Refresh mode is unknown or unsupported. + + + * \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Unknown"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.linkedentitydatadomainrefreshmodechangedeventargs.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.linkedentitydatadomainrefreshmodechangedeventargs.yml new file mode 100644 index 0000000000..93cf56305a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.linkedentitydatadomainrefreshmodechangedeventargs.yml @@ -0,0 +1,127 @@ +### YamlMime:TSType +name: Excel.LinkedEntityDataDomainRefreshModeChangedEventArgs +uid: excel!Excel.LinkedEntityDataDomainRefreshModeChangedEventArgs:interface +package: excel! +fullName: Excel.LinkedEntityDataDomainRefreshModeChangedEventArgs +summary: >- + Provides information about the linked entity data domain whose refresh mode + was changed. +remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + This interface isn't supported in Excel on the web. + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: id + uid: excel!Excel.LinkedEntityDataDomainRefreshModeChangedEventArgs#id:member + package: excel! + fullName: id + summary: >- + Gets the ID of the linked entity data domain whose refresh mode was + changed. This ID is defined by Office Add-ins. This ID is not applicable + to linked entity data domains defined by service data providers, such as + Bing or Power BI. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'id?: string;' + return: + type: string + - name: refreshMode + uid: >- + excel!Excel.LinkedEntityDataDomainRefreshModeChangedEventArgs#refreshMode:member + package: excel! + fullName: refreshMode + summary: Gets the new refresh mode of the linked entity data domain. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: >- + refreshMode: Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | + "Manual" | "OnLoad" | "Periodic"; + return: + type: >- + | + "Unknown" | "Manual" | "OnLoad" | "Periodic" + - name: serviceId + uid: >- + excel!Excel.LinkedEntityDataDomainRefreshModeChangedEventArgs#serviceId:member + package: excel! + fullName: serviceId + summary: >- + Gets the service ID of the linked entity data domain whose refresh mode + was changed. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'serviceId: number;' + return: + type: number + - name: source + uid: >- + excel!Excel.LinkedEntityDataDomainRefreshModeChangedEventArgs#source:member + package: excel! + fullName: source + summary: Gets the source of the event. See `Excel.EventSource` for details. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'source: Excel.EventSource | "Local" | "Remote";' + return: + type: | "Local" | "Remote" + - name: type + uid: excel!Excel.LinkedEntityDataDomainRefreshModeChangedEventArgs#type:member + package: excel! + fullName: type + summary: Gets the type of the event. See `Excel.EventType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'type: "LinkedEntityDataDomainRefreshModeChanged";' + return: + type: '"LinkedEntityDataDomainRefreshModeChanged"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.linkedentityid.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.linkedentityid.yml new file mode 100644 index 0000000000..d50b4cf117 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.linkedentityid.yml @@ -0,0 +1,86 @@ +### YamlMime:TSType +name: Excel.LinkedEntityId +uid: excel!Excel.LinkedEntityId:interface +package: excel! +fullName: Excel.LinkedEntityId +summary: >- + The linked entity ID object represents a set of properties that describes a + service and culture for locating this service defined value. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: culture + uid: excel!Excel.LinkedEntityId#culture:member + package: excel! + fullName: culture + summary: >- + Represents which language culture was used to create this `CellValue`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'culture: string;' + return: + type: string + - name: domainId + uid: excel!Excel.LinkedEntityId#domainId:member + package: excel! + fullName: domainId + summary: >- + Represents a domain specific to a service used to create the + `CellValue`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'domainId?: string;' + return: + type: string + - name: entityId + uid: excel!Excel.LinkedEntityId#entityId:member + package: excel! + fullName: entityId + summary: >- + Represents an identifier specific to a service used to create the + `CellValue`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'entityId: string;' + return: + type: string + - name: serviceId + uid: excel!Excel.LinkedEntityId#serviceId:member + package: excel! + fullName: serviceId + summary: Represents which service was used to create the `CellValue`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'serviceId: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.linkedentityidculture.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.linkedentityidculture.yml new file mode 100644 index 0000000000..b441e1b67c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.linkedentityidculture.yml @@ -0,0 +1,59 @@ +### YamlMime:TSType +name: Excel.LinkedEntityIdCulture +uid: excel!Excel.LinkedEntityIdCulture:interface +package: excel! +fullName: Excel.LinkedEntityIdCulture +summary: Represents the entity ID and culture for a `LinkedEntityCellValue` object. +remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + This interface isn't supported in Excel on the web. + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: culture + uid: excel!Excel.LinkedEntityIdCulture#culture:member + package: excel! + fullName: culture + summary: >- + Represents the language culture used to create the `LinkedEntityCellValue` + object. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'culture: string;' + return: + type: string + - name: entityId + uid: excel!Excel.LinkedEntityIdCulture#entityId:member + package: excel! + fullName: entityId + summary: >- + Represents the identifier specific to a service used to create the + `LinkedEntityCellValue` object. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'entityId: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.linkedentityloadservicerequest.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.linkedentityloadservicerequest.yml new file mode 100644 index 0000000000..3a4b06f9c7 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.linkedentityloadservicerequest.yml @@ -0,0 +1,61 @@ +### YamlMime:TSType +name: Excel.LinkedEntityLoadServiceRequest +uid: excel!Excel.LinkedEntityLoadServiceRequest:interface +package: excel! +fullName: Excel.LinkedEntityLoadServiceRequest +summary: >- + Represents a request to `@linkedEntityLoadService` custom function to load + `LinkedEntityCellValue` objects. +remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + This interface isn't supported in Excel on the web. + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: domainId + uid: excel!Excel.LinkedEntityLoadServiceRequest#domainId:member + package: excel! + fullName: domainId + summary: >- + Represents the domain specific to the service used to create the + `LinkedEntityCellValue` objects. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'domainId: string;' + return: + type: string + - name: entities + uid: excel!Excel.LinkedEntityLoadServiceRequest#entities:member + package: excel! + fullName: entities + summary: >- + Represents the entity IDs and cultures of the `LinkedEntityCellValue` + objects to load. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This property isn't supported in Excel on the web. + + isPreview: false + isDeprecated: false + syntax: + content: 'entities: LinkedEntityIdCulture[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.linkedentityloadserviceresult.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.linkedentityloadserviceresult.yml new file mode 100644 index 0000000000..64327ef8a0 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.linkedentityloadserviceresult.yml @@ -0,0 +1,35 @@ +### YamlMime:TSType +name: Excel.LinkedEntityLoadServiceResult +uid: excel!Excel.LinkedEntityLoadServiceResult:interface +package: excel! +fullName: Excel.LinkedEntityLoadServiceResult +summary: >- + Represents the result of a request to `@linkedEntityLoadService` custom + function to load `LinkedEntityCellValue` objects. +remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: entities + uid: excel!Excel.LinkedEntityLoadServiceResult#entities:member + package: excel! + fullName: entities + summary: >- + Represents the loaded `LinkedEntityCellValue` objects. The loaded objects + must be returned in the same order as the `entities` property of + `LinkedEntityLoadServiceRequest`. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'entities: LinkedEntityCellValue[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.listdatavalidation.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.listdatavalidation.yml new file mode 100644 index 0000000000..d17804b879 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.listdatavalidation.yml @@ -0,0 +1,49 @@ +### YamlMime:TSType +name: Excel.ListDataValidation +uid: excel!Excel.ListDataValidation:interface +package: excel! +fullName: Excel.ListDataValidation +summary: Represents the List data validation criteria. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: inCellDropDown + uid: excel!Excel.ListDataValidation#inCellDropDown:member + package: excel! + fullName: inCellDropDown + summary: >- + Specifies whether to display the list in a cell drop-down. The default is + `true`. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'inCellDropDown: boolean;' + return: + type: boolean + - name: source + uid: excel!Excel.ListDataValidation#source:member + package: excel! + fullName: source + summary: >- + Source of the list for data validation When setting the value, it can be + passed in as a `Range` object, or a string that contains a comma-separated + number, boolean, or date. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'source: string | Range;' + return: + type: string | diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.loadtotype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.loadtotype.yml new file mode 100644 index 0000000000..0254cceff8 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.loadtotype.yml @@ -0,0 +1,57 @@ +### YamlMime:TSEnum +name: Excel.LoadToType +uid: excel!Excel.LoadToType:enum +package: excel! +fullName: Excel.LoadToType +summary: An enum that specifies the query load to destination. +remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: connectionOnly + uid: excel!Excel.LoadToType.connectionOnly:member + package: excel! + summary: >- + Load to connection only. + + + * \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ConnectionOnly"' + - name: pivotChart + uid: excel!Excel.LoadToType.pivotChart:member + package: excel! + summary: >- + Load to PivotChart. + + + * \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"PivotChart"' + - name: pivotTable + uid: excel!Excel.LoadToType.pivotTable:member + package: excel! + summary: >- + Load to PivotTable. + + + * \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"PivotTable"' + - name: table + uid: excel!Excel.LoadToType.table:member + package: excel! + summary: >- + Load to a table. + + + * \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Table"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.mixedcellcontrol.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.mixedcellcontrol.yml new file mode 100644 index 0000000000..b684b0afe3 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.mixedcellcontrol.yml @@ -0,0 +1,30 @@ +### YamlMime:TSType +name: Excel.MixedCellControl +uid: excel!Excel.MixedCellControl:interface +package: excel! +fullName: Excel.MixedCellControl +summary: >- + Represents the result of a query that resulted in multiple cell controls. If + the result has multiple controls, then they can't be represented as a single + result. +remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: type + uid: excel!Excel.MixedCellControl#type:member + package: excel! + fullName: type + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'type: CellControlType.mixed;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.nameditem.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.nameditem.yml new file mode 100644 index 0000000000..7be47d55c9 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.nameditem.yml @@ -0,0 +1,584 @@ +### YamlMime:TSType +name: Excel.NamedItem +uid: excel!Excel.NamedItem:class +package: excel! +fullName: Excel.NamedItem +summary: >- + Represents a defined name for a range of cells or value. Names can be + primitive named objects (as seen in the type below), range object, or a + reference to a range. This object can be used to obtain range object + associated with names. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/34-named-item/create-and-remove-named-item.yaml + + + await Excel.run(async (context) => { + // Log all the named items in the active worksheet. + const namedItems = context.workbook.worksheets.getActiveWorksheet().names.load(); + await context.sync(); + + console.log("This worksheet contains " + namedItems.items.length + " named items."); + + for (let i = 0; i < namedItems.items.length; i++) { + const namedItem : Excel.NamedItem = namedItems.items[i]; + console.log(JSON.stringify(namedItem)) + "\n"; + } + + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +type: class +properties: + - name: arrayValues + uid: excel!Excel.NamedItem#arrayValues:member + package: excel! + fullName: arrayValues + summary: Returns an object containing values and types of the named item. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly arrayValues: Excel.NamedItemArrayValues;' + return: + type: + - name: comment + uid: excel!Excel.NamedItem#comment:member + package: excel! + fullName: comment + summary: Specifies the comment associated with this name. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'comment: string;' + return: + type: string + - name: context + uid: excel!Excel.NamedItem#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: formula + uid: excel!Excel.NamedItem#formula:member + package: excel! + fullName: formula + summary: >- + The formula of the named item. Formulas always start with an equal sign + ("="). + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/34-named-item/update-named-item.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + + // Get the named item + const myNamedItem = sheet.names.getItemOrNullObject("MyRange"); + myNamedItem.load("name, formula"); + await context.sync(); + + if (myNamedItem.isNullObject) { + console.log(`There is no named item. Create it with "Add named item for a range" first.`); + } else { + // Update named item to point to the second range + myNamedItem.formula = "=Sample!$B$10:$D$14"; + sheet.getRange("B10:D14").select(); + await context.sync(); + + console.log(`Just updated the named item "${myNamedItem.name}" -- it's now located here: ${myNamedItem.formula}`); + } + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'formula: any;' + return: + type: any + - name: name + uid: excel!Excel.NamedItem#name:member + package: excel! + fullName: name + summary: The name of the object. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly name: string;' + return: + type: string + - name: scope + uid: excel!Excel.NamedItem#scope:member + package: excel! + fullName: scope + summary: >- + Specifies if the name is scoped to the workbook or to a specific + worksheet. Possible values are: Worksheet, Workbook. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly scope: Excel.NamedItemScope | "Worksheet" | "Workbook";' + return: + type: >- + | "Worksheet" | + "Workbook" + - name: type + uid: excel!Excel.NamedItem#type:member + package: excel! + fullName: type + summary: >- + Specifies the type of the value returned by the name's formula. See + `Excel.NamedItemType` for details. + remarks: >- + \[ [API set: ExcelApi 1.1 for String,Integer,Double,Boolean,Range,Error; + 1.7 for + Array](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly type: Excel.NamedItemType | "String" | "Integer" | "Double" | + "Boolean" | "Range" | "Error" | "Array"; + return: + type: >- + | "String" | "Integer" | + "Double" | "Boolean" | "Range" | "Error" | "Array" + - name: value + uid: excel!Excel.NamedItem#value:member + package: excel! + fullName: value + 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: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly value: any;' + return: + type: any + - name: valueAsJson + uid: excel!Excel.NamedItem#valueAsJson:member + package: excel! + fullName: valueAsJson + summary: >- + A JSON representation of the values in this named item. Unlike + `NamedItem.value`, `NamedItem.valueAsJson` supports all data types + which can be in a cell. Examples include formatted number values and web + images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the en-US locale. To + retrieve data in the user's display locale, use + `NamedItem.valueAsJsonLocal`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly valueAsJson: CellValue | string;' + return: + type: | string + - name: valueAsJsonLocal + uid: excel!Excel.NamedItem#valueAsJsonLocal:member + package: excel! + fullName: valueAsJsonLocal + summary: >- + A JSON representation of the values in this named item. Unlike + `NamedItem.value`, `NamedItem.valueAsJsonLocal` supports all data + types which can be in a cell. Examples include formatted number values and + web images, in addition to the standard boolean, number, and string + values. Data returned from this API always aligns with the user's display + locale. To retrieve data independent of locale, use + `NamedItem.valueAsJson`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly valueAsJsonLocal: CellValue | string;' + return: + type: | string + - name: visible + uid: excel!Excel.NamedItem#visible:member + package: excel! + fullName: visible + summary: Specifies if the object is visible. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible: boolean;' + return: + type: boolean + - name: worksheet + uid: excel!Excel.NamedItem#worksheet:member + package: excel! + fullName: worksheet + summary: >- + Returns the worksheet on which the named item is scoped to. Throws an + error if the item is scoped to the workbook instead. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly worksheet: Excel.Worksheet;' + return: + type: + - name: worksheetOrNullObject + uid: excel!Excel.NamedItem#worksheetOrNullObject:member + package: excel! + fullName: worksheetOrNullObject + summary: >- + Returns the worksheet to which the named item is scoped. If the item is + scoped to the workbook instead, then this method returns an object with + its `isNullObject` property set to `true`. For further + information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly worksheetOrNullObject: Excel.Worksheet;' + return: + type: +methods: + - name: delete() + uid: excel!Excel.NamedItem#delete:member(1) + package: excel! + fullName: delete() + summary: Deletes the given name. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/34-named-item/create-and-remove-named-item.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const totalName = sheet.names.getItemOrNullObject("TotalAmount"); + totalName.load(); + await context.sync(); + + if (totalName.value) { + totalName.delete(); + + // Replace the named item (TotalAmount) with the actual formula for TotalAmount to avoid displaying #NAME in the cell. + sheet.getRange("D11").values = [["=SUM(ExpensesTable[AMOUNT])"]]; + } else { + console.log("No named item created for the formula."); + } + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'delete(): void;' + return: + type: void + description: '' + - name: getRange() + uid: excel!Excel.NamedItem#getRange:member(1) + package: excel! + fullName: getRange() + summary: >- + Returns the range object that is associated with the name. Throws an error + if the named item's type is not a range. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Returns the Range object that is associated with the name. + + // Returns `null` if the name is not of type Range. + + // Note: This API currently supports only the Workbook scoped items. + + await Excel.run(async (context) => { + const names = context.workbook.names; + const range = names.getItem('MyRange').getRange(); + range.load('address'); + await context.sync(); + + console.log(range.address); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getRange(): Excel.Range;' + return: + type: + description: '' + - name: getRangeOrNullObject() + uid: excel!Excel.NamedItem#getRangeOrNullObject:member(1) + package: excel! + fullName: getRangeOrNullObject() + summary: >- + Returns the range object that is associated with the name. If the named + item's type is not a range, then this method returns an object with its + `isNullObject` property set to `true`. For further information, + see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getRangeOrNullObject(): Excel.Range;' + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.NamedItem#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(options?: Excel.Interfaces.NamedItemLoadOptions): Excel.NamedItem;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.NamedItem#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.NamedItem;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: |- + + + #### Examples + + ```TypeScript + await Excel.run(async (context) => { + const names = context.workbook.names; + const namedItem = names.getItem('MyRange'); + namedItem.load('type'); + await context.sync(); + + console.log(namedItem.type); + }); + ``` + - name: load(propertyNamesAndPaths) + uid: excel!Excel.NamedItem#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.NamedItem; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.NamedItem#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.NamedItemUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.NamedItem#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.NamedItem): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.NamedItem#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.NamedItem` object + is an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Excel.Interfaces.NamedItemData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.NamedItemData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.nameditemarrayvalues.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.nameditemarrayvalues.yml new file mode 100644 index 0000000000..bd40d50373 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.nameditemarrayvalues.yml @@ -0,0 +1,211 @@ +### YamlMime:TSType +name: Excel.NamedItemArrayValues +uid: excel!Excel.NamedItemArrayValues:class +package: excel! +fullName: Excel.NamedItemArrayValues +summary: Represents an object containing values and types of a named item. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.NamedItemArrayValues#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: types + uid: excel!Excel.NamedItemArrayValues#types:member + package: excel! + fullName: types + summary: Represents the types for each item in the named item array + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly types: Excel.RangeValueType[][];' + return: + type: [][] + - name: values + uid: excel!Excel.NamedItemArrayValues#values:member + package: excel! + fullName: values + summary: Represents the values of each item in the named item array. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly values: any[][];' + return: + type: any[][] + - name: valuesAsJson + uid: excel!Excel.NamedItemArrayValues#valuesAsJson:member + package: excel! + fullName: valuesAsJson + summary: >- + A JSON representation of the values in this named item array. Unlike + `NamedItemArrayValues.values`, `NamedItemArrayValues.valuesAsJson` + supports all data types which can be in a cell. Examples include formatted + number values and web images, in addition to the standard boolean, number, + and string values. Data returned from this API always aligns with the + en-US locale. To retrieve data in the user's display locale, use + `NamedItemArrayValues.valuesAsJsonLocal`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly valuesAsJson: CellValue[][];' + return: + type: [][] + - name: valuesAsJsonLocal + uid: excel!Excel.NamedItemArrayValues#valuesAsJsonLocal:member + package: excel! + fullName: valuesAsJsonLocal + summary: >- + A JSON representation of the values in this named item array. Unlike + `NamedItemArrayValues.values`, + `NamedItemArrayValues.valuesAsJsonLocal` supports all data types which can + be in a cell. Examples include formatted number values and web images, in + addition to the standard boolean, number, and string values. Data returned + from this API always aligns with the user's display locale. To retrieve + data independent of locale, use `NamedItemArrayValues.valuesAsJson`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly valuesAsJsonLocal: CellValue[][];' + return: + type: [][] +methods: + - name: load(options) + uid: excel!Excel.NamedItemArrayValues#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.NamedItemArrayValuesLoadOptions): + Excel.NamedItemArrayValues; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.NamedItemArrayValues#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.NamedItemArrayValues;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.NamedItemArrayValues#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.NamedItemArrayValues; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.NamedItemArrayValues#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.NamedItemArrayValues` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.NamedItemArrayValuesData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.NamedItemArrayValuesData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.nameditemcollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.nameditemcollection.yml new file mode 100644 index 0000000000..1725c34320 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.nameditemcollection.yml @@ -0,0 +1,318 @@ +### YamlMime:TSType +name: Excel.NamedItemCollection +uid: excel!Excel.NamedItemCollection:class +package: excel! +fullName: Excel.NamedItemCollection +summary: >- + A collection of all the `NamedItem` objects that are part of the workbook or + worksheet, depending on how it was reached. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.NamedItemCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: excel!Excel.NamedItemCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.NamedItem[];' + return: + type: [] +methods: + - name: add(name, reference, comment) + uid: excel!Excel.NamedItemCollection#add:member(1) + package: excel! + fullName: add(name, reference, comment) + summary: Adds a new name to the collection of the given scope. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/34-named-item/create-and-remove-named-item.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const headerRange = sheet.getRange("A1:D1"); + + sheet.names.add("ExpensesHeader", headerRange); + const namedItems = sheet.names.load("name, type"); + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + add(name: string, reference: Range | string, comment?: string): + Excel.NamedItem; + parameters: + - id: name + description: The name of the named item. + type: string + - id: reference + description: The formula or the range that the name will refer to. + type: | string + - id: comment + description: Optional. The comment associated with the named item. + type: string + return: + type: + description: '' + - name: addFormulaLocal(name, formula, comment) + uid: excel!Excel.NamedItemCollection#addFormulaLocal:member(1) + package: excel! + fullName: addFormulaLocal(name, formula, comment) + summary: >- + Adds a new name to the collection of the given scope using the user's + locale for the formula. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + addFormulaLocal(name: string, formula: string, comment?: string): + Excel.NamedItem; + parameters: + - id: name + description: The name of the named item. + type: string + - id: formula + description: The formula in the user's locale that the name will refer to. + type: string + - id: comment + description: Optional. The comment associated with the named item. + type: string + return: + type: + description: '' + - name: getCount() + uid: excel!Excel.NamedItemCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Gets the number of named items in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getItem(name) + uid: excel!Excel.NamedItemCollection#getItem:member(1) + package: excel! + fullName: getItem(name) + summary: Gets a `NamedItem` object using its name. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const sheetName = 'Sheet1'; + const nameditem = context.workbook.names.getItem(sheetName); + nameditem.load('type'); + await context.sync(); + + console.log(nameditem.type); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getItem(name: string): Excel.NamedItem;' + parameters: + - id: name + description: Nameditem name. + type: string + return: + type: + description: '' + - name: getItemOrNullObject(name) + uid: excel!Excel.NamedItemCollection#getItemOrNullObject:member(1) + package: excel! + fullName: getItemOrNullObject(name) + summary: >- + Gets a `NamedItem` object using its name. If the object does not exist, + then this method returns an object with its `isNullObject` property set to + `true`. For further information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemOrNullObject(name: string): Excel.NamedItem;' + parameters: + - id: name + description: Nameditem name. + type: string + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.NamedItemCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.NamedItemCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): Excel.NamedItemCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.NamedItemCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.NamedItemCollection;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: |- + + + #### Examples + + ```TypeScript + await Excel.run(async (context) => { + const nameditems = context.workbook.names; + nameditems.load('items'); + await context.sync(); + + for (let i = 0; i < nameditems.items.length; i++) { + console.log(nameditems.items[i].name); + } + }); + ``` + - name: load(propertyNamesAndPaths) + uid: excel!Excel.NamedItemCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.NamedItemCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.NamedItemCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.NamedItemCollection` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.NamedItemCollectionData`) that contains an + "items" array with shallow copies of any loaded properties from the + collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.NamedItemCollectionData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.nameditemscope.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.nameditemscope.yml new file mode 100644 index 0000000000..d659fa65e6 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.nameditemscope.yml @@ -0,0 +1,27 @@ +### YamlMime:TSEnum +name: Excel.NamedItemScope +uid: excel!Excel.NamedItemScope:enum +package: excel! +fullName: Excel.NamedItemScope +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: workbook + uid: excel!Excel.NamedItemScope.workbook:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Workbook"' + - name: worksheet + uid: excel!Excel.NamedItemScope.worksheet:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Worksheet"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.nameditemtype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.nameditemtype.yml new file mode 100644 index 0000000000..0b4eb68ef8 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.nameditemtype.yml @@ -0,0 +1,63 @@ +### YamlMime:TSEnum +name: Excel.NamedItemType +uid: excel!Excel.NamedItemType:enum +package: excel! +fullName: Excel.NamedItemType +summary: '' +remarks: >- + \[ [API set: ExcelApi 1.1 for String,Integer,Double,Boolean,Range,Error; 1.7 + for Array](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + +isPreview: false +isDeprecated: false +fields: + - name: array + uid: excel!Excel.NamedItemType.array:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Array"' + - name: boolean + uid: excel!Excel.NamedItemType.boolean:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Boolean"' + - name: double + uid: excel!Excel.NamedItemType.double:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Double"' + - name: error + uid: excel!Excel.NamedItemType.error:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Error"' + - name: integer + uid: excel!Excel.NamedItemType.integer:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Integer"' + - name: range + uid: excel!Excel.NamedItemType.range:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Range"' + - name: string + uid: excel!Excel.NamedItemType.string:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"String"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.nameerrorcellvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.nameerrorcellvalue.yml new file mode 100644 index 0000000000..03bba33a97 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.nameerrorcellvalue.yml @@ -0,0 +1,85 @@ +### YamlMime:TSType +name: Excel.NameErrorCellValue +uid: excel!Excel.NameErrorCellValue:interface +package: excel! +fullName: Excel.NameErrorCellValue +summary: Represents the value of a cell containing a \#NAME? error. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: basicType + uid: excel!Excel.NameErrorCellValue#basicType:member + package: excel! + fullName: basicType + summary: >- + Represents the value that would be returned by `Range.valueTypes` for a + cell with this value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicType?: RangeValueType.error | "Error";' + return: + type: | "Error" + - name: basicValue + uid: excel!Excel.NameErrorCellValue#basicValue:member + package: excel! + fullName: basicValue + summary: >- + Represents the value that would be returned by `Range.values` for a cell + with this value. When accessed through a `valuesAsJson` property, this + string value aligns with the en-US locale. When accessed through a + `valuesAsJsonLocal` property, this string value aligns with the user's + display locale. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicValue?: "#NAME?" | string;' + return: + type: '"#NAME?" | string' + - name: errorType + uid: excel!Excel.NameErrorCellValue#errorType:member + package: excel! + fullName: errorType + summary: Represents the type of `ErrorCellValue`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'errorType?: ErrorCellValueType.name | "Name";' + return: + type: | "Name" + - name: type + uid: excel!Excel.NameErrorCellValue#type:member + package: excel! + fullName: type + summary: Represents the type of this cell value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: CellValueType.error | "Error";' + return: + type: | "Error" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.notavailableerrorcellvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.notavailableerrorcellvalue.yml new file mode 100644 index 0000000000..0587e033ac --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.notavailableerrorcellvalue.yml @@ -0,0 +1,87 @@ +### YamlMime:TSType +name: Excel.NotAvailableErrorCellValue +uid: excel!Excel.NotAvailableErrorCellValue:interface +package: excel! +fullName: Excel.NotAvailableErrorCellValue +summary: Represents the value of a cell containing a \#N/A error. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: basicType + uid: excel!Excel.NotAvailableErrorCellValue#basicType:member + package: excel! + fullName: basicType + summary: >- + Represents the value that would be returned by `Range.valueTypes` for a + cell with this value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicType?: RangeValueType.error | "Error";' + return: + type: | "Error" + - name: basicValue + uid: excel!Excel.NotAvailableErrorCellValue#basicValue:member + package: excel! + fullName: basicValue + summary: >- + Represents the value that would be returned by `Range.values` for a cell + with this value. When accessed through a `valuesAsJson` property, this + string value aligns with the en-US locale. When accessed through a + `valuesAsJsonLocal` property, this string value aligns with the user's + display locale. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicValue?: "#N/A" | string;' + return: + type: '"#N/A" | string' + - name: errorType + uid: excel!Excel.NotAvailableErrorCellValue#errorType:member + package: excel! + fullName: errorType + summary: Represents the type of `ErrorCellValue`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'errorType?: ErrorCellValueType.notAvailable | "NotAvailable";' + return: + type: >- + | + "NotAvailable" + - name: type + uid: excel!Excel.NotAvailableErrorCellValue#type:member + package: excel! + fullName: type + summary: Represents the type of this cell value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: CellValueType.error | "Error";' + return: + type: | "Error" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.note.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.note.yml new file mode 100644 index 0000000000..002fd3d0ed --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.note.yml @@ -0,0 +1,426 @@ +### YamlMime:TSType +name: Excel.Note +uid: excel!Excel.Note:class +package: excel! +fullName: Excel.Note +summary: Represents a note in the workbook or worksheet. +remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/excel-note-basics.yaml + + + // This function changes the height and width of the first note. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Notes"); + const note = sheet.notes.getItemAt(0); + note.height = 200; + note.width = 400; + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +type: class +properties: + - name: authorName + uid: excel!Excel.Note#authorName:member + package: excel! + fullName: authorName + summary: Gets the author of the note. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly authorName: string;' + return: + type: string + - name: content + uid: excel!Excel.Note#content:member + package: excel! + fullName: content + summary: Specifies the text of the note. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/excel-note-basics.yaml + + + // This function changes the content in the first note. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Notes"); + const note = sheet.notes.getItemAt(0); + note.content = "Changing the content of the first note."; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'content: string;' + return: + type: string + - name: context + uid: excel!Excel.Note#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: height + uid: excel!Excel.Note#height:member + package: excel! + fullName: height + summary: Specifies the height of the note. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/excel-note-basics.yaml + + + // This function changes the height and width of the first note. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Notes"); + const note = sheet.notes.getItemAt(0); + note.height = 200; + note.width = 400; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'height: number;' + return: + type: number + - name: visible + uid: excel!Excel.Note#visible:member + package: excel! + fullName: visible + summary: >- + Specifies the visibility of the note. A value of `true` means the note is + shown. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/excel-note-basics.yaml + + + // This function sets the note on cell A1 to visible. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Notes"); + const firstNote = sheet.notes.getItem("A1"); + + firstNote.load(); + await context.sync(); + + firstNote.visible = true; + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'visible: boolean;' + return: + type: boolean + - name: width + uid: excel!Excel.Note#width:member + package: excel! + fullName: width + summary: Specifies the width of the note. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/excel-note-basics.yaml + + + // This function changes the height and width of the first note. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Notes"); + const note = sheet.notes.getItemAt(0); + note.height = 200; + note.width = 400; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'width: number;' + return: + type: number +methods: + - name: delete() + uid: excel!Excel.Note#delete:member(1) + package: excel! + fullName: delete() + summary: Deletes the note. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/excel-note-basics.yaml + + + // This function deletes the note from cell A2. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Notes"); + const note = sheet.notes.getItem("A2"); + note.delete(); + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'delete(): void;' + return: + type: void + description: '' + - name: getLocation() + uid: excel!Excel.Note#getLocation:member(1) + package: excel! + fullName: getLocation() + summary: Gets the cell where this note is located. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getLocation(): Excel.Range;' + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.Note#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(options?: Excel.Interfaces.NoteLoadOptions): Excel.Note;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.Note#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.Note;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.Note#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.Note; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.Note#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.NoteUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.Note#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.Note): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.Note#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.Note` object is + an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Excel.Interfaces.NoteData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.NoteData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.notecollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.notecollection.yml new file mode 100644 index 0000000000..867df69ccc --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.notecollection.yml @@ -0,0 +1,343 @@ +### YamlMime:TSType +name: Excel.NoteCollection +uid: excel!Excel.NoteCollection:class +package: excel! +fullName: Excel.NoteCollection +summary: Represents a collection of note objects that are part of the workbook. +remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/excel-note-basics.yaml + + + // This function adds a note to the selected cell. + + await Excel.run(async (context) => { + const selectedRange = context.workbook.getSelectedRange(); + + // Note that an InvalidArgument error is thrown if multiple cells are selected. + context.workbook.notes.add(selectedRange, "The first note."); + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.NoteCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: excel!Excel.NoteCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.Note[];' + return: + type: [] +methods: + - name: add(cellAddress, content) + uid: excel!Excel.NoteCollection#add:member(1) + package: excel! + fullName: add(cellAddress, content) + summary: Adds a new note with the given content on the given cell. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/excel-note-basics.yaml + + + // This function adds a note to the selected cell. + + await Excel.run(async (context) => { + const selectedRange = context.workbook.getSelectedRange(); + + // Note that an InvalidArgument error is thrown if multiple cells are selected. + context.workbook.notes.add(selectedRange, "The first note."); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'add(cellAddress: Range | string, content: any): Excel.Note;' + parameters: + - id: cellAddress + description: >- + The cell to which the note is added. This can be a `Range` object or + a string such as "A1". If the string is invalid, or the range is not + a single cell, an `InvalidCellAddress` error is thrown. + type: | string + - id: content + description: The text of the note. + type: any + return: + type: + description: '' + - name: getCount() + uid: excel!Excel.NoteCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Gets the number of notes in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getItem(key) + uid: excel!Excel.NoteCollection#getItem:member(1) + package: excel! + fullName: getItem(key) + summary: Gets a note by its cell address. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/excel-note-basics.yaml + + + // This function sets the note on cell A1 to visible. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Notes"); + const firstNote = sheet.notes.getItem("A1"); + + firstNote.load(); + await context.sync(); + + firstNote.visible = true; + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getItem(key: string): Excel.Note;' + parameters: + - id: key + description: The cell address of the note. + type: string + return: + type: + description: >- + The note with the given cell address. If there is no note with the + given cell address, then the `ItemNotFound` error is thrown. + - name: getItemAt(index) + uid: excel!Excel.NoteCollection#getItemAt:member(1) + package: excel! + fullName: getItemAt(index) + summary: Gets a note from the collection based on its position. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/excel-note-basics.yaml + + + // This function changes the content in the first note. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Notes"); + const note = sheet.notes.getItemAt(0); + note.content = "Changing the content of the first note."; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemAt(index: number): Excel.Note;' + parameters: + - id: index + description: The index value of the note to be retrieved. Zero-indexed. + type: number + return: + type: + description: '' + - name: getItemOrNullObject(key) + uid: excel!Excel.NoteCollection#getItemOrNullObject:member(1) + package: excel! + fullName: getItemOrNullObject(key) + summary: >- + Gets a note by its cell address. If the note object does not exist, then + this method returns an object with its `isNullObject` property set to + `true`. For further information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemOrNullObject(key: string): Excel.Note;' + parameters: + - id: key + description: The cell address of the note. + type: string + return: + type: + description: The note with the given cell address or null object. + - name: load(options) + uid: excel!Excel.NoteCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.NoteCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): Excel.NoteCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.NoteCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.NoteCollection;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.NoteCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.NoteCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.NoteCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.NoteCollection` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.NoteCollectionData`) that + contains an "items" array with shallow copies of any loaded properties + from the collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.NoteCollectionData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.nullerrorcellvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.nullerrorcellvalue.yml new file mode 100644 index 0000000000..74fd6c4178 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.nullerrorcellvalue.yml @@ -0,0 +1,85 @@ +### YamlMime:TSType +name: Excel.NullErrorCellValue +uid: excel!Excel.NullErrorCellValue:interface +package: excel! +fullName: Excel.NullErrorCellValue +summary: Represents the value of a cell containing a \#NULL! error. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: basicType + uid: excel!Excel.NullErrorCellValue#basicType:member + package: excel! + fullName: basicType + summary: >- + Represents the value that would be returned by `Range.valueTypes` for a + cell with this value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicType?: RangeValueType.error | "Error";' + return: + type: | "Error" + - name: basicValue + uid: excel!Excel.NullErrorCellValue#basicValue:member + package: excel! + fullName: basicValue + summary: >- + Represents the value that would be returned by `Range.values` for a cell + with this value. When accessed through a `valuesAsJson` property, this + string value aligns with the en-US locale. When accessed through a + `valuesAsJsonLocal` property, this string value aligns with the user's + display locale. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicValue?: "#NULL!" | string;' + return: + type: '"#NULL!" | string' + - name: errorType + uid: excel!Excel.NullErrorCellValue#errorType:member + package: excel! + fullName: errorType + summary: Represents the type of `ErrorCellValue`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'errorType?: ErrorCellValueType.null | "Null";' + return: + type: | "Null" + - name: type + uid: excel!Excel.NullErrorCellValue#type:member + package: excel! + fullName: type + summary: Represents the type of this cell value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: CellValueType.error | "Error";' + return: + type: | "Error" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.numberformatcategory.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.numberformatcategory.yml new file mode 100644 index 0000000000..b2d60cd05a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.numberformatcategory.yml @@ -0,0 +1,158 @@ +### YamlMime:TSEnum +name: Excel.NumberFormatCategory +uid: excel!Excel.NumberFormatCategory:enum +package: excel! +fullName: Excel.NumberFormatCategory +summary: Represents a category of number formats. +remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: accounting + uid: excel!Excel.NumberFormatCategory.accounting:member + package: excel! + summary: >- + Accounting formats line up the currency symbols and decimal points in a + column. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Accounting"' + - name: currency + uid: excel!Excel.NumberFormatCategory.currency:member + package: excel! + summary: >- + Currency formats are used for general monetary values. Use Accounting + formats to align decimal points in a column. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Currency"' + - name: custom + uid: excel!Excel.NumberFormatCategory.custom:member + package: excel! + summary: >- + A custom format that is not a part of any category. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Custom"' + - name: date + uid: excel!Excel.NumberFormatCategory.date:member + package: excel! + summary: >- + Date formats display date and time serial numbers as date values. Date + formats that begin with an asterisk (*) respond to changes in regional + date and time settings that are specified for the operating system. + Formats without an asterisk are not affected by operating system settings. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Date"' + - name: fraction + uid: excel!Excel.NumberFormatCategory.fraction:member + package: excel! + summary: >- + Fraction formats display the cell value as a whole number with the + remainder rounded to the nearest fraction value. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Fraction"' + - name: general + uid: excel!Excel.NumberFormatCategory.general:member + package: excel! + summary: >- + General format cells have no specific number format. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"General"' + - name: number + uid: excel!Excel.NumberFormatCategory.number:member + package: excel! + summary: >- + Number is used for general display of numbers. Currency and Accounting + offer specialized formatting for monetary value. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Number"' + - name: percentage + uid: excel!Excel.NumberFormatCategory.percentage:member + package: excel! + summary: >- + Percentage formats multiply the cell value by 100 and displays the result + with a percent symbol. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Percentage"' + - name: scientific + uid: excel!Excel.NumberFormatCategory.scientific:member + package: excel! + summary: >- + Scientific formats display the cell value as a number between 1 and 10 + multiplied by a power of 10. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Scientific"' + - name: special + uid: excel!Excel.NumberFormatCategory.special:member + package: excel! + summary: >- + Special formats are useful for tracking list and database values. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Special"' + - name: text + uid: excel!Excel.NumberFormatCategory.text:member + package: excel! + summary: >- + Text format cells are treated as text even when a number is in the cell. + The cell is displayed exactly as entered. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Text"' + - name: time + uid: excel!Excel.NumberFormatCategory.time:member + package: excel! + summary: >- + Time formats display date and time serial numbers as date values. Time + formats that begin with an asterisk (*) respond to changes in regional + date and time settings that are specified for the operating system. + Formats without an asterisk are not affected by operating system settings. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Time"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.numberformatinfo.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.numberformatinfo.yml new file mode 100644 index 0000000000..87609eb722 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.numberformatinfo.yml @@ -0,0 +1,269 @@ +### YamlMime:TSType +name: Excel.NumberFormatInfo +uid: excel!Excel.NumberFormatInfo:class +package: excel! +fullName: Excel.NumberFormatInfo +summary: >- + Defines the culturally appropriate format of displaying numbers. This is based + on current system culture settings. +remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.NumberFormatInfo#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: currencySymbol + uid: excel!Excel.NumberFormatInfo#currencySymbol:member + package: excel! + fullName: currencySymbol + summary: >- + Gets the currency symbol for currency values. This is based on current + system settings. + remarks: >- + \[ [API set: ExcelApi + 1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly currencySymbol: string;' + return: + type: string + - name: numberDecimalSeparator + uid: excel!Excel.NumberFormatInfo#numberDecimalSeparator:member + package: excel! + fullName: numberDecimalSeparator + summary: >- + Gets the string used as the decimal separator for numeric values. This is + based on current system settings. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/culture-info.yaml + + + // This will convert a number like "14,37" to "14.37" + + // (assuming the system decimal separator is "."). + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + + const decimalSource = sheet.getRange("B2"); + + decimalSource.load("values"); + + context.application.cultureInfo.numberFormat.load("numberDecimalSeparator"); + + await context.sync(); + + + const systemDecimalSeparator = + context.application.cultureInfo.numberFormat.numberDecimalSeparator; + + const oldDecimalString: string = decimalSource.values[0][0]; + + + // This assumes the input column is standardized to use "," as the decimal + separator. + + const newDecimalString = oldDecimalString.replace(",", + systemDecimalSeparator); + + + const resultRange = sheet.getRange("C2"); + + resultRange.values = [[newDecimalString]]; + + resultRange.format.autofitColumns(); + + await context.sync(); + }); + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly numberDecimalSeparator: string;' + return: + type: string + - name: numberGroupSeparator + uid: excel!Excel.NumberFormatInfo#numberGroupSeparator:member + package: excel! + fullName: numberGroupSeparator + summary: >- + Gets the string used to separate groups of digits to the left of the + decimal for numeric values. This is based on current system settings. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/culture-info.yaml + + + await Excel.run(async (context) => { + // This will convert a number like "123-456-789" to "123,456,789" + // (assuming the system thousands separator is ","). + const sheet = context.workbook.worksheets.getItem("Sample"); + const bigNumberSource = sheet.getRange("B3"); + bigNumberSource.load("values"); + context.application.cultureInfo.numberFormat.load("numberGroupSeparator"); + await context.sync(); + + const systemThousandsSeparator = context.application.cultureInfo.numberFormat.numberGroupSeparator; + const oldBigNumberString: string = bigNumberSource.values[0][0]; + + // This assumes the input column is standardized to use "-" as the number group separator. + const newBigNumberString = oldBigNumberString.replace(/-/g, systemThousandsSeparator); + + const resultRange = sheet.getRange("C3"); + resultRange.values = [[newBigNumberString]]; + resultRange.format.autofitColumns(); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly numberGroupSeparator: string;' + return: + type: string +methods: + - name: load(options) + uid: excel!Excel.NumberFormatInfo#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.NumberFormatInfoLoadOptions): + Excel.NumberFormatInfo; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.NumberFormatInfo#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.NumberFormatInfo;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.NumberFormatInfo#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.NumberFormatInfo; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.NumberFormatInfo#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.NumberFormatInfo` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.NumberFormatInfoData`) that + contains shallow copies of any loaded child properties from the original + object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.NumberFormatInfoData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.numerrorcellvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.numerrorcellvalue.yml new file mode 100644 index 0000000000..496d6970da --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.numerrorcellvalue.yml @@ -0,0 +1,119 @@ +### YamlMime:TSType +name: Excel.NumErrorCellValue +uid: excel!Excel.NumErrorCellValue:interface +package: excel! +fullName: Excel.NumErrorCellValue +summary: Represents the value of a cell containing a \#NUM! error. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: basicType + uid: excel!Excel.NumErrorCellValue#basicType:member + package: excel! + fullName: basicType + summary: >- + Represents the value that would be returned by `Range.valueTypes` for a + cell with this value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicType?: RangeValueType.error | "Error";' + return: + type: | "Error" + - name: basicValue + uid: excel!Excel.NumErrorCellValue#basicValue:member + package: excel! + fullName: basicValue + summary: >- + Represents the value that would be returned by `Range.values` for a cell + with this value. When accessed through a `valuesAsJson` property, this + string value aligns with the en-US locale. When accessed through a + `valuesAsJsonLocal` property, this string value aligns with the user's + display locale. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicValue?: "#NUM!" | string;' + return: + type: '"#NUM!" | string' + - name: errorSubType + uid: excel!Excel.NumErrorCellValue#errorSubType:member + package: excel! + fullName: errorSubType + summary: Represents the type of `NumErrorCellValue`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'errorSubType?: NumErrorCellValueSubType | "Unknown" | "ArrayTooLarge";' + return: + type: >- + | "Unknown" | + "ArrayTooLarge" + - name: errorType + uid: excel!Excel.NumErrorCellValue#errorType:member + package: excel! + fullName: errorType + summary: Represents the type of `ErrorCellValue`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'errorType?: ErrorCellValueType.num | "Num";' + return: + type: | "Num" + - name: functionName + uid: excel!Excel.NumErrorCellValue#functionName:member + package: excel! + fullName: functionName + summary: Represents the name of the function causing the error. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'functionName?: string;' + return: + type: string + - name: type + uid: excel!Excel.NumErrorCellValue#type:member + package: excel! + fullName: type + summary: Represents the type of this cell value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: CellValueType.error | "Error";' + return: + type: | "Error" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.numerrorcellvaluesubtype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.numerrorcellvaluesubtype.yml new file mode 100644 index 0000000000..d445ee512b --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.numerrorcellvaluesubtype.yml @@ -0,0 +1,37 @@ +### YamlMime:TSEnum +name: Excel.NumErrorCellValueSubType +uid: excel!Excel.NumErrorCellValueSubType:enum +package: excel! +fullName: Excel.NumErrorCellValueSubType +summary: Represents types of \#NUM! errors. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: arrayTooLarge + uid: excel!Excel.NumErrorCellValueSubType.arrayTooLarge:member + package: excel! + summary: >- + An error caused by a cell's formula having an array parameter with too + many rows or columns. The maximum number of rows and columns in an array + parameter is 1048576. Displays as error type \#NUM! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ArrayTooLarge"' + - name: unknown + uid: excel!Excel.NumErrorCellValueSubType.unknown:member + package: excel! + summary: >- + An unknown type of error. Displays as error type \#NUM! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Unknown"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.pagebreak.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.pagebreak.yml new file mode 100644 index 0000000000..2d58d8c4cc --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.pagebreak.yml @@ -0,0 +1,188 @@ +### YamlMime:TSType +name: Excel.PageBreak +uid: excel!Excel.PageBreak:class +package: excel! +fullName: Excel.PageBreak +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: columnIndex + uid: excel!Excel.PageBreak#columnIndex:member + package: excel! + fullName: columnIndex + summary: Specifies the column index for the page break. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly columnIndex: number;' + return: + type: number + - name: context + uid: excel!Excel.PageBreak#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: rowIndex + uid: excel!Excel.PageBreak#rowIndex:member + package: excel! + fullName: rowIndex + summary: Specifies the row index for the page break. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly rowIndex: number;' + return: + type: number +methods: + - name: delete() + uid: excel!Excel.PageBreak#delete:member(1) + package: excel! + fullName: delete() + summary: Deletes a page break object. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'delete(): void;' + return: + type: void + description: '' + - name: getCellAfterBreak() + uid: excel!Excel.PageBreak#getCellAfterBreak:member(1) + package: excel! + fullName: getCellAfterBreak() + summary: Gets the first cell after the page break. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCellAfterBreak(): Excel.Range;' + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.PageBreak#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(options?: Excel.Interfaces.PageBreakLoadOptions): Excel.PageBreak;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.PageBreak#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.PageBreak;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.PageBreak#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.PageBreak; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.PageBreak#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.PageBreak` object + is an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Excel.Interfaces.PageBreakData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.PageBreakData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.pagebreakcollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.pagebreakcollection.yml new file mode 100644 index 0000000000..d06f51f04e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.pagebreakcollection.yml @@ -0,0 +1,233 @@ +### YamlMime:TSType +name: Excel.PageBreakCollection +uid: excel!Excel.PageBreakCollection:class +package: excel! +fullName: Excel.PageBreakCollection +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.PageBreakCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: excel!Excel.PageBreakCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.PageBreak[];' + return: + type: [] +methods: + - name: add(pageBreakRange) + uid: excel!Excel.PageBreakCollection#add:member(1) + package: excel! + fullName: add(pageBreakRange) + summary: Adds a page break before the top-left cell of the range specified. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-page-layout.yaml + + + await Excel.run(async (context) => { + const farmSheet = context.workbook.worksheets.getItem("Print"); + farmSheet.horizontalPageBreaks.add("A21:E21"); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'add(pageBreakRange: Range | string): Excel.PageBreak;' + parameters: + - id: pageBreakRange + description: The range immediately after the page break to be added. + type: | string + return: + type: + description: '' + - name: getCount() + uid: excel!Excel.PageBreakCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Gets the number of page breaks in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getItem(index) + uid: excel!Excel.PageBreakCollection#getItem:member(1) + package: excel! + fullName: getItem(index) + summary: Gets a page break object via the index. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItem(index: number): Excel.PageBreak;' + parameters: + - id: index + description: Index of the page break. + type: number + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.PageBreakCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.PageBreakCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): Excel.PageBreakCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.PageBreakCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.PageBreakCollection;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.PageBreakCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.PageBreakCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: removePageBreaks() + uid: excel!Excel.PageBreakCollection#removePageBreaks:member(1) + package: excel! + fullName: removePageBreaks() + summary: Resets all manual page breaks in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'removePageBreaks(): void;' + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.PageBreakCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.PageBreakCollection` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.PageBreakCollectionData`) that contains an + "items" array with shallow copies of any loaded properties from the + collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.PageBreakCollectionData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.pagelayout.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.pagelayout.yml new file mode 100644 index 0000000000..6687125ff7 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.pagelayout.yml @@ -0,0 +1,874 @@ +### YamlMime:TSType +name: Excel.PageLayout +uid: excel!Excel.PageLayout:class +package: excel! +fullName: Excel.PageLayout +summary: >- + Represents layout and print settings that are not dependent on any + printer-specific implementation. These settings include margins, orientation, + page numbering, title rows, and print area. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: blackAndWhite + uid: excel!Excel.PageLayout#blackAndWhite:member + package: excel! + fullName: blackAndWhite + summary: The worksheet's black and white print option. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'blackAndWhite: boolean;' + return: + type: boolean + - name: bottomMargin + uid: excel!Excel.PageLayout#bottomMargin:member + package: excel! + fullName: bottomMargin + summary: The worksheet's bottom page margin to use for printing in points. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'bottomMargin: number;' + return: + type: number + - name: centerHorizontally + uid: excel!Excel.PageLayout#centerHorizontally:member + package: excel! + fullName: centerHorizontally + summary: >- + The worksheet's center horizontally flag. This flag determines whether the + worksheet will be centered horizontally when it's printed. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-page-layout.yaml + + + await Excel.run(async (context) => { + const farmSheet = context.workbook.worksheets.getItem("Print"); + farmSheet.pageLayout.centerHorizontally = true; + farmSheet.pageLayout.centerVertically = true; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'centerHorizontally: boolean;' + return: + type: boolean + - name: centerVertically + uid: excel!Excel.PageLayout#centerVertically:member + package: excel! + fullName: centerVertically + summary: >- + The worksheet's center vertically flag. This flag determines whether the + worksheet will be centered vertically when it's printed. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-page-layout.yaml + + + await Excel.run(async (context) => { + const farmSheet = context.workbook.worksheets.getItem("Print"); + farmSheet.pageLayout.centerHorizontally = true; + farmSheet.pageLayout.centerVertically = true; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'centerVertically: boolean;' + return: + type: boolean + - name: context + uid: excel!Excel.PageLayout#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: draftMode + uid: excel!Excel.PageLayout#draftMode:member + package: excel! + fullName: draftMode + summary: >- + The worksheet's draft mode option. If `true`, the sheet will be + printed without graphics. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'draftMode: boolean;' + return: + type: boolean + - name: firstPageNumber + uid: excel!Excel.PageLayout#firstPageNumber:member + package: excel! + fullName: firstPageNumber + summary: >- + The worksheet's first page number to print. A `null` value represents + "auto" page numbering. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'firstPageNumber: number | "";' + return: + type: number | "" + - name: footerMargin + uid: excel!Excel.PageLayout#footerMargin:member + package: excel! + fullName: footerMargin + summary: The worksheet's footer margin, in points, for use when printing. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'footerMargin: number;' + return: + type: number + - name: headerMargin + uid: excel!Excel.PageLayout#headerMargin:member + package: excel! + fullName: headerMargin + summary: The worksheet's header margin, in points, for use when printing. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'headerMargin: number;' + return: + type: number + - name: headersFooters + uid: excel!Excel.PageLayout#headersFooters:member + package: excel! + fullName: headersFooters + summary: Header and footer configuration for the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly headersFooters: Excel.HeaderFooterGroup;' + return: + type: + - name: leftMargin + uid: excel!Excel.PageLayout#leftMargin:member + package: excel! + fullName: leftMargin + summary: The worksheet's left margin, in points, for use when printing. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'leftMargin: number;' + return: + type: number + - name: orientation + uid: excel!Excel.PageLayout#orientation:member + package: excel! + fullName: orientation + summary: The worksheet's orientation of the page. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-page-layout.yaml + + + await Excel.run(async (context) => { + const farmSheet = context.workbook.worksheets.getItem("Print"); + farmSheet.pageLayout.orientation = Excel.PageOrientation.landscape; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'orientation: Excel.PageOrientation | "Portrait" | "Landscape";' + return: + type: >- + | "Portrait" | + "Landscape" + - name: paperSize + uid: excel!Excel.PageLayout#paperSize:member + package: excel! + fullName: paperSize + summary: The worksheet's paper size of the page. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + paperSize: Excel.PaperType | "Letter" | "LetterSmall" | "Tabloid" | + "Ledger" | "Legal" | "Statement" | "Executive" | "A3" | "A4" | "A4Small" + | "A5" | "B4" | "B5" | "Folio" | "Quatro" | "Paper10x14" | "Paper11x17" + | "Note" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | + "Envelope14" | "Csheet" | "Dsheet" | "Esheet" | "EnvelopeDL" | + "EnvelopeC5" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC6" | + "EnvelopeC65" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | + "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "FanfoldUS" | + "FanfoldStdGerman" | "FanfoldLegalGerman"; + return: + type: >- + | "Letter" | "LetterSmall" | + "Tabloid" | "Ledger" | "Legal" | "Statement" | "Executive" | "A3" | + "A4" | "A4Small" | "A5" | "B4" | "B5" | "Folio" | "Quatro" | + "Paper10x14" | "Paper11x17" | "Note" | "Envelope9" | "Envelope10" | + "Envelope11" | "Envelope12" | "Envelope14" | "Csheet" | "Dsheet" | + "Esheet" | "EnvelopeDL" | "EnvelopeC5" | "EnvelopeC3" | "EnvelopeC4" | + "EnvelopeC6" | "EnvelopeC65" | "EnvelopeB4" | "EnvelopeB5" | + "EnvelopeB6" | "EnvelopeItaly" | "EnvelopeMonarch" | + "EnvelopePersonal" | "FanfoldUS" | "FanfoldStdGerman" | + "FanfoldLegalGerman" + - name: printComments + uid: excel!Excel.PageLayout#printComments:member + package: excel! + fullName: printComments + summary: Specifies if the worksheet's comments should be displayed when printing. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + printComments: Excel.PrintComments | "NoComments" | "EndSheet" | + "InPlace"; + return: + type: >- + | "NoComments" | + "EndSheet" | "InPlace" + - name: printErrors + uid: excel!Excel.PageLayout#printErrors:member + package: excel! + fullName: printErrors + summary: The worksheet's print errors option. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + printErrors: Excel.PrintErrorType | "AsDisplayed" | "Blank" | "Dash" | + "NotAvailable"; + return: + type: >- + | "AsDisplayed" | + "Blank" | "Dash" | "NotAvailable" + - name: printGridlines + uid: excel!Excel.PageLayout#printGridlines:member + package: excel! + fullName: printGridlines + summary: Specifies if the worksheet's gridlines will be printed. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'printGridlines: boolean;' + return: + type: boolean + - name: printHeadings + uid: excel!Excel.PageLayout#printHeadings:member + package: excel! + fullName: printHeadings + summary: Specifies if the worksheet's headings will be printed. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'printHeadings: boolean;' + return: + type: boolean + - name: printOrder + uid: excel!Excel.PageLayout#printOrder:member + package: excel! + fullName: printOrder + summary: >- + The worksheet's page print order option. This specifies the order to use + for processing the page number printed. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'printOrder: Excel.PrintOrder | "DownThenOver" | "OverThenDown";' + return: + type: >- + | "DownThenOver" | + "OverThenDown" + - name: rightMargin + uid: excel!Excel.PageLayout#rightMargin:member + package: excel! + fullName: rightMargin + summary: The worksheet's right margin, in points, for use when printing. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rightMargin: number;' + return: + type: number + - name: topMargin + uid: excel!Excel.PageLayout#topMargin:member + package: excel! + fullName: topMargin + summary: The worksheet's top margin, in points, for use when printing. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'topMargin: number;' + return: + type: number + - name: zoom + uid: excel!Excel.PageLayout#zoom:member + package: excel! + fullName: zoom + summary: >- + The worksheet's print zoom options. The `PageLayoutZoomOptions` object + must be set as a JSON object (use `x.zoom = {...}` instead of + `x.zoom.scale = ...`). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-page-layout.yaml + + + await Excel.run(async (context) => { + const farmSheet = context.workbook.worksheets.getItem("Print"); + farmSheet.pageLayout.zoom = { scale: 200 }; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'zoom: Excel.PageLayoutZoomOptions;' + return: + type: +methods: + - name: getPrintArea() + uid: excel!Excel.PageLayout#getPrintArea:member(1) + package: excel! + fullName: getPrintArea() + summary: >- + Gets the `RangeAreas` object, comprising one or more rectangular ranges, + that represents the print area for the worksheet. If there is no print + area, an `ItemNotFound` error will be thrown. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getPrintArea(): Excel.RangeAreas;' + return: + type: + description: '' + - name: getPrintAreaOrNullObject() + uid: excel!Excel.PageLayout#getPrintAreaOrNullObject:member(1) + package: excel! + fullName: getPrintAreaOrNullObject() + summary: >- + Gets the `RangeAreas` object, comprising one or more rectangular ranges, + that represents the print area for the worksheet. If there is no print + area, then this method returns an object with its `isNullObject` property + set to `true`. For further information, see [*OrNullObject + methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getPrintAreaOrNullObject(): Excel.RangeAreas;' + return: + type: + description: '' + - name: getPrintTitleColumns() + uid: excel!Excel.PageLayout#getPrintTitleColumns:member(1) + package: excel! + fullName: getPrintTitleColumns() + summary: Gets the range object representing the title columns. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getPrintTitleColumns(): Excel.Range;' + return: + type: + description: '' + - name: getPrintTitleColumnsOrNullObject() + uid: excel!Excel.PageLayout#getPrintTitleColumnsOrNullObject:member(1) + package: excel! + fullName: getPrintTitleColumnsOrNullObject() + summary: >- + Gets the range object representing the title columns. If not set, then + this method returns an object with its `isNullObject` property set to + `true`. For further information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getPrintTitleColumnsOrNullObject(): Excel.Range;' + return: + type: + description: '' + - name: getPrintTitleRows() + uid: excel!Excel.PageLayout#getPrintTitleRows:member(1) + package: excel! + fullName: getPrintTitleRows() + summary: Gets the range object representing the title rows. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getPrintTitleRows(): Excel.Range;' + return: + type: + description: '' + - name: getPrintTitleRowsOrNullObject() + uid: excel!Excel.PageLayout#getPrintTitleRowsOrNullObject:member(1) + package: excel! + fullName: getPrintTitleRowsOrNullObject() + summary: >- + Gets the range object representing the title rows. If not set, then this + method returns an object with its `isNullObject` property set to + `true`. For further information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getPrintTitleRowsOrNullObject(): Excel.Range;' + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.PageLayout#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.PageLayoutLoadOptions): + Excel.PageLayout; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.PageLayout#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.PageLayout;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.PageLayout#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.PageLayout; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.PageLayout#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.PageLayoutUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.PageLayout#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.PageLayout): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: setPrintArea(printArea) + uid: excel!Excel.PageLayout#setPrintArea:member(1) + package: excel! + fullName: setPrintArea(printArea) + summary: Sets the worksheet's print area. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-page-layout.yaml + + + await Excel.run(async (context) => { + const farmSheet = context.workbook.worksheets.getItem("Print"); + farmSheet.pageLayout.setPrintArea("A1:D41"); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'setPrintArea(printArea: Range | RangeAreas | string): void;' + parameters: + - id: printArea + description: The range or ranges of the content to print. + type: >- + | | string + return: + type: void + description: '' + - name: setPrintMargins(unit, marginOptions) + uid: excel!Excel.PageLayout#setPrintMargins:member(1) + package: excel! + fullName: setPrintMargins(unit, marginOptions) + summary: Sets the worksheet's page margins with units. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + setPrintMargins(unit: Excel.PrintMarginUnit, marginOptions: + Excel.PageLayoutMarginOptions): void; + parameters: + - id: unit + description: Measurement unit for the margins provided. + type: + - id: marginOptions + description: Margin values to set. Margins not provided remain unchanged. + type: + return: + type: void + description: '' + - name: setPrintMargins(unit, marginOptions) + uid: excel!Excel.PageLayout#setPrintMargins:member(2) + package: excel! + fullName: setPrintMargins(unit, marginOptions) + summary: Sets the worksheet's page margins with units. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + setPrintMargins(unit: "Points" | "Inches" | "Centimeters", + marginOptions: Excel.PageLayoutMarginOptions): void; + parameters: + - id: unit + description: Measurement unit for the margins provided. + type: '"Points" | "Inches" | "Centimeters"' + - id: marginOptions + description: Margin values to set. Margins not provided remain unchanged. + type: + return: + type: void + description: '' + - name: setPrintTitleColumns(printTitleColumns) + uid: excel!Excel.PageLayout#setPrintTitleColumns:member(1) + package: excel! + fullName: setPrintTitleColumns(printTitleColumns) + summary: >- + Sets the columns that contain the cells to be repeated at the left of each + page of the worksheet for printing. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'setPrintTitleColumns(printTitleColumns: Range | string): void;' + parameters: + - id: printTitleColumns + description: >- + The columns to be repeated to the left of each page. The range must + span the entire column to be valid. + type: | string + return: + type: void + description: '' + - name: setPrintTitleRows(printTitleRows) + uid: excel!Excel.PageLayout#setPrintTitleRows:member(1) + package: excel! + fullName: setPrintTitleRows(printTitleRows) + summary: >- + Sets the rows that contain the cells to be repeated at the top of each + page of the worksheet for printing. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-page-layout.yaml + + + await Excel.run(async (context) => { + const farmSheet = context.workbook.worksheets.getItem("Print"); + farmSheet.pageLayout.setPrintTitleRows("$1:$1"); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'setPrintTitleRows(printTitleRows: Range | string): void;' + parameters: + - id: printTitleRows + description: >- + The rows to be repeated at the top of each page. The range must span + the entire row to be valid. + type: | string + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.PageLayout#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.PageLayout` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.PageLayoutData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.PageLayoutData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.pagelayoutmarginoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.pagelayoutmarginoptions.yml new file mode 100644 index 0000000000..5ea40237a7 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.pagelayoutmarginoptions.yml @@ -0,0 +1,116 @@ +### YamlMime:TSType +name: Excel.PageLayoutMarginOptions +uid: excel!Excel.PageLayoutMarginOptions:interface +package: excel! +fullName: Excel.PageLayoutMarginOptions +summary: Represents the options in page layout margins. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: bottom + uid: excel!Excel.PageLayoutMarginOptions#bottom:member + package: excel! + fullName: bottom + summary: >- + Specifies the page layout bottom margin in the unit specified to use for + printing. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'bottom?: number;' + return: + type: number + - name: footer + uid: excel!Excel.PageLayoutMarginOptions#footer:member + package: excel! + fullName: footer + summary: >- + Specifies the page layout footer margin in the unit specified to use for + printing. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'footer?: number;' + return: + type: number + - name: header + uid: excel!Excel.PageLayoutMarginOptions#header:member + package: excel! + fullName: header + summary: >- + Specifies the page layout header margin in the unit specified to use for + printing. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'header?: number;' + return: + type: number + - name: left + uid: excel!Excel.PageLayoutMarginOptions#left:member + package: excel! + fullName: left + summary: >- + Specifies the page layout left margin in the unit specified to use for + printing. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left?: number;' + return: + type: number + - name: right + uid: excel!Excel.PageLayoutMarginOptions#right:member + package: excel! + fullName: right + summary: >- + Specifies the page layout right margin in the unit specified to use for + printing. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'right?: number;' + return: + type: number + - name: top + uid: excel!Excel.PageLayoutMarginOptions#top:member + package: excel! + fullName: top + summary: >- + Specifies the page layout top margin in the unit specified to use for + printing. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.pagelayoutzoomoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.pagelayoutzoomoptions.yml new file mode 100644 index 0000000000..fda2b8c81a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.pagelayoutzoomoptions.yml @@ -0,0 +1,65 @@ +### YamlMime:TSType +name: Excel.PageLayoutZoomOptions +uid: excel!Excel.PageLayoutZoomOptions:interface +package: excel! +fullName: Excel.PageLayoutZoomOptions +summary: Represents page zoom properties. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: horizontalFitToPages + uid: excel!Excel.PageLayoutZoomOptions#horizontalFitToPages:member + package: excel! + fullName: horizontalFitToPages + summary: >- + Number of pages to fit horizontally. This value can be `null` if + percentage scale is used. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'horizontalFitToPages?: number;' + return: + type: number + - name: scale + uid: excel!Excel.PageLayoutZoomOptions#scale:member + package: excel! + fullName: scale + summary: >- + Print page scale value can be between 10 and 400. This value can be `null` + if fit to page tall or wide is specified. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'scale?: number;' + return: + type: number + - name: verticalFitToPages + uid: excel!Excel.PageLayoutZoomOptions#verticalFitToPages:member + package: excel! + fullName: verticalFitToPages + summary: >- + Number of pages to fit vertically. This value can be `null` if percentage + scale is used. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'verticalFitToPages?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.pageorientation.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.pageorientation.yml new file mode 100644 index 0000000000..7b28f3866c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.pageorientation.yml @@ -0,0 +1,45 @@ +### YamlMime:TSEnum +name: Excel.PageOrientation +uid: excel!Excel.PageOrientation:enum +package: excel! +fullName: Excel.PageOrientation +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-page-layout.yaml + + + await Excel.run(async (context) => { + const farmSheet = context.workbook.worksheets.getItem("Print"); + farmSheet.pageLayout.orientation = Excel.PageOrientation.landscape; + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: landscape + uid: excel!Excel.PageOrientation.landscape:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Landscape"' + - name: portrait + uid: excel!Excel.PageOrientation.portrait:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Portrait"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.papertype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.papertype.yml new file mode 100644 index 0000000000..89f7b39e07 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.papertype.yml @@ -0,0 +1,300 @@ +### YamlMime:TSEnum +name: Excel.PaperType +uid: excel!Excel.PaperType:enum +package: excel! +fullName: Excel.PaperType +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: a3 + uid: excel!Excel.PaperType.a3:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"A3"' + - name: a4 + uid: excel!Excel.PaperType.a4:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"A4"' + - name: a4Small + uid: excel!Excel.PaperType.a4Small:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"A4Small"' + - name: a5 + uid: excel!Excel.PaperType.a5:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"A5"' + - name: b4 + uid: excel!Excel.PaperType.b4:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"B4"' + - name: b5 + uid: excel!Excel.PaperType.b5:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"B5"' + - name: csheet + uid: excel!Excel.PaperType.csheet:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Csheet"' + - name: dsheet + uid: excel!Excel.PaperType.dsheet:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Dsheet"' + - name: envelope10 + uid: excel!Excel.PaperType.envelope10:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Envelope10"' + - name: envelope11 + uid: excel!Excel.PaperType.envelope11:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Envelope11"' + - name: envelope12 + uid: excel!Excel.PaperType.envelope12:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Envelope12"' + - name: envelope14 + uid: excel!Excel.PaperType.envelope14:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Envelope14"' + - name: envelope9 + uid: excel!Excel.PaperType.envelope9:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Envelope9"' + - name: envelopeB4 + uid: excel!Excel.PaperType.envelopeB4:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"EnvelopeB4"' + - name: envelopeB5 + uid: excel!Excel.PaperType.envelopeB5:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"EnvelopeB5"' + - name: envelopeB6 + uid: excel!Excel.PaperType.envelopeB6:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"EnvelopeB6"' + - name: envelopeC3 + uid: excel!Excel.PaperType.envelopeC3:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"EnvelopeC3"' + - name: envelopeC4 + uid: excel!Excel.PaperType.envelopeC4:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"EnvelopeC4"' + - name: envelopeC5 + uid: excel!Excel.PaperType.envelopeC5:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"EnvelopeC5"' + - name: envelopeC6 + uid: excel!Excel.PaperType.envelopeC6:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"EnvelopeC6"' + - name: envelopeC65 + uid: excel!Excel.PaperType.envelopeC65:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"EnvelopeC65"' + - name: envelopeDL + uid: excel!Excel.PaperType.envelopeDL:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"EnvelopeDL"' + - name: envelopeItaly + uid: excel!Excel.PaperType.envelopeItaly:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"EnvelopeItaly"' + - name: envelopeMonarch + uid: excel!Excel.PaperType.envelopeMonarch:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"EnvelopeMonarch"' + - name: envelopePersonal + uid: excel!Excel.PaperType.envelopePersonal:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"EnvelopePersonal"' + - name: esheet + uid: excel!Excel.PaperType.esheet:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Esheet"' + - name: executive + uid: excel!Excel.PaperType.executive:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Executive"' + - name: fanfoldLegalGerman + uid: excel!Excel.PaperType.fanfoldLegalGerman:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FanfoldLegalGerman"' + - name: fanfoldStdGerman + uid: excel!Excel.PaperType.fanfoldStdGerman:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FanfoldStdGerman"' + - name: fanfoldUS + uid: excel!Excel.PaperType.fanfoldUS:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FanfoldUS"' + - name: folio + uid: excel!Excel.PaperType.folio:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Folio"' + - name: ledger + uid: excel!Excel.PaperType.ledger:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Ledger"' + - name: legal + uid: excel!Excel.PaperType.legal:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Legal"' + - name: letter + uid: excel!Excel.PaperType.letter:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Letter"' + - name: letterSmall + uid: excel!Excel.PaperType.letterSmall:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LetterSmall"' + - name: note + uid: excel!Excel.PaperType.note:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Note"' + - name: paper10x14 + uid: excel!Excel.PaperType.paper10x14:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Paper10x14"' + - name: paper11x17 + uid: excel!Excel.PaperType.paper11x17:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Paper11x17"' + - name: quatro + uid: excel!Excel.PaperType.quatro:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Quatro"' + - name: statement + uid: excel!Excel.PaperType.statement:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Statement"' + - name: tabloid + uid: excel!Excel.PaperType.tabloid:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Tabloid"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.pictureformat.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.pictureformat.yml new file mode 100644 index 0000000000..d56445c599 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.pictureformat.yml @@ -0,0 +1,93 @@ +### YamlMime:TSEnum +name: Excel.PictureFormat +uid: excel!Excel.PictureFormat:enum +package: excel! +fullName: Excel.PictureFormat +summary: The format of the image. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-images.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Shapes"); + const shape = sheet.shapes.getItem("Image"); + const result = shape.getAsImage(Excel.PictureFormat.png); + await context.sync(); + + const imageString = result.value; + // Your add-in would save this string as a .png file. + console.log("The image's Base64-encoded string: " + imageString); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: bmp + uid: excel!Excel.PictureFormat.bmp:member + package: excel! + summary: >- + Bitmap image. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"BMP"' + - name: gif + uid: excel!Excel.PictureFormat.gif:member + package: excel! + summary: >- + Graphics Interchange Format. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"GIF"' + - name: jpeg + uid: excel!Excel.PictureFormat.jpeg:member + package: excel! + summary: >- + Joint Photographic Experts Group. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"JPEG"' + - name: png + uid: excel!Excel.PictureFormat.png:member + package: excel! + summary: >- + Portable Network Graphics. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"PNG"' + - name: svg + uid: excel!Excel.PictureFormat.svg:member + package: excel! + summary: >- + Scalable Vector Graphic. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"SVG"' + - name: unknown + uid: excel!Excel.PictureFormat.unknown:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"UNKNOWN"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotaxis.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotaxis.yml new file mode 100644 index 0000000000..6349f312b4 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotaxis.yml @@ -0,0 +1,63 @@ +### YamlMime:TSEnum +name: Excel.PivotAxis +uid: excel!Excel.PivotAxis:enum +package: excel! +fullName: Excel.PivotAxis +summary: Represents the axis from which to get the PivotItems. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: column + uid: excel!Excel.PivotAxis.column:member + package: excel! + summary: >- + The column axis. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Column"' + - name: data + uid: excel!Excel.PivotAxis.data:member + package: excel! + summary: >- + The data axis. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Data"' + - name: filter + uid: excel!Excel.PivotAxis.filter:member + package: excel! + summary: >- + The filter axis. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Filter"' + - name: row + uid: excel!Excel.PivotAxis.row:member + package: excel! + summary: >- + The row axis. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Row"' + - name: unknown + uid: excel!Excel.PivotAxis.unknown:member + package: excel! + summary: >- + The axis or region is unknown or unsupported. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Unknown"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotdatefilter.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotdatefilter.yml new file mode 100644 index 0000000000..7d2dea2edb --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotdatefilter.yml @@ -0,0 +1,148 @@ +### YamlMime:TSType +name: Excel.PivotDateFilter +uid: excel!Excel.PivotDateFilter:interface +package: excel! +fullName: Excel.PivotDateFilter +summary: >- + Configurable template for a date filter to apply to a PivotField. The + `condition` defines what criteria need to be set in order for the filter to + operate. +remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: comparator + uid: excel!Excel.PivotDateFilter#comparator:member + package: excel! + fullName: comparator + summary: >- + The comparator is the static value to which other values are compared. The + type of comparison is defined by the condition. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'comparator?: Excel.FilterDatetime;' + return: + type: + - name: condition + uid: excel!Excel.PivotDateFilter#condition:member + package: excel! + fullName: condition + summary: >- + Specifies the condition for the filter, which defines the necessary + filtering criteria. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + condition: Excel.DateFilterCondition | "Unknown" | "Equals" | "Before" | + "BeforeOrEqualTo" | "After" | "AfterOrEqualTo" | "Between" | "Tomorrow" + | "Today" | "Yesterday" | "NextWeek" | "ThisWeek" | "LastWeek" | + "NextMonth" | "ThisMonth" | "LastMonth" | "NextQuarter" | "ThisQuarter" + | "LastQuarter" | "NextYear" | "ThisYear" | "LastYear" | "YearToDate" | + "AllDatesInPeriodQuarter1" | "AllDatesInPeriodQuarter2" | + "AllDatesInPeriodQuarter3" | "AllDatesInPeriodQuarter4" | + "AllDatesInPeriodJanuary" | "AllDatesInPeriodFebruary" | + "AllDatesInPeriodMarch" | "AllDatesInPeriodApril" | + "AllDatesInPeriodMay" | "AllDatesInPeriodJune" | "AllDatesInPeriodJuly" + | "AllDatesInPeriodAugust" | "AllDatesInPeriodSeptember" | + "AllDatesInPeriodOctober" | "AllDatesInPeriodNovember" | + "AllDatesInPeriodDecember"; + return: + type: >- + | "Unknown" | + "Equals" | "Before" | "BeforeOrEqualTo" | "After" | "AfterOrEqualTo" | + "Between" | "Tomorrow" | "Today" | "Yesterday" | "NextWeek" | + "ThisWeek" | "LastWeek" | "NextMonth" | "ThisMonth" | "LastMonth" | + "NextQuarter" | "ThisQuarter" | "LastQuarter" | "NextYear" | + "ThisYear" | "LastYear" | "YearToDate" | "AllDatesInPeriodQuarter1" | + "AllDatesInPeriodQuarter2" | "AllDatesInPeriodQuarter3" | + "AllDatesInPeriodQuarter4" | "AllDatesInPeriodJanuary" | + "AllDatesInPeriodFebruary" | "AllDatesInPeriodMarch" | + "AllDatesInPeriodApril" | "AllDatesInPeriodMay" | + "AllDatesInPeriodJune" | "AllDatesInPeriodJuly" | + "AllDatesInPeriodAugust" | "AllDatesInPeriodSeptember" | + "AllDatesInPeriodOctober" | "AllDatesInPeriodNovember" | + "AllDatesInPeriodDecember" + - name: exclusive + uid: excel!Excel.PivotDateFilter#exclusive:member + package: excel! + fullName: exclusive + summary: >- + If `true`, filter *excludes* items that meet criteria. The + default is `false` (filter to include items that meet criteria). + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'exclusive?: boolean;' + return: + type: boolean + - name: lowerBound + uid: excel!Excel.PivotDateFilter#lowerBound:member + package: excel! + fullName: lowerBound + summary: The lower-bound of the range for the `between` filter condition. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'lowerBound?: Excel.FilterDatetime;' + return: + type: + - name: upperBound + uid: excel!Excel.PivotDateFilter#upperBound:member + package: excel! + fullName: upperBound + summary: The upper-bound of the range for the `between` filter condition. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'upperBound?: Excel.FilterDatetime;' + return: + type: + - name: wholeDays + uid: excel!Excel.PivotDateFilter#wholeDays:member + package: excel! + fullName: wholeDays + summary: >- + For `equals`, `before`, `after`, and `between` + filter conditions, indicates if comparisons should be made as whole days. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'wholeDays?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotfield.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotfield.yml new file mode 100644 index 0000000000..47903fa4a9 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotfield.yml @@ -0,0 +1,556 @@ +### YamlMime:TSType +name: Excel.PivotField +uid: excel!Excel.PivotField:class +package: excel! +fullName: Excel.PivotField +summary: Represents the Excel PivotField. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.PivotField#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: id + uid: excel!Excel.PivotField#id:member + package: excel! + fullName: id + summary: ID of the PivotField. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly id: string;' + return: + type: string + - name: items + uid: excel!Excel.PivotField#items:member + package: excel! + fullName: items + summary: Returns the PivotItems associated with the PivotField. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.PivotItemCollection;' + return: + type: + - name: name + uid: excel!Excel.PivotField#name:member + package: excel! + fullName: name + summary: Name of the PivotField. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name: string;' + return: + type: string + - name: showAllItems + uid: excel!Excel.PivotField#showAllItems:member + package: excel! + fullName: showAllItems + summary: Determines whether to show all items of the PivotField. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showAllItems: boolean;' + return: + type: boolean + - name: subtotals + uid: excel!Excel.PivotField#subtotals:member + package: excel! + fullName: subtotals + summary: Subtotals of the PivotField. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'subtotals: Excel.Subtotals;' + return: + type: +methods: + - name: applyFilter(filter) + uid: excel!Excel.PivotField#applyFilter:member(1) + package: excel! + fullName: applyFilter(filter) + summary: >- + Sets one or more of the field's current PivotFilters and applies them to + the field. If the provided filters are invalid or cannot be applied, an + exception is thrown. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'applyFilter(filter: Excel.PivotFilters): void;' + parameters: + - id: filter + description: >- + A configured specific PivotFilter, or a PivotFilters interface + containing multiple configured filters. + type: + return: + type: void + description: '' + - name: clearAllFilters() + uid: excel!Excel.PivotField#clearAllFilters:member(1) + package: excel! + fullName: clearAllFilters() + summary: >- + Clears all criteria from all of the field's filters. This removes any + active filtering on the field. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotfilters.yaml + + + await Excel.run(async (context) => { + // Clear all the PivotFilters. + + // Get the PivotTable. + const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales"); + pivotTable.hierarchies.load("name"); + await context.sync(); + + // Clear the filters on each PivotField. + pivotTable.hierarchies.items.forEach((hierarchy) => { + hierarchy.fields.getItem(hierarchy.name).clearAllFilters(); + }); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'clearAllFilters(): void;' + return: + type: void + description: '' + - name: clearFilter(filterType) + uid: excel!Excel.PivotField#clearFilter:member(1) + package: excel! + fullName: clearFilter(filterType) + summary: >- + Clears all existing criteria from the field's filter of the given type (if + one is currently applied). + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'clearFilter(filterType: Excel.PivotFilterType): void;' + parameters: + - id: filterType + description: The type of filter on the field of which to clear all criteria. + type: + return: + type: void + description: '' + - name: clearFilter(filterType) + uid: excel!Excel.PivotField#clearFilter:member(2) + package: excel! + fullName: clearFilter(filterType) + summary: >- + Clears all existing criteria from the field's filter of the given type (if + one is currently applied). + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + clearFilter(filterType: "Unknown" | "Value" | "Manual" | "Label" | + "Date"): void; + parameters: + - id: filterType + description: The type of filter on the field of which to clear all criteria. + type: '"Unknown" | "Value" | "Manual" | "Label" | "Date"' + return: + type: void + description: '' + - name: getFilters() + uid: excel!Excel.PivotField#getFilters:member(1) + package: excel! + fullName: getFilters() + summary: Gets all filters currently applied on the field. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getFilters(): OfficeExtension.ClientResult;' + return: + type: >- + <> + description: A PivotFilters interface with all active filters. + - name: isFiltered(filterType) + uid: excel!Excel.PivotField#isFiltered:member(1) + package: excel! + fullName: isFiltered(filterType) + summary: Checks if there are any applied filters on the field. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + isFiltered(filterType?: Excel.PivotFilterType): + OfficeExtension.ClientResult; + parameters: + - id: filterType + description: >- + The filter type to check. If no type is provided, this method will + check if any filter is applied. + type: + return: + type: >- + <boolean> + description: >- + True if the field has a filter of type `filterType` applied. If + `filterType` is not specified, `true` is returned if the field has any + applied filters. + - name: isFiltered(filterType) + uid: excel!Excel.PivotField#isFiltered:member(2) + package: excel! + fullName: isFiltered(filterType) + summary: Checks if there are any applied filters on the field. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + isFiltered(filterType?: "Unknown" | "Value" | "Manual" | "Label" | + "Date"): OfficeExtension.ClientResult; + parameters: + - id: filterType + description: >- + The filter type to check. If no type is provided, this method will + check if any filter is applied. + type: '"Unknown" | "Value" | "Manual" | "Label" | "Date"' + return: + type: >- + <boolean> + description: >- + True if the field has a filter of type `filterType` applied. If + `filterType` is not specified, `true` is returned if the field has any + applied filters. + - name: load(options) + uid: excel!Excel.PivotField#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.PivotFieldLoadOptions): + Excel.PivotField; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.PivotField#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.PivotField;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.PivotField#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.PivotField; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.PivotField#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.PivotFieldUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.PivotField#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.PivotField): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: sortByLabels(sortBy) + uid: excel!Excel.PivotField#sortByLabels:member(1) + package: excel! + fullName: sortByLabels(sortBy) + summary: >- + Sorts the PivotField. If a DataPivotHierarchy is specified, then sort will + be applied based on it, if not sort will be based on the PivotField + itself. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'sortByLabels(sortBy: SortBy): void;' + parameters: + - id: sortBy + description: Specifies if the sorting is done in ascending or descending order. + type: + return: + type: void + description: '' + - name: sortByValues(sortBy, valuesHierarchy, pivotItemScope) + uid: excel!Excel.PivotField#sortByValues:member(1) + package: excel! + fullName: sortByValues(sortBy, valuesHierarchy, pivotItemScope) + summary: >- + Sorts the PivotField by specified values in a given scope. The scope + defines which specific values will be used to sort when there are multiple + values from the same DataPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + sortByValues(sortBy: Excel.SortBy, valuesHierarchy: + Excel.DataPivotHierarchy, pivotItemScope?: Array): + void; + parameters: + - id: sortBy + description: Specifies if the sorting is done in ascending or descending order. + type: + - id: valuesHierarchy + description: >- + Specifies the values hierarchy on the data axis to be used for + sorting. + type: + - id: pivotItemScope + description: >- + The items that should be used for the scope of the sorting. These + will be the items that make up the row or column that you want to + sort on. If a string is used instead of a PivotItem, the string + represents the ID of the PivotItem. If there are no items other than + data hierarchy on the axis you want to sort on, this can be empty. + type: Array< | string> + return: + type: void + description: '' + - name: sortByValues(sortBy, valuesHierarchy, pivotItemScope) + uid: excel!Excel.PivotField#sortByValues:member(2) + package: excel! + fullName: sortByValues(sortBy, valuesHierarchy, pivotItemScope) + summary: >- + Sorts the PivotField by specified values in a given scope. The scope + defines which specific values will be used to sort when there are multiple + values from the same DataPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + sortByValues(sortBy: "Ascending" | "Descending", valuesHierarchy: + Excel.DataPivotHierarchy, pivotItemScope?: Array): + void; + parameters: + - id: sortBy + description: Specifies if the sorting is done in ascending or descending order. + type: '"Ascending" | "Descending"' + - id: valuesHierarchy + description: >- + Specifies the values hierarchy on the data axis to be used for + sorting. + type: + - id: pivotItemScope + description: >- + The items that should be used for the scope of the sorting. These + will be the items that make up the row or column that you want to + sort on. If a string is used instead of a PivotItem, the string + represents the ID of the PivotItem. If there are no items other than + data hierarchy on the axis you want to sort on, this can be empty. + type: Array< | string> + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.PivotField#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.PivotField` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.PivotFieldData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.PivotFieldData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotfieldcollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotfieldcollection.yml new file mode 100644 index 0000000000..3da4d4dcf2 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotfieldcollection.yml @@ -0,0 +1,206 @@ +### YamlMime:TSType +name: Excel.PivotFieldCollection +uid: excel!Excel.PivotFieldCollection:class +package: excel! +fullName: Excel.PivotFieldCollection +summary: >- + Represents a collection of all the PivotFields that are part of a PivotTable's + hierarchy. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.PivotFieldCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: excel!Excel.PivotFieldCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.PivotField[];' + return: + type: [] +methods: + - name: getCount() + uid: excel!Excel.PivotFieldCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Gets the number of pivot fields in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getItem(name) + uid: excel!Excel.PivotFieldCollection#getItem:member(1) + package: excel! + fullName: getItem(name) + summary: Gets a PivotField by its name or ID. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItem(name: string): Excel.PivotField;' + parameters: + - id: name + description: Name of the PivotField to be retrieved. + type: string + return: + type: + description: '' + - name: getItemOrNullObject(name) + uid: excel!Excel.PivotFieldCollection#getItemOrNullObject:member(1) + package: excel! + fullName: getItemOrNullObject(name) + summary: >- + Gets a PivotField by name. If the PivotField does not exist, then this + method returns an object with its `isNullObject` property set to + `true`. For further information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemOrNullObject(name: string): Excel.PivotField;' + parameters: + - id: name + description: Name of the PivotField to be retrieved. + type: string + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.PivotFieldCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.PivotFieldCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): Excel.PivotFieldCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.PivotFieldCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.PivotFieldCollection;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.PivotFieldCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.PivotFieldCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.PivotFieldCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.PivotFieldCollection` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.PivotFieldCollectionData`) that contains an + "items" array with shallow copies of any loaded properties from the + collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.PivotFieldCollectionData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotfilters.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotfilters.yml new file mode 100644 index 0000000000..87c764f8fc --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotfilters.yml @@ -0,0 +1,230 @@ +### YamlMime:TSType +name: Excel.PivotFilters +uid: excel!Excel.PivotFilters:interface +package: excel! +fullName: Excel.PivotFilters +summary: >- + An interface representing all PivotFilters currently applied to a given + PivotField. +remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: dateFilter + uid: excel!Excel.PivotFilters#dateFilter:member + package: excel! + fullName: dateFilter + summary: >- + The PivotField's currently applied date filter. This property is `null` if + no value filter is applied. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotfilters.yaml + + + await Excel.run(async (context) => { + // Add a date-based PivotFilter. + + // Get the PivotTable. + const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales"); + + // PivotFilters can only be applied to PivotHierarchies that are being used for pivoting. + // If it's not already there, add "Date Updated" to the hierarchies. + let dateHierarchy = pivotTable.rowHierarchies.getItemOrNullObject("Date Updated"); + await context.sync(); + if (dateHierarchy.isNullObject) { + dateHierarchy = pivotTable.rowHierarchies.add(pivotTable.hierarchies.getItem("Date Updated")); + } + + // Apply a date filter to filter out anything logged before August. + const filterField = dateHierarchy.fields.getItem("Date Updated"); + const dateFilter = { + condition: Excel.DateFilterCondition.afterOrEqualTo, + comparator: { + date: "2020-08-01", + specificity: Excel.FilterDatetimeSpecificity.month + } + }; + filterField.applyFilter({ dateFilter: dateFilter }); + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'dateFilter?: Excel.PivotDateFilter;' + return: + type: + - name: labelFilter + uid: excel!Excel.PivotFilters#labelFilter:member + package: excel! + fullName: labelFilter + summary: >- + The PivotField's currently applied label filter. This property is `null` + if no value filter is applied. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotfilters.yaml + + + await Excel.run(async (context) => { + // Add a PivotFilter to filter based on the strings of item labels. + + // Get the PivotTable. + const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales"); + + // Get the "Type" field. + const field = pivotTable.hierarchies.getItem("Type").fields.getItem("Type"); + + // Filter out any types that start with "L" ("Lemons" and "Limes" in this case). + const filter: Excel.PivotLabelFilter = { + condition: Excel.LabelFilterCondition.beginsWith, + substring: "L", + exclusive: true + }; + + // Apply the label filter to the field. + field.applyFilter({ labelFilter: filter }); + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'labelFilter?: Excel.PivotLabelFilter;' + return: + type: + - name: manualFilter + uid: excel!Excel.PivotFilters#manualFilter:member + package: excel! + fullName: manualFilter + summary: >- + The PivotField's currently applied manual filter. This property is `null` + if no value filter is applied. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotfilters.yaml + + + await Excel.run(async (context) => { + // Add a PivotFilter to filter on manually-selected items. + + // Get the PivotTable. + const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales"); + + // PivotFilters can only be applied to PivotHierarchies that are being used for pivoting. + // If it's not already there, add "Classification" to the hierarchies. + let classHierarchy = pivotTable.filterHierarchies.getItemOrNullObject("Classification"); + await context.sync(); + if (classHierarchy.isNullObject) { + classHierarchy = pivotTable.filterHierarchies.add(pivotTable.hierarchies.getItem("Classification")); + } + + // Apply a manual filter to include only a specific PivotItem (the string "Organic"). + const filterField = classHierarchy.fields.getItem("Classification"); + const manualFilter = { selectedItems: ["Organic"]}; + filterField.applyFilter({ manualFilter: manualFilter }); + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'manualFilter?: Excel.PivotManualFilter;' + return: + type: + - name: valueFilter + uid: excel!Excel.PivotFilters#valueFilter:member + package: excel! + fullName: valueFilter + summary: >- + The PivotField's currently applied value filter. This property is `null` + if no value filter is applied. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotfilters.yaml + + + await Excel.run(async (context) => { + // Add a PivotFilter to filter on the values correlated with a row. + + // Get the PivotTable. + const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales"); + + // Get the "Farm" field. + const field = pivotTable.hierarchies.getItem("Farm").fields.getItem("Farm"); + + // Filter to only include rows with more than 500 wholesale crates sold. + const filter: Excel.PivotValueFilter = { + condition: Excel.ValueFilterCondition.greaterThan, + comparator: 500, + value: "Sum of Crates Sold Wholesale" + }; + + // Apply the value filter to the field. + field.applyFilter({ valueFilter: filter }); + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'valueFilter?: Excel.PivotValueFilter;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotfiltertopbottomcriterion.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotfiltertopbottomcriterion.yml new file mode 100644 index 0000000000..014cc04630 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotfiltertopbottomcriterion.yml @@ -0,0 +1,62 @@ +### YamlMime:TSEnum +name: Excel.PivotFilterTopBottomCriterion +uid: excel!Excel.PivotFilterTopBottomCriterion:enum +package: excel! +fullName: Excel.PivotFilterTopBottomCriterion +summary: Represents the criteria for the top/bottom values filter. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: bottomItems + uid: excel!Excel.PivotFilterTopBottomCriterion.bottomItems:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"BottomItems"' + - name: bottomPercent + uid: excel!Excel.PivotFilterTopBottomCriterion.bottomPercent:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"BottomPercent"' + - name: bottomSum + uid: excel!Excel.PivotFilterTopBottomCriterion.bottomSum:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"BottomSum"' + - name: invalid + uid: excel!Excel.PivotFilterTopBottomCriterion.invalid:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Invalid"' + - name: topItems + uid: excel!Excel.PivotFilterTopBottomCriterion.topItems:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"TopItems"' + - name: topPercent + uid: excel!Excel.PivotFilterTopBottomCriterion.topPercent:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"TopPercent"' + - name: topSum + uid: excel!Excel.PivotFilterTopBottomCriterion.topSum:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"TopSum"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotfiltertype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotfiltertype.yml new file mode 100644 index 0000000000..993073a373 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotfiltertype.yml @@ -0,0 +1,71 @@ +### YamlMime:TSEnum +name: Excel.PivotFilterType +uid: excel!Excel.PivotFilterType:enum +package: excel! +fullName: Excel.PivotFilterType +summary: A simple enum that represents a type of filter for a PivotField. +remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: date + uid: excel!Excel.PivotFilterType.date:member + package: excel! + summary: >- + Filters PivotItems with a date in place of a label. Note: A PivotField + cannot simultaneously have a label filter and a date filter applied. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Date"' + - name: label + uid: excel!Excel.PivotFilterType.label:member + package: excel! + summary: >- + Filters PivotItems based on their labels. Note: A PivotField cannot + simultaneously have a label filter and a date filter applied. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Label"' + - name: manual + uid: excel!Excel.PivotFilterType.manual:member + package: excel! + summary: >- + Filters specific manually selected PivotItems from the PivotTable. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Manual"' + - name: unknown + uid: excel!Excel.PivotFilterType.unknown:member + package: excel! + summary: >- + `PivotFilterType` is unknown or unsupported. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Unknown"' + - name: value + uid: excel!Excel.PivotFilterType.value:member + package: excel! + summary: >- + Filters based on the value of a PivotItem with respect to a + `DataPivotHierarchy`. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Value"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.pivothierarchy.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivothierarchy.yml new file mode 100644 index 0000000000..550344bce2 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivothierarchy.yml @@ -0,0 +1,263 @@ +### YamlMime:TSType +name: Excel.PivotHierarchy +uid: excel!Excel.PivotHierarchy:class +package: excel! +fullName: Excel.PivotHierarchy +summary: Represents the Excel PivotHierarchy. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.PivotHierarchy#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: fields + uid: excel!Excel.PivotHierarchy#fields:member + package: excel! + fullName: fields + summary: Returns the PivotFields associated with the PivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotfilters.yaml + + + await Excel.run(async (context) => { + // Add a PivotFilter to filter on the values correlated with a row. + + // Get the PivotTable. + const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales"); + + // Get the "Farm" field. + const field = pivotTable.hierarchies.getItem("Farm").fields.getItem("Farm"); + + // Filter to only include rows with more than 500 wholesale crates sold. + const filter: Excel.PivotValueFilter = { + condition: Excel.ValueFilterCondition.greaterThan, + comparator: 500, + value: "Sum of Crates Sold Wholesale" + }; + + // Apply the value filter to the field. + field.applyFilter({ valueFilter: filter }); + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly fields: Excel.PivotFieldCollection;' + return: + type: + - name: id + uid: excel!Excel.PivotHierarchy#id:member + package: excel! + fullName: id + summary: ID of the PivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly id: string;' + return: + type: string + - name: name + uid: excel!Excel.PivotHierarchy#name:member + package: excel! + fullName: name + summary: Name of the PivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name: string;' + return: + type: string +methods: + - name: load(options) + uid: excel!Excel.PivotHierarchy#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.PivotHierarchyLoadOptions): + Excel.PivotHierarchy; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.PivotHierarchy#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.PivotHierarchy;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.PivotHierarchy#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.PivotHierarchy; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.PivotHierarchy#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.PivotHierarchyUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.PivotHierarchy#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.PivotHierarchy): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.PivotHierarchy#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.PivotHierarchy` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.PivotHierarchyData`) that + contains shallow copies of any loaded child properties from the original + object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.PivotHierarchyData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.pivothierarchycollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivothierarchycollection.yml new file mode 100644 index 0000000000..f2989ea5f1 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivothierarchycollection.yml @@ -0,0 +1,206 @@ +### YamlMime:TSType +name: Excel.PivotHierarchyCollection +uid: excel!Excel.PivotHierarchyCollection:class +package: excel! +fullName: Excel.PivotHierarchyCollection +summary: >- + Represents a collection of all the PivotHierarchies that are part of the + PivotTable. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.PivotHierarchyCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: excel!Excel.PivotHierarchyCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.PivotHierarchy[];' + return: + type: [] +methods: + - name: getCount() + uid: excel!Excel.PivotHierarchyCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Gets the number of pivot hierarchies in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getItem(name) + uid: excel!Excel.PivotHierarchyCollection#getItem:member(1) + package: excel! + fullName: getItem(name) + summary: Gets a PivotHierarchy by its name or ID. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItem(name: string): Excel.PivotHierarchy;' + parameters: + - id: name + description: Name of the PivotHierarchy to be retrieved. + type: string + return: + type: + description: '' + - name: getItemOrNullObject(name) + uid: excel!Excel.PivotHierarchyCollection#getItemOrNullObject:member(1) + package: excel! + fullName: getItemOrNullObject(name) + summary: >- + Gets a PivotHierarchy by name. If the PivotHierarchy does not exist, then + this method returns an object with its `isNullObject` property set to + `true`. For further information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemOrNullObject(name: string): Excel.PivotHierarchy;' + parameters: + - id: name + description: Name of the PivotHierarchy to be retrieved. + type: string + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.PivotHierarchyCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.PivotHierarchyCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): Excel.PivotHierarchyCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.PivotHierarchyCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.PivotHierarchyCollection;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.PivotHierarchyCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.PivotHierarchyCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.PivotHierarchyCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.PivotHierarchyCollection` object is an API object, the `toJSON` + method returns a plain JavaScript object (typed as + `Excel.Interfaces.PivotHierarchyCollectionData`) that contains an + "items" array with shallow copies of any loaded properties from the + collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.PivotHierarchyCollectionData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotitem.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotitem.yml new file mode 100644 index 0000000000..ff93ad5bb4 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotitem.yml @@ -0,0 +1,239 @@ +### YamlMime:TSType +name: Excel.PivotItem +uid: excel!Excel.PivotItem:class +package: excel! +fullName: Excel.PivotItem +summary: Represents the Excel PivotItem. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.PivotItem#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: id + uid: excel!Excel.PivotItem#id:member + package: excel! + fullName: id + summary: ID of the PivotItem. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly id: string;' + return: + type: string + - name: isExpanded + uid: excel!Excel.PivotItem#isExpanded:member + package: excel! + fullName: isExpanded + summary: >- + Determines whether the item is expanded to show child items or if it's + collapsed and child items are hidden. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'isExpanded: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.PivotItem#name:member + package: excel! + fullName: name + summary: Name of the PivotItem. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name: string;' + return: + type: string + - name: visible + uid: excel!Excel.PivotItem#visible:member + package: excel! + fullName: visible + summary: Specifies if the PivotItem is visible. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible: boolean;' + return: + type: boolean +methods: + - name: load(options) + uid: excel!Excel.PivotItem#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(options?: Excel.Interfaces.PivotItemLoadOptions): Excel.PivotItem;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.PivotItem#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.PivotItem;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.PivotItem#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.PivotItem; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.PivotItem#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.PivotItemUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.PivotItem#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.PivotItem): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.PivotItem#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.PivotItem` object + is an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Excel.Interfaces.PivotItemData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.PivotItemData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotitemcollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotitemcollection.yml new file mode 100644 index 0000000000..1a87dfb239 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotitemcollection.yml @@ -0,0 +1,206 @@ +### YamlMime:TSType +name: Excel.PivotItemCollection +uid: excel!Excel.PivotItemCollection:class +package: excel! +fullName: Excel.PivotItemCollection +summary: >- + Represents a collection of all the PivotItems related to their parent + PivotField. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.PivotItemCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: excel!Excel.PivotItemCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.PivotItem[];' + return: + type: [] +methods: + - name: getCount() + uid: excel!Excel.PivotItemCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Gets the number of PivotItems in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getItem(name) + uid: excel!Excel.PivotItemCollection#getItem:member(1) + package: excel! + fullName: getItem(name) + summary: Gets a PivotItem by its name or ID. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItem(name: string): Excel.PivotItem;' + parameters: + - id: name + description: Name of the PivotItem to be retrieved. + type: string + return: + type: + description: '' + - name: getItemOrNullObject(name) + uid: excel!Excel.PivotItemCollection#getItemOrNullObject:member(1) + package: excel! + fullName: getItemOrNullObject(name) + summary: >- + Gets a PivotItem by name. If the PivotItem does not exist, then this + method returns an object with its `isNullObject` property set to + `true`. For further information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemOrNullObject(name: string): Excel.PivotItem;' + parameters: + - id: name + description: Name of the PivotItem to be retrieved. + type: string + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.PivotItemCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.PivotItemCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): Excel.PivotItemCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.PivotItemCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.PivotItemCollection;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.PivotItemCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.PivotItemCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.PivotItemCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.PivotItemCollection` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.PivotItemCollectionData`) that contains an + "items" array with shallow copies of any loaded properties from the + collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.PivotItemCollectionData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotlabelfilter.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotlabelfilter.yml new file mode 100644 index 0000000000..b5b1f3f555 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotlabelfilter.yml @@ -0,0 +1,134 @@ +### YamlMime:TSType +name: Excel.PivotLabelFilter +uid: excel!Excel.PivotLabelFilter:interface +package: excel! +fullName: Excel.PivotLabelFilter +summary: >- + Configurable template for a label filter to apply to a PivotField. The + `condition` defines what criteria need to be set in order for the filter to + operate. +remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: comparator + uid: excel!Excel.PivotLabelFilter#comparator:member + package: excel! + fullName: comparator + summary: >- + The comparator is the static value to which other values are compared. The + type of comparison is defined by the condition. Note: A numeric string is + treated as a number when being compared against other numeric strings. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'comparator?: string;' + return: + type: string + - name: condition + uid: excel!Excel.PivotLabelFilter#condition:member + package: excel! + fullName: condition + summary: >- + Specifies the condition for the filter, which defines the necessary + filtering criteria. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + condition: Excel.LabelFilterCondition | "Unknown" | "Equals" | + "BeginsWith" | "EndsWith" | "Contains" | "GreaterThan" | + "GreaterThanOrEqualTo" | "LessThan" | "LessThanOrEqualTo" | "Between"; + return: + type: >- + | "Unknown" | + "Equals" | "BeginsWith" | "EndsWith" | "Contains" | "GreaterThan" | + "GreaterThanOrEqualTo" | "LessThan" | "LessThanOrEqualTo" | "Between" + - name: exclusive + uid: excel!Excel.PivotLabelFilter#exclusive:member + package: excel! + fullName: exclusive + summary: >- + If `true`, filter *excludes* items that meet criteria. The + default is `false` (filter to include items that meet criteria). + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'exclusive?: boolean;' + return: + type: boolean + - name: lowerBound + uid: excel!Excel.PivotLabelFilter#lowerBound:member + package: excel! + fullName: lowerBound + summary: >- + The lower-bound of the range for the `between` filter condition. Note: A + numeric string is treated as a number when being compared against other + numeric strings. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'lowerBound?: string;' + return: + type: string + - name: substring + uid: excel!Excel.PivotLabelFilter#substring:member + package: excel! + fullName: substring + summary: >- + The substring used for the `beginsWith`, `endsWith`, and + `contains` filter conditions. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'substring?: string;' + return: + type: string + - name: upperBound + uid: excel!Excel.PivotLabelFilter#upperBound:member + package: excel! + fullName: upperBound + summary: >- + The upper-bound of the range for the `between` filter condition. Note: A + numeric string is treated as a number when being compared against other + numeric strings. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'upperBound?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotlayout.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotlayout.yml new file mode 100644 index 0000000000..b63de39d7a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotlayout.yml @@ -0,0 +1,982 @@ +### YamlMime:TSType +name: Excel.PivotLayout +uid: excel!Excel.PivotLayout:class +package: excel! +fullName: Excel.PivotLayout +summary: Represents the visual layout of the PivotTable. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: altTextDescription + uid: excel!Excel.PivotLayout#altTextDescription:member + package: excel! + fullName: altTextDescription + summary: >- + The alt text description of the PivotTable. + + + Alt text provides alternative, text-based representations of the + information contained in the PivotTable. This information is useful for + people with vision or cognitive impairments who may not be able to see or + understand the table. A title can be read to a person with a disability + and is used to determine whether they wish to hear the description of the + content. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotlayout.yaml + + + await Excel.run(async (context) => { + // Set the alt text for the displayed PivotTable. + const pivotTable = context.workbook.pivotTables.getItem("Farm Sales"); + const pivotLayout = pivotTable.layout; + + pivotLayout.altTextTitle = "Farm Sales PivotTable"; + pivotLayout.altTextDescription = "A summary of fruit sales. It is pivoted on farm name, and fruit type. The aggregated data is both the sums of crates sold at the farms and the sums of crates sold wholesale."; + console.log("Adding alt text. Check the PivotTable settings to see the changes."); + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'altTextDescription: string;' + return: + type: string + - name: altTextTitle + uid: excel!Excel.PivotLayout#altTextTitle:member + package: excel! + fullName: altTextTitle + summary: >- + The alt text title of the PivotTable. + + + Alt text provides alternative, text-based representations of the + information contained in the PivotTable. This information is useful for + people with vision or cognitive impairments who may not be able to see or + understand the table. A title can be read to a person with a disability + and is used to determine whether they wish to hear the description of the + content. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'altTextTitle: string;' + return: + type: string + - name: autoFormat + uid: excel!Excel.PivotLayout#autoFormat:member + package: excel! + fullName: autoFormat + summary: >- + Specifies if formatting will be automatically formatted when it's + refreshed or when fields are moved. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'autoFormat: boolean;' + return: + type: boolean + - name: context + uid: excel!Excel.PivotLayout#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: emptyCellText + uid: excel!Excel.PivotLayout#emptyCellText:member + package: excel! + fullName: emptyCellText + summary: >- + The text that is automatically filled into any empty cell in the + PivotTable if `fillEmptyCells == true`. Note that this value + persists if `fillEmptyCells` is set to `false`, and that setting + this value does not set that property to `true`. By default, this + is an empty string. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotlayout.yaml + + + await Excel.run(async (context) => { + // Set a default value for an empty cell in the PivotTable. This doesn't include cells left blank by the layout. + const pivotTable = context.workbook.pivotTables.getItem("Farm Sales"); + const pivotLayout = pivotTable.layout; + + pivotLayout.emptyCellText = "--"; + + // Set the text alignment to match the rest of the PivotTable. + pivotLayout.getDataBodyRange().format.horizontalAlignment = Excel.HorizontalAlignment.right; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'emptyCellText: string;' + return: + type: string + - name: enableFieldList + uid: excel!Excel.PivotLayout#enableFieldList:member + package: excel! + fullName: enableFieldList + summary: Specifies if the field list can be shown in the UI. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'enableFieldList: boolean;' + return: + type: boolean + - name: fillEmptyCells + uid: excel!Excel.PivotLayout#fillEmptyCells:member + package: excel! + fullName: fillEmptyCells + summary: >- + Specifies whether empty cells in the PivotTable should be populated with + the `emptyCellText`. Default is `false`. Note that the + value of `emptyCellText` persists when this property is set to `false`. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotlayout.yaml + + + await Excel.run(async (context) => { + // Toggle whether empty cells are filled with a default value. + const pivotTable = context.workbook.pivotTables.getItem("Farm Sales"); + const pivotLayout = pivotTable.layout; + + pivotLayout.load("fillEmptyCells"); + await context.sync(); + + let fillToSet = !pivotLayout.fillEmptyCells; + console.log(`Filling empty cells? - ${fillToSet}`); + + pivotLayout.fillEmptyCells = fillToSet; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'fillEmptyCells: boolean;' + return: + type: boolean + - name: layoutType + uid: excel!Excel.PivotLayout#layoutType:member + package: excel! + fullName: layoutType + summary: >- + This property indicates the PivotLayoutType of all fields on the + PivotTable. If fields have different states, this will be null. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotlayout.yaml + + + await Excel.run(async (context) => { + // Change the PivotLayout.type to a new type. + const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales"); + pivotTable.layout.load("layoutType"); + await context.sync(); + + // Cycle between the three layout types. + if (pivotTable.layout.layoutType === "Compact") { + pivotTable.layout.layoutType = "Outline"; + } else if (pivotTable.layout.layoutType === "Outline") { + pivotTable.layout.layoutType = "Tabular"; + } else { + pivotTable.layout.layoutType = "Compact"; + } + + await context.sync(); + console.log("Pivot layout is now " + pivotTable.layout.layoutType); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'layoutType: Excel.PivotLayoutType | "Compact" | "Tabular" | "Outline";' + return: + type: >- + | "Compact" | + "Tabular" | "Outline" + - name: preserveFormatting + uid: excel!Excel.PivotLayout#preserveFormatting:member + package: excel! + fullName: preserveFormatting + summary: >- + Specifies if formatting is preserved when the report is refreshed or + recalculated by operations such as pivoting, sorting, or changing page + field items. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotlayout.yaml + + + await Excel.run(async (context) => { + // Set whether the PivotTable keeps the established format after it is refreshed and recalculated. + const pivotTable = context.workbook.pivotTables.getItem("Farm Sales"); + const pivotLayout = pivotTable.layout; + + pivotLayout.load("preserveFormatting"); + await context.sync(); + + let preserveFormattingToSet = !pivotLayout.preserveFormatting; + console.log(`Preserve the formatting PivotTable after a refresh? - ${preserveFormattingToSet}`); + + pivotLayout.preserveFormatting = preserveFormattingToSet; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'preserveFormatting: boolean;' + return: + type: boolean + - name: showColumnGrandTotals + uid: excel!Excel.PivotLayout#showColumnGrandTotals:member + package: excel! + fullName: showColumnGrandTotals + summary: Specifies if the PivotTable report shows grand totals for columns. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotlayout.yaml + + + await Excel.run(async (context) => { + // Turn the grand totals on and off for the rows and columns. + const pivotTable = context.workbook.pivotTables.getItem("Farm Sales"); + const pivotLayout = pivotTable.layout; + + pivotLayout.load(["showRowGrandTotals", "showColumnGrandTotals"]); + await context.sync(); + + let showColumnTotals = !pivotLayout.showColumnGrandTotals; + let showRowTotals = !pivotLayout.showRowGrandTotals; + console.log(`Show column grand totals? - ${showColumnTotals}`); + console.log(`Show row grand totals? - ${showRowTotals}`); + + pivotLayout.showColumnGrandTotals = showColumnTotals; + pivotLayout.showRowGrandTotals = showRowTotals; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'showColumnGrandTotals: boolean;' + return: + type: boolean + - name: showFieldHeaders + uid: excel!Excel.PivotLayout#showFieldHeaders:member + package: excel! + fullName: showFieldHeaders + summary: >- + Specifies whether the PivotTable displays field headers (field captions + and filter drop-downs). + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotlayout.yaml + + + await Excel.run(async (context) => { + // Turn the field headers on and off for the row and column hierarchies. + const pivotTable = context.workbook.pivotTables.getItem("Farm Sales"); + const pivotLayout = pivotTable.layout; + pivotLayout.load("showFieldHeaders"); + await context.sync(); + + let showHeaders = !pivotLayout.showFieldHeaders; + console.log(`Show field headers? - ${showHeaders}`); + pivotLayout.showFieldHeaders = showHeaders; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'showFieldHeaders: boolean;' + return: + type: boolean + - name: showRowGrandTotals + uid: excel!Excel.PivotLayout#showRowGrandTotals:member + package: excel! + fullName: showRowGrandTotals + summary: Specifies if the PivotTable report shows grand totals for rows. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotlayout.yaml + + + await Excel.run(async (context) => { + // Turn the grand totals on and off for the rows and columns. + const pivotTable = context.workbook.pivotTables.getItem("Farm Sales"); + const pivotLayout = pivotTable.layout; + + pivotLayout.load(["showRowGrandTotals", "showColumnGrandTotals"]); + await context.sync(); + + let showColumnTotals = !pivotLayout.showColumnGrandTotals; + let showRowTotals = !pivotLayout.showRowGrandTotals; + console.log(`Show column grand totals? - ${showColumnTotals}`); + console.log(`Show row grand totals? - ${showRowTotals}`); + + pivotLayout.showColumnGrandTotals = showColumnTotals; + pivotLayout.showRowGrandTotals = showRowTotals; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'showRowGrandTotals: boolean;' + return: + type: boolean + - name: subtotalLocation + uid: excel!Excel.PivotLayout#subtotalLocation:member + package: excel! + fullName: subtotalLocation + summary: >- + This property indicates the `SubtotalLocationType` of all fields on the + PivotTable. If fields have different states, this will be `null`. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + subtotalLocation: Excel.SubtotalLocationType | "AtTop" | "AtBottom" | + "Off"; + return: + type: >- + | "AtTop" | + "AtBottom" | "Off" +methods: + - name: displayBlankLineAfterEachItem(display) + uid: excel!Excel.PivotLayout#displayBlankLineAfterEachItem:member(1) + package: excel! + fullName: displayBlankLineAfterEachItem(display) + summary: >- + Sets whether or not to display a blank line after each item. This is set + at the global level for the PivotTable and applied to individual + PivotFields. This function overwrites the setting for all fields in the + PivotTable to the value of `display` parameter. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotlayout.yaml + + + await Excel.run(async (context) => { + // Add a blank row after each PivotItem in the row hierarchy. + const pivotTable = context.workbook.pivotTables.getItem("Farm Sales"); + const pivotLayout = pivotTable.layout; + + pivotLayout.displayBlankLineAfterEachItem(true); + console.log("Setting `PivotLayout.displayBlankLineAfterEachItem` to true."); + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'displayBlankLineAfterEachItem(display: boolean): void;' + parameters: + - id: display + description: True turns on the blank-line display setting. False turns it off. + type: boolean + return: + type: void + description: '' + - name: getColumnLabelRange() + uid: excel!Excel.PivotLayout#getColumnLabelRange:member(1) + package: excel! + fullName: getColumnLabelRange() + summary: Returns the range where the PivotTable's column labels reside. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getColumnLabelRange(): Excel.Range;' + return: + type: + description: '' + - name: getDataBodyRange() + uid: excel!Excel.PivotLayout#getDataBodyRange:member(1) + package: excel! + fullName: getDataBodyRange() + summary: Returns the range where the PivotTable's data values reside. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-filters-and-summaries.yaml + + + await Excel.run(async (context) => { + const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales"); + + // The layout controls the ranges used by the PivotTable. + const range = pivotTable.layout.getDataBodyRange(); + + // Get all the data hierarchy totals. + const grandTotalRange = range.getLastRow(); + grandTotalRange.load("address"); + await context.sync(); + + // Use the wholesale and farm sale totals to make a final sum. + const masterTotalRange = context.workbook.worksheets.getActiveWorksheet().getRange("B27:C27"); + masterTotalRange.formulas = [["All Crates", "=SUM(" + grandTotalRange.address + ")"]]; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getDataBodyRange(): Excel.Range;' + return: + type: + description: '' + - name: getDataHierarchy(cell) + uid: excel!Excel.PivotLayout#getDataHierarchy:member(1) + package: excel! + fullName: getDataHierarchy(cell) + summary: >- + Gets the DataHierarchy that is used to calculate the value in a specified + range within the PivotTable. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getDataHierarchy(cell: Range | string): Excel.DataPivotHierarchy;' + parameters: + - id: cell + description: A single cell within the PivotTable data body. + type: | string + return: + type: + description: >- + The DataPivotHierarchy object used to calculate the value in the + specified cell. + - name: getFilterAxisRange() + uid: excel!Excel.PivotLayout#getFilterAxisRange:member(1) + package: excel! + fullName: getFilterAxisRange() + summary: Returns the range of the PivotTable's filter area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getFilterAxisRange(): Excel.Range;' + return: + type: + description: '' + - name: getPivotItems(axis, cell) + uid: excel!Excel.PivotLayout#getPivotItems:member(1) + package: excel! + fullName: getPivotItems(axis, cell) + summary: >- + Gets the PivotItems from an axis that make up the value in a specified + range within the PivotTable. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + getPivotItems(axis: Excel.PivotAxis, cell: Range | string): + Excel.PivotItemCollection; + parameters: + - id: axis + description: >- + The axis from which to get the PivotItems. Must be either "row" or + "column." + type: + - id: cell + description: A single cell within the PivotTable's data body. + type: | string + return: + type: + description: >- + A PivotItemCollection of the PivotItems that are used to calculate the + values in the specified row. + - name: getPivotItems(axis, cell) + uid: excel!Excel.PivotLayout#getPivotItems:member(2) + package: excel! + fullName: getPivotItems(axis, cell) + summary: >- + Gets the PivotItems from an axis that make up the value in a specified + range within the PivotTable. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + getPivotItems(axis: "Unknown" | "Row" | "Column" | "Data" | "Filter", + cell: Range | string): Excel.PivotItemCollection; + parameters: + - id: axis + description: >- + The axis from which to get the PivotItems. Must be either "row" or + "column." + type: '"Unknown" | "Row" | "Column" | "Data" | "Filter"' + - id: cell + description: A single cell within the PivotTable's data body. + type: | string + return: + type: + description: >- + A PivotItemCollection of the PivotItems that are used to calculate the + values in the specified row. + - name: getRange() + uid: excel!Excel.PivotLayout#getRange:member(1) + package: excel! + fullName: getRange() + summary: Returns the range the PivotTable exists on, excluding the filter area. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getRange(): Excel.Range;' + return: + type: + description: '' + - name: getRowLabelRange() + uid: excel!Excel.PivotLayout#getRowLabelRange:member(1) + package: excel! + fullName: getRowLabelRange() + summary: Returns the range where the PivotTable's row labels reside. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getRowLabelRange(): Excel.Range;' + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.PivotLayout#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.PivotLayoutLoadOptions): + Excel.PivotLayout; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.PivotLayout#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.PivotLayout;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.PivotLayout#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.PivotLayout; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: repeatAllItemLabels(repeatLabels) + uid: excel!Excel.PivotLayout#repeatAllItemLabels:member(1) + package: excel! + fullName: repeatAllItemLabels(repeatLabels) + summary: >- + Sets the "repeat all item labels" setting across all fields in the + PivotTable. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotlayout.yaml + + + await Excel.run(async (context) => { + // Repeat the PivotItem labels for each row used by another level of the row hierarchy. + const pivotTable = context.workbook.pivotTables.getItem("Farm Sales"); + const pivotLayout = pivotTable.layout; + + pivotLayout.repeatAllItemLabels(true); + console.log("Setting `PivotLayout.repeatAllItemLabels` to true."); + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'repeatAllItemLabels(repeatLabels: boolean): void;' + parameters: + - id: repeatLabels + description: >- + True turns on the label-repetition display setting. False turns it + off. + type: boolean + return: + type: void + description: '' + - name: set(properties, options) + uid: excel!Excel.PivotLayout#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.PivotLayoutUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.PivotLayout#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.PivotLayout): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: setAutoSortOnCell(cell, sortBy) + uid: excel!Excel.PivotLayout#setAutoSortOnCell:member(1) + package: excel! + fullName: setAutoSortOnCell(cell, sortBy) + summary: >- + Sets the PivotTable to automatically sort using the specified cell to + automatically select all necessary criteria and context. This behaves + identically to applying an autosort from the UI. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'setAutoSortOnCell(cell: Range | string, sortBy: Excel.SortBy): void;' + parameters: + - id: cell + description: >- + A single cell to use get the criteria from for applying the + autosort. + type: | string + - id: sortBy + description: The direction of the sort. + type: + return: + type: void + description: '' + - name: setAutoSortOnCell(cell, sortBy) + uid: excel!Excel.PivotLayout#setAutoSortOnCell:member(2) + package: excel! + fullName: setAutoSortOnCell(cell, sortBy) + summary: >- + Sets the PivotTable to automatically sort using the specified cell to + automatically select all necessary criteria and context. This behaves + identically to applying an autosort from the UI. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + setAutoSortOnCell(cell: Range | string, sortBy: "Ascending" | + "Descending"): void; + parameters: + - id: cell + description: >- + A single cell to use get the criteria from for applying the + autosort. + type: | string + - id: sortBy + description: The direction of the sort. + type: '"Ascending" | "Descending"' + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.PivotLayout#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.PivotLayout` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.PivotLayoutData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.PivotLayoutData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotlayouttype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotlayouttype.yml new file mode 100644 index 0000000000..241161e394 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotlayouttype.yml @@ -0,0 +1,46 @@ +### YamlMime:TSEnum +name: Excel.PivotLayoutType +uid: excel!Excel.PivotLayoutType:enum +package: excel! +fullName: Excel.PivotLayoutType +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: compact + uid: excel!Excel.PivotLayoutType.compact:member + package: excel! + summary: >- + A horizontally compressed form with labels from the next field in the same + column. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Compact"' + - name: outline + uid: excel!Excel.PivotLayoutType.outline:member + package: excel! + summary: >- + Inner fields' items are on same row as outer fields' items and subtotals + are always on the bottom. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Outline"' + - name: tabular + uid: excel!Excel.PivotLayoutType.tabular:member + package: excel! + summary: >- + Inner fields' items are always on a new line relative to the outer fields' + items. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Tabular"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotmanualfilter.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotmanualfilter.yml new file mode 100644 index 0000000000..1addfe5228 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotmanualfilter.yml @@ -0,0 +1,35 @@ +### YamlMime:TSType +name: Excel.PivotManualFilter +uid: excel!Excel.PivotManualFilter:interface +package: excel! +fullName: Excel.PivotManualFilter +summary: >- + Configurable template for a manual filter to apply to a PivotField. The + `condition` defines what criteria need to be set in order for the filter to + operate. +remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: selectedItems + uid: excel!Excel.PivotManualFilter#selectedItems:member + package: excel! + fullName: selectedItems + summary: >- + A list of selected items to manually filter. These must be existing and + valid items from the chosen field. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'selectedItems?: Array;' + return: + type: Array<string | > diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.pivottable.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivottable.yml new file mode 100644 index 0000000000..904159e706 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivottable.yml @@ -0,0 +1,664 @@ +### YamlMime:TSType +name: Excel.PivotTable +uid: excel!Excel.PivotTable:class +package: excel! +fullName: Excel.PivotTable +summary: >- + Represents an Excel PivotTable. To learn more about the PivotTable object + model, read [Work with PivotTables using the Excel JavaScript + API](https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-pivottables). +remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: allowMultipleFiltersPerField + uid: excel!Excel.PivotTable#allowMultipleFiltersPerField:member + package: excel! + fullName: allowMultipleFiltersPerField + summary: >- + Specifies if the PivotTable allows the application of multiple + PivotFilters on a given PivotField in the table. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'allowMultipleFiltersPerField: boolean;' + return: + type: boolean + - name: columnHierarchies + uid: excel!Excel.PivotTable#columnHierarchies:member + package: excel! + fullName: columnHierarchies + summary: The Column Pivot Hierarchies of the PivotTable. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-create-and-modify.yaml + + + await Excel.run(async (context) => { + const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales"); + + // Check if the PivotTable already has a column. + const column = pivotTable.columnHierarchies.getItemOrNullObject("Farm"); + column.load("id"); + await context.sync(); + + if (column.isNullObject) { + // Adding the farm column to the column hierarchy automatically removes it from the row hierarchy. + pivotTable.columnHierarchies.add(pivotTable.hierarchies.getItem("Farm")); + } else { + pivotTable.columnHierarchies.remove(column); + } + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly columnHierarchies: Excel.RowColumnPivotHierarchyCollection;' + return: + type: + - name: context + uid: excel!Excel.PivotTable#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: dataHierarchies + uid: excel!Excel.PivotTable#dataHierarchies:member + package: excel! + fullName: dataHierarchies + summary: The Data Pivot Hierarchies of the PivotTable. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-create-and-modify.yaml + + + await Excel.run(async (context) => { + const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales"); + pivotTable.dataHierarchies.add(pivotTable.hierarchies.getItem("Crates Sold at Farm")); + pivotTable.dataHierarchies.add(pivotTable.hierarchies.getItem("Crates Sold Wholesale")); + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly dataHierarchies: Excel.DataPivotHierarchyCollection;' + return: + type: + - name: enableDataValueEditing + uid: excel!Excel.PivotTable#enableDataValueEditing:member + package: excel! + fullName: enableDataValueEditing + summary: >- + Specifies if the PivotTable allows values in the data body to be edited by + the user. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'enableDataValueEditing: boolean;' + return: + type: boolean + - name: filterHierarchies + uid: excel!Excel.PivotTable#filterHierarchies:member + package: excel! + fullName: filterHierarchies + summary: The Filter Pivot Hierarchies of the PivotTable. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-filters-and-summaries.yaml + + + async function filter(functionType: Excel.AggregationFunction) { + await Excel.run(async (context) => { + const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales"); + const filters = pivotTable.filterHierarchies; + const filter = filters.getItemOrNullObject("Classification"); + filter.load(); + await context.sync(); + + // Add the Classification hierarchy to the filter, if it's not already there. + if (filter.isNullObject) { + filters.add(pivotTable.hierarchies.getItem("Classification")); + await context.sync(); + } + }); + } + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly filterHierarchies: Excel.FilterPivotHierarchyCollection;' + return: + type: + - name: hierarchies + uid: excel!Excel.PivotTable#hierarchies:member + package: excel! + fullName: hierarchies + summary: The Pivot Hierarchies of the PivotTable. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly hierarchies: Excel.PivotHierarchyCollection;' + return: + type: + - name: id + uid: excel!Excel.PivotTable#id:member + package: excel! + fullName: id + summary: ID of the PivotTable. + remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly id: string;' + return: + type: string + - name: layout + uid: excel!Excel.PivotTable#layout:member + package: excel! + fullName: layout + summary: >- + The PivotLayout describing the layout and visual structure of the + PivotTable. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-create-and-modify.yaml + + + await Excel.run(async (context) => { + const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales"); + pivotTable.layout.load("layoutType"); + await context.sync(); + + // Cycle between the three layout types. + if (pivotTable.layout.layoutType === "Compact") { + pivotTable.layout.layoutType = "Outline"; + } else if (pivotTable.layout.layoutType === "Outline") { + pivotTable.layout.layoutType = "Tabular"; + } else { + pivotTable.layout.layoutType = "Compact"; + } + await context.sync(); + console.log("Pivot layout is now " + pivotTable.layout.layoutType); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly layout: Excel.PivotLayout;' + return: + type: + - name: name + uid: excel!Excel.PivotTable#name:member + package: excel! + fullName: name + summary: Name of the PivotTable. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name: string;' + return: + type: string + - name: refreshOnOpen + uid: excel!Excel.PivotTable#refreshOnOpen:member + package: excel! + fullName: refreshOnOpen + summary: >- + Specifies whether the PivotTable refreshes when the workbook opens. + Corresponds to "Refresh on load" setting in the UI. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'refreshOnOpen: boolean;' + return: + type: boolean + - name: rowHierarchies + uid: excel!Excel.PivotTable#rowHierarchies:member + package: excel! + fullName: rowHierarchies + summary: The Row Pivot Hierarchies of the PivotTable. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly rowHierarchies: Excel.RowColumnPivotHierarchyCollection;' + return: + type: + - name: useCustomSortLists + uid: excel!Excel.PivotTable#useCustomSortLists:member + package: excel! + fullName: useCustomSortLists + summary: Specifies if the PivotTable uses custom lists when sorting. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'useCustomSortLists: boolean;' + return: + type: boolean + - name: worksheet + uid: excel!Excel.PivotTable#worksheet:member + package: excel! + fullName: worksheet + summary: The worksheet containing the current PivotTable. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly worksheet: Excel.Worksheet;' + return: + type: +methods: + - name: delete() + uid: excel!Excel.PivotTable#delete:member(1) + package: excel! + fullName: delete() + summary: Deletes the PivotTable. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-create-and-modify.yaml + + + await Excel.run(async (context) => { + context.workbook.worksheets.getItem("Pivot").pivotTables.getItem("Farm Sales").delete(); + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'delete(): void;' + return: + type: void + description: '' + - name: getDataSourceString() + uid: excel!Excel.PivotTable#getDataSourceString:member(1) + package: excel! + fullName: getDataSourceString() + summary: >- + Returns the string representation of the data source for the PivotTable. + This method currently supports string representations for table and range + objects. Otherwise, it returns an empty string. + remarks: >- + \[ [API set: ExcelApi + 1.15](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-source-data.yaml + + + // This function logs information about the data source of a PivotTable. + + await Excel.run(async (context) => { + const worksheet = context.workbook.worksheets.getItem("TotalPivot"); + const pivotTable = worksheet.pivotTables.getItem("All Farm Sales"); + + // Retrieve the type and string representation of the data source of the PivotTable. + const pivotTableDataSourceType = pivotTable.getDataSourceType(); + const pivotTableDataSourceString = pivotTable.getDataSourceString(); + await context.sync(); + + // Log the data source information. + console.log("Data source: " + pivotTableDataSourceString.value); + console.log("Source type: " + pivotTableDataSourceType.value); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getDataSourceString(): OfficeExtension.ClientResult;' + return: + type: <string> + description: '' + - name: getDataSourceType() + uid: excel!Excel.PivotTable#getDataSourceType:member(1) + package: excel! + fullName: getDataSourceType() + summary: Gets the type of the data source for the PivotTable. + remarks: >- + \[ [API set: ExcelApi + 1.15](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-source-data.yaml + + + // This function logs information about the data source of a PivotTable. + + await Excel.run(async (context) => { + const worksheet = context.workbook.worksheets.getItem("TotalPivot"); + const pivotTable = worksheet.pivotTables.getItem("All Farm Sales"); + + // Retrieve the type and string representation of the data source of the PivotTable. + const pivotTableDataSourceType = pivotTable.getDataSourceType(); + const pivotTableDataSourceString = pivotTable.getDataSourceString(); + await context.sync(); + + // Log the data source information. + console.log("Data source: " + pivotTableDataSourceString.value); + console.log("Source type: " + pivotTableDataSourceType.value); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getDataSourceType(): OfficeExtension.ClientResult;' + return: + type: >- + <> + description: '' + - name: load(options) + uid: excel!Excel.PivotTable#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.PivotTableLoadOptions): + Excel.PivotTable; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.PivotTable#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.PivotTable;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.PivotTable#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.PivotTable; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: refresh() + uid: excel!Excel.PivotTable#refresh:member(1) + package: excel! + fullName: refresh() + summary: Refreshes the PivotTable. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-refresh.yaml + + + // This function refreshes the "Farm Sales" PivotTable, + + // which updates the PivotTable with changes made to the source table. + + await Excel.run(async (context) => { + const pivotTable = context.workbook.pivotTables.getItem("Farm Sales"); + pivotTable.refresh(); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'refresh(): void;' + return: + type: void + description: '' + - name: set(properties, options) + uid: excel!Excel.PivotTable#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.PivotTableUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.PivotTable#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.PivotTable): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.PivotTable#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.PivotTable` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.PivotTableData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.PivotTableData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.pivottablecollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivottablecollection.yml new file mode 100644 index 0000000000..7cb0a6e3d2 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivottablecollection.yml @@ -0,0 +1,301 @@ +### YamlMime:TSType +name: Excel.PivotTableCollection +uid: excel!Excel.PivotTableCollection:class +package: excel! +fullName: Excel.PivotTableCollection +summary: >- + Represents a collection of all the PivotTables that are part of the workbook + or worksheet. +remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.PivotTableCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: excel!Excel.PivotTableCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.PivotTable[];' + return: + type: [] +methods: + - name: add(name, source, destination) + uid: excel!Excel.PivotTableCollection#add:member(1) + package: excel! + fullName: add(name, source, destination) + summary: >- + Add a PivotTable based on the specified source data and insert it at the + top-left cell of the destination range. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-create-and-modify.yaml + + + await Excel.run(async (context) => { + const rangeToAnalyze = context.workbook.worksheets.getItem("Data").getRange("A1:E21"); + const rangeToPlacePivot = context.workbook.worksheets.getItem("Pivot").getRange("A2"); + context.workbook.worksheets.getItem("Pivot").pivotTables.add("Farm Sales", rangeToAnalyze, rangeToPlacePivot); + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + add(name: string, source: Range | string | Table, destination: Range | + string): Excel.PivotTable; + parameters: + - id: name + description: The name of the new PivotTable. + type: string + - id: source + description: >- + The source data for the new PivotTable, this can either be a range + (or string address including the worksheet name) or a table. + type: >- + | string | + - id: destination + description: >- + The cell in the upper-left corner of the PivotTable report's + destination range (the range on the worksheet where the resulting + report will be placed). + type: | string + return: + type: + description: Returns the newly inserted PivotTable. + - name: getCount() + uid: excel!Excel.PivotTableCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Gets the number of pivot tables in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getItem(name) + uid: excel!Excel.PivotTableCollection#getItem:member(1) + package: excel! + fullName: getItem(name) + summary: Gets a PivotTable by name. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-refresh.yaml + + + // This function refreshes the "Farm Sales" PivotTable, + + // which updates the PivotTable with changes made to the source table. + + await Excel.run(async (context) => { + const pivotTable = context.workbook.pivotTables.getItem("Farm Sales"); + pivotTable.refresh(); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getItem(name: string): Excel.PivotTable;' + parameters: + - id: name + description: Name of the PivotTable to be retrieved. + type: string + return: + type: + description: '' + - name: getItemOrNullObject(name) + uid: excel!Excel.PivotTableCollection#getItemOrNullObject:member(1) + package: excel! + fullName: getItemOrNullObject(name) + summary: >- + Gets a PivotTable by name. If the PivotTable does not exist, then this + method returns an object with its `isNullObject` property set to + `true`. For further information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemOrNullObject(name: string): Excel.PivotTable;' + parameters: + - id: name + description: Name of the PivotTable to be retrieved. + type: string + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.PivotTableCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.PivotTableCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): Excel.PivotTableCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.PivotTableCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.PivotTableCollection;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.PivotTableCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.PivotTableCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: refreshAll() + uid: excel!Excel.PivotTableCollection#refreshAll:member(1) + package: excel! + fullName: refreshAll() + summary: Refreshes all the pivot tables in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'refreshAll(): void;' + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.PivotTableCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.PivotTableCollection` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.PivotTableCollectionData`) that contains an + "items" array with shallow copies of any loaded properties from the + collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.PivotTableCollectionData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.pivottablescopedcollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivottablescopedcollection.yml new file mode 100644 index 0000000000..ee0f631981 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivottablescopedcollection.yml @@ -0,0 +1,259 @@ +### YamlMime:TSType +name: Excel.PivotTableScopedCollection +uid: excel!Excel.PivotTableScopedCollection:class +package: excel! +fullName: Excel.PivotTableScopedCollection +summary: >- + Represents a scoped collection of PivotTables. The PivotTables are sorted + based on the location of the PivotTable's top-left corner. They are ordered + top-to-bottom and then left-to-right. +remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.PivotTableScopedCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: excel!Excel.PivotTableScopedCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.PivotTable[];' + return: + type: [] +methods: + - name: getCount() + uid: excel!Excel.PivotTableScopedCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Gets the number of PivotTables in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getFirst() + uid: excel!Excel.PivotTableScopedCollection#getFirst:member(1) + package: excel! + fullName: getFirst() + summary: >- + Gets the first PivotTable in the collection. The PivotTables in the + collection are sorted top-to-bottom and left-to-right, such that top-left + table is the first PivotTable in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getFirst(): Excel.PivotTable;' + return: + type: + description: '' + - name: getFirstOrNullObject() + uid: excel!Excel.PivotTableScopedCollection#getFirstOrNullObject:member(1) + package: excel! + fullName: getFirstOrNullObject() + summary: >- + Gets the first PivotTable in the collection. The PivotTables in the + collection are sorted top-to-bottom and left-to-right, such that the + top-left table is the first PivotTable in the collection. If the + collection is empty, then this method returns an object with its + `isNullObject` property set to `true`. For further information, + see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.15](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getFirstOrNullObject(): Excel.PivotTable;' + return: + type: + description: '' + - name: getItem(key) + uid: excel!Excel.PivotTableScopedCollection#getItem:member(1) + package: excel! + fullName: getItem(key) + summary: Gets a PivotTable by name. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItem(key: string): Excel.PivotTable;' + parameters: + - id: key + description: Name of the PivotTable to be retrieved. + type: string + return: + type: + description: '' + - name: getItemOrNullObject(name) + uid: excel!Excel.PivotTableScopedCollection#getItemOrNullObject:member(1) + package: excel! + fullName: getItemOrNullObject(name) + summary: >- + Gets a PivotTable by name. If the PivotTable does not exist, then this + method returns an object with its `isNullObject` property set to + `true`. For further information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemOrNullObject(name: string): Excel.PivotTable;' + parameters: + - id: name + description: Name of the PivotTable to be retrieved. + type: string + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.PivotTableScopedCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.PivotTableScopedCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): + Excel.PivotTableScopedCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.PivotTableScopedCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNames?: string | string[]): + Excel.PivotTableScopedCollection; + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.PivotTableScopedCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.PivotTableScopedCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.PivotTableScopedCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.PivotTableScopedCollection` object is an API object, the `toJSON` + method returns a plain JavaScript object (typed as + `Excel.Interfaces.PivotTableScopedCollectionData`) that contains + an "items" array with shallow copies of any loaded properties from the + collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.PivotTableScopedCollectionData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.pivottablestyle.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivottablestyle.yml new file mode 100644 index 0000000000..e93dac292f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivottablestyle.yml @@ -0,0 +1,256 @@ +### YamlMime:TSType +name: Excel.PivotTableStyle +uid: excel!Excel.PivotTableStyle:class +package: excel! +fullName: Excel.PivotTableStyle +summary: >- + Represents a PivotTable style, which defines style elements by PivotTable + region. +remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.PivotTableStyle#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: name + uid: excel!Excel.PivotTableStyle#name:member + package: excel! + fullName: name + summary: Specifies the name of the PivotTable style. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name: string;' + return: + type: string + - name: readOnly + uid: excel!Excel.PivotTableStyle#readOnly:member + package: excel! + fullName: readOnly + summary: Specifies if this `PivotTableStyle` object is read-only. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly readOnly: boolean;' + return: + type: boolean +methods: + - name: delete() + uid: excel!Excel.PivotTableStyle#delete:member(1) + package: excel! + fullName: delete() + summary: Deletes the PivotTable style. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'delete(): void;' + return: + type: void + description: '' + - name: duplicate() + uid: excel!Excel.PivotTableStyle#duplicate:member(1) + package: excel! + fullName: duplicate() + summary: >- + Creates a duplicate of this PivotTable style with copies of all the style + elements. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'duplicate(): Excel.PivotTableStyle;' + return: + type: + description: >- + The new `PivotTableStyle` object that has been duplicated from this + PivotTable style. + - name: load(options) + uid: excel!Excel.PivotTableStyle#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.PivotTableStyleLoadOptions): + Excel.PivotTableStyle; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.PivotTableStyle#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.PivotTableStyle;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.PivotTableStyle#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.PivotTableStyle; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.PivotTableStyle#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.PivotTableStyleUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.PivotTableStyle#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.PivotTableStyle): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.PivotTableStyle#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.PivotTableStyle` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.PivotTableStyleData`) that + contains shallow copies of any loaded child properties from the original + object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.PivotTableStyleData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.pivottablestylecollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivottablestylecollection.yml new file mode 100644 index 0000000000..3340d7ae34 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivottablestylecollection.yml @@ -0,0 +1,281 @@ +### YamlMime:TSType +name: Excel.PivotTableStyleCollection +uid: excel!Excel.PivotTableStyleCollection:class +package: excel! +fullName: Excel.PivotTableStyleCollection +summary: Represents a collection of PivotTable styles. +remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.PivotTableStyleCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: excel!Excel.PivotTableStyleCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.PivotTableStyle[];' + return: + type: [] +methods: + - name: add(name, makeUniqueName) + uid: excel!Excel.PivotTableStyleCollection#add:member(1) + package: excel! + fullName: add(name, makeUniqueName) + summary: Creates a blank `PivotTableStyle` with the specified name. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'add(name: string, makeUniqueName?: boolean): Excel.PivotTableStyle;' + parameters: + - id: name + description: >- + The unique name for the new PivotTable style. Will throw an + `InvalidArgument` error if the name is already in use. + type: string + - id: makeUniqueName + description: >- + Optional. Defaults to `false`. If `true`, will + append numbers to the name in order to make it unique, if needed. + type: boolean + return: + type: + description: The newly created `PivotTableStyle`. + - name: getCount() + uid: excel!Excel.PivotTableStyleCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Gets the number of PivotTable styles in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getDefault() + uid: excel!Excel.PivotTableStyleCollection#getDefault:member(1) + package: excel! + fullName: getDefault() + summary: Gets the default PivotTable style for the parent object's scope. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getDefault(): Excel.PivotTableStyle;' + return: + type: + description: >- + The `PivotTableStyle` object that is the current default PivotTable + style. + - name: getItem(name) + uid: excel!Excel.PivotTableStyleCollection#getItem:member(1) + package: excel! + fullName: getItem(name) + summary: Gets a `PivotTableStyle` by name. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItem(name: string): Excel.PivotTableStyle;' + parameters: + - id: name + description: Name of the PivotTable style to be retrieved. + type: string + return: + type: + description: The `PivotTableStyle` object whose name matches the input. + - name: getItemOrNullObject(name) + uid: excel!Excel.PivotTableStyleCollection#getItemOrNullObject:member(1) + package: excel! + fullName: getItemOrNullObject(name) + summary: >- + Gets a `PivotTableStyle` by name. If the `PivotTableStyle` does not exist, + then this method returns an object with its `isNullObject` property set to + `true`. For further information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemOrNullObject(name: string): Excel.PivotTableStyle;' + parameters: + - id: name + description: Name of the PivotTable style to be retrieved. + type: string + return: + type: + description: The `PivotTableStyle` object whose name matches the input. + - name: load(options) + uid: excel!Excel.PivotTableStyleCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.PivotTableStyleCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): + Excel.PivotTableStyleCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.PivotTableStyleCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNames?: string | string[]): + Excel.PivotTableStyleCollection; + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.PivotTableStyleCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.PivotTableStyleCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: setDefault(newDefaultStyle) + uid: excel!Excel.PivotTableStyleCollection#setDefault:member(1) + package: excel! + fullName: setDefault(newDefaultStyle) + summary: Sets the default PivotTable style for use in the parent object's scope. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'setDefault(newDefaultStyle: PivotTableStyle | string): void;' + parameters: + - id: newDefaultStyle + description: >- + The `PivotTableStyle` object, or name of the `PivotTableStyle` + object, that should be the new default. + type: | string + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.PivotTableStyleCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.PivotTableStyleCollection` object is an API object, the `toJSON` + method returns a plain JavaScript object (typed as + `Excel.Interfaces.PivotTableStyleCollectionData`) that contains an + "items" array with shallow copies of any loaded properties from the + collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.PivotTableStyleCollectionData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotvaluefilter.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotvaluefilter.yml new file mode 100644 index 0000000000..d16f25866a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.pivotvaluefilter.yml @@ -0,0 +1,167 @@ +### YamlMime:TSType +name: Excel.PivotValueFilter +uid: excel!Excel.PivotValueFilter:interface +package: excel! +fullName: Excel.PivotValueFilter +summary: >- + Configurable template for a value filter to apply to a PivotField. The + `condition` defines what criteria need to be set in order for the filter to + operate. +remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: comparator + uid: excel!Excel.PivotValueFilter#comparator:member + package: excel! + fullName: comparator + summary: >- + The comparator is the static value to which other values are compared. The + type of comparison is defined by the condition. For example, if comparator + is "50" and condition is "greaterThan", all item values that are not + greater than 50 will be removed by the filter. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'comparator?: number;' + return: + type: number + - name: condition + uid: excel!Excel.PivotValueFilter#condition:member + package: excel! + fullName: condition + summary: >- + Specifies the condition for the filter, which defines the necessary + filtering criteria. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + condition: Excel.ValueFilterCondition | "Unknown" | "Equals" | + "GreaterThan" | "GreaterThanOrEqualTo" | "LessThan" | + "LessThanOrEqualTo" | "Between" | "TopN" | "BottomN"; + return: + type: >- + | "Unknown" | + "Equals" | "GreaterThan" | "GreaterThanOrEqualTo" | "LessThan" | + "LessThanOrEqualTo" | "Between" | "TopN" | "BottomN" + - name: exclusive + uid: excel!Excel.PivotValueFilter#exclusive:member + package: excel! + fullName: exclusive + summary: >- + If `true`, filter *excludes* items that meet criteria. The + default is `false` (filter to include items that meet criteria). + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'exclusive?: boolean;' + return: + type: boolean + - name: lowerBound + uid: excel!Excel.PivotValueFilter#lowerBound:member + package: excel! + fullName: lowerBound + summary: The lower-bound of the range for the `between` filter condition. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'lowerBound?: number;' + return: + type: number + - name: selectionType + uid: excel!Excel.PivotValueFilter#selectionType:member + package: excel! + fullName: selectionType + summary: >- + Specifies if the filter is for the top/bottom N items, top/bottom N + percent, or top/bottom N sum. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + selectionType?: Excel.TopBottomSelectionType | "Items" | "Percent" | + "Sum"; + return: + type: >- + | "Items" | + "Percent" | "Sum" + - name: threshold + uid: excel!Excel.PivotValueFilter#threshold:member + package: excel! + fullName: threshold + summary: >- + The "N" threshold number of items, percent, or sum to be filtered for a + top/bottom filter condition. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'threshold?: number;' + return: + type: number + - name: upperBound + uid: excel!Excel.PivotValueFilter#upperBound:member + package: excel! + fullName: upperBound + summary: The upper-bound of the range for the `between` filter condition. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'upperBound?: number;' + return: + type: number + - name: value + uid: excel!Excel.PivotValueFilter#value:member + package: excel! + fullName: value + summary: Name of the chosen "value" in the field by which to filter. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'value: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.placeholdererrorcellvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.placeholdererrorcellvalue.yml new file mode 100644 index 0000000000..a84952d225 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.placeholdererrorcellvalue.yml @@ -0,0 +1,111 @@ +### YamlMime:TSType +name: Excel.PlaceholderErrorCellValue +uid: excel!Excel.PlaceholderErrorCellValue:interface +package: excel! +fullName: Excel.PlaceholderErrorCellValue +summary: >- + Represents the value of a cell containing a \#BUSY! error. This type of error + is used as a placeholder while the value of a cell is downloaded. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: basicType + uid: excel!Excel.PlaceholderErrorCellValue#basicType:member + package: excel! + fullName: basicType + summary: >- + Represents the value that would be returned by `Range.valueTypes` for a + cell with this value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicType?: RangeValueType.error | "Error";' + return: + type: | "Error" + - name: basicValue + uid: excel!Excel.PlaceholderErrorCellValue#basicValue:member + package: excel! + fullName: basicValue + summary: >- + Represents the value that would be returned by `Range.values` for a cell + with this value. When accessed through a `valuesAsJson` property, this + string value aligns with the en-US locale. When accessed through a + `valuesAsJsonLocal` property, this string value aligns with the user's + display locale. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicValue?: "#BUSY!" | string;' + return: + type: '"#BUSY!" | string' + - name: errorType + uid: excel!Excel.PlaceholderErrorCellValue#errorType:member + package: excel! + fullName: errorType + summary: Represents the type of `ErrorCellValue`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'errorType?: ErrorCellValueType.placeholder | "Placeholder";' + return: + type: >- + | + "Placeholder" + - name: target + uid: excel!Excel.PlaceholderErrorCellValue#target:member + package: excel! + fullName: target + summary: >- + `PlaceholderErrorCellValue` is used during processing, while data is + downloaded. The `target` property represents the data that is downloading, + the data for which the `PlaceholderErrorCellValue` object is a + placeholder. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'target: LinkedEntityCellValue | WebImageCellValue;' + return: + type: >- + | + - name: type + uid: excel!Excel.PlaceholderErrorCellValue#type:member + package: excel! + fullName: type + summary: Represents the type of this cell value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: CellValueType.error | "Error";' + return: + type: | "Error" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.placement.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.placement.yml new file mode 100644 index 0000000000..ea0bbb2a30 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.placement.yml @@ -0,0 +1,43 @@ +### YamlMime:TSEnum +name: Excel.Placement +uid: excel!Excel.Placement:enum +package: excel! +fullName: Excel.Placement +summary: Specifies the way that an object is attached to its underlying cells. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: absolute + uid: excel!Excel.Placement.absolute:member + package: excel! + summary: >- + The object is free floating. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Absolute"' + - name: oneCell + uid: excel!Excel.Placement.oneCell:member + package: excel! + summary: >- + The object is moved with the cells. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"OneCell"' + - name: twoCell + uid: excel!Excel.Placement.twoCell:member + package: excel! + summary: >- + The object is moved and sized with the cells. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"TwoCell"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.presetcriteriaconditionalformat.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.presetcriteriaconditionalformat.yml new file mode 100644 index 0000000000..fc3444e3ce --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.presetcriteriaconditionalformat.yml @@ -0,0 +1,250 @@ +### YamlMime:TSType +name: Excel.PresetCriteriaConditionalFormat +uid: excel!Excel.PresetCriteriaConditionalFormat:class +package: excel! +fullName: Excel.PresetCriteriaConditionalFormat +summary: >- + Represents the preset criteria conditional format such as above average, below + average, unique values, contains blank, nonblank, error, and noerror. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.PresetCriteriaConditionalFormat#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: format + uid: excel!Excel.PresetCriteriaConditionalFormat#format:member + package: excel! + fullName: format + summary: >- + Returns a format object, encapsulating the conditional formats font, fill, + borders, and other properties. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly format: Excel.ConditionalRangeFormat;' + return: + type: + - name: rule + uid: excel!Excel.PresetCriteriaConditionalFormat#rule:member + package: excel! + fullName: rule + summary: The rule of the conditional format. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const range = sheet.getRange("B2:M5"); + const conditionalFormat = range.conditionalFormats + .add(Excel.ConditionalFormatType.presetCriteria); + conditionalFormat.preset.format.font.color = "white"; + conditionalFormat.preset.rule = { criterion: Excel.ConditionalFormatPresetCriterion.oneStdDevAboveAverage }; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'rule: Excel.ConditionalPresetCriteriaRule;' + return: + type: +methods: + - name: load(options) + uid: excel!Excel.PresetCriteriaConditionalFormat#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: + Excel.Interfaces.PresetCriteriaConditionalFormatLoadOptions): + Excel.PresetCriteriaConditionalFormat; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.PresetCriteriaConditionalFormat#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNames?: string | string[]): + Excel.PresetCriteriaConditionalFormat; + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.PresetCriteriaConditionalFormat#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.PresetCriteriaConditionalFormat; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.PresetCriteriaConditionalFormat#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.PresetCriteriaConditionalFormatUpdateData, + options?: OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.PresetCriteriaConditionalFormat#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.PresetCriteriaConditionalFormat): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.PresetCriteriaConditionalFormat#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.PresetCriteriaConditionalFormat` object is an API object, the + `toJSON` method returns a plain JavaScript object (typed as + `Excel.Interfaces.PresetCriteriaConditionalFormatData`) that + contains shallow copies of any loaded child properties from the original + object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.PresetCriteriaConditionalFormatData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.printcomments.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.printcomments.yml new file mode 100644 index 0000000000..4b2afa7e7b --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.printcomments.yml @@ -0,0 +1,43 @@ +### YamlMime:TSEnum +name: Excel.PrintComments +uid: excel!Excel.PrintComments:enum +package: excel! +fullName: Excel.PrintComments +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: endSheet + uid: excel!Excel.PrintComments.endSheet:member + package: excel! + summary: >- + Comments will be printed as end notes at the end of the worksheet. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"EndSheet"' + - name: inPlace + uid: excel!Excel.PrintComments.inPlace:member + package: excel! + summary: >- + Comments will be printed where they were inserted in the worksheet. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"InPlace"' + - name: noComments + uid: excel!Excel.PrintComments.noComments:member + package: excel! + summary: >- + Comments will not be printed. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"NoComments"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.printerrortype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.printerrortype.yml new file mode 100644 index 0000000000..f3048d58e9 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.printerrortype.yml @@ -0,0 +1,41 @@ +### YamlMime:TSEnum +name: Excel.PrintErrorType +uid: excel!Excel.PrintErrorType:enum +package: excel! +fullName: Excel.PrintErrorType +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: asDisplayed + uid: excel!Excel.PrintErrorType.asDisplayed:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"AsDisplayed"' + - name: blank + uid: excel!Excel.PrintErrorType.blank:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Blank"' + - name: dash + uid: excel!Excel.PrintErrorType.dash:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Dash"' + - name: notAvailable + uid: excel!Excel.PrintErrorType.notAvailable:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"NotAvailable"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.printmarginunit.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.printmarginunit.yml new file mode 100644 index 0000000000..8139b50018 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.printmarginunit.yml @@ -0,0 +1,43 @@ +### YamlMime:TSEnum +name: Excel.PrintMarginUnit +uid: excel!Excel.PrintMarginUnit:enum +package: excel! +fullName: Excel.PrintMarginUnit +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: centimeters + uid: excel!Excel.PrintMarginUnit.centimeters:member + package: excel! + summary: >- + Assign the page margins in centimeters. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Centimeters"' + - name: inches + uid: excel!Excel.PrintMarginUnit.inches:member + package: excel! + summary: >- + Assign the page margins in inches. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Inches"' + - name: points + uid: excel!Excel.PrintMarginUnit.points:member + package: excel! + summary: >- + Assign the page margins in points. A point is 1/72 of an inch. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Points"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.printorder.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.printorder.yml new file mode 100644 index 0000000000..3809d88b8e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.printorder.yml @@ -0,0 +1,35 @@ +### YamlMime:TSEnum +name: Excel.PrintOrder +uid: excel!Excel.PrintOrder:enum +package: excel! +fullName: Excel.PrintOrder +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: downThenOver + uid: excel!Excel.PrintOrder.downThenOver:member + package: excel! + summary: >- + Process down the rows before processing across pages or page fields to the + right. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"DownThenOver"' + - name: overThenDown + uid: excel!Excel.PrintOrder.overThenDown:member + package: excel! + summary: >- + Process across pages or page fields to the right before moving down the + rows. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"OverThenDown"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.protectionselectionmode.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.protectionselectionmode.yml new file mode 100644 index 0000000000..2dd3b46623 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.protectionselectionmode.yml @@ -0,0 +1,43 @@ +### YamlMime:TSEnum +name: Excel.ProtectionSelectionMode +uid: excel!Excel.ProtectionSelectionMode:enum +package: excel! +fullName: Excel.ProtectionSelectionMode +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: none + uid: excel!Excel.ProtectionSelectionMode.none:member + package: excel! + summary: >- + Selection is not allowed for any cells. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"None"' + - name: normal + uid: excel!Excel.ProtectionSelectionMode.normal:member + package: excel! + summary: >- + Selection is allowed for all cells. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Normal"' + - name: unlocked + uid: excel!Excel.ProtectionSelectionMode.unlocked:member + package: excel! + summary: >- + Selection is allowed only for cells that are not locked. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Unlocked"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.query.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.query.yml new file mode 100644 index 0000000000..719c8c5c46 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.query.yml @@ -0,0 +1,305 @@ +### YamlMime:TSType +name: Excel.Query +uid: excel!Excel.Query:class +package: excel! +fullName: Excel.Query +summary: Represents a Power Query query. +remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.Query#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: error + uid: excel!Excel.Query#error:member + package: excel! + fullName: error + summary: Gets the query error message from when the query was last refreshed. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly error: Excel.QueryError | "Unknown" | "None" | + "FailedLoadToWorksheet" | "FailedLoadToDataModel" | "FailedDownload" | + "FailedToCompleteDownload"; + return: + type: >- + | "Unknown" | "None" | + "FailedLoadToWorksheet" | "FailedLoadToDataModel" | "FailedDownload" | + "FailedToCompleteDownload" + - name: loadedTo + uid: excel!Excel.Query#loadedTo:member + package: excel! + fullName: loadedTo + summary: Gets the query loaded to object type. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly loadedTo: Excel.LoadToType | "ConnectionOnly" | "Table" | + "PivotTable" | "PivotChart"; + return: + type: >- + | "ConnectionOnly" | + "Table" | "PivotTable" | "PivotChart" + - name: loadedToDataModel + uid: excel!Excel.Query#loadedToDataModel:member + package: excel! + fullName: loadedToDataModel + summary: Specifies if the query loaded to the data model. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly loadedToDataModel: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Query#name:member + package: excel! + fullName: name + summary: >- + Gets the name of the query. Query names cannot contain periods or + quotation marks. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // This function retrieves the query collection in a workbook, + + // loads the query items in that collection, and then + + // logs the name of each query to the console. + + await Excel.run(async (context) => { + const queries = context.workbook.queries; + queries.load("items"); + await context.sync(); + + console.log("Name of each query: ") + console.log(" " + queries.items.map((query) => query.name).join("\n ")); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly name: string;' + return: + type: string + - name: refreshDate + uid: excel!Excel.Query#refreshDate:member + package: excel! + fullName: refreshDate + summary: Gets the date and time when the query was last refreshed. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // This function retrieves the query collection in a workbook, + + // loads the query items in that collection, and then + + // logs the last refresh date of each query to the console. + + await Excel.run(async (context) => { + const queries = context.workbook.queries; + queries.load("items"); + await context.sync(); + + console.log("Last refresh date of each query: ") + console.log(" " + queries.items.map((query) => query.refreshDate).join("\n ")); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly refreshDate: Date;' + return: + type: Date + - name: rowsLoadedCount + uid: excel!Excel.Query#rowsLoadedCount:member + package: excel! + fullName: rowsLoadedCount + summary: >- + Gets the number of rows that were loaded when the query was last + refreshed. If last refresh has errors the value will be -1. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // This function retrieves the query collection in a workbook, + + // loads the query items in that collection, and then + + // logs the number of rows loaded in each query. + + await Excel.run(async (context) => { + const queries = context.workbook.queries; + queries.load("items"); + await context.sync(); + + console.log("Rows loaded from each query: ") + console.log(" " + queries.items.map((query) => query.rowsLoadedCount).join("\n ")); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly rowsLoadedCount: number;' + return: + type: number +methods: + - name: load(options) + uid: excel!Excel.Query#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(options?: Excel.Interfaces.QueryLoadOptions): Excel.Query;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.Query#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.Query;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.Query#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.Query; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.Query#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.Query` object is + an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Excel.Interfaces.QueryData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.QueryData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.querycollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.querycollection.yml new file mode 100644 index 0000000000..b15eac3d9a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.querycollection.yml @@ -0,0 +1,218 @@ +### YamlMime:TSType +name: Excel.QueryCollection +uid: excel!Excel.QueryCollection:class +package: excel! +fullName: Excel.QueryCollection +summary: Represents the collection of queries in the workbook. +remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.QueryCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: excel!Excel.QueryCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.Query[];' + return: + type: [] + description: |- + + + #### Examples + + ```TypeScript + // This function retrieves the query collection in a workbook, + // loads the query items in that collection, and then + // logs the name of each query to the console. + await Excel.run(async (context) => { + const queries = context.workbook.queries; + queries.load("items"); + await context.sync(); + + console.log("Name of each query: ") + console.log(" " + queries.items.map((query) => query.name).join("\n ")); + }); + ``` +methods: + - name: getCount() + uid: excel!Excel.QueryCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Gets the number of queries in the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // This function retrieves the query collection in a workbook and then + + // logs the number of queries in the collection to the console. + + await Excel.run(async (context) => { + const queries = context.workbook.queries; + const count = queries.getCount(); + await context.sync(); + + console.log("Query count: " + count.value); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getItem(key) + uid: excel!Excel.QueryCollection#getItem:member(1) + package: excel! + fullName: getItem(key) + summary: Gets a query from the collection based on its name. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItem(key: string): Excel.Query;' + parameters: + - id: key + description: The name of the query case-insensitive. + type: string + return: + type: + description: >- + The query with the given name. If there is no query by that name, then + an error is thrown. + - name: load(options) + uid: excel!Excel.QueryCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.QueryCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): Excel.QueryCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.QueryCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.QueryCollection;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.QueryCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.QueryCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.QueryCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.QueryCollection` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.QueryCollectionData`) that + contains an "items" array with shallow copies of any loaded properties + from the collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.QueryCollectionData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.queryerror.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.queryerror.yml new file mode 100644 index 0000000000..4c45b4c94d --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.queryerror.yml @@ -0,0 +1,79 @@ +### YamlMime:TSEnum +name: Excel.QueryError +uid: excel!Excel.QueryError:enum +package: excel! +fullName: Excel.QueryError +summary: An enum that specifies the query load error message. +remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: failedDownload + uid: excel!Excel.QueryError.failedDownload:member + package: excel! + summary: >- + Download failed. + + + * \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"FailedDownload"' + - name: failedLoadToDataModel + uid: excel!Excel.QueryError.failedLoadToDataModel:member + package: excel! + summary: >- + Load to the data model failed. + + + * \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"FailedLoadToDataModel"' + - name: failedLoadToWorksheet + uid: excel!Excel.QueryError.failedLoadToWorksheet:member + package: excel! + summary: >- + Load to the worksheet failed. + + + * \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"FailedLoadToWorksheet"' + - name: failedToCompleteDownload + uid: excel!Excel.QueryError.failedToCompleteDownload:member + package: excel! + summary: >- + Download did not complete. + + + * \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"FailedToCompleteDownload"' + - name: none + uid: excel!Excel.QueryError.none:member + package: excel! + summary: >- + No error. + + + * \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"None"' + - name: unknown + uid: excel!Excel.QueryError.unknown:member + package: excel! + summary: >- + Unknown error. + + + * \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Unknown"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.range.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.range.yml new file mode 100644 index 0000000000..1fa17ecebd --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.range.yml @@ -0,0 +1,4468 @@ +### YamlMime:TSType +name: Excel.Range +uid: excel!Excel.Range:class +package: excel! +fullName: Excel.Range +summary: >- + Range represents a set of one or more contiguous cells such as a cell, a row, + a column, or a block of cells. To learn more about how ranges are used + throughout the API, start with [Ranges in the Excel JavaScript + API](https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-core-concepts#ranges). +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Get a Range object by its address. + + await Excel.run(async (context) => { + const sheetName = "Sheet1"; + const rangeAddress = "A1:F8"; + const worksheet = context.workbook.worksheets.getItem(sheetName); + const range = worksheet.getRange(rangeAddress); + const cell = range.getCell(0,0); + cell.load('address'); + await context.sync(); + + console.log(cell.address); + }); + + ``` + +isPreview: false +isDeprecated: false +type: class +properties: + - name: address + uid: excel!Excel.Range#address:member + package: excel! + fullName: address + summary: >- + Specifies the range reference in A1-style. Address value contains the + sheet reference (e.g., "Sheet1!A1:B4"). + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly address: string;' + return: + type: string + - name: addressLocal + uid: excel!Excel.Range#addressLocal:member + package: excel! + fullName: addressLocal + summary: >- + Represents the range reference for the specified range in the language of + the user. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly addressLocal: string;' + return: + type: string + - name: cellCount + uid: excel!Excel.Range#cellCount:member + package: excel! + fullName: cellCount + summary: >- + Specifies the number of cells in the range. This API will return -1 if the + cell count exceeds 2^31-1 (2,147,483,647). + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly cellCount: number;' + return: + type: number + - name: columnCount + uid: excel!Excel.Range#columnCount:member + package: excel! + fullName: columnCount + summary: Specifies the total number of columns in the range. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly columnCount: number;' + return: + type: number + - name: columnHidden + uid: excel!Excel.Range#columnHidden:member + package: excel! + fullName: columnHidden + summary: >- + Represents if all columns in the current range are hidden. Value is `true` + when all columns in a range are hidden. Value is `false` when no columns + in the range are hidden. Value is `null` when some columns in a range are + hidden and other columns in the same range are not hidden. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'columnHidden: boolean;' + return: + type: boolean + - name: columnIndex + uid: excel!Excel.Range#columnIndex:member + package: excel! + fullName: columnIndex + summary: Specifies the column number of the first cell in the range. Zero-indexed. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly columnIndex: number;' + return: + type: number + - name: conditionalFormats + uid: excel!Excel.Range#conditionalFormats:member + package: excel! + fullName: conditionalFormats + summary: The collection of `ConditionalFormats` that intersect the range. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly conditionalFormats: Excel.ConditionalFormatCollection;' + return: + type: + - name: context + uid: excel!Excel.Range#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: control + uid: excel!Excel.Range#control:member + package: excel! + fullName: control + summary: >- + Accesses the cell control applied to this range. If the range has multiple + cell controls, this returns `EmptyCellControl`. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml + + + // Add checkboxes to the table. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Get the second column in the table, without the header. + const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange(); + + // Change the boolean values to checkboxes. + range.control = { + type: Excel.CellControlType.checkbox + }; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'control: CellControl;' + return: + type: + - name: dataValidation + uid: excel!Excel.Range#dataValidation:member + package: excel! + fullName: dataValidation + summary: Returns a data validation object. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly dataValidation: Excel.DataValidation;' + return: + type: + - name: format + uid: excel!Excel.Range#format:member + package: excel! + fullName: format + summary: >- + Returns a format object, encapsulating the range's font, fill, borders, + alignment, and other properties. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly format: Excel.RangeFormat;' + return: + type: + - name: formulas + uid: excel!Excel.Range#formulas:member + package: excel! + fullName: formulas + summary: >- + Represents the formula in A1-style notation. If a cell has no formula, its + value is returned instead. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulas: any[][];' + return: + type: any[][] + - name: formulasLocal + uid: excel!Excel.Range#formulasLocal:member + package: excel! + fullName: formulasLocal + summary: >- + Represents the formula in A1-style notation, in the user's language and + number-formatting locale. For example, the English "=SUM(A1, 1.5)" formula + would become "=SUMME(A1; 1,5)" in German. If a cell has no formula, its + value is returned instead. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulasLocal: any[][];' + return: + type: any[][] + - name: formulasR1C1 + uid: excel!Excel.Range#formulasR1C1:member + package: excel! + fullName: formulasR1C1 + summary: >- + Represents the formula in R1C1-style notation. If a cell has no formula, + its value is returned instead. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulasR1C1: any[][];' + return: + type: any[][] + - name: hasSpill + uid: excel!Excel.Range#hasSpill:member + package: excel! + fullName: hasSpill + summary: >- + Represents if all cells have a spill border. Returns `true` if all cells + have a spill border, or `false` if all cells do not have a spill border. + Returns `null` if there are cells both with and without spill borders + within the range. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly hasSpill: boolean;' + return: + type: boolean + - name: height + uid: excel!Excel.Range#height:member + package: excel! + fullName: height + summary: >- + Returns the distance in points, for 100% zoom, from the top edge of the + range to the bottom edge of the range. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly height: number;' + return: + type: number + - name: hidden + uid: excel!Excel.Range#hidden:member + package: excel! + fullName: hidden + summary: >- + Represents if all cells in the current range are hidden. Value is `true` + when all cells in a range are hidden. Value is `false` when no cells in + the range are hidden. Value is `null` when some cells in a range are + hidden and other cells in the same range are not hidden. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly hidden: boolean;' + return: + type: boolean + - name: hyperlink + uid: excel!Excel.Range#hyperlink:member + package: excel! + fullName: hyperlink + summary: Represents the hyperlink for the current range. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-hyperlink.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Orders"); + + let productsRange = sheet.getRange("A3:A5"); + productsRange.load("values"); + + await context.sync(); + + // Create a hyperlink to a URL + // for each product name in the first table. + for (let i = 0; i < productsRange.values.length; i++) { + let cellRange = productsRange.getCell(i, 0); + let cellText = productsRange.values[i][0]; + + let hyperlink = { + textToDisplay: cellText, + screenTip: "Search Bing for '" + cellText + "'", + address: "https://www.bing.com?q=" + cellText + } + cellRange.hyperlink = hyperlink; + } + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'hyperlink: Excel.RangeHyperlink;' + return: + type: + - name: isEntireColumn + uid: excel!Excel.Range#isEntireColumn:member + package: excel! + fullName: isEntireColumn + summary: Represents if the current range is an entire column. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly isEntireColumn: boolean;' + return: + type: boolean + - name: isEntireRow + uid: excel!Excel.Range#isEntireRow:member + package: excel! + fullName: isEntireRow + summary: Represents if the current range is an entire row. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly isEntireRow: boolean;' + return: + type: boolean + - name: left + uid: excel!Excel.Range#left:member + package: excel! + fullName: left + summary: >- + Returns the distance in points, for 100% zoom, from the left edge of the + worksheet to the left edge of the range. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly left: number;' + return: + type: number + - name: linkedDataTypeState + uid: excel!Excel.Range#linkedDataTypeState:member + package: excel! + fullName: linkedDataTypeState + summary: Represents the data type state of each cell. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly linkedDataTypeState: Excel.LinkedDataTypeState[][];' + return: + type: [][] + - name: numberFormat + uid: excel!Excel.Range#numberFormat:member + package: excel! + fullName: numberFormat + summary: >- + Represents Excel's number format code for the given range. For more + information about Excel number formatting, see [Number format + codes](https://support.microsoft.com/office/5026bbd6-04bc-48cd-bf33-80f18b4eae68). + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Set the text of the chart title to "My Chart" and display it as an + overlay on the chart. + + await Excel.run(async (context) => { + const sheetName = "Sheet1"; + const rangeAddress = "F5:G7"; + const numberFormat = [[null, "d-mmm"], [null, "d-mmm"], [null, null]] + const values = [["Today", 42147], ["Tomorrow", "5/24"], ["Difference in days", null]]; + const formulas = [[null,null], [null,null], [null,"=G6-G5"]]; + const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); + range.numberFormat = numberFormat; + range.values = values; + range.formulas= formulas; + range.load('text'); + await context.sync(); + + console.log(range.text); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat: any[][];' + return: + type: any[][] + - name: numberFormatCategories + uid: excel!Excel.Range#numberFormatCategories:member + package: excel! + fullName: numberFormatCategories + summary: Represents the category of number format of each cell. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly numberFormatCategories: Excel.NumberFormatCategory[][];' + return: + type: [][] + - name: numberFormatLocal + uid: excel!Excel.Range#numberFormatLocal:member + package: excel! + fullName: numberFormatLocal + summary: >- + Represents Excel's number format code for the given range, based on the + language settings of the user. Excel does not perform any language or + format coercion when getting or setting the `numberFormatLocal` property. + Any returned text uses the locally-formatted strings based on the language + specified in the system settings. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormatLocal: any[][];' + return: + type: any[][] + - name: rowCount + uid: excel!Excel.Range#rowCount:member + package: excel! + fullName: rowCount + summary: Returns the total number of rows in the range. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly rowCount: number;' + return: + type: number + - name: rowHidden + uid: excel!Excel.Range#rowHidden:member + package: excel! + fullName: rowHidden + summary: >- + Represents if all rows in the current range are hidden. Value is `true` + when all rows in a range are hidden. Value is `false` when no rows in the + range are hidden. Value is `null` when some rows in a range are hidden and + other rows in the same range are not hidden. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rowHidden: boolean;' + return: + type: boolean + - name: rowIndex + uid: excel!Excel.Range#rowIndex:member + package: excel! + fullName: rowIndex + summary: Returns the row number of the first cell in the range. Zero-indexed. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly rowIndex: number;' + return: + type: number + - name: savedAsArray + uid: excel!Excel.Range#savedAsArray:member + package: excel! + fullName: savedAsArray + summary: >- + Represents if all the cells would be saved as an array formula. Returns + `true` if all cells would be saved as an array formula, or `false` if all + cells would not be saved as an array formula. Returns `null` if some cells + would be saved as an array formula and some would not be. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly savedAsArray: boolean;' + return: + type: boolean + - name: sort + uid: excel!Excel.Range#sort:member + package: excel! + fullName: sort + summary: Represents the range sort of the current range. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/event-column-and-row-sort.yaml + + + async function sortTopToBottom(criteria: string) { + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + const range = sheet.getRange("A1:E5"); + + // Find the column header that provides the sort criteria. + const header = range.find(criteria, {}); + header.load("columnIndex"); + await context.sync(); + + range.sort.apply( + [ + { + key: header.columnIndex, + sortOn: Excel.SortOn.value + } + ], + false /*matchCase*/, + true /*hasHeaders*/, + Excel.SortOrientation.rows + ); + await context.sync(); + }); + } + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly sort: Excel.RangeSort;' + return: + type: + - name: style + uid: excel!Excel.Range#style:member + package: excel! + fullName: style + summary: >- + Represents the style of the current range. If the styles of the cells are + inconsistent, `null` will be returned. For custom styles, the style name + will be returned. For built-in styles, a string representing a value in + the `BuiltInStyle` enum will be returned. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml + + + await Excel.run(async (context) => { + let worksheet = context.workbook.worksheets.getItem("Sample"); + let range = worksheet.getRange("A1:E1"); + + // Apply built-in style. + // Styles are in the Home tab ribbon. + range.style = Excel.BuiltInStyle.neutral; + range.format.horizontalAlignment = "Right"; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'style: string;' + return: + type: string + - name: text + uid: excel!Excel.Range#text:member + package: excel! + fullName: text + summary: >- + Text values of the specified range. The text value will not depend on the + cell width. The number sign (\#) substitution that happens in the Excel UI + will not affect the text value returned by the API. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly text: string[][];' + return: + type: string[][] + - name: top + uid: excel!Excel.Range#top:member + package: excel! + fullName: top + summary: >- + Returns the distance in points, for 100% zoom, from the top edge of the + worksheet to the top edge of the range. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly top: number;' + return: + type: number + - name: values + uid: excel!Excel.Range#values:member + package: excel! + fullName: values + summary: >- + Represents the raw values of the specified range. The data returned could + be a string, number, or boolean. Cells that contain an error will return + the error string. If the returned value starts with a plus ("+"), minus + ("-"), or equal sign ("="), Excel interprets this value as a formula. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml + + + // Change the value of the checkbox in B3. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + const range = sheet.getRange("B3"); + + range.values = [["TRUE"]]; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'values: any[][];' + return: + type: any[][] + - name: valuesAsJson + uid: excel!Excel.Range#valuesAsJson:member + package: excel! + fullName: valuesAsJson + summary: >- + A JSON representation of the values in the cells in this range. Unlike + `Range.values`, `Range.valuesAsJson` supports all data types which + can be in a cell. Examples include formatted number values and web images, + in addition to the standard boolean, number, and string values. Data + returned from this API always aligns with the en-US locale. To retrieve + data in the user's display locale, use `Range.valuesAsJsonLocal`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-formatted-number.yaml + + + // This function creates a double data type, + + // and sets the format of this data type as a date. + + await Excel.run(async (context) => { + // Get the Sample worksheet and a range on that sheet. + const sheet = context.workbook.worksheets.getItemOrNullObject("Sample"); + const dateRange = sheet.getRange("A1"); + + // Write a number formatted as a date to cell A1. + dateRange.valuesAsJson = [ + [ + { + type: Excel.CellValueType.double, + basicValue: 32889.0, + numberFormat: "m/d/yyyy" + } + ] + ]; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJson: CellValue[][];' + return: + type: [][] + - name: valuesAsJsonLocal + uid: excel!Excel.Range#valuesAsJsonLocal:member + package: excel! + fullName: valuesAsJsonLocal + summary: >- + A JSON representation of the values in the cells in this range. Unlike + `Range.values`, `Range.valuesAsJsonLocal` supports all data types + which can be in a cell. Examples include formatted number values and web + images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the user's display locale. + To retrieve data independent of locale, use `Range.valuesAsJson`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJsonLocal: CellValue[][];' + return: + type: [][] + - name: valueTypes + uid: excel!Excel.Range#valueTypes:member + package: excel! + fullName: valueTypes + summary: Specifies the type of data in each cell. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly valueTypes: Excel.RangeValueType[][];' + return: + type: [][] + - name: width + uid: excel!Excel.Range#width:member + package: excel! + fullName: width + summary: >- + Returns the distance in points, for 100% zoom, from the left edge of the + range to the right edge of the range. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly width: number;' + return: + type: number + - name: worksheet + uid: excel!Excel.Range#worksheet:member + package: excel! + fullName: worksheet + summary: The worksheet containing the current range. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly worksheet: Excel.Worksheet;' + return: + type: +methods: + - name: autoFill(destinationRange, autoFillType) + uid: excel!Excel.Range#autoFill:member(1) + package: excel! + fullName: autoFill(destinationRange, autoFillType) + summary: >- + Fills a range from the current range to the destination range using the + specified AutoFill logic. The destination range can be `null` or can + extend the source range either horizontally or vertically. Discontiguous + ranges are not supported. + + + For more information, see [Use AutoFill and Flash + Fill](https://support.microsoft.com/office/2e79a709-c814-4b27-8bc2-c4dc84d49464). + remarks: >- + \[ [API set: ExcelApi 1.9, ExcelApi Preview for null + `destinationRange`](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-auto-fill.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + const sumCell = sheet.getRange("P4"); + + // Copy everything. The formulas will be contextually updated based on their new locations. + sumCell.autoFill("P4:P7", Excel.AutoFillType.fillCopy); + sumCell.format.autofitColumns(); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + autoFill(destinationRange?: Range | string, autoFillType?: + Excel.AutoFillType): void; + parameters: + - 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). + type: | string + - id: autoFillType + description: >- + The type of AutoFill. Specifies how the destination range is to be + filled, based on the contents of the current range. Default is + "FillDefault". + type: + return: + type: void + description: '' + - name: autoFill(destinationRange, autoFillType) + uid: excel!Excel.Range#autoFill:member(2) + package: excel! + fullName: autoFill(destinationRange, autoFillType) + summary: >- + Fills a range from the current range to the destination range using the + specified AutoFill logic. The destination range can be `null` or can + extend the source range either horizontally or vertically. Discontiguous + ranges are not supported. + + + For more information, see [Use AutoFill and Flash + Fill](https://support.microsoft.com/office/2e79a709-c814-4b27-8bc2-c4dc84d49464). + remarks: >- + \[ [API set: ExcelApi 1.9, ExcelApi Preview for null + `destinationRange`](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + autoFill(destinationRange?: Range | string, autoFillType?: "FillDefault" + | "FillCopy" | "FillSeries" | "FillFormats" | "FillValues" | "FillDays" + | "FillWeekdays" | "FillMonths" | "FillYears" | "LinearTrend" | + "GrowthTrend" | "FlashFill"): void; + parameters: + - 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). + type: | string + - id: autoFillType + description: >- + The type of AutoFill. Specifies how the destination range is to be + filled, based on the contents of the current range. Default is + "FillDefault". + type: >- + "FillDefault" | "FillCopy" | "FillSeries" | "FillFormats" | + "FillValues" | "FillDays" | "FillWeekdays" | "FillMonths" | + "FillYears" | "LinearTrend" | "GrowthTrend" | "FlashFill" + return: + type: void + description: '' + - name: calculate() + uid: excel!Excel.Range#calculate:member(1) + package: excel! + fullName: calculate() + summary: Calculates a range of cells on a worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'calculate(): void;' + return: + type: void + description: '' + - name: clear(applyTo) + uid: excel!Excel.Range#clear:member(1) + package: excel! + fullName: clear(applyTo) + summary: Clear range values and formatting, such as fill and border. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Clear the format and contents of the range. + + await Excel.run(async (context) => { + const sheetName = "Sheet1"; + const rangeAddress = "D:F"; + const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); + range.clear(); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'clear(applyTo?: Excel.ClearApplyTo): void;' + parameters: + - id: applyTo + description: >- + Optional. Determines the type of clear action. See + `Excel.ClearApplyTo` for details. + type: + return: + type: void + description: '' + - name: clear(applyTo) + uid: excel!Excel.Range#clear:member(2) + package: excel! + fullName: clear(applyTo) + summary: Clear range values and formatting, such as fill and border. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + clear(applyTo?: "All" | "Formats" | "Contents" | "Hyperlinks" | + "RemoveHyperlinks" | "ResetContents"): void; + parameters: + - id: applyTo + description: >- + Optional. Determines the type of clear action. See + `Excel.ClearApplyTo` for details. + type: >- + "All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks" | + "ResetContents" + return: + type: void + description: '' + - name: clearOrResetContents() + uid: excel!Excel.Range#clearOrResetContents:member(1) + package: excel! + fullName: clearOrResetContents() + summary: >- + Clears the values of the cells in the range, with special consideration + given to cells containing controls. If the range contains only blank + values and controls set to their default value, then the values and + control formatting are removed. Otherwise, this sets the cells with + controls to their default value and clears the values of the other cells + in the range. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml + + + // Remove all content from the Analysis column. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Get the second column in the table, without the header. + const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange(); + + // Clear all the data from the second column. + range.clearOrResetContents(); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'clearOrResetContents(): void;' + return: + type: void + description: '' + - name: convertDataTypeToText() + uid: excel!Excel.Range#convertDataTypeToText:member(1) + package: excel! + fullName: convertDataTypeToText() + summary: Converts the range cells with data types into text. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'convertDataTypeToText(): void;' + return: + type: void + description: '' + - name: convertToLinkedDataType(serviceID, languageCulture) + uid: excel!Excel.Range#convertToLinkedDataType:member(1) + package: excel! + fullName: convertToLinkedDataType(serviceID, languageCulture) + summary: Converts the range cells into linked data types in the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + convertToLinkedDataType(serviceID: number, languageCulture: string): + void; + parameters: + - id: serviceID + description: The service ID which will be used to query the data. + type: number + - id: languageCulture + description: Language culture to query the service for. + type: string + return: + type: void + description: '' + - name: copyFrom(sourceRange, copyType, skipBlanks, transpose) + uid: excel!Excel.Range#copyFrom:member(1) + package: excel! + fullName: copyFrom(sourceRange, copyType, skipBlanks, transpose) + summary: >- + Copies cell data or formatting from the source range or `RangeAreas` to + the current range. The destination range can be a different size than the + source range or `RangeAreas`. The destination is expanded + automatically if it's smaller than the source. Note: Like the copy + functionality in the Excel UI, if the destination range is an exact + multiple greater than the source range in either rows or columns, then the + source content is replicated multiple times. For example, a 2x2 range copy + into a 2x6 range will result in 3 copies of the original 2x2 range. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-copyfrom.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + // Place a label in front of the copied data. + sheet.getRange("F2").values = [["Copied Formula"]]; + + // Copy a range preserving the formulas. + // Note: non-formula values are copied over as is. + sheet.getRange("G2").copyFrom("A1:E1", Excel.RangeCopyType.formulas); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + copyFrom(sourceRange: Range | RangeAreas | string, copyType?: + Excel.RangeCopyType, skipBlanks?: boolean, transpose?: boolean): void; + parameters: + - id: sourceRange + description: >- + The source range or `RangeAreas` to copy from. When the source + `RangeAreas` has multiple ranges, their form must be able to be + created by removing full rows or columns from a rectangular range. + type: >- + | | string + - id: copyType + description: The type of cell data or formatting to copy over. Default is "All". + type: + - id: skipBlanks + description: True if to skip blank cells in the source range. Default is false. + type: boolean + - id: transpose + description: >- + True if to transpose the cells in the destination range. Default is + false. + type: boolean + return: + type: void + description: '' + - name: copyFrom(sourceRange, copyType, skipBlanks, transpose) + uid: excel!Excel.Range#copyFrom:member(2) + package: excel! + fullName: copyFrom(sourceRange, copyType, skipBlanks, transpose) + summary: >- + Copies cell data or formatting from the source range or `RangeAreas` to + the current range. The destination range can be a different size than the + source range or `RangeAreas`. The destination is expanded + automatically if it's smaller than the source. Note: Like the copy + functionality in the Excel UI, if the destination range is an exact + multiple greater than the source range in either rows or columns, then the + source content is replicated multiple times. For example, a 2x2 range copy + into a 2x6 range will result in 3 copies of the original 2x2 range. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + copyFrom(sourceRange: Range | RangeAreas | string, copyType?: "All" | + "Formulas" | "Values" | "Formats" | "Link", skipBlanks?: boolean, + transpose?: boolean): void; + parameters: + - id: sourceRange + description: >- + The source range or `RangeAreas` to copy from. When the source + `RangeAreas` has multiple ranges, their form must be able to be + created by removing full rows or columns from a rectangular range. + type: >- + | | string + - id: copyType + description: The type of cell data or formatting to copy over. Default is "All". + type: '"All" | "Formulas" | "Values" | "Formats" | "Link"' + - id: skipBlanks + description: True if to skip blank cells in the source range. Default is false. + type: boolean + - id: transpose + description: >- + True if to transpose the cells in the destination range. Default is + false. + type: boolean + return: + type: void + description: '' + - name: delete(shift) + uid: excel!Excel.Range#delete:member(1) + package: excel! + fullName: delete(shift) + summary: Deletes the cells associated with the range. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const sheetName = "Sheet1"; + const rangeAddress = "D:F"; + const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); + range.delete("Left"); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'delete(shift: Excel.DeleteShiftDirection): void;' + parameters: + - id: shift + description: >- + Specifies which way to shift the cells. See + `Excel.DeleteShiftDirection` for details. + type: + return: + type: void + description: '' + - name: delete(shift) + uid: excel!Excel.Range#delete:member(2) + package: excel! + fullName: delete(shift) + summary: Deletes the cells associated with the range. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'delete(shift: "Up" | "Left"): void;' + parameters: + - id: shift + description: >- + Specifies which way to shift the cells. See + `Excel.DeleteShiftDirection` for details. + type: '"Up" | "Left"' + return: + type: void + description: '' + - name: find(text, criteria) + uid: excel!Excel.Range#find:member(1) + package: excel! + fullName: find(text, criteria) + summary: >- + Finds the given string based on the criteria specified. If the current + range is larger than a single cell, then the search will be limited to + that range, else the search will cover the entire sheet starting after + that cell. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-find.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const table = sheet.tables.getItem("ExpensesTable"); + const searchRange = table.getRange(); + + // NOTE: If no match is found, an ItemNotFound error + // is thrown when Range.find is evaluated. + const searchText = (document.getElementById("searchText") as HTMLTextAreaElement).value; + const foundRange = searchRange.find(searchText, { + completeMatch: isCompleteMatchToggle, + matchCase: isMatchCaseToggle, + searchDirection: searchDirectionToggle + }); + + foundRange.load("address"); + await context.sync(); + + + console.log(foundRange.address); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'find(text: string, criteria: Excel.SearchCriteria): Excel.Range;' + parameters: + - id: text + description: The string to find. + type: string + - id: criteria + description: >- + Additional search criteria, including the search direction and + whether the search needs to match the entire cell or be + case-sensitive. + type: + return: + type: + description: >- + The `Range` object representing the first cell that contains a value + matching the search text and criteria. + - name: findOrNullObject(text, criteria) + uid: excel!Excel.Range#findOrNullObject:member(1) + package: excel! + fullName: findOrNullObject(text, criteria) + summary: >- + Finds the given string based on the criteria specified. If the current + range is larger than a single cell, then the search will be limited to + that range, else the search will cover the entire sheet starting after + that cell. If there are no matches, then this method returns an object + with its `isNullObject` property set to `true`. For further + information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-find.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const table = sheet.tables.getItem("ExpensesTable"); + const searchRange = table.getRange(); + const searchText = (document.getElementById("searchText") as HTMLTextAreaElement).value; + const foundRange = searchRange.findOrNullObject(searchText, { + completeMatch: isCompleteMatchToggle, + matchCase: isMatchCaseToggle, + searchDirection: searchDirectionToggle + }); + + foundRange.load("address"); + await context.sync(); + + if (foundRange.isNullObject) { + console.log("Text not found"); + } else { + console.log(foundRange.address); + } + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + findOrNullObject(text: string, criteria: Excel.SearchCriteria): + Excel.Range; + parameters: + - id: text + description: The string to find. + type: string + - id: criteria + description: >- + Additional search criteria, including the search direction and + whether the search needs to match the entire cell or be + case-sensitive. + type: + return: + type: + description: The `Range` which matched the search criteria. + - name: flashFill() + uid: excel!Excel.Range#flashFill:member(1) + package: excel! + fullName: flashFill() + summary: >- + Does a Flash Fill to the current range. Flash Fill automatically fills + data when it senses a pattern, so the range must be a single column range + and have data around it in order to find a pattern. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'flashFill(): void;' + return: + type: void + description: '' + - name: getAbsoluteResizedRange(numRows, numColumns) + uid: excel!Excel.Range#getAbsoluteResizedRange:member(1) + package: excel! + fullName: getAbsoluteResizedRange(numRows, numColumns) + summary: >- + Gets a `Range` object with the same top-left cell as the current `Range` + object, but with the specified numbers of rows and columns. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + getAbsoluteResizedRange(numRows: number, numColumns: number): + Excel.Range; + parameters: + - id: numRows + description: The number of rows of the new range size. + type: number + - id: numColumns + description: The number of columns of the new range size. + type: number + return: + type: + description: '' + - name: getBoundingRect(anotherRange) + uid: excel!Excel.Range#getBoundingRect:member(1) + package: excel! + fullName: getBoundingRect(anotherRange) + summary: >- + Gets the smallest range object that encompasses the given ranges. For + example, the `GetBoundingRect` of "B2:C5" and "D10:E15" is "B2:E15". + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const sheetName = "Sheet1"; + const rangeAddress = "D4:G6"; + let range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); + range = range.getBoundingRect("G4:H8"); + range.load('address'); + await context.sync(); + + console.log(range.address); // Prints Sheet1!D4:H8 + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getBoundingRect(anotherRange: Range | string): Excel.Range;' + parameters: + - id: anotherRange + description: The range object, address, or range name. + type: | string + return: + type: + description: '' + - name: getCell(row, column) + uid: excel!Excel.Range#getCell:member(1) + package: excel! + fullName: getCell(row, column) + summary: >- + Gets the range object containing the single cell based on row and column + numbers. The cell can be outside the bounds of its parent range, so long + as it stays within the worksheet grid. The returned cell is located + relative to the top left cell of the range. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const sheetName = "Sheet1"; + const rangeAddress = "A1:F8"; + const worksheet = context.workbook.worksheets.getItem(sheetName); + const range = worksheet.getRange(rangeAddress); + const cell = range.getCell(0,0); + cell.load('address'); + await context.sync(); + + console.log(cell.address); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getCell(row: number, column: number): Excel.Range;' + parameters: + - id: row + description: Row number of the cell to be retrieved. Zero-indexed. + type: number + - id: column + description: Column number of the cell to be retrieved. Zero-indexed. + type: number + return: + type: + description: '' + - name: getCellProperties(cellPropertiesLoadOptions) + uid: excel!Excel.Range#getCellProperties:member(1) + package: excel! + fullName: getCellProperties(cellPropertiesLoadOptions) + summary: >- + Returns a 2D array, encapsulating the data for each cell's font, fill, + borders, alignment, and other properties. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/cell-properties.yaml + + + await Excel.run(async (context) => { + const cell = context.workbook.getActiveCell(); + + // Define the cell properties to get by setting the matching LoadOptions to true. + const propertiesToGet = cell.getCellProperties({ + address: true, + format: { + fill: { + color: true + }, + font: { + color: true + } + }, + style: true + }); + + // Sync to get the data from the workbook. + await context.sync(); + const cellProperties = propertiesToGet.value[0][0]; + console.log( + `Address: ${cellProperties.address}\nStyle: ${cellProperties.style}\nFill Color: ${cellProperties.format.fill.color}\nFont Color: ${cellProperties.format.font.color}`); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + getCellProperties(cellPropertiesLoadOptions: CellPropertiesLoadOptions): + OfficeExtension.ClientResult; + parameters: + - id: cellPropertiesLoadOptions + description: An object that represents which cell properties to load. + type: + return: + type: >- + <[][]> + description: >- + A 2D array where each item represents the requested properties of the + corresponding cell. + - name: getColumn(column) + uid: excel!Excel.Range#getColumn:member(1) + package: excel! + fullName: getColumn(column) + summary: Gets a column contained in the range. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const sheetName = "Sheet19"; + const rangeAddress = "A1:F8"; + const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getColumn(1); + range.load('address'); + await context.sync(); + + console.log(range.address); // prints Sheet1!B1:B8 + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getColumn(column: number): Excel.Range;' + parameters: + - id: column + description: Column number of the range to be retrieved. Zero-indexed. + type: number + return: + type: + description: '' + - name: getColumnProperties(columnPropertiesLoadOptions) + uid: excel!Excel.Range#getColumnProperties:member(1) + package: excel! + fullName: getColumnProperties(columnPropertiesLoadOptions) + summary: >- + Returns a single-dimensional array, encapsulating the data for each + column's font, fill, borders, alignment, and other properties. For + properties that are not consistent across each cell within a given column, + null will be returned. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + getColumnProperties(columnPropertiesLoadOptions: + ColumnPropertiesLoadOptions): + OfficeExtension.ClientResult; + parameters: + - id: columnPropertiesLoadOptions + description: An object that represents which column properties to load. + type: + return: + type: >- + <[]> + description: >- + An array where each item represents the requested properties of the + corresponding column. + - name: getColumnsAfter(count) + uid: excel!Excel.Range#getColumnsAfter:member(1) + package: excel! + fullName: getColumnsAfter(count) + summary: >- + Gets a certain number of columns to the right of the current `Range` + object. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getColumnsAfter(count?: number): Excel.Range;' + parameters: + - id: count + description: >- + Optional. The number of columns to include in the resulting range. + In general, use a positive number to create a range outside the + current range. You can also use a negative number to create a range + within the current range. The default value is 1. + type: number + return: + type: + description: '' + - name: getColumnsBefore(count) + uid: excel!Excel.Range#getColumnsBefore:member(1) + package: excel! + fullName: getColumnsBefore(count) + summary: >- + Gets a certain number of columns to the left of the current `Range` + object. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getColumnsBefore(count?: number): Excel.Range;' + parameters: + - id: count + description: >- + Optional. The number of columns to include in the resulting range. + In general, use a positive number to create a range outside the + current range. You can also use a negative number to create a range + within the current range. The default value is 1. + type: number + return: + type: + description: '' + - name: getDependents() + uid: excel!Excel.Range#getDependents:member(1) + package: excel! + fullName: getDependents() + summary: >- + Returns a `WorkbookRangeAreas` object that represents the range containing + all the dependent cells of a specified range in the same worksheet or + across multiple worksheets. Throws an `ItemNotFound` error if no + dependents are found. + remarks: >- + \[ [API set: ExcelApi + 1.15](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-dependents.yaml + + + // This function highlights all the dependent cells of the active cell. + + // Dependent cells contain formulas that refer to other cells. + + await Excel.run(async (context) => { + // Get addresses of the active cell's dependent cells. + const range = context.workbook.getActiveCell(); + const dependents = range.getDependents(); + range.load("address"); + dependents.areas.load("address"); + await context.sync(); + + console.log(`All dependent cells of ${range.address}:`); + + // Use the dependents API to loop through dependents of the active cell. + for (let i = 0; i < dependents.areas.items.length; i++) { + // Highlight and print out the address of each dependent cell. + dependents.areas.items[i].format.fill.color = "Orange"; + console.log(` ${dependents.areas.items[i].address}`); + } + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getDependents(): Excel.WorkbookRangeAreas;' + return: + type: + description: '' + - name: getDirectDependents() + uid: excel!Excel.Range#getDirectDependents:member(1) + package: excel! + fullName: getDirectDependents() + summary: >- + Returns a `WorkbookRangeAreas` object that represents the range containing + all the direct dependent cells of a specified range in the same worksheet + or across multiple worksheets. Throws an `ItemNotFound` error if no + dependents are found. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-direct-dependents.yaml + + + await Excel.run(async (context) => { + // Direct dependents are cells that contain formulas that refer to other cells. + let range = context.workbook.getActiveCell(); + let directDependents = range.getDirectDependents(); + range.load("address"); + directDependents.areas.load("address"); + await context.sync(); + + console.log(`Direct dependent cells of ${range.address}:`); + + // Use the direct dependents API to loop through direct dependents of the active cell. + for (let i = 0; i < directDependents.areas.items.length; i++) { + // Highlight and print the address of each dependent cell. + directDependents.areas.items[i].format.fill.color = "Yellow"; + console.log(` ${directDependents.areas.items[i].address}`); + } + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getDirectDependents(): Excel.WorkbookRangeAreas;' + return: + type: + description: '' + - name: getDirectPrecedents() + uid: excel!Excel.Range#getDirectPrecedents:member(1) + package: excel! + fullName: getDirectPrecedents() + summary: >- + Returns a `WorkbookRangeAreas` object that represents the range containing + all the direct precedent cells of a specified range in the same worksheet + or across multiple worksheets. Throws an `ItemNotFound` error if no + precedents are found. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/precedents.yaml + + + await Excel.run(async (context) => { + // Precedents are cells referenced by the formula in a cell. + // A "direct precedent" is a cell directly referenced by the selected formula. + let range = context.workbook.getActiveCell(); + let directPrecedents = range.getDirectPrecedents(); + range.load("address"); + directPrecedents.areas.load("address"); + await context.sync(); + + console.log(`Direct precedent cells of ${range.address}:`); + + // Use the direct precedents API to loop through precedents of the active cell. + for (let i = 0; i < directPrecedents.areas.items.length; i++) { + // Highlight and console the address of each precedent cell. + directPrecedents.areas.items[i].format.fill.color = "Yellow"; + console.log(` ${directPrecedents.areas.items[i].address}`); + } + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getDirectPrecedents(): Excel.WorkbookRangeAreas;' + return: + type: + description: '' + - name: getDisplayedCellProperties(cellPropertiesLoadOptions) + uid: excel!Excel.Range#getDisplayedCellProperties:member(1) + package: excel! + fullName: getDisplayedCellProperties(cellPropertiesLoadOptions) + summary: >- + Returns a 2D array, encapsulating the display data for each cell's font, + fill, borders, alignment, and other properties. Unlike + `getCellProperties`, which only shows properties that are set + directly for the cell, this returns properties that are displayed from + indirect sources, such as conditional formatting or styles. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + getDisplayedCellProperties(cellPropertiesLoadOptions: + CellPropertiesLoadOptions): + OfficeExtension.ClientResult; + parameters: + - id: cellPropertiesLoadOptions + description: An object that represents which cell properties to load. + type: + return: + type: >- + <[][]> + description: >- + A 2D array where each item represents the requested display properties + of the corresponding cell. + - name: getEntireColumn() + uid: excel!Excel.Range#getEntireColumn:member(1) + package: excel! + fullName: getEntireColumn() + summary: >- + Gets an object that represents the entire column of the range (for + example, if the current range represents cells "B4:E11", its + `getEntireColumn` is a range that represents columns "B:E"). + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Note: the grid properties of the Range (values, numberFormat, + formulas) + + // contains null since the Range in question is unbounded. + + await Excel.run(async (context) => { + const sheetName = "Sheet1"; + const rangeAddress = "D:F"; + const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); + const rangeEC = range.getEntireColumn(); + rangeEC.load('address'); + await context.sync(); + + console.log(rangeEC.address); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getEntireColumn(): Excel.Range;' + return: + type: + description: '' + - name: getEntireRow() + uid: excel!Excel.Range#getEntireRow:member(1) + package: excel! + fullName: getEntireRow() + summary: >- + Gets an object that represents the entire row of the range (for example, + if the current range represents cells "B4:E11", its `GetEntireRow` is a + range that represents rows "4:11"). + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Gets an object that represents the entire row of the range + + // (for example, if the current range represents cells "B4:E11", + + // its GetEntireRow is a range that represents rows "4:11"). + + await Excel.run(async (context) => { + const sheetName = "Sheet1"; + const rangeAddress = "D:F"; + const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); + const rangeER = range.getEntireRow(); + rangeER.load('address'); + await context.sync(); + + console.log(rangeER.address); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getEntireRow(): Excel.Range;' + return: + type: + description: '' + - name: getExtendedRange(direction, activeCell) + uid: excel!Excel.Range#getExtendedRange:member(1) + package: excel! + fullName: getExtendedRange(direction, activeCell) + summary: >- + Returns a range object that includes the current range and up to the edge + of the range, based on the provided direction. This matches the + Ctrl+Shift+Arrow key behavior in the + Excel on Windows UI. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-get-range-edge.yaml + + + await Excel.run(async (context) => { + // Get the selected range. + const range = context.workbook.getSelectedRange(); + + // Specify the direction with the `KeyboardDirection` enum. + const direction = Excel.KeyboardDirection.down; + + // Get the active cell in the workbook. + const activeCell = context.workbook.getActiveCell(); + + // Get all the cells from the currently selected range to the bottom-most edge of the used range. + // This method acts like the Ctrl+Shift+Arrow key keyboard shortcut while a range is selected. + const extendedRange = range.getExtendedRange( + direction, + activeCell // If the selected range contains more than one cell, the active cell must be defined. + ); + extendedRange.select(); + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + getExtendedRange(direction: Excel.KeyboardDirection, activeCell?: Range + | string): Excel.Range; + parameters: + - id: direction + description: The direction from the active cell. + type: + - id: activeCell + description: >- + The active cell in this range. By default, the active cell is the + top-left cell of the range. An error is thrown if the active cell is + not in this range. + type: | string + return: + type: + description: '' + - name: getExtendedRange(direction, activeCell) + uid: excel!Excel.Range#getExtendedRange:member(2) + package: excel! + fullName: getExtendedRange(direction, activeCell) + summary: >- + Returns a range object that includes the current range and up to the edge + of the range, based on the provided direction. This matches the + Ctrl+Shift+Arrow key behavior in the + Excel on Windows UI. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + getExtendedRange(direction: "Left" | "Right" | "Up" | "Down", + activeCell?: Range | string): Excel.Range; + parameters: + - id: direction + description: The direction from the active cell. + type: '"Left" | "Right" | "Up" | "Down"' + - id: activeCell + description: >- + The active cell in this range. By default, the active cell is the + top-left cell of the range. An error is thrown if the active cell is + not in this range. + type: | string + return: + type: + description: '' + - name: getImage() + uid: excel!Excel.Range#getImage:member(1) + package: excel! + fullName: getImage() + summary: Renders the range as a Base64-encoded PNG image. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getImage(): OfficeExtension.ClientResult;' + return: + type: <string> + description: '' + - name: getIntersection(anotherRange) + uid: excel!Excel.Range#getIntersection:member(1) + package: excel! + fullName: getIntersection(anotherRange) + summary: >- + Gets the range object that represents the rectangular intersection of the + given ranges. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const sheetName = "Sheet1"; + const rangeAddress = "A1:F8"; + const range = + context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getIntersection("D4:G6"); + range.load('address'); + await context.sync(); + + console.log(range.address); // prints Sheet1!D4:F6 + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getIntersection(anotherRange: Range | string): Excel.Range;' + parameters: + - id: anotherRange + description: >- + The range object or range address that will be used to determine the + intersection of ranges. + type: | string + return: + type: + description: '' + - name: getIntersectionOrNullObject(anotherRange) + uid: excel!Excel.Range#getIntersectionOrNullObject:member(1) + package: excel! + fullName: getIntersectionOrNullObject(anotherRange) + summary: >- + Gets the range object that represents the rectangular intersection of the + given ranges. If no intersection is found, then this method returns an + object with its `isNullObject` property set to `true`. For further + information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-relationships.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const salesTable = sheet.tables.getItem("SalesTable"); + const dataRange = salesTable.getDataBodyRange(); + + // We want the most recent quarter that has data, so + // exclude quarters without data and get the last of + // the remaining columns. + const usedDataRange = dataRange.getUsedRange(true /* valuesOnly */); + const currentQuarterRange = usedDataRange.getLastColumn(); + + // Asian and European teams have separate contests. + const asianSalesRange = sheet.getRange("A2:E4"); + const europeanSalesRange = sheet.getRange("A5:E7"); + + // The data for each chart is the intersection of the + // current quarter column and the rows for the continent. + const asianContestRange = asianSalesRange.getIntersectionOrNullObject(currentQuarterRange); + const europeanContestRange = europeanSalesRange.getIntersectionOrNullObject(currentQuarterRange); + + // Must sync before you can test the output of *OrNullObject + // method/property. + await context.sync(); + + if (asianContestRange.isNullObject) { + // See the declaration of this function for how to + // test this code path. + reportMissingData("Asian"); + } else { + createContinentChart( + sheet, + "Asian", + asianContestRange, + "A9", + "F24" + ); + } + + if (europeanContestRange.isNullObject) { + // See the declaration of this function for how to + // test this code path. + reportMissingData("European"); + } else { + createContinentChart( + sheet, + "European", + europeanContestRange, + "A25", + "F40" + ); + } + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getIntersectionOrNullObject(anotherRange: Range | string): Excel.Range;' + parameters: + - id: anotherRange + description: >- + The range object or range address that will be used to determine the + intersection of ranges. + type: | string + return: + type: + description: '' + - name: getLastCell() + uid: excel!Excel.Range#getLastCell:member(1) + package: excel! + fullName: getLastCell() + summary: >- + Gets the last cell within the range. For example, the last cell of "B2:D5" + is "D5". + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const sheetName = "Sheet1"; + const rangeAddress = "A1:F8"; + const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getLastCell(); + range.load('address'); + await context.sync(); + + console.log(range.address); // prints Sheet1!F8 + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getLastCell(): Excel.Range;' + return: + type: + description: '' + - name: getLastColumn() + uid: excel!Excel.Range#getLastColumn:member(1) + package: excel! + fullName: getLastColumn() + summary: >- + Gets the last column within the range. For example, the last column of + "B2:D5" is "D2:D5". + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const sheetName = "Sheet1"; + const rangeAddress = "A1:F8"; + const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getLastColumn(); + range.load('address'); + await context.sync(); + + console.log(range.address); // prints Sheet1!F1:F8 + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getLastColumn(): Excel.Range;' + return: + type: + description: '' + - name: getLastRow() + uid: excel!Excel.Range#getLastRow:member(1) + package: excel! + fullName: getLastRow() + summary: >- + Gets the last row within the range. For example, the last row of "B2:D5" + is "B5:D5". + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const sheetName = "Sheet1"; + const rangeAddress = "A1:F8"; + const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getLastRow(); + range.load('address'); + await context.sync(); + + console.log(range.address); // prints Sheet1!A8:F8 + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getLastRow(): Excel.Range;' + return: + type: + description: '' + - name: getMergedAreasOrNullObject() + uid: excel!Excel.Range#getMergedAreasOrNullObject:member(1) + package: excel! + fullName: getMergedAreasOrNullObject() + summary: >- + Returns a `RangeAreas` object that represents the merged areas in this + range. Note that if the merged areas count in this range is more than 512, + then this method will fail to return the result. If the `RangeAreas` + object doesn't exist, then this method returns an object with its + `isNullObject` property set to `true`. For further information, + see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-merged-ranges.yaml + + + await Excel.run(async (context) => { + // Retrieve the worksheet and the table in that worksheet. + const sheet = context.workbook.worksheets.getActiveWorksheet(); + const tableRange = sheet.getRange("B2:E6"); + + // Retrieve the merged range within the table and load its details. + const mergedAreas = tableRange.getMergedAreasOrNullObject(); + mergedAreas.load("address"); + mergedAreas.load("cellCount"); + + // Select the merged range. + const range = mergedAreas.areas.getItemAt(0); + range.select(); + await context.sync(); + + // Print out the details of the `mergedAreas` range object. + console.log(`Address of the merged range: ${mergedAreas.address}`); + console.log(`Number of cells in the merged range: ${mergedAreas.cellCount}`); + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getMergedAreasOrNullObject(): Excel.RangeAreas;' + return: + type: + description: '' + - name: getOffsetRange(rowOffset, columnOffset) + uid: excel!Excel.Range#getOffsetRange:member(1) + package: excel! + fullName: getOffsetRange(rowOffset, columnOffset) + summary: >- + Gets an object which represents a range that's offset from the specified + range. The dimension of the returned range will match this range. If the + resulting range is forced outside the bounds of the worksheet grid, an + error will be thrown. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const sheetName = "Sheet1"; + const rangeAddress = "D4:F6"; + const range = + context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getOffsetRange(-1,4); + range.load('address'); + await context.sync(); + + console.log(range.address); // prints Sheet1!H3:J5 + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getOffsetRange(rowOffset: number, columnOffset: number): Excel.Range;' + parameters: + - id: rowOffset + description: >- + The number of rows (positive, negative, or 0) by which the range is + to be offset. Positive values are offset downward, and negative + values are offset upward. + type: number + - id: columnOffset + description: >- + The number of columns (positive, negative, or 0) by which the range + is to be offset. Positive values are offset to the right, and + negative values are offset to the left. + type: number + return: + type: + description: '' + - name: getPivotTables(fullyContained) + uid: excel!Excel.Range#getPivotTables:member(1) + package: excel! + fullName: getPivotTables(fullyContained) + summary: Gets a scoped collection of PivotTables that overlap with the range. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-get-pivottables.yaml + + + await Excel.run(async (context) => { + const activeRange = context.workbook.getSelectedRange(); + + // Get all the PivotTables that intersect with this range. + const partiallyContainedPivotTables = activeRange.getPivotTables(); + // Get all the PivotTables that are completely contained within this range. + const fullyContainedPivotTables = activeRange.getPivotTables(true); + + partiallyContainedPivotTables.load("name"); + fullyContainedPivotTables.load("name"); + await context.sync(); + + // Display the names in the console. + console.log("PivotTables in the current range:") + partiallyContainedPivotTables.items.forEach((pivotTable) => { + console.log(`\t${pivotTable.name}`); + }); + console.log("PivotTables completely contained in the current range:") + fullyContainedPivotTables.items.forEach((pivotTable) => { + console.log(`\t${pivotTable.name}`); + }); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + getPivotTables(fullyContained?: boolean): + Excel.PivotTableScopedCollection; + parameters: + - id: fullyContained + description: >- + If `true`, returns only PivotTables that are fully contained + within the range bounds. The default value is `false`. + type: boolean + return: + type: + description: '' + - name: getPrecedents() + uid: excel!Excel.Range#getPrecedents:member(1) + package: excel! + fullName: getPrecedents() + summary: >- + Returns a `WorkbookRangeAreas` object that represents the range containing + all the precedent cells of a specified range in the same worksheet or + across multiple worksheets. Throws an `ItemNotFound` error if no + precedents are found. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/precedents.yaml + + + await Excel.run(async (context) => { + // Precedents are cells referenced by the formula in a cell. + let range = context.workbook.getActiveCell(); + let precedents = range.getPrecedents(); + range.load("address"); + precedents.areas.load("address"); + await context.sync(); + + console.log(`All precedent cells of ${range.address}:`); + + // Use the precedents API to loop through precedents of the active cell. + for (let i = 0; i < precedents.areas.items.length; i++) { + // Highlight and console the address of each precedent cell. + precedents.areas.items[i].format.fill.color = "Orange"; + console.log(` ${precedents.areas.items[i].address}`); + } + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getPrecedents(): Excel.WorkbookRangeAreas;' + return: + type: + description: '' + - name: getRangeEdge(direction, activeCell) + uid: excel!Excel.Range#getRangeEdge:member(1) + package: excel! + fullName: getRangeEdge(direction, activeCell) + summary: >- + Returns a range object that is the edge cell of the data region that + corresponds to the provided direction. This matches the + Ctrl+Arrow key behavior in the Excel on Windows UI. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-get-range-edge.yaml + + + await Excel.run(async (context) => { + // Get the selected range. + const range = context.workbook.getSelectedRange(); + + // Specify the direction with the `KeyboardDirection` enum. + const direction = Excel.KeyboardDirection.up; + + // Get the active cell in the workbook. + const activeCell = context.workbook.getActiveCell(); + + // Get the top-most cell of the current used range. + // This method acts like the Ctrl+Arrow key keyboard shortcut while a range is selected. + const rangeEdge = range.getRangeEdge( + direction, + activeCell // If the selected range contains more than one cell, the active cell must be defined. + ); + rangeEdge.select(); + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + getRangeEdge(direction: Excel.KeyboardDirection, activeCell?: Range | + string): Excel.Range; + parameters: + - id: direction + description: The direction from the active cell. + type: + - id: activeCell + description: >- + The active cell in this range. By default, the active cell is the + top-left cell of the range. An error is thrown if the active cell is + not in this range. + type: | string + return: + type: + description: '' + - name: getRangeEdge(direction, activeCell) + uid: excel!Excel.Range#getRangeEdge:member(2) + package: excel! + fullName: getRangeEdge(direction, activeCell) + summary: >- + Returns a range object that is the edge cell of the data region that + corresponds to the provided direction. This matches the + Ctrl+Arrow key behavior in the Excel on Windows UI. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + getRangeEdge(direction: "Left" | "Right" | "Up" | "Down", activeCell?: + Range | string): Excel.Range; + parameters: + - id: direction + description: The direction from the active cell. + type: '"Left" | "Right" | "Up" | "Down"' + - id: activeCell + description: >- + The active cell in this range. By default, the active cell is the + top-left cell of the range. An error is thrown if the active cell is + not in this range. + type: | string + return: + type: + description: '' + - name: getResizedRange(deltaRows, deltaColumns) + uid: excel!Excel.Range#getResizedRange:member(1) + package: excel! + fullName: getResizedRange(deltaRows, deltaColumns) + summary: >- + Gets a `Range` object similar to the current `Range` object, but with its + bottom-right corner expanded (or contracted) by some number of rows and + columns. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getResizedRange(deltaRows: number, deltaColumns: number): Excel.Range;' + parameters: + - id: deltaRows + description: >- + The number of rows by which to expand the bottom-right corner, + relative to the current range. Use a positive number to expand the + range, or a negative number to decrease it. + type: number + - id: deltaColumns + description: >- + The number of columns by which to expand the bottom-right corner, + relative to the current range. Use a positive number to expand the + range, or a negative number to decrease it. + type: number + return: + type: + description: '' + - name: getRow(row) + uid: excel!Excel.Range#getRow:member(1) + package: excel! + fullName: getRow(row) + summary: Gets a row contained in the range. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const sheetName = "Sheet1"; + const rangeAddress = "A1:F8"; + const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getRow(1); + range.load('address'); + await context.sync(); + + console.log(range.address); // prints Sheet1!A2:F2 + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getRow(row: number): Excel.Range;' + parameters: + - id: row + description: Row number of the range to be retrieved. Zero-indexed. + type: number + return: + type: + description: '' + - name: getRowProperties(rowPropertiesLoadOptions) + uid: excel!Excel.Range#getRowProperties:member(1) + package: excel! + fullName: getRowProperties(rowPropertiesLoadOptions) + summary: >- + Returns a single-dimensional array, encapsulating the data for each row's + font, fill, borders, alignment, and other properties. For properties that + are not consistent across each cell within a given row, `null` will be + returned. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + getRowProperties(rowPropertiesLoadOptions: RowPropertiesLoadOptions): + OfficeExtension.ClientResult; + parameters: + - id: rowPropertiesLoadOptions + description: An object that represents which row properties to load. + type: + return: + type: >- + <[]> + description: >- + An array where each item represents the requested properties of the + corresponding row. + - name: getRowsAbove(count) + uid: excel!Excel.Range#getRowsAbove:member(1) + package: excel! + fullName: getRowsAbove(count) + summary: Gets a certain number of rows above the current `Range` object. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getRowsAbove(count?: number): Excel.Range;' + parameters: + - id: count + description: >- + Optional. The number of rows to include in the resulting range. In + general, use a positive number to create a range outside the current + range. You can also use a negative number to create a range within + the current range. The default value is 1. + type: number + return: + type: + description: '' + - name: getRowsBelow(count) + uid: excel!Excel.Range#getRowsBelow:member(1) + package: excel! + fullName: getRowsBelow(count) + summary: Gets a certain number of rows below the current `Range` object. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getRowsBelow(count?: number): Excel.Range;' + parameters: + - id: count + description: >- + Optional. The number of rows to include in the resulting range. In + general, use a positive number to create a range outside the current + range. You can also use a negative number to create a range within + the current range. The default value is 1. + type: number + return: + type: + description: '' + - name: getSpecialCells(cellType, cellValueType) + uid: excel!Excel.Range#getSpecialCells:member(1) + package: excel! + fullName: getSpecialCells(cellType, cellValueType) + summary: >- + Gets the `RangeAreas` object, comprising one or more rectangular ranges, + that represents all the cells that match the specified type and value. If + no special cells are found, an `ItemNotFound` error will be thrown. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-areas.yaml + + + await Excel.run(async (context) => { + + const sheet = context.workbook.worksheets.getActiveWorksheet(); + const usedRange = sheet.getUsedRange(); + + // Find the ranges with either text or logical (boolean) values. + const formulaRanges = usedRange.getSpecialCells("Constants", "LogicalText"); + formulaRanges.format.fill.color = "orange"; + + return context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + getSpecialCells(cellType: Excel.SpecialCellType, cellValueType?: + Excel.SpecialCellValueType): Excel.RangeAreas; + parameters: + - id: cellType + description: The type of cells to include. + type: + - id: cellValueType + description: >- + If `cellType` is either `constants` or `formulas`, this + argument is used to determine which types of cells to include in the + result. These values can be combined together to return more than + one type. The default is to select all constants or formulas, no + matter what the type. + type: + return: + type: + description: '' + - name: getSpecialCells(cellType, cellValueType) + uid: excel!Excel.Range#getSpecialCells:member(2) + package: excel! + fullName: getSpecialCells(cellType, cellValueType) + summary: >- + Gets the `RangeAreas` object, comprising one or more rectangular ranges, + that represents all the cells that match the specified type and value. If + no special cells are found, an `ItemNotFound` error will be thrown. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + getSpecialCells(cellType: "ConditionalFormats" | "DataValidations" | + "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | + "SameDataValidation" | "Visible", cellValueType?: "All" | "Errors" | + "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" + | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | + "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | + "NumbersText" | "Text"): Excel.RangeAreas; + parameters: + - id: cellType + description: The type of cells to include. + type: >- + "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | + "Formulas" | "SameConditionalFormat" | "SameDataValidation" | + "Visible" + - id: cellValueType + description: >- + If `cellType` is either `constants` or `formulas`, this + argument is used to determine which types of cells to include in the + result. These values can be combined together to return more than + one type. The default is to select all constants or formulas, no + matter what the type. + type: >- + "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" + | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | + "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" + | "Numbers" | "NumbersText" | "Text" + return: + type: + description: '' + - name: getSpecialCellsOrNullObject(cellType, cellValueType) + uid: excel!Excel.Range#getSpecialCellsOrNullObject:member(1) + package: excel! + fullName: getSpecialCellsOrNullObject(cellType, cellValueType) + summary: >- + Gets the `RangeAreas` object, comprising one or more ranges, that + represents all the cells that match the specified type and value. If no + special cells are found, then this method returns an object with its + `isNullObject` property set to `true`. For further information, + see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, + cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas; + parameters: + - id: cellType + description: The type of cells to include. + type: + - id: cellValueType + description: >- + If `cellType` is either `constants` or `formulas`, this + argument is used to determine which types of cells to include in the + result. These values can be combined together to return more than + one type. The default is to select all constants or formulas, no + matter what the type. + type: + return: + type: + description: '' + - name: getSpecialCellsOrNullObject(cellType, cellValueType) + uid: excel!Excel.Range#getSpecialCellsOrNullObject:member(2) + package: excel! + fullName: getSpecialCellsOrNullObject(cellType, cellValueType) + summary: >- + Gets the `RangeAreas` object, comprising one or more ranges, that + represents all the cells that match the specified type and value. If no + special cells are found, then this method returns an object with its + `isNullObject` property set to `true`. For further information, + see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + getSpecialCellsOrNullObject(cellType: "ConditionalFormats" | + "DataValidations" | "Blanks" | "Constants" | "Formulas" | + "SameConditionalFormat" | "SameDataValidation" | "Visible", + cellValueType?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | + "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | + "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | + "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): + Excel.RangeAreas; + parameters: + - id: cellType + description: The type of cells to include. + type: >- + "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | + "Formulas" | "SameConditionalFormat" | "SameDataValidation" | + "Visible" + - id: cellValueType + description: >- + If `cellType` is either `constants` or `formulas`, this + argument is used to determine which types of cells to include in the + result. These values can be combined together to return more than + one type. The default is to select all constants or formulas, no + matter what the type. + type: >- + "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" + | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | + "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" + | "Numbers" | "NumbersText" | "Text" + return: + type: + description: '' + - name: getSpillingToRange() + uid: excel!Excel.Range#getSpillingToRange:member(1) + package: excel! + fullName: getSpillingToRange() + summary: >- + Gets the range object containing the spill range when called on an anchor + cell. Fails if applied to a range with more than one cell. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/dynamic-arrays.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + + // Set G4 to a formula that returns a dynamic array. + const targetCell = sheet.getRange("G4"); + targetCell.formulas = [["=A4:D4"]]; + + // Get the address of the cells that the dynamic array spilled into. + const spillRange = targetCell.getSpillingToRange(); + spillRange.load("address"); + + // Fit the columns for readability. + sheet.getUsedRange().format.autofitColumns(); + await context.sync(); + + console.log(`Copying the table headers spilled into ${spillRange.address}.`); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getSpillingToRange(): Excel.Range;' + return: + type: + description: '' + - name: getSpillingToRangeOrNullObject() + uid: excel!Excel.Range#getSpillingToRangeOrNullObject:member(1) + package: excel! + fullName: getSpillingToRangeOrNullObject() + summary: >- + Gets the range object containing the spill range when called on an anchor + cell. If the range isn't an anchor cell or the spill range can't be found, + then this method returns an object with its `isNullObject` property set to + `true`. For further information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getSpillingToRangeOrNullObject(): Excel.Range;' + return: + type: + description: '' + - name: getSpillParent() + uid: excel!Excel.Range#getSpillParent:member(1) + package: excel! + fullName: getSpillParent() + summary: >- + Gets the range object containing the anchor cell for a cell getting + spilled into. Fails if applied to a range with more than one cell. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getSpillParent(): Excel.Range;' + return: + type: + description: '' + - name: getSpillParentOrNullObject() + uid: excel!Excel.Range#getSpillParentOrNullObject:member(1) + package: excel! + fullName: getSpillParentOrNullObject() + summary: >- + Gets the range object containing the anchor cell for the cell getting + spilled into. If it's not a spilled cell, or more than one cell is given, + then this method returns an object with its `isNullObject` property set to + `true`. For further information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getSpillParentOrNullObject(): Excel.Range;' + return: + type: + description: '' + - name: getSurroundingRegion() + uid: excel!Excel.Range#getSurroundingRegion:member(1) + package: excel! + fullName: getSurroundingRegion() + summary: >- + Returns a `Range` object that represents the surrounding region for the + top-left cell in this range. A surrounding region is a range bounded by + any combination of blank rows and blank columns relative to this range. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getSurroundingRegion(): Excel.Range;' + return: + type: + description: '' + - name: getTables(fullyContained) + uid: excel!Excel.Range#getTables:member(1) + package: excel! + fullName: getTables(fullyContained) + summary: Gets a scoped collection of tables that overlap with the range. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getTables(fullyContained?: boolean): Excel.TableScopedCollection;' + parameters: + - id: fullyContained + description: >- + If `true`, returns only tables that are fully contained + within the range bounds. The default value is `false`. + type: boolean + return: + type: + description: '' + - name: getUsedRange(valuesOnly) + uid: excel!Excel.Range#getUsedRange:member(1) + package: excel! + fullName: getUsedRange(valuesOnly) + summary: >- + Returns the used range of the given range object. If there are no used + cells within the range, this function will throw an `ItemNotFound` error. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-relationships.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const salesTable = sheet.tables.getItem("SalesTable"); + const dataRange = salesTable.getDataBodyRange(); + + // We want the most recent quarter that has data, so + // exclude quarters without data and get the last of + // the remaining columns. + const usedDataRange = dataRange.getUsedRange(true /* valuesOnly */); + const currentQuarterRange = usedDataRange.getLastColumn(); + + // Asian and European teams have separate contests. + const asianSalesRange = sheet.getRange("A2:E4"); + const europeanSalesRange = sheet.getRange("A5:E7"); + + // The data for each chart is the intersection of the + // current quarter column and the rows for the continent. + const asianContestRange = asianSalesRange.getIntersectionOrNullObject(currentQuarterRange); + const europeanContestRange = europeanSalesRange.getIntersectionOrNullObject(currentQuarterRange); + + // Must sync before you can test the output of *OrNullObject + // method/property. + await context.sync(); + + if (asianContestRange.isNullObject) { + // See the declaration of this function for how to + // test this code path. + reportMissingData("Asian"); + } else { + createContinentChart( + sheet, + "Asian", + asianContestRange, + "A9", + "F24" + ); + } + + if (europeanContestRange.isNullObject) { + // See the declaration of this function for how to + // test this code path. + reportMissingData("European"); + } else { + createContinentChart( + sheet, + "European", + europeanContestRange, + "A25", + "F40" + ); + } + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getUsedRange(valuesOnly?: boolean): Excel.Range;' + parameters: + - id: valuesOnly + description: >- + Considers only cells with values as used cells. \[Api set: ExcelApi + 1.2\] + type: boolean + return: + type: + description: '' + - name: getUsedRangeOrNullObject(valuesOnly) + uid: excel!Excel.Range#getUsedRangeOrNullObject:member(1) + package: excel! + fullName: getUsedRangeOrNullObject(valuesOnly) + summary: >- + Returns the used range of the given range object. If there are no used + cells within the range, then this method returns an object with its + `isNullObject` property set to `true`. For further information, + see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/used-range.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const salesTable = sheet.tables.getItem("SalesTable"); + const dataRange = salesTable.getDataBodyRange(); + + // Pass true so only cells with values count as used + const usedDataRange = dataRange.getUsedRangeOrNullObject( + true /* valuesOnly */ + ); + + //Must sync before reading value returned from *OrNullObject method/property. + await context.sync(); + + if (usedDataRange.isNullObject) { + console.log("Need Data to Make Chart"); + console.log("To create a meaningful chart, press 'Fill the table' (or add names to the Product column and numbers to some of the other cells). Then press 'Try to create chart' again."); + } else { + const chart = sheet.charts.add( + Excel.ChartType.columnClustered, + dataRange, + "Columns" + ); + chart.setPosition("A15", "F30"); + chart.title.text = "Quarterly sales chart"; + chart.legend.position = "Right"; + chart.legend.format.fill.setSolidColor("white"); + chart.dataLabels.format.font.size = 15; + chart.dataLabels.format.font.color = "black"; + } + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getUsedRangeOrNullObject(valuesOnly?: boolean): Excel.Range;' + parameters: + - id: valuesOnly + description: Considers only cells with values as used cells. + type: boolean + return: + type: + description: '' + - name: getVisibleView() + uid: excel!Excel.Range#getVisibleView:member(1) + package: excel! + fullName: getVisibleView() + summary: Represents the visible rows of the current range. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getVisibleView(): Excel.RangeView;' + return: + type: + description: '' + - name: group(groupOption) + uid: excel!Excel.Range#group:member(1) + package: excel! + fullName: group(groupOption) + summary: Groups columns and rows for an outline. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/outline.yaml + + + Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Group the larger, main level. Note that the outline controls + // will be on row 10, meaning 4-9 will collapse and expand. + sheet.getRange("4:9").group(Excel.GroupOption.byRows); + + // Group the smaller, sublevels. Note that the outline controls + // will be on rows 6 and 9, meaning 4-5 and 7-8 will collapse and expand. + sheet.getRange("4:5").group(Excel.GroupOption.byRows); + sheet.getRange("7:8").group(Excel.GroupOption.byRows); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'group(groupOption: Excel.GroupOption): void;' + parameters: + - id: groupOption + description: >- + Specifies how the range can be grouped by rows or columns. An + `InvalidArgument` error is thrown when the group option differs from + the range's `isEntireRow` or `isEntireColumn` property (i.e., + `range.isEntireRow` is true and `groupOption` is "ByColumns" or + `range.isEntireColumn` is true and `groupOption` is "ByRows"). + type: + return: + type: void + description: '' + - name: group(groupOption) + uid: excel!Excel.Range#group:member(2) + package: excel! + fullName: group(groupOption) + summary: Groups columns and rows for an outline. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'group(groupOption: "ByRows" | "ByColumns"): void;' + parameters: + - id: groupOption + description: >- + Specifies how the range can be grouped by rows or columns. An + `InvalidArgument` error is thrown when the group option differs from + the range's `isEntireRow` or `isEntireColumn` property (i.e., + `range.isEntireRow` is true and `groupOption` is "ByColumns" or + `range.isEntireColumn` is true and `groupOption` is "ByRows"). + type: '"ByRows" | "ByColumns"' + return: + type: void + description: '' + - name: hideGroupDetails(groupOption) + uid: excel!Excel.Range#hideGroupDetails:member(1) + package: excel! + fullName: hideGroupDetails(groupOption) + summary: Hides the details of the row or column group. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'hideGroupDetails(groupOption: Excel.GroupOption): void;' + parameters: + - id: groupOption + description: >- + Specifies whether to hide the details of grouped rows or grouped + columns. + type: + return: + type: void + description: '' + - name: hideGroupDetails(groupOption) + uid: excel!Excel.Range#hideGroupDetails:member(2) + package: excel! + fullName: hideGroupDetails(groupOption) + summary: Hides the details of the row or column group. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'hideGroupDetails(groupOption: "ByRows" | "ByColumns"): void;' + parameters: + - id: groupOption + description: >- + Specifies whether to hide the details of grouped rows or grouped + columns. + type: '"ByRows" | "ByColumns"' + return: + type: void + description: '' + - name: insert(shift) + uid: excel!Excel.Range#insert:member(1) + package: excel! + fullName: insert(shift) + summary: >- + Inserts a cell or a range of cells into the worksheet in place of this + range, and shifts the other cells to make space. Returns a new `Range` + object at the now blank space. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const sheetName = "Sheet1"; + const rangeAddress = "F5:F10"; + const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); + range.insert(Excel.InsertShiftDirection.down); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'insert(shift: Excel.InsertShiftDirection): Excel.Range;' + parameters: + - id: shift + description: >- + Specifies which way to shift the cells. See + `Excel.InsertShiftDirection` for details. + type: + return: + type: + description: '' + - name: insert(shift) + uid: excel!Excel.Range#insert:member(2) + package: excel! + fullName: insert(shift) + summary: >- + Inserts a cell or a range of cells into the worksheet in place of this + range, and shifts the other cells to make space. Returns a new `Range` + object at the now blank space. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'insert(shift: "Down" | "Right"): Excel.Range;' + parameters: + - id: shift + description: >- + Specifies which way to shift the cells. See + `Excel.InsertShiftDirection` for details. + type: '"Down" | "Right"' + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.Range#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(options?: Excel.Interfaces.RangeLoadOptions): Excel.Range;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.Range#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.Range;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: |- + + + #### Examples + + ```TypeScript + // Use the range address to get the range object. + await Excel.run(async (context) => { + const sheetName = "Sheet1"; + const rangeAddress = "A1:F8"; + const worksheet = context.workbook.worksheets.getItem(sheetName); + const range = worksheet.getRange(rangeAddress); + range.load('cellCount'); + await context.sync(); + + console.log(range.cellCount); + }); + ``` + - name: load(propertyNamesAndPaths) + uid: excel!Excel.Range#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.Range; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: merge(across) + uid: excel!Excel.Range#merge:member(1) + package: excel! + fullName: merge(across) + summary: Merge the range cells into one region in the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const sheetName = "Sheet1"; + const rangeAddress = "A1:C3"; + const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); + range.merge(true); + await context.sync(); + }); + + ``` + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-merged-ranges.yaml + + + await Excel.run(async (context) => { + // Retrieve the worksheet and the table in that worksheet. + const sheet = context.workbook.worksheets.getActiveWorksheet(); + const tableRange = sheet.getRange("B2:E6"); + + // Create a merged range in the first row of the table. + const chartTitle = tableRange.getRow(0); + chartTitle.merge(true); + + // Format the merged range. + chartTitle.format.horizontalAlignment = "Center"; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'merge(across?: boolean): void;' + parameters: + - id: across + description: >- + Optional. Set `true` to merge cells in each row of the specified + range as separate merged cells. The default value is `false`. + type: boolean + return: + type: void + description: '' + - name: moveTo(destinationRange) + uid: excel!Excel.Range#moveTo:member(1) + package: excel! + fullName: moveTo(destinationRange) + summary: >- + Moves cell values, formatting, and formulas from current range to the + destination range, replacing the old information in those cells. The + destination range will be expanded automatically if it is smaller than the + current range. Any cells in the destination range that are outside of the + original range's area are not changed. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-copyfrom.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + // Place a label in front of the moved data. + sheet.getRange("F12").values = [["Moved Range:"]]; + + // Move the range from A1:E1 to G12:K12. + sheet.getRange("A1:E1").moveTo("G12"); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'moveTo(destinationRange: Range | string): void;' + parameters: + - id: destinationRange + description: >- + destinationRange Specifies the range to where the information in + this range will be moved. + type: | string + return: + type: void + description: '' + - name: removeDuplicates(columns, includesHeader) + uid: excel!Excel.Range#removeDuplicates:member(1) + package: excel! + fullName: removeDuplicates(columns, includesHeader) + summary: Removes duplicate values from the range specified by the columns. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-remove-duplicates.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const range = sheet.getRange("B2:D11"); + + const deleteResult = range.removeDuplicates([0],true); + deleteResult.load(); + await context.sync(); + + console.log(deleteResult.removed + " entries with duplicate names removed."); + console.log(deleteResult.uniqueRemaining + " entries with unique names remain in the range."); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + removeDuplicates(columns: number[], includesHeader: boolean): + Excel.RemoveDuplicatesResult; + parameters: + - id: columns + description: >- + The columns inside the range that may contain duplicates. At least + one column needs to be specified. Zero-indexed. + type: number[] + - id: includesHeader + description: True if the input data contains header. Default is false. + type: boolean + return: + type: + description: >- + The resulting object that contains the number of rows removed and the + number of remaining unique rows. + - name: replaceAll(text, replacement, criteria) + uid: excel!Excel.Range#replaceAll:member(1) + package: excel! + fullName: replaceAll(text, replacement, criteria) + summary: >- + Finds and replaces the given string based on the criteria specified within + the current range. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + replaceAll(text: string, replacement: string, criteria: + Excel.ReplaceCriteria): OfficeExtension.ClientResult; + parameters: + - id: text + description: String to find. + type: string + - id: replacement + description: The string that replaces the original string. + type: string + - id: criteria + description: Additional replacement criteria. + type: + return: + type: <number> + description: The number of replacements performed. + - name: select() + uid: excel!Excel.Range#select:member(1) + package: excel! + fullName: select() + summary: Selects the specified range in the Excel UI. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const sheetName = "Sheet1"; + const rangeAddress = "F5:F10"; + const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); + range.select(); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'select(): void;' + return: + type: void + description: '' + - name: set(properties, options) + uid: excel!Excel.Range#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.RangeUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.Range#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.Range): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: >- + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/90-scenarios/multiple-property-set.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + + const sourceRange = sheet.getRange("B2:E2"); + sourceRange.load("format/fill/color, format/font/name, format/font/color"); + await context.sync(); + + // Set properties based on the loaded and synced + // source range. + const targetRange = sheet.getRange("B7:E7"); + targetRange.set(sourceRange); + targetRange.format.autofitColumns(); + await context.sync(); + }); + + ``` + - name: setCellProperties(cellPropertiesData) + uid: excel!Excel.Range#setCellProperties:member(1) + package: excel! + fullName: setCellProperties(cellPropertiesData) + summary: >- + Updates the range based on a 2D array of cell properties, encapsulating + things like font, fill, borders, and alignment. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/cell-properties.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Creating the SettableCellProperties objects to use for the range. + // In your add-in, these should be created once, outside the function. + const topHeaderProps: Excel.SettableCellProperties = { + // The style property takes a string matching the name of an Excel style. + // Built-in style names are listed in the `BuiltInStyle` enum. + // Note that a style will overwrite any formatting, + // so do not use the format property with the style property. + style: "Heading1" + }; + + const headerProps: Excel.SettableCellProperties = { + // Any subproperties of format that are not set will not be changed when these cell properties are set. + format: { + fill: { + color: "Blue" + }, + font: { + color: "White", + bold: true + } + } + }; + + const nonApplicableProps: Excel.SettableCellProperties = { + format: { + fill: { + pattern: Excel.FillPattern.gray25 + }, + font: { + color: "Gray", + italic: true + } + } + }; + + const matchupScoreProps: Excel.SettableCellProperties = { + format: { + borders: { + bottom: { + style: Excel.BorderLineStyle.continuous + }, + left: { + style: Excel.BorderLineStyle.continuous + }, + right: { + style: Excel.BorderLineStyle.continuous + }, + top: { + style: Excel.BorderLineStyle.continuous + } + } + } + }; + + const range = sheet.getRange("A1:E5"); + + // You can use empty JSON objects to avoid changing a cell's properties. + range.setCellProperties([ + [topHeaderProps, {}, {}, {}, {}], + [{}, {}, headerProps, headerProps, headerProps], + [{}, headerProps, nonApplicableProps, matchupScoreProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, nonApplicableProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, matchupScoreProps, nonApplicableProps] + ]); + + sheet.getUsedRange().format.autofitColumns(); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'setCellProperties(cellPropertiesData: SettableCellProperties[][]): void;' + parameters: + - id: cellPropertiesData + description: A 2D array that represents which properties to set in each cell. + type: [][] + return: + type: void + description: '' + - name: setColumnProperties(columnPropertiesData) + uid: excel!Excel.Range#setColumnProperties:member(1) + package: excel! + fullName: setColumnProperties(columnPropertiesData) + summary: >- + Updates the range based on a single-dimensional array of column + properties, encapsulating things like font, fill, borders, and alignment. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + setColumnProperties(columnPropertiesData: SettableColumnProperties[]): + void; + parameters: + - id: columnPropertiesData + description: An array that represents which properties to set in each column. + type: [] + return: + type: void + description: '' + - name: setDirty() + uid: excel!Excel.Range#setDirty:member(1) + package: excel! + fullName: setDirty() + summary: Set a range to be recalculated when the next recalculation occurs. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'setDirty(): void;' + return: + type: void + description: '' + - name: setRowProperties(rowPropertiesData) + uid: excel!Excel.Range#setRowProperties:member(1) + package: excel! + fullName: setRowProperties(rowPropertiesData) + summary: >- + Updates the range based on a single-dimensional array of row properties, + encapsulating things like font, fill, borders, and alignment. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'setRowProperties(rowPropertiesData: SettableRowProperties[]): void;' + parameters: + - id: rowPropertiesData + description: An array that represents which properties to set in each row. + type: [] + return: + type: void + description: '' + - name: showCard() + uid: excel!Excel.Range#showCard:member(1) + package: excel! + fullName: showCard() + summary: Displays the card for an active cell if it has rich value content. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showCard(): void;' + return: + type: void + description: '' + - name: showGroupDetails(groupOption) + uid: excel!Excel.Range#showGroupDetails:member(1) + package: excel! + fullName: showGroupDetails(groupOption) + summary: Shows the details of the row or column group. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showGroupDetails(groupOption: Excel.GroupOption): void;' + parameters: + - id: groupOption + description: >- + Specifies whether to show the details of grouped rows or grouped + columns. + type: + return: + type: void + description: '' + - name: showGroupDetails(groupOption) + uid: excel!Excel.Range#showGroupDetails:member(2) + package: excel! + fullName: showGroupDetails(groupOption) + summary: Shows the details of the row or column group. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showGroupDetails(groupOption: "ByRows" | "ByColumns"): void;' + parameters: + - id: groupOption + description: >- + Specifies whether to show the details of grouped rows or grouped + columns. + type: '"ByRows" | "ByColumns"' + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.Range#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.Range` object is + an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Excel.Interfaces.RangeData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.RangeData;' + return: + type: + description: '' + - name: track() + uid: excel!Excel.Range#track:member(1) + package: excel! + fullName: track() + summary: >- + Track the object for automatic adjustment based on surrounding changes in + the document. This call is a shorthand for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). If you're using this object across `.sync` calls and outside the + sequential execution of a ".run" batch, and get an "InvalidObjectPath" + error when setting a property or invoking a method on the object, you need + to add the object to the tracked object collection when the object was + first created. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'track(): Excel.Range;' + return: + type: + description: '' + - name: ungroup(groupOption) + uid: excel!Excel.Range#ungroup:member(1) + package: excel! + fullName: ungroup(groupOption) + summary: Ungroups columns and rows for an outline. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/outline.yaml + + + Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // This removes two levels of groups from the "A1-R10" range. + // Any groups at the same level on the same dimension will be removed by a single call. + sheet.getRange("A1:R10").ungroup(Excel.GroupOption.byRows); + sheet.getRange("A1:R10").ungroup(Excel.GroupOption.byRows); + sheet.getRange("A1:R10").ungroup(Excel.GroupOption.byColumns); + sheet.getRange("A1:R10").ungroup(Excel.GroupOption.byColumns); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'ungroup(groupOption: Excel.GroupOption): void;' + parameters: + - id: groupOption + description: Specifies how the range can be ungrouped by rows or columns. + type: + return: + type: void + description: '' + - name: ungroup(groupOption) + uid: excel!Excel.Range#ungroup:member(2) + package: excel! + fullName: ungroup(groupOption) + summary: Ungroups columns and rows for an outline. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'ungroup(groupOption: "ByRows" | "ByColumns"): void;' + parameters: + - id: groupOption + description: Specifies how the range can be ungrouped by rows or columns. + type: '"ByRows" | "ByColumns"' + return: + type: void + description: '' + - name: unmerge() + uid: excel!Excel.Range#unmerge:member(1) + package: excel! + fullName: unmerge() + summary: Unmerge the range cells into separate cells. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const sheetName = "Sheet1"; + const rangeAddress = "A1:C3"; + const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); + range.unmerge(); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'unmerge(): void;' + return: + type: void + description: '' + - name: untrack() + uid: excel!Excel.Range#untrack:member(1) + package: excel! + fullName: untrack() + summary: >- + Release the memory associated with this object, if it has previously been + tracked. This call is shorthand for + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). Having many tracked objects slows down the host application, so + please remember to free any objects you add, once you're done using them. + You'll need to call `context.sync()` before the memory release takes + effect. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'untrack(): Excel.Range;' + return: + type: + description: |- + + + #### Examples + + ```TypeScript + await Excel.run(async (context) => { + const largeRange = context.workbook.getSelectedRange(); + largeRange.load(["rowCount", "columnCount"]); + await context.sync(); + + for (let i = 0; i < largeRange.rowCount; i++) { + for (let j = 0; j < largeRange.columnCount; j++) { + const cell = largeRange.getCell(i, j); + cell.values = [[i *j]]; + + // Call untrack() to release the range from memory. + cell.untrack(); + } + } + + await context.sync(); + }); + ``` +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.rangeareas.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.rangeareas.yml new file mode 100644 index 0000000000..a970c4db04 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.rangeareas.yml @@ -0,0 +1,1092 @@ +### YamlMime:TSType +name: Excel.RangeAreas +uid: excel!Excel.RangeAreas:class +package: excel! +fullName: Excel.RangeAreas +summary: >- + `RangeAreas` represents a collection of one or more rectangular ranges in the + same worksheet. To learn how to use discontiguous ranges, read [Work with + multiple ranges simultaneously in Excel + add-ins](https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-multiple-ranges). +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: address + uid: excel!Excel.RangeAreas#address:member + package: excel! + fullName: address + summary: >- + Returns the `RangeAreas` reference in A1-style. Address value will contain + the worksheet name for each rectangular block of cells (e.g., + "Sheet1!A1:B4, Sheet1!D1:D4"). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly address: string;' + return: + type: string + - name: addressLocal + uid: excel!Excel.RangeAreas#addressLocal:member + package: excel! + fullName: addressLocal + summary: Returns the `RangeAreas` reference in the user locale. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly addressLocal: string;' + return: + type: string + - name: areaCount + uid: excel!Excel.RangeAreas#areaCount:member + package: excel! + fullName: areaCount + summary: >- + Returns the number of rectangular ranges that comprise this `RangeAreas` + object. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly areaCount: number;' + return: + type: number + - name: areas + uid: excel!Excel.RangeAreas#areas:member + package: excel! + fullName: areas + summary: >- + Returns a collection of rectangular ranges that comprise this `RangeAreas` + object. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly areas: Excel.RangeCollection;' + return: + type: + - name: cellCount + uid: excel!Excel.RangeAreas#cellCount:member + package: excel! + fullName: cellCount + summary: >- + Returns the number of cells in the `RangeAreas` object, summing up the + cell counts of all of the individual rectangular ranges. Returns -1 if the + cell count exceeds 2^31-1 (2,147,483,647). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly cellCount: number;' + return: + type: number + - name: conditionalFormats + uid: excel!Excel.RangeAreas#conditionalFormats:member + package: excel! + fullName: conditionalFormats + summary: >- + Returns a collection of conditional formats that intersect with any cells + in this `RangeAreas` object. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly conditionalFormats: Excel.ConditionalFormatCollection;' + return: + type: + - name: context + uid: excel!Excel.RangeAreas#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: dataValidation + uid: excel!Excel.RangeAreas#dataValidation:member + package: excel! + fullName: dataValidation + summary: >- + Returns a data validation object for all ranges in the `RangeAreas`. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly dataValidation: Excel.DataValidation;' + return: + type: + - name: format + uid: excel!Excel.RangeAreas#format:member + package: excel! + fullName: format + summary: >- + Returns a `RangeFormat` object, encapsulating the font, fill, borders, + alignment, and other properties for all ranges in the `RangeAreas` object. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-areas.yaml + + + await Excel.run(async (context) => { + + const sheet = context.workbook.worksheets.getActiveWorksheet(); + const usedRange = sheet.getUsedRange(); + + // Find the ranges with formulas. + const formulaRanges = usedRange.getSpecialCells("Formulas"); + formulaRanges.format.fill.color = "lightgreen"; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly format: Excel.RangeFormat;' + return: + type: + - name: isEntireColumn + uid: excel!Excel.RangeAreas#isEntireColumn:member + package: excel! + fullName: isEntireColumn + summary: >- + Specifies if all the ranges on this `RangeAreas` object represent entire + columns (e.g., "A:C, Q:Z"). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly isEntireColumn: boolean;' + return: + type: boolean + - name: isEntireRow + uid: excel!Excel.RangeAreas#isEntireRow:member + package: excel! + fullName: isEntireRow + summary: >- + Specifies if all the ranges on this `RangeAreas` object represent entire + rows (e.g., "1:3, 5:7"). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly isEntireRow: boolean;' + return: + type: boolean + - name: style + uid: excel!Excel.RangeAreas#style:member + package: excel! + fullName: style + summary: >- + Represents the style for all ranges in this `RangeAreas` object. If the + styles of the cells are inconsistent, `null` will be returned. For custom + styles, the style name will be returned. For built-in styles, a string + representing a value in the `BuiltInStyle` enum will be returned. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'style: string;' + return: + type: string + - name: worksheet + uid: excel!Excel.RangeAreas#worksheet:member + package: excel! + fullName: worksheet + summary: Returns the worksheet for the current `RangeAreas`. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly worksheet: Excel.Worksheet;' + return: + type: +methods: + - name: calculate() + uid: excel!Excel.RangeAreas#calculate:member(1) + package: excel! + fullName: calculate() + summary: Calculates all cells in the `RangeAreas`. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'calculate(): void;' + return: + type: void + description: '' + - name: clear(applyTo) + uid: excel!Excel.RangeAreas#clear:member(1) + package: excel! + fullName: clear(applyTo) + summary: >- + Clears values, format, fill, border, and other properties on each of the + areas that comprise this `RangeAreas` object. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'clear(applyTo?: Excel.ClearApplyTo): void;' + parameters: + - id: applyTo + description: >- + Optional. Determines the type of clear action. See + `Excel.ClearApplyTo` for details. Default is "All". + type: + return: + type: void + description: '' + - name: clear(applyTo) + uid: excel!Excel.RangeAreas#clear:member(2) + package: excel! + fullName: clear(applyTo) + summary: >- + Clears values, format, fill, border, and other properties on each of the + areas that comprise this `RangeAreas` object. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + clear(applyTo?: "All" | "Formats" | "Contents" | "Hyperlinks" | + "RemoveHyperlinks" | "ResetContents"): void; + parameters: + - id: applyTo + description: >- + Optional. Determines the type of clear action. See + `Excel.ClearApplyTo` for details. Default is "All". + type: >- + "All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks" | + "ResetContents" + return: + type: void + description: '' + - name: clearOrResetContents() + uid: excel!Excel.RangeAreas#clearOrResetContents:member(1) + package: excel! + fullName: clearOrResetContents() + summary: >- + Clears the values of the cells in the ranges, with special consideration + given to cells containing controls. If the ranges contain only blank + values and controls set to their default value, then the values and + control formatting are removed. Otherwise, this sets the cells with + controls to their default value and clears the values of the other cells + in the ranges. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'clearOrResetContents(): void;' + return: + type: void + description: '' + - name: convertDataTypeToText() + uid: excel!Excel.RangeAreas#convertDataTypeToText:member(1) + package: excel! + fullName: convertDataTypeToText() + summary: Converts all cells in the `RangeAreas` with data types into text. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'convertDataTypeToText(): void;' + return: + type: void + description: '' + - name: convertToLinkedDataType(serviceID, languageCulture) + uid: excel!Excel.RangeAreas#convertToLinkedDataType:member(1) + package: excel! + fullName: convertToLinkedDataType(serviceID, languageCulture) + summary: Converts all cells in the `RangeAreas` into linked data types. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + convertToLinkedDataType(serviceID: number, languageCulture: string): + void; + parameters: + - id: serviceID + description: The service ID which will be used to query the data. + type: number + - id: languageCulture + description: Language culture to query the service for. + type: string + return: + type: void + description: '' + - name: copyFrom(sourceRange, copyType, skipBlanks, transpose) + uid: excel!Excel.RangeAreas#copyFrom:member(1) + package: excel! + fullName: copyFrom(sourceRange, copyType, skipBlanks, transpose) + summary: >- + Copies cell data or formatting from the source range or `RangeAreas` to + the current `RangeAreas`. The destination `RangeAreas` can be a + different size than the source range or `RangeAreas`. The + destination will be expanded automatically if it is smaller than the + source. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + copyFrom(sourceRange: Range | RangeAreas | string, copyType?: + Excel.RangeCopyType, skipBlanks?: boolean, transpose?: boolean): void; + parameters: + - id: sourceRange + description: >- + The source range or `RangeAreas` to copy from. When the source + `RangeAreas` has multiple ranges, their form must able to be created + by removing full rows or columns from a rectangular range. + type: >- + | | string + - id: copyType + description: The type of cell data or formatting to copy over. Default is "All". + type: + - id: skipBlanks + description: >- + True if to skip blank cells in the source range or `RangeAreas`. Default is false. + type: boolean + - id: transpose + description: >- + True if to transpose the cells in the destination `RangeAreas`. Default is false. + type: boolean + return: + type: void + description: '' + - name: copyFrom(sourceRange, copyType, skipBlanks, transpose) + uid: excel!Excel.RangeAreas#copyFrom:member(2) + package: excel! + fullName: copyFrom(sourceRange, copyType, skipBlanks, transpose) + summary: >- + Copies cell data or formatting from the source range or `RangeAreas` to + the current `RangeAreas`. The destination `RangeAreas` can be a + different size than the source range or `RangeAreas`. The + destination will be expanded automatically if it is smaller than the + source. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + copyFrom(sourceRange: Range | RangeAreas | string, copyType?: "All" | + "Formulas" | "Values" | "Formats" | "Link", skipBlanks?: boolean, + transpose?: boolean): void; + parameters: + - id: sourceRange + description: >- + The source range or `RangeAreas` to copy from. When the source + `RangeAreas` has multiple ranges, their form must able to be created + by removing full rows or columns from a rectangular range. + type: >- + | | string + - id: copyType + description: The type of cell data or formatting to copy over. Default is "All". + type: '"All" | "Formulas" | "Values" | "Formats" | "Link"' + - id: skipBlanks + description: >- + True if to skip blank cells in the source range or `RangeAreas`. Default is false. + type: boolean + - id: transpose + description: >- + True if to transpose the cells in the destination `RangeAreas`. Default is false. + type: boolean + return: + type: void + description: '' + - name: getEntireColumn() + uid: excel!Excel.RangeAreas#getEntireColumn:member(1) + package: excel! + fullName: getEntireColumn() + summary: >- + Returns a `RangeAreas` object that represents the entire columns of the + `RangeAreas` (for example, if the current `RangeAreas` represents cells + "B4:E11, H2", it returns a `RangeAreas` that represents columns "B:E, + H:H"). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getEntireColumn(): Excel.RangeAreas;' + return: + type: + description: '' + - name: getEntireRow() + uid: excel!Excel.RangeAreas#getEntireRow:member(1) + package: excel! + fullName: getEntireRow() + summary: >- + Returns a `RangeAreas` object that represents the entire rows of the + `RangeAreas` (for example, if the current `RangeAreas` represents cells + "B4:E11", it returns a `RangeAreas` that represents rows "4:11"). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getEntireRow(): Excel.RangeAreas;' + return: + type: + description: '' + - name: getIntersection(anotherRange) + uid: excel!Excel.RangeAreas#getIntersection:member(1) + package: excel! + fullName: getIntersection(anotherRange) + summary: >- + Returns the `RangeAreas` object that represents the intersection of the + given ranges or `RangeAreas`. If no intersection is found, an + `ItemNotFound` error will be thrown. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + getIntersection(anotherRange: Range | RangeAreas | string): + Excel.RangeAreas; + parameters: + - id: anotherRange + description: >- + The range, `RangeAreas` object, or range address that will be used + to determine the intersection. + type: >- + | | string + return: + type: + description: '' + - name: getIntersectionOrNullObject(anotherRange) + uid: excel!Excel.RangeAreas#getIntersectionOrNullObject:member(1) + package: excel! + fullName: getIntersectionOrNullObject(anotherRange) + summary: >- + Returns the `RangeAreas` object that represents the intersection of the + given ranges or `RangeAreas`. If no intersection is found, then + this method returns an object with its `isNullObject` property set to + `true`. For further information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + getIntersectionOrNullObject(anotherRange: Range | RangeAreas | string): + Excel.RangeAreas; + parameters: + - id: anotherRange + description: >- + The range, `RangeAreas` object, or address that will be used to + determine the intersection. + type: >- + | | string + return: + type: + description: '' + - name: getOffsetRangeAreas(rowOffset, columnOffset) + uid: excel!Excel.RangeAreas#getOffsetRangeAreas:member(1) + package: excel! + fullName: getOffsetRangeAreas(rowOffset, columnOffset) + summary: >- + Returns a `RangeAreas` object that is shifted by the specific row and + column offset. The dimension of the returned `RangeAreas` will match the + original object. If the resulting `RangeAreas` is forced outside the + bounds of the worksheet grid, an error will be thrown. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + getOffsetRangeAreas(rowOffset: number, columnOffset: number): + Excel.RangeAreas; + parameters: + - id: rowOffset + description: >- + The number of rows (positive, negative, or 0) by which the + `RangeAreas` is to be offset. Positive values are offset downward, + and negative values are offset upward. + type: number + - id: columnOffset + description: >- + The number of columns (positive, negative, or 0) by which the + `RangeAreas` is to be offset. Positive values are offset to the + right, and negative values are offset to the left. + type: number + return: + type: + description: '' + - name: getSpecialCells(cellType, cellValueType) + uid: excel!Excel.RangeAreas#getSpecialCells:member(1) + package: excel! + fullName: getSpecialCells(cellType, cellValueType) + summary: >- + Returns a `RangeAreas` object that represents all the cells that match the + specified type and value. Throws an error if no special cells are found + that match the criteria. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + getSpecialCells(cellType: Excel.SpecialCellType, cellValueType?: + Excel.SpecialCellValueType): Excel.RangeAreas; + parameters: + - id: cellType + description: The type of cells to include. + type: + - id: cellValueType + description: >- + If `cellType` is either `constants` or `formulas`, this + argument is used to determine which types of cells to include in the + result. These values can be combined together to return more than + one type. The default is to select all constants or formulas, no + matter what the type. + type: + return: + type: + description: '' + - name: getSpecialCells(cellType, cellValueType) + uid: excel!Excel.RangeAreas#getSpecialCells:member(2) + package: excel! + fullName: getSpecialCells(cellType, cellValueType) + summary: >- + Returns a `RangeAreas` object that represents all the cells that match the + specified type and value. Throws an error if no special cells are found + that match the criteria. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + getSpecialCells(cellType: "ConditionalFormats" | "DataValidations" | + "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | + "SameDataValidation" | "Visible", cellValueType?: "All" | "Errors" | + "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" + | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | + "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | + "NumbersText" | "Text"): Excel.RangeAreas; + parameters: + - id: cellType + description: The type of cells to include. + type: >- + "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | + "Formulas" | "SameConditionalFormat" | "SameDataValidation" | + "Visible" + - id: cellValueType + description: >- + If `cellType` is either `constants` or `formulas`, this + argument is used to determine which types of cells to include in the + result. These values can be combined together to return more than + one type. The default is to select all constants or formulas, no + matter what the type. + type: >- + "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" + | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | + "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" + | "Numbers" | "NumbersText" | "Text" + return: + type: + description: '' + - name: getSpecialCellsOrNullObject(cellType, cellValueType) + uid: excel!Excel.RangeAreas#getSpecialCellsOrNullObject:member(1) + package: excel! + fullName: getSpecialCellsOrNullObject(cellType, cellValueType) + summary: >- + Returns a `RangeAreas` object that represents all the cells that match the + specified type and value. If no special cells are found that match the + criteria, then this method returns an object with its `isNullObject` + property set to `true`. For further information, see + [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, + cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas; + parameters: + - id: cellType + description: The type of cells to include. + type: + - id: cellValueType + description: >- + If `cellType` is either `constants` or `formulas`, this + argument is used to determine which types of cells to include in the + result. These values can be combined together to return more than + one type. The default is to select all constants or formulas, no + matter what the type. + type: + return: + type: + description: '' + - name: getSpecialCellsOrNullObject(cellType, cellValueType) + uid: excel!Excel.RangeAreas#getSpecialCellsOrNullObject:member(2) + package: excel! + fullName: getSpecialCellsOrNullObject(cellType, cellValueType) + summary: >- + Returns a `RangeAreas` object that represents all the cells that match the + specified type and value. If no special cells are found that match the + criteria, then this method returns an object with its `isNullObject` + property set to `true`. For further information, see + [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + getSpecialCellsOrNullObject(cellType: "ConditionalFormats" | + "DataValidations" | "Blanks" | "Constants" | "Formulas" | + "SameConditionalFormat" | "SameDataValidation" | "Visible", + cellValueType?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | + "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | + "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | + "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): + Excel.RangeAreas; + parameters: + - id: cellType + description: The type of cells to include. + type: >- + "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | + "Formulas" | "SameConditionalFormat" | "SameDataValidation" | + "Visible" + - id: cellValueType + description: >- + If `cellType` is either `constants` or `formulas`, this + argument is used to determine which types of cells to include in the + result. These values can be combined together to return more than + one type. The default is to select all constants or formulas, no + matter what the type. + type: >- + "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" + | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | + "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" + | "Numbers" | "NumbersText" | "Text" + return: + type: + description: '' + - name: getTables(fullyContained) + uid: excel!Excel.RangeAreas#getTables:member(1) + package: excel! + fullName: getTables(fullyContained) + summary: >- + Returns a scoped collection of tables that overlap with any range in this + `RangeAreas` object. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getTables(fullyContained?: boolean): Excel.TableScopedCollection;' + parameters: + - id: fullyContained + description: >- + If `true`, returns only tables that are fully contained + within the range bounds. Default is `false`. + type: boolean + return: + type: + description: '' + - name: getUsedRangeAreas(valuesOnly) + uid: excel!Excel.RangeAreas#getUsedRangeAreas:member(1) + package: excel! + fullName: getUsedRangeAreas(valuesOnly) + summary: >- + Returns the used `RangeAreas` that comprises all the used areas of + individual rectangular ranges in the `RangeAreas` object. If there are no + used cells within the `RangeAreas`, the `ItemNotFound` error will + be thrown. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getUsedRangeAreas(valuesOnly?: boolean): Excel.RangeAreas;' + parameters: + - id: valuesOnly + description: >- + Whether to only consider cells with values as used cells. Default is + `false`. + type: boolean + return: + type: + description: '' + - name: getUsedRangeAreasOrNullObject(valuesOnly) + uid: excel!Excel.RangeAreas#getUsedRangeAreasOrNullObject:member(1) + package: excel! + fullName: getUsedRangeAreasOrNullObject(valuesOnly) + summary: >- + Returns the used `RangeAreas` that comprises all the used areas of + individual rectangular ranges in the `RangeAreas` object. If there are no + used cells within the `RangeAreas`, then this method returns an + object with its `isNullObject` property set to `true`. For further + information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getUsedRangeAreasOrNullObject(valuesOnly?: boolean): Excel.RangeAreas;' + parameters: + - id: valuesOnly + description: Whether to only consider cells with values as used cells. + type: boolean + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.RangeAreas#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.RangeAreasLoadOptions): + Excel.RangeAreas; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.RangeAreas#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.RangeAreas;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.RangeAreas#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.RangeAreas; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: select() + uid: excel!Excel.RangeAreas#select:member(1) + package: excel! + fullName: select() + summary: Selects the specified range areas in the Excel UI. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'select(): void;' + return: + type: void + description: '' + - name: set(properties, options) + uid: excel!Excel.RangeAreas#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.RangeAreasUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.RangeAreas#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.RangeAreas): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: setDirty() + uid: excel!Excel.RangeAreas#setDirty:member(1) + package: excel! + fullName: setDirty() + summary: >- + Sets the `RangeAreas` to be recalculated when the next recalculation + occurs. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'setDirty(): void;' + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.RangeAreas#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.RangeAreas` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.RangeAreasData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.RangeAreasData;' + return: + type: + description: '' + - name: track() + uid: excel!Excel.RangeAreas#track:member(1) + package: excel! + fullName: track() + summary: >- + Track the object for automatic adjustment based on surrounding changes in + the document. This call is a shorthand for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). If you're using this object across `.sync` calls and outside the + sequential execution of a ".run" batch, and get an "InvalidObjectPath" + error when setting a property or invoking a method on the object, you need + to add the object to the tracked object collection when the object was + first created. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'track(): Excel.RangeAreas;' + return: + type: + description: '' + - name: untrack() + uid: excel!Excel.RangeAreas#untrack:member(1) + package: excel! + fullName: untrack() + summary: >- + Release the memory associated with this object, if it has previously been + tracked. This call is shorthand for + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). Having many tracked objects slows down the host application, so + please remember to free any objects you add, once you're done using them. + You'll need to call `context.sync()` before the memory release takes + effect. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'untrack(): Excel.RangeAreas;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.rangeareascollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.rangeareascollection.yml new file mode 100644 index 0000000000..360f1ffc81 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.rangeareascollection.yml @@ -0,0 +1,181 @@ +### YamlMime:TSType +name: Excel.RangeAreasCollection +uid: excel!Excel.RangeAreasCollection:class +package: excel! +fullName: Excel.RangeAreasCollection +summary: Contains the collection of cross-workbook level ranges. +remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.RangeAreasCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: excel!Excel.RangeAreasCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.RangeAreas[];' + return: + type: [] +methods: + - name: getCount() + uid: excel!Excel.RangeAreasCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Gets the number of `RangeAreas` objects in this collection. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getItemAt(index) + uid: excel!Excel.RangeAreasCollection#getItemAt:member(1) + package: excel! + fullName: getItemAt(index) + summary: Returns the `RangeAreas` object based on position in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemAt(index: number): Excel.RangeAreas;' + parameters: + - id: index + description: Index value of the range object to be retrieved. Zero-indexed. + type: number + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.RangeAreasCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.RangeAreasCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): Excel.RangeAreasCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.RangeAreasCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.RangeAreasCollection;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.RangeAreasCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.RangeAreasCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.RangeAreasCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.RangeAreasCollection` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.RangeAreasCollectionData`) that contains an + "items" array with shallow copies of any loaded properties from the + collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.RangeAreasCollectionData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.rangeborder.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.rangeborder.yml new file mode 100644 index 0000000000..902fdee2d8 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.rangeborder.yml @@ -0,0 +1,306 @@ +### YamlMime:TSType +name: Excel.RangeBorder +uid: excel!Excel.RangeBorder:class +package: excel! +fullName: Excel.RangeBorder +summary: Represents the border of an object. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: color + uid: excel!Excel.RangeBorder#color:member + package: excel! + fullName: color + summary: >- + HTML color code representing the color of the border line, in the form + \#RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange"). + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color: string;' + return: + type: string + - name: context + uid: excel!Excel.RangeBorder#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: sideIndex + uid: excel!Excel.RangeBorder#sideIndex:member + package: excel! + fullName: sideIndex + summary: >- + Constant value that indicates the specific side of the border. See + `Excel.BorderIndex` for details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly sideIndex: Excel.BorderIndex | "EdgeTop" | "EdgeBottom" | + "EdgeLeft" | "EdgeRight" | "InsideVertical" | "InsideHorizontal" | + "DiagonalDown" | "DiagonalUp"; + return: + type: >- + | "EdgeTop" | "EdgeBottom" + | "EdgeLeft" | "EdgeRight" | "InsideVertical" | "InsideHorizontal" | + "DiagonalDown" | "DiagonalUp" + - name: style + uid: excel!Excel.RangeBorder#style:member + package: excel! + fullName: style + summary: >- + One of the constants of line style specifying the line style for the + border. See `Excel.BorderLineStyle` for details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Add grid borders around the range. + + await Excel.run(async (context) => { + const sheetName = "Sheet1"; + const rangeAddress = "A1:F8"; + const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress); + range.format.borders.getItem('InsideHorizontal').style = 'Continuous'; + range.format.borders.getItem('InsideVertical').style = 'Continuous'; + range.format.borders.getItem('EdgeBottom').style = 'Continuous'; + range.format.borders.getItem('EdgeLeft').style = 'Continuous'; + range.format.borders.getItem('EdgeRight').style = 'Continuous'; + range.format.borders.getItem('EdgeTop').style = 'Continuous'; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + style: Excel.BorderLineStyle | "None" | "Continuous" | "Dash" | + "DashDot" | "DashDotDot" | "Dot" | "Double" | "SlantDashDot"; + return: + type: >- + | "None" | + "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot" | "Double" | + "SlantDashDot" + - name: tintAndShade + uid: excel!Excel.RangeBorder#tintAndShade:member + package: excel! + fullName: tintAndShade + summary: >- + Specifies a double that lightens or darkens a color for the range border, + the value is between -1 (darkest) and 1 (brightest), with 0 for the + original color. A `null` value indicates that the border doesn't have a + uniform `tintAndShade` setting. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tintAndShade: number;' + return: + type: number + - name: weight + uid: excel!Excel.RangeBorder#weight:member + package: excel! + fullName: weight + summary: >- + Specifies the weight of the border around a range. See + `Excel.BorderWeight` for details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'weight: Excel.BorderWeight | "Hairline" | "Thin" | "Medium" | "Thick";' + return: + type: >- + | "Hairline" | "Thin" | + "Medium" | "Thick" +methods: + - name: load(options) + uid: excel!Excel.RangeBorder#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.RangeBorderLoadOptions): + Excel.RangeBorder; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.RangeBorder#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.RangeBorder;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.RangeBorder#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.RangeBorder; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.RangeBorder#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.RangeBorderUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.RangeBorder#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.RangeBorder): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.RangeBorder#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.RangeBorder` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.RangeBorderData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.RangeBorderData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.rangebordercollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.rangebordercollection.yml new file mode 100644 index 0000000000..c3fe120d89 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.rangebordercollection.yml @@ -0,0 +1,307 @@ +### YamlMime:TSType +name: Excel.RangeBorderCollection +uid: excel!Excel.RangeBorderCollection:class +package: excel! +fullName: Excel.RangeBorderCollection +summary: Represents the border objects that make up the range border. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.RangeBorderCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: count + uid: excel!Excel.RangeBorderCollection#count:member + package: excel! + fullName: count + summary: Number of border objects in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly count: number;' + return: + type: number + - name: items + uid: excel!Excel.RangeBorderCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.RangeBorder[];' + return: + type: [] + - name: tintAndShade + uid: excel!Excel.RangeBorderCollection#tintAndShade:member + package: excel! + fullName: tintAndShade + summary: >- + Specifies a double that lightens or darkens a color for range borders. The + value is between -1 (darkest) and 1 (brightest), with 0 for the original + color. A `null` value indicates that the entire border collection doesn't + have a uniform `tintAndShade` setting. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tintAndShade: number;' + return: + type: number +methods: + - name: getItem(index) + uid: excel!Excel.RangeBorderCollection#getItem:member(1) + package: excel! + fullName: getItem(index) + summary: Gets a border object using its name. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const sheetName = "Sheet1"; + const rangeAddress = "A1:F8"; + const worksheet = context.workbook.worksheets.getItem(sheetName); + const range = worksheet.getRange(rangeAddress); + const border = range.format.borders.getItem(Excel.BorderIndex.edgeTop); + border.load('style'); + await context.sync(); + + console.log(border.style); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getItem(index: Excel.BorderIndex): Excel.RangeBorder;' + parameters: + - id: index + description: >- + Index value of the border object to be retrieved. See + `Excel.BorderIndex` for details. + type: + return: + type: + description: '' + - name: getItem(index) + uid: excel!Excel.RangeBorderCollection#getItem:member(2) + package: excel! + fullName: getItem(index) + summary: Gets a border object using its name. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + getItem(index: "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight" | + "InsideVertical" | "InsideHorizontal" | "DiagonalDown" | "DiagonalUp"): + Excel.RangeBorder; + parameters: + - id: index + description: >- + Index value of the border object to be retrieved. See + `Excel.BorderIndex` for details. + type: >- + "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight" | + "InsideVertical" | "InsideHorizontal" | "DiagonalDown" | + "DiagonalUp" + return: + type: + description: '' + - name: getItemAt(index) + uid: excel!Excel.RangeBorderCollection#getItemAt:member(1) + package: excel! + fullName: getItemAt(index) + summary: Gets a border object using its index. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const sheetName = "Sheet1"; + const rangeAddress = "A1:F8"; + const worksheet = context.workbook.worksheets.getItem(sheetName); + const range = worksheet.getRange(rangeAddress); + const border = range.format.borders.getItemAt(0); + border.load('sideIndex'); + await context.sync(); + + console.log(border.sideIndex); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemAt(index: number): Excel.RangeBorder;' + parameters: + - id: index + description: Index value of the object to be retrieved. Zero-indexed. + type: number + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.RangeBorderCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.RangeBorderCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): Excel.RangeBorderCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.RangeBorderCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.RangeBorderCollection;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: |- + + + #### Examples + + ```TypeScript + await Excel.run(async (context) => { + const sheetName = "Sheet1"; + const rangeAddress = "A1:F8"; + const worksheet = context.workbook.worksheets.getItem(sheetName); + const range = worksheet.getRange(rangeAddress); + const borders = range.format.borders; + borders.load('items'); + await context.sync(); + + console.log(borders.count); + for (let i = 0; i < borders.items.length; i++) { + console.log(borders.items[i].sideIndex); + } + }); + ``` + - name: load(propertyNamesAndPaths) + uid: excel!Excel.RangeBorderCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.RangeBorderCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.RangeBorderCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.RangeBorderCollection` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.RangeBorderCollectionData`) that contains an + "items" array with shallow copies of any loaded properties from the + collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.RangeBorderCollectionData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.rangecollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.rangecollection.yml new file mode 100644 index 0000000000..60bc9dffba --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.rangecollection.yml @@ -0,0 +1,178 @@ +### YamlMime:TSType +name: Excel.RangeCollection +uid: excel!Excel.RangeCollection:class +package: excel! +fullName: Excel.RangeCollection +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.RangeCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: excel!Excel.RangeCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.Range[];' + return: + type: [] +methods: + - name: getCount() + uid: excel!Excel.RangeCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Returns the number of ranges in the `RangeCollection`. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getItemAt(index) + uid: excel!Excel.RangeCollection#getItemAt:member(1) + package: excel! + fullName: getItemAt(index) + summary: >- + Returns the range object based on its position in the + `RangeCollection`. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemAt(index: number): Excel.Range;' + parameters: + - id: index + description: Index value of the range object to be retrieved. Zero-indexed. + type: number + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.RangeCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.RangeCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): Excel.RangeCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.RangeCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.RangeCollection;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.RangeCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.RangeCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.RangeCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.RangeCollection` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.RangeCollectionData`) that + contains an "items" array with shallow copies of any loaded properties + from the collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.RangeCollectionData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.rangecopytype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.rangecopytype.yml new file mode 100644 index 0000000000..c37a11f65c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.rangecopytype.yml @@ -0,0 +1,64 @@ +### YamlMime:TSEnum +name: Excel.RangeCopyType +uid: excel!Excel.RangeCopyType:enum +package: excel! +fullName: Excel.RangeCopyType +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-copyfrom.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + // Place a label in front of the copied data. + sheet.getRange("F2").values = [["Copied Formula"]]; + + // Copy a range preserving the formulas. + // Note: non-formula values are copied over as is. + sheet.getRange("G2").copyFrom("A1:E1", Excel.RangeCopyType.formulas); + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: all + uid: excel!Excel.RangeCopyType.all:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"All"' + - name: formats + uid: excel!Excel.RangeCopyType.formats:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Formats"' + - name: formulas + uid: excel!Excel.RangeCopyType.formulas:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Formulas"' + - name: values + uid: excel!Excel.RangeCopyType.values:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Values"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.rangefill.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.rangefill.yml new file mode 100644 index 0000000000..df847b8e75 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.rangefill.yml @@ -0,0 +1,327 @@ +### YamlMime:TSType +name: Excel.RangeFill +uid: excel!Excel.RangeFill:class +package: excel! +fullName: Excel.RangeFill +summary: Represents the background of a range object. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: color + uid: excel!Excel.RangeFill#color:member + package: excel! + fullName: color + summary: >- + HTML color code representing the color of the background, in the form + \#RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange") + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color: string;' + return: + type: string + - name: context + uid: excel!Excel.RangeFill#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: pattern + uid: excel!Excel.RangeFill#pattern:member + package: excel! + fullName: pattern + summary: >- + The pattern of a range. See `Excel.FillPattern` for details. + LinearGradient and RectangularGradient are not supported. A `null` value + indicates that the entire range doesn't have a uniform pattern setting. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + pattern: Excel.FillPattern | "None" | "Solid" | "Gray50" | "Gray75" | + "Gray25" | "Horizontal" | "Vertical" | "Down" | "Up" | "Checker" | + "SemiGray75" | "LightHorizontal" | "LightVertical" | "LightDown" | + "LightUp" | "Grid" | "CrissCross" | "Gray16" | "Gray8" | + "LinearGradient" | "RectangularGradient"; + return: + type: >- + | "None" | "Solid" | + "Gray50" | "Gray75" | "Gray25" | "Horizontal" | "Vertical" | "Down" | + "Up" | "Checker" | "SemiGray75" | "LightHorizontal" | "LightVertical" + | "LightDown" | "LightUp" | "Grid" | "CrissCross" | "Gray16" | "Gray8" + | "LinearGradient" | "RectangularGradient" + - name: patternColor + uid: excel!Excel.RangeFill#patternColor:member + package: excel! + fullName: patternColor + summary: >- + The HTML color code representing the color of the range pattern, in the + form \#RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange"). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'patternColor: string;' + return: + type: string + - name: patternTintAndShade + uid: excel!Excel.RangeFill#patternTintAndShade:member + package: excel! + fullName: patternTintAndShade + summary: >- + Specifies a double that lightens or darkens a pattern color for the range + fill. The value is between -1 (darkest) and 1 (brightest), with 0 for the + original color. A `null` value indicates that the range doesn't have + uniform `patternTintAndShade` settings. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'patternTintAndShade: number;' + return: + type: number + - name: tintAndShade + uid: excel!Excel.RangeFill#tintAndShade:member + package: excel! + fullName: tintAndShade + summary: >- + Specifies a double that lightens or darkens a color for the range fill. + The value is between -1 (darkest) and 1 (brightest), with 0 for the + original color. A `null` value indicates that the range doesn't have + uniform `tintAndShade` settings. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tintAndShade: number;' + return: + type: number +methods: + - name: clear() + uid: excel!Excel.RangeFill#clear:member(1) + package: excel! + fullName: clear() + summary: Resets the range background. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const sheetName = "Sheet1"; + const rangeAddress = "F:G"; + const worksheet = context.workbook.worksheets.getItem(sheetName); + const range = worksheet.getRange(rangeAddress); + const rangeFill = range.format.fill; + rangeFill.clear(); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'clear(): void;' + return: + type: void + description: '' + - name: load(options) + uid: excel!Excel.RangeFill#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(options?: Excel.Interfaces.RangeFillLoadOptions): Excel.RangeFill;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.RangeFill#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.RangeFill;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: |- + + + #### Examples + + ```TypeScript + await Excel.run(async (context) => { + const sheetName = "Sheet1"; + const rangeAddress = "F:G"; + const worksheet = context.workbook.worksheets.getItem(sheetName); + const range = worksheet.getRange(rangeAddress); + const rangeFill = range.format.fill; + rangeFill.load('color'); + await context.sync(); + console.log(rangeFill.color); + }); + ``` + - name: load(propertyNamesAndPaths) + uid: excel!Excel.RangeFill#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.RangeFill; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.RangeFill#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.RangeFillUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.RangeFill#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.RangeFill): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.RangeFill#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.RangeFill` object + is an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Excel.Interfaces.RangeFillData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.RangeFillData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.rangefont.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.rangefont.yml new file mode 100644 index 0000000000..88de1ae58a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.rangefont.yml @@ -0,0 +1,385 @@ +### YamlMime:TSType +name: Excel.RangeFont +uid: excel!Excel.RangeFont:class +package: excel! +fullName: Excel.RangeFont +summary: >- + This object represents the font attributes (font name, font size, color, etc.) + for an object. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: bold + uid: excel!Excel.RangeFont#bold:member + package: excel! + fullName: bold + summary: Represents the bold status of the font. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'bold: boolean;' + return: + type: boolean + - name: color + uid: excel!Excel.RangeFont#color:member + package: excel! + fullName: color + summary: >- + HTML color code representation of the text color (e.g., \#FF0000 + represents Red). + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color: string;' + return: + type: string + - name: context + uid: excel!Excel.RangeFont#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: italic + uid: excel!Excel.RangeFont#italic:member + package: excel! + fullName: italic + summary: Specifies the italic status of the font. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'italic: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.RangeFont#name:member + package: excel! + fullName: name + summary: >- + Font name (e.g., "Calibri"). The name's length should not be greater than + 31 characters. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Change the font of the selected range to "Impact". + + await Excel.run(async (context) => { + const selection = context.workbook.getSelectedRange(); + selection.format.font.name = "Impact"; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'name: string;' + return: + type: string + - name: size + uid: excel!Excel.RangeFont#size:member + package: excel! + fullName: size + summary: Font size. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'size: number;' + return: + type: number + - name: strikethrough + uid: excel!Excel.RangeFont#strikethrough:member + package: excel! + fullName: strikethrough + summary: >- + Specifies the strikethrough status of font. A `null` value indicates that + the entire range doesn't have a uniform strikethrough setting. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'strikethrough: boolean;' + return: + type: boolean + - name: subscript + uid: excel!Excel.RangeFont#subscript:member + package: excel! + fullName: subscript + summary: >- + Specifies the subscript status of font. Returns `true` if all the fonts of + the range are subscript. Returns `false` if all the fonts of the range are + superscript or normal (neither superscript, nor subscript). Returns `null` + otherwise. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'subscript: boolean;' + return: + type: boolean + - name: superscript + uid: excel!Excel.RangeFont#superscript:member + package: excel! + fullName: superscript + summary: >- + Specifies the superscript status of font. Returns `true` if all the fonts + of the range are superscript. Returns `false` if all the fonts of the + range are subscript or normal (neither superscript, nor subscript). + Returns `null` otherwise. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'superscript: boolean;' + return: + type: boolean + - name: tintAndShade + uid: excel!Excel.RangeFont#tintAndShade:member + package: excel! + fullName: tintAndShade + summary: >- + Specifies a double that lightens or darkens a color for the range font. + The value is between -1 (darkest) and 1 (brightest), with 0 for the + original color. A `null` value indicates that the entire range doesn't + have a uniform font `tintAndShade` setting. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tintAndShade: number;' + return: + type: number + - name: underline + uid: excel!Excel.RangeFont#underline:member + package: excel! + fullName: underline + summary: >- + Type of underline applied to the font. See `Excel.RangeUnderlineStyle` for + details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + underline: Excel.RangeUnderlineStyle | "None" | "Single" | "Double" | + "SingleAccountant" | "DoubleAccountant"; + return: + type: >- + | "None" | + "Single" | "Double" | "SingleAccountant" | "DoubleAccountant" +methods: + - name: load(options) + uid: excel!Excel.RangeFont#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(options?: Excel.Interfaces.RangeFontLoadOptions): Excel.RangeFont;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.RangeFont#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.RangeFont;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: |- + + + #### Examples + + ```TypeScript + await Excel.run(async (context) => { + const sheetName = "Sheet1"; + const rangeAddress = "F:G"; + const worksheet = context.workbook.worksheets.getItem(sheetName); + const range = worksheet.getRange(rangeAddress); + const rangeFont = range.format.font; + rangeFont.load('name'); + await context.sync(); + console.log(rangeFont.name); + }); + ``` + - name: load(propertyNamesAndPaths) + uid: excel!Excel.RangeFont#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.RangeFont; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.RangeFont#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.RangeFontUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.RangeFont#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.RangeFont): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.RangeFont#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.RangeFont` object + is an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Excel.Interfaces.RangeFontData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.RangeFontData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.rangeformat.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.rangeformat.yml new file mode 100644 index 0000000000..a3d9f132ff --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.rangeformat.yml @@ -0,0 +1,575 @@ +### YamlMime:TSType +name: Excel.RangeFormat +uid: excel!Excel.RangeFormat:class +package: excel! +fullName: Excel.RangeFormat +summary: >- + A format object encapsulating the range's font, fill, borders, alignment, and + other properties. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: autoIndent + uid: excel!Excel.RangeFormat#autoIndent:member + package: excel! + fullName: autoIndent + summary: >- + Specifies if text is automatically indented when text alignment is set to + equal distribution. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'autoIndent: boolean;' + return: + type: boolean + - name: borders + uid: excel!Excel.RangeFormat#borders:member + package: excel! + fullName: borders + summary: Collection of border objects that apply to the overall range. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly borders: Excel.RangeBorderCollection;' + return: + type: + - name: columnWidth + uid: excel!Excel.RangeFormat#columnWidth:member + package: excel! + fullName: columnWidth + summary: >- + Specifies the width of all columns within the range. If the column widths + are not uniform, `null` will be returned. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'columnWidth: number;' + return: + type: number + - name: context + uid: excel!Excel.RangeFormat#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: fill + uid: excel!Excel.RangeFormat#fill:member + package: excel! + fullName: fill + summary: Returns the fill object defined on the overall range. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly fill: Excel.RangeFill;' + return: + type: + - name: font + uid: excel!Excel.RangeFormat#font:member + package: excel! + fullName: font + summary: Returns the font object defined on the overall range. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly font: Excel.RangeFont;' + return: + type: + - name: horizontalAlignment + uid: excel!Excel.RangeFormat#horizontalAlignment:member + package: excel! + fullName: horizontalAlignment + summary: >- + Represents the horizontal alignment for the specified object. See + `Excel.HorizontalAlignment` for details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + horizontalAlignment: Excel.HorizontalAlignment | "General" | "Left" | + "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | + "Distributed"; + return: + type: >- + | "General" | + "Left" | "Center" | "Right" | "Fill" | "Justify" | + "CenterAcrossSelection" | "Distributed" + - name: indentLevel + uid: excel!Excel.RangeFormat#indentLevel:member + package: excel! + fullName: indentLevel + summary: An integer from 0 to 250 that indicates the indent level. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'indentLevel: number;' + return: + type: number + - name: protection + uid: excel!Excel.RangeFormat#protection:member + package: excel! + fullName: protection + summary: Returns the format protection object for a range. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly protection: Excel.FormatProtection;' + return: + type: + - name: readingOrder + uid: excel!Excel.RangeFormat#readingOrder:member + package: excel! + fullName: readingOrder + summary: The reading order for the range. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readingOrder: Excel.ReadingOrder | "Context" | "LeftToRight" | + "RightToLeft"; + return: + type: >- + | "Context" | + "LeftToRight" | "RightToLeft" + - name: rowHeight + uid: excel!Excel.RangeFormat#rowHeight:member + package: excel! + fullName: rowHeight + summary: >- + The height of all rows in the range. If the row heights are not uniform, + `null` will be returned. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rowHeight: number;' + return: + type: number + - name: shrinkToFit + uid: excel!Excel.RangeFormat#shrinkToFit:member + package: excel! + fullName: shrinkToFit + summary: >- + Specifies if text automatically shrinks to fit in the available column + width. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'shrinkToFit: boolean;' + return: + type: boolean + - name: textOrientation + uid: excel!Excel.RangeFormat#textOrientation:member + package: excel! + fullName: textOrientation + summary: >- + The text orientation of all the cells within the range. The text + orientation should be an integer either from -90 to 90, or 180 for + vertically-oriented text. If the orientation within a range are not + uniform, then `null` will be returned. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-text-orientation.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const range = sheet.getRange("B2:E2"); + + // Set textOrientation to either an integer between -90 and 90 + // or to 180 for vertically-oriented text. + range.format.textOrientation = 90; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'textOrientation: number;' + return: + type: number + - name: useStandardHeight + uid: excel!Excel.RangeFormat#useStandardHeight:member + package: excel! + fullName: useStandardHeight + summary: >- + Determines if the row height of the `Range` object equals the standard + height of the sheet. Returns `true` if the row height of the `Range` + object equals the standard height of the sheet. Returns `null` if the + range contains more than one row and the rows aren't all the same height. + Returns `false` otherwise. Note: This property is only intended to be set + to `true`. Setting it to `false` has no effect. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'useStandardHeight: boolean;' + return: + type: boolean + - name: useStandardWidth + uid: excel!Excel.RangeFormat#useStandardWidth:member + package: excel! + fullName: useStandardWidth + summary: >- + Specifies if the column width of the `Range` object equals the standard + width of the sheet. Returns `true` if the column width of the `Range` + object equals the standard width of the sheet. Returns `null` if the range + contains more than one column and the columns aren't all the same height. + Returns `false` otherwise. Note: This property is only intended to be set + to `true`. Setting it to `false` has no effect. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'useStandardWidth: boolean;' + return: + type: boolean + - name: verticalAlignment + uid: excel!Excel.RangeFormat#verticalAlignment:member + package: excel! + fullName: verticalAlignment + summary: >- + Represents the vertical alignment for the specified object. See + `Excel.VerticalAlignment` for details. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + verticalAlignment: Excel.VerticalAlignment | "Top" | "Center" | "Bottom" + | "Justify" | "Distributed"; + return: + type: >- + | "Top" | "Center" | + "Bottom" | "Justify" | "Distributed" + - name: wrapText + uid: excel!Excel.RangeFormat#wrapText:member + package: excel! + fullName: wrapText + summary: >- + Specifies if Excel wraps the text in the object. A `null` value indicates + that the entire range doesn't have a uniform wrap setting + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'wrapText: boolean;' + return: + type: boolean +methods: + - name: adjustIndent(amount) + uid: excel!Excel.RangeFormat#adjustIndent:member(1) + package: excel! + fullName: adjustIndent(amount) + summary: >- + Adjusts the indentation of the range formatting. The indent value ranges + from 0 to 250 and is measured in characters. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'adjustIndent(amount: number): void;' + parameters: + - id: amount + description: >- + The number of character spaces by which the current indent is + adjusted. This value should be between -250 and 250. **Note**: + If the amount would raise the indent level above 250, the indent + level stays with 250. Similarly, if the amount would lower the + indent level below 0, the indent level stays 0. + type: number + return: + type: void + description: '' + - name: autofitColumns() + uid: excel!Excel.RangeFormat#autofitColumns:member(1) + package: excel! + fullName: autofitColumns() + summary: >- + Changes the width of the columns of the current range to achieve the best + fit, based on the current data in the columns. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'autofitColumns(): void;' + return: + type: void + description: '' + - name: autofitRows() + uid: excel!Excel.RangeFormat#autofitRows:member(1) + package: excel! + fullName: autofitRows() + summary: >- + Changes the height of the rows of the current range to achieve the best + fit, based on the current data in the columns. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'autofitRows(): void;' + return: + type: void + description: '' + - name: load(options) + uid: excel!Excel.RangeFormat#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.RangeFormatLoadOptions): + Excel.RangeFormat; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.RangeFormat#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.RangeFormat;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: |- + + + #### Examples + + ```TypeScript + // Select all of the range's format properties. + await Excel.run(async (context) => { + const sheetName = "Sheet1"; + const rangeAddress = "F:G"; + const worksheet = context.workbook.worksheets.getItem(sheetName); + const range = worksheet.getRange(rangeAddress); + range.load(["format/*", "format/fill", "format/borders", "format/font"]); + await context.sync(); + + console.log(range.format.wrapText); + console.log(range.format.fill.color); + console.log(range.format.font.name); + }); + ``` + - name: load(propertyNamesAndPaths) + uid: excel!Excel.RangeFormat#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.RangeFormat; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.RangeFormat#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.RangeFormatUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.RangeFormat#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.RangeFormat): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.RangeFormat#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.RangeFormat` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.RangeFormatData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.RangeFormatData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.rangehyperlink.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.rangehyperlink.yml new file mode 100644 index 0000000000..a67fe2dab0 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.rangehyperlink.yml @@ -0,0 +1,224 @@ +### YamlMime:TSType +name: Excel.RangeHyperlink +uid: excel!Excel.RangeHyperlink:interface +package: excel! +fullName: Excel.RangeHyperlink +summary: Represents the necessary strings to get/set a hyperlink (XHL) object. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: address + uid: excel!Excel.RangeHyperlink#address:member + package: excel! + fullName: address + summary: Represents the URL target for the hyperlink. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-hyperlink.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Orders"); + + let productsRange = sheet.getRange("A3:A5"); + productsRange.load("values"); + + await context.sync(); + + // Create a hyperlink to a URL + // for each product name in the first table. + for (let i = 0; i < productsRange.values.length; i++) { + let cellRange = productsRange.getCell(i, 0); + let cellText = productsRange.values[i][0]; + + let hyperlink = { + textToDisplay: cellText, + screenTip: "Search Bing for '" + cellText + "'", + address: "https://www.bing.com?q=" + cellText + } + cellRange.hyperlink = hyperlink; + } + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'address?: string;' + return: + type: string + - name: documentReference + uid: excel!Excel.RangeHyperlink#documentReference:member + package: excel! + fullName: documentReference + summary: Represents the document reference target for the hyperlink. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-hyperlink.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Orders"); + + let productsRange = sheet.getRange("A9:A11"); + productsRange.load("values"); + + await context.sync(); + + // Create a hyperlink to a location within the workbook + // for each product name in the second table. + for (let i = 0; i < productsRange.values.length; i++) { + let cellRange = productsRange.getCell(i, 0); + let cellText = productsRange.values[i][0]; + + let hyperlink = { + textToDisplay: cellText, + screenTip: "Navigate to the '" + cellText + "' worksheet", + documentReference: cellText + "!A1" + } + cellRange.hyperlink = hyperlink; + } + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'documentReference?: string;' + return: + type: string + - name: screenTip + uid: excel!Excel.RangeHyperlink#screenTip:member + package: excel! + fullName: screenTip + summary: Represents the string displayed when hovering over the hyperlink. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-hyperlink.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Orders"); + + let productsRange = sheet.getRange("A3:A5"); + productsRange.load("values"); + + await context.sync(); + + // Create a hyperlink to a URL + // for each product name in the first table. + for (let i = 0; i < productsRange.values.length; i++) { + let cellRange = productsRange.getCell(i, 0); + let cellText = productsRange.values[i][0]; + + let hyperlink = { + textToDisplay: cellText, + screenTip: "Search Bing for '" + cellText + "'", + address: "https://www.bing.com?q=" + cellText + } + cellRange.hyperlink = hyperlink; + } + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'screenTip?: string;' + return: + type: string + - name: textToDisplay + uid: excel!Excel.RangeHyperlink#textToDisplay:member + package: excel! + fullName: textToDisplay + summary: >- + Represents the string that is displayed in the top left most cell in the + range. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-hyperlink.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Orders"); + + let productsRange = sheet.getRange("A3:A5"); + productsRange.load("values"); + + await context.sync(); + + // Create a hyperlink to a URL + // for each product name in the first table. + for (let i = 0; i < productsRange.values.length; i++) { + let cellRange = productsRange.getCell(i, 0); + let cellText = productsRange.values[i][0]; + + let hyperlink = { + textToDisplay: cellText, + screenTip: "Search Bing for '" + cellText + "'", + address: "https://www.bing.com?q=" + cellText + } + cellRange.hyperlink = hyperlink; + } + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'textToDisplay?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.rangereference.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.rangereference.yml new file mode 100644 index 0000000000..6d971f93bf --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.rangereference.yml @@ -0,0 +1,31 @@ +### YamlMime:TSType +name: Excel.RangeReference +uid: excel!Excel.RangeReference:interface +package: excel! +fullName: Excel.RangeReference +summary: >- + Represents a string reference of the form "SheetName!A1:B5", or a global or + local named range. +remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: address + uid: excel!Excel.RangeReference#address:member + package: excel! + fullName: address + summary: The address of the range, for example "SheetName!A1:B5". + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'address: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.rangesort.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.rangesort.yml new file mode 100644 index 0000000000..c04b14f4ea --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.rangesort.yml @@ -0,0 +1,128 @@ +### YamlMime:TSType +name: Excel.RangeSort +uid: excel!Excel.RangeSort:class +package: excel! +fullName: Excel.RangeSort +summary: Manages sorting operations on `Range` objects. +remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.RangeSort#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: +methods: + - name: apply(fields, matchCase, hasHeaders, orientation, method) + uid: excel!Excel.RangeSort#apply:member(1) + package: excel! + fullName: apply(fields, matchCase, hasHeaders, orientation, method) + summary: Perform a sort operation. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + apply(fields: Excel.SortField[], matchCase?: boolean, hasHeaders?: + boolean, orientation?: Excel.SortOrientation, method?: + Excel.SortMethod): void; + parameters: + - id: fields + description: The list of conditions to sort on. + type: [] + - id: matchCase + description: Optional. Whether to have the casing impact string ordering. + type: boolean + - id: hasHeaders + description: Optional. Whether the range has a header. + type: boolean + - id: orientation + description: Optional. Whether the operation is sorting rows or columns. + type: + - id: method + description: Optional. The ordering method used for Chinese characters. + type: + return: + type: void + description: '' + - name: apply(fields, matchCase, hasHeaders, orientation, method) + uid: excel!Excel.RangeSort#apply:member(2) + package: excel! + fullName: apply(fields, matchCase, hasHeaders, orientation, method) + summary: Perform a sort operation. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + apply(fields: Excel.SortField[], matchCase?: boolean, hasHeaders?: + boolean, orientation?: "Rows" | "Columns", method?: "PinYin" | + "StrokeCount"): void; + parameters: + - id: fields + description: The list of conditions to sort on. + type: [] + - id: matchCase + description: Optional. Whether to have the casing impact string ordering. + type: boolean + - id: hasHeaders + description: Optional. Whether the range has a header. + type: boolean + - id: orientation + description: Optional. Whether the operation is sorting rows or columns. + type: '"Rows" | "Columns"' + - id: method + description: Optional. The ordering method used for Chinese characters. + type: '"PinYin" | "StrokeCount"' + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.RangeSort#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.RangeSort` object + is an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Excel.Interfaces.RangeSortData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + toJSON(): { + [key: string]: string; + }; + return: + type: |- + { + [key: string]: string; + } + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.rangetextrun.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.rangetextrun.yml new file mode 100644 index 0000000000..7b5edd6b5d --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.rangetextrun.yml @@ -0,0 +1,52 @@ +### YamlMime:TSType +name: Excel.RangeTextRun +uid: excel!Excel.RangeTextRun:interface +package: excel! +fullName: Excel.RangeTextRun +summary: >- + Represents a sequence of one or more characters that share the same font + attributes in a cell. Can be used as the `textRuns` properties of + `getCellProperties` or the `textRuns` input parameter of + `setCellProperties`. +remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: font + uid: excel!Excel.RangeTextRun#font:member + package: excel! + fullName: font + summary: >- + The font attributes (such as font name, font size, and color) applied to + this text run. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'font?: Excel.CellPropertiesFont;' + return: + type: + - name: text + uid: excel!Excel.RangeTextRun#text:member + package: excel! + fullName: text + summary: The text of this text run. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'text: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.rangeunderlinestyle.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.rangeunderlinestyle.yml new file mode 100644 index 0000000000..873692c4e4 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.rangeunderlinestyle.yml @@ -0,0 +1,84 @@ +### YamlMime:TSEnum +name: Excel.RangeUnderlineStyle +uid: excel!Excel.RangeUnderlineStyle:enum +package: excel! +fullName: Excel.RangeUnderlineStyle +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-hyperlink.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Orders"); + + const productsRange = sheet.getRange("A3:A11"); + productsRange.load("values"); + + await context.sync(); + + // Clear all hyperlinks. + for (let i = 0; i < productsRange.values.length; i++) { + let cellRange = productsRange.getCell(i, 0); + + // Clear the hyperlink. + // This removes the hyperlink but does not update text format. + cellRange.clear(Excel.ClearApplyTo.hyperlinks); + + // Update text format. + cellRange.format.font.underline = Excel.RangeUnderlineStyle.none; + cellRange.format.font.color = "#000000"; + } + + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: double + uid: excel!Excel.RangeUnderlineStyle.double:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Double"' + - name: doubleAccountant + uid: excel!Excel.RangeUnderlineStyle.doubleAccountant:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"DoubleAccountant"' + - name: none + uid: excel!Excel.RangeUnderlineStyle.none:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"None"' + - name: single + uid: excel!Excel.RangeUnderlineStyle.single:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Single"' + - name: singleAccountant + uid: excel!Excel.RangeUnderlineStyle.singleAccountant:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"SingleAccountant"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.rangevaluetype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.rangevaluetype.yml new file mode 100644 index 0000000000..ebe2bcce61 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.rangevaluetype.yml @@ -0,0 +1,69 @@ +### YamlMime:TSEnum +name: Excel.RangeValueType +uid: excel!Excel.RangeValueType:enum +package: excel! +fullName: Excel.RangeValueType +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: boolean + uid: excel!Excel.RangeValueType.boolean:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Boolean"' + - name: double + uid: excel!Excel.RangeValueType.double:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Double"' + - name: empty + uid: excel!Excel.RangeValueType.empty:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Empty"' + - name: error + uid: excel!Excel.RangeValueType.error:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Error"' + - name: integer + uid: excel!Excel.RangeValueType.integer:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Integer"' + - name: richValue + uid: excel!Excel.RangeValueType.richValue:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"RichValue"' + - name: string + uid: excel!Excel.RangeValueType.string:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"String"' + - name: unknown + uid: excel!Excel.RangeValueType.unknown:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Unknown"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.rangeview.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.rangeview.yml new file mode 100644 index 0000000000..6eff7ba6c6 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.rangeview.yml @@ -0,0 +1,433 @@ +### YamlMime:TSType +name: Excel.RangeView +uid: excel!Excel.RangeView:class +package: excel! +fullName: Excel.RangeView +summary: RangeView represents a set of visible cells of the parent range. +remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: cellAddresses + uid: excel!Excel.RangeView#cellAddresses:member + package: excel! + fullName: cellAddresses + summary: Represents the cell addresses of the `RangeView`. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly cellAddresses: any[][];' + return: + type: any[][] + - name: columnCount + uid: excel!Excel.RangeView#columnCount:member + package: excel! + fullName: columnCount + summary: The number of visible columns. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly columnCount: number;' + return: + type: number + - name: context + uid: excel!Excel.RangeView#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: formulas + uid: excel!Excel.RangeView#formulas:member + package: excel! + fullName: formulas + summary: >- + Represents the formula in A1-style notation. If a cell has no formula, its + value is returned instead. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulas: any[][];' + return: + type: any[][] + - name: formulasLocal + uid: excel!Excel.RangeView#formulasLocal:member + package: excel! + fullName: formulasLocal + summary: >- + Represents the formula in A1-style notation, in the user's language and + number-formatting locale. For example, the English "=SUM(A1, 1.5)" formula + would become "=SUMME(A1; 1,5)" in German. If a cell has no formula, its + value is returned instead. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulasLocal: any[][];' + return: + type: any[][] + - name: formulasR1C1 + uid: excel!Excel.RangeView#formulasR1C1:member + package: excel! + fullName: formulasR1C1 + summary: >- + Represents the formula in R1C1-style notation. If a cell has no formula, + its value is returned instead. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulasR1C1: any[][];' + return: + type: any[][] + - name: index + uid: excel!Excel.RangeView#index:member + package: excel! + fullName: index + summary: Returns a value that represents the index of the `RangeView`. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly index: number;' + return: + type: number + - name: numberFormat + uid: excel!Excel.RangeView#numberFormat:member + package: excel! + fullName: numberFormat + summary: Represents Excel's number format code for the given cell. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat: any[][];' + return: + type: any[][] + - name: rowCount + uid: excel!Excel.RangeView#rowCount:member + package: excel! + fullName: rowCount + summary: The number of visible rows. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly rowCount: number;' + return: + type: number + - name: rows + uid: excel!Excel.RangeView#rows:member + package: excel! + fullName: rows + summary: Represents a collection of range views associated with the range. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly rows: Excel.RangeViewCollection;' + return: + type: + - name: text + uid: excel!Excel.RangeView#text:member + package: excel! + fullName: text + summary: >- + Text values of the specified range. The text value will not depend on the + cell width. The \# sign substitution that happens in Excel UI will not + affect the text value returned by the API. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly text: string[][];' + return: + type: string[][] + - name: values + uid: excel!Excel.RangeView#values:member + package: excel! + fullName: values + summary: >- + Represents the raw values of the specified range view. The data returned + could be of type string, number, or a boolean. Cells that contain an error + will return the error string. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'values: any[][];' + return: + type: any[][] + - name: valuesAsJson + uid: excel!Excel.RangeView#valuesAsJson:member + package: excel! + fullName: valuesAsJson + summary: >- + A JSON representation of the values in the cells in this range. Unlike + `RangeView.values`, `RangeView.valuesAsJson` supports all data + types which can be in a cell. Examples include formatted number values and + web images, in addition to the standard boolean, number, and string + values. Data returned from this API always aligns with the en-US locale. + To retrieve data in the user's display locale, use + `RangeView.valuesAsJsonLocal`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJson: CellValue[][];' + return: + type: [][] + - name: valuesAsJsonLocal + uid: excel!Excel.RangeView#valuesAsJsonLocal:member + package: excel! + fullName: valuesAsJsonLocal + summary: >- + A JSON representation of the values in the cells in this range. Unlike + `RangeView.values`, `RangeView.valuesAsJsonLocal` supports all + data types which can be in a cell. Examples include formatted number + values and web images, in addition to the standard boolean, number, and + string values. Data returned from this API always aligns with the user's + display locale. To retrieve data independent of locale, use + `RangeView.valuesAsJson`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJsonLocal: CellValue[][];' + return: + type: [][] + - name: valueTypes + uid: excel!Excel.RangeView#valueTypes:member + package: excel! + fullName: valueTypes + summary: Represents the type of data of each cell. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly valueTypes: Excel.RangeValueType[][];' + return: + type: [][] +methods: + - name: getRange() + uid: excel!Excel.RangeView#getRange:member(1) + package: excel! + fullName: getRange() + summary: Gets the parent range associated with the current `RangeView`. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getRange(): Excel.Range;' + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.RangeView#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(options?: Excel.Interfaces.RangeViewLoadOptions): Excel.RangeView;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.RangeView#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.RangeView;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.RangeView#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.RangeView; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.RangeView#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.RangeViewUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.RangeView#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.RangeView): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.RangeView#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.RangeView` object + is an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Excel.Interfaces.RangeViewData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.RangeViewData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.rangeviewcollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.rangeviewcollection.yml new file mode 100644 index 0000000000..046f142fea --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.rangeviewcollection.yml @@ -0,0 +1,179 @@ +### YamlMime:TSType +name: Excel.RangeViewCollection +uid: excel!Excel.RangeViewCollection:class +package: excel! +fullName: Excel.RangeViewCollection +summary: Represents a collection of `RangeView` objects. +remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.RangeViewCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: excel!Excel.RangeViewCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.RangeView[];' + return: + type: [] +methods: + - name: getCount() + uid: excel!Excel.RangeViewCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Gets the number of `RangeView` objects in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getItemAt(index) + uid: excel!Excel.RangeViewCollection#getItemAt:member(1) + package: excel! + fullName: getItemAt(index) + summary: Gets a `RangeView` row via its index. Zero-indexed. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemAt(index: number): Excel.RangeView;' + parameters: + - id: index + description: Index of the visible row. + type: number + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.RangeViewCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.RangeViewCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): Excel.RangeViewCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.RangeViewCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.RangeViewCollection;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.RangeViewCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.RangeViewCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.RangeViewCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.RangeViewCollection` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.RangeViewCollectionData`) that contains an + "items" array with shallow copies of any loaded properties from the + collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.RangeViewCollectionData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.readingorder.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.readingorder.yml new file mode 100644 index 0000000000..702846bee6 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.readingorder.yml @@ -0,0 +1,74 @@ +### YamlMime:TSEnum +name: Excel.ReadingOrder +uid: excel!Excel.ReadingOrder:enum +package: excel! +fullName: Excel.ReadingOrder +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml + + + await Excel.run(async (context) => { + let style = context.workbook.styles.getItem("Diagonal Orientation Style"); + style.load("textOrientation, horizontalAlignment, autoIndent, readingOrder, wrapText, includeProtection, shrinkToFit, locked"); + + await context.sync(); + + console.log("Orientation: " + style.textOrientation); + console.log("Horizontal alignment: " + style.horizontalAlignment); + console.log("Add indent: " + style.autoIndent); + console.log("Reading order: " + style.readingOrder); + console.log("Wrap text: " + style.wrapText); + console.log("Include protection: " + style.includeProtection); + console.log("Shrink to fit: " + style.shrinkToFit); + console.log("Style locked: " + style.locked); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: context + uid: excel!Excel.ReadingOrder.context:member + package: excel! + summary: >- + Reading order is determined by the language of the first character + entered. If a right-to-left language character is entered first, reading + order is right to left. If a left-to-right language character is entered + first, reading order is left to right. + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Context"' + - name: leftToRight + uid: excel!Excel.ReadingOrder.leftToRight:member + package: excel! + summary: >- + Left to right reading order + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LeftToRight"' + - name: rightToLeft + uid: excel!Excel.ReadingOrder.rightToLeft:member + package: excel! + summary: >- + Right to left reading order + + + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"RightToLeft"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.referencecellvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.referencecellvalue.yml new file mode 100644 index 0000000000..76a9dc5c5f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.referencecellvalue.yml @@ -0,0 +1,96 @@ +### YamlMime:TSType +name: Excel.ReferenceCellValue +uid: excel!Excel.ReferenceCellValue:interface +package: excel! +fullName: Excel.ReferenceCellValue +summary: >- + Represents a reference into `referencedValues`. One scenario for using + this reference is to avoid duplicating cell value objects (such as an + `EntityCellValue`). Define a cell value object once in + `referencedValues`, and then refer to that cell value from many places + by using a `ReferenceCellValue` where the duplicated value would have + appeared. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: basicType + uid: excel!Excel.ReferenceCellValue#basicType:member + package: excel! + fullName: basicType + summary: >- + Represents the value that would be returned by `Range.valueTypes` for a + cell with this value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + basicType?: RangeValueType | "Boolean" | "Double" | "Error" | "Empty" | + "String"; + return: + type: >- + | "Boolean" | "Double" + | "Error" | "Empty" | "String" + - name: basicValue + uid: excel!Excel.ReferenceCellValue#basicValue:member + package: excel! + fullName: basicValue + summary: >- + Represents the value that would be returned by `Range.values` for a cell + with this value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicValue?: boolean | number | string;' + return: + type: boolean | number | string + - name: reference + uid: excel!Excel.ReferenceCellValue#reference:member + package: excel! + fullName: reference + summary: >- + Represents the index into the `referencedValues` properties of cell values + such as `EntityCellValue` and `ArrayCellValue`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'reference: number;' + return: + type: number + - name: type + uid: excel!Excel.ReferenceCellValue#type:member + package: excel! + fullName: type + summary: Represents the type of this cell value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: CellValueType.reference | "Reference";' + return: + type: >- + | + "Reference" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.referencedvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.referencedvalue.yml new file mode 100644 index 0000000000..168b4928ba --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.referencedvalue.yml @@ -0,0 +1,26 @@ +### YamlMime:TSTypeAlias +name: Excel.ReferencedValue +uid: excel!Excel.ReferencedValue:type +package: excel! +fullName: Excel.ReferencedValue +summary: Represents the value in a cell. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), + [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), + [Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue), + [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), + [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), + [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue) + +isPreview: false +isDeprecated: false +syntax: >- + export type ReferencedValue = ArrayCellValue | EntityCellValue | + RootReferenceCellValue | DoubleCellValue | StringCellValue | BooleanCellValue; diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.referencevaluetype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.referencevaluetype.yml new file mode 100644 index 0000000000..5c883e65d7 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.referencevaluetype.yml @@ -0,0 +1,79 @@ +### YamlMime:TSEnum +name: Excel.ReferenceValueType +uid: excel!Excel.ReferenceValueType:enum +package: excel! +fullName: Excel.ReferenceValueType +summary: Represents the types of the `ReferenceValue` object. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: array + uid: excel!Excel.ReferenceValueType.array:member + package: excel! + summary: >- + Represents an `ArrayCellValue`. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Array"' + - name: boolean + uid: excel!Excel.ReferenceValueType.boolean:member + package: excel! + summary: >- + Represents a `BooleanCellValue`. + + + * \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Boolean"' + - name: double + uid: excel!Excel.ReferenceValueType.double:member + package: excel! + summary: >- + Represents a `DoubleCellValue`. + + + * \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Double"' + - name: entity + uid: excel!Excel.ReferenceValueType.entity:member + package: excel! + summary: >- + Represents an `EntityCellValue`. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Entity"' + - name: root + uid: excel!Excel.ReferenceValueType.root:member + package: excel! + summary: >- + Represents a `RootReferenceCellValue`. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Root"' + - name: string + uid: excel!Excel.ReferenceValueType.string:member + package: excel! + summary: >- + Represents a `StringCellValue`. + + + * \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"String"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.referrorcellvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.referrorcellvalue.yml new file mode 100644 index 0000000000..c00893aed2 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.referrorcellvalue.yml @@ -0,0 +1,105 @@ +### YamlMime:TSType +name: Excel.RefErrorCellValue +uid: excel!Excel.RefErrorCellValue:interface +package: excel! +fullName: Excel.RefErrorCellValue +summary: Represents the value of a cell containing a \#REF! error. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: basicType + uid: excel!Excel.RefErrorCellValue#basicType:member + package: excel! + fullName: basicType + summary: >- + Represents the value that would be returned by `Range.valueTypes` for a + cell with this value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicType?: RangeValueType.error | "Error";' + return: + type: | "Error" + - name: basicValue + uid: excel!Excel.RefErrorCellValue#basicValue:member + package: excel! + fullName: basicValue + summary: >- + Represents the value that would be returned by `Range.values` for a cell + with this value. When accessed through a `valuesAsJson` property, this + string value aligns with the en-US locale. When accessed through a + `valuesAsJsonLocal` property, this string value aligns with the user's + display locale. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicValue?: "#REF!" | string;' + return: + type: '"#REF!" | string' + - name: errorSubType + uid: excel!Excel.RefErrorCellValue#errorSubType:member + package: excel! + fullName: errorSubType + summary: Represents the type of `RefErrorCellValue`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + errorSubType?: RefErrorCellValueSubType | "Unknown" | + "ExternalLinksStructuredRef" | "ExternalLinksCalculatedRef"; + return: + type: >- + | "Unknown" | + "ExternalLinksStructuredRef" | "ExternalLinksCalculatedRef" + - name: errorType + uid: excel!Excel.RefErrorCellValue#errorType:member + package: excel! + fullName: errorType + summary: Represents the type of `ErrorCellValue`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'errorType?: ErrorCellValueType.ref | "Ref";' + return: + type: | "Ref" + - name: type + uid: excel!Excel.RefErrorCellValue#type:member + package: excel! + fullName: type + summary: Represents the type of this cell value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: CellValueType.error | "Error";' + return: + type: | "Error" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.referrorcellvaluesubtype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.referrorcellvaluesubtype.yml new file mode 100644 index 0000000000..78cbc72e9a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.referrorcellvaluesubtype.yml @@ -0,0 +1,48 @@ +### YamlMime:TSEnum +name: Excel.RefErrorCellValueSubType +uid: excel!Excel.RefErrorCellValueSubType:enum +package: excel! +fullName: Excel.RefErrorCellValueSubType +summary: Represents types of \#REF! errors. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: externalLinksCalculatedRef + uid: excel!Excel.RefErrorCellValueSubType.externalLinksCalculatedRef:member + package: excel! + summary: >- + An error caused by dynamic array references from the linked workbook. + Displays as error type \#REF! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ExternalLinksCalculatedRef"' + - name: externalLinksStructuredRef + uid: excel!Excel.RefErrorCellValueSubType.externalLinksStructuredRef:member + package: excel! + summary: >- + An error caused by structured references from the linked workbook. + Displays as error type \#REF! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"ExternalLinksStructuredRef"' + - name: unknown + uid: excel!Excel.RefErrorCellValueSubType.unknown:member + package: excel! + summary: >- + An unknown type of error. Displays as error type \#REF! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Unknown"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.removeduplicatesresult.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.removeduplicatesresult.yml new file mode 100644 index 0000000000..0e73156b5e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.removeduplicatesresult.yml @@ -0,0 +1,188 @@ +### YamlMime:TSType +name: Excel.RemoveDuplicatesResult +uid: excel!Excel.RemoveDuplicatesResult:class +package: excel! +fullName: Excel.RemoveDuplicatesResult +summary: Represents the results from `Range.removeDuplicates`. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.RemoveDuplicatesResult#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: removed + uid: excel!Excel.RemoveDuplicatesResult#removed:member + package: excel! + fullName: removed + summary: Number of duplicated rows removed by the operation. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly removed: number;' + return: + type: number + - name: uniqueRemaining + uid: excel!Excel.RemoveDuplicatesResult#uniqueRemaining:member + package: excel! + fullName: uniqueRemaining + summary: Number of remaining unique rows present in the resulting range. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-remove-duplicates.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const range = sheet.getRange("B2:D11"); + + const deleteResult = range.removeDuplicates([0],true); + deleteResult.load(); + await context.sync(); + + console.log(deleteResult.removed + " entries with duplicate names removed."); + console.log(deleteResult.uniqueRemaining + " entries with unique names remain in the range."); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly uniqueRemaining: number;' + return: + type: number +methods: + - name: load(options) + uid: excel!Excel.RemoveDuplicatesResult#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.RemoveDuplicatesResultLoadOptions): + Excel.RemoveDuplicatesResult; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.RemoveDuplicatesResult#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.RemoveDuplicatesResult;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.RemoveDuplicatesResult#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.RemoveDuplicatesResult; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.RemoveDuplicatesResult#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.RemoveDuplicatesResult` object is an API object, the `toJSON` + method returns a plain JavaScript object (typed as + `Excel.Interfaces.RemoveDuplicatesResultData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.RemoveDuplicatesResultData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.replacecriteria.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.replacecriteria.yml new file mode 100644 index 0000000000..945dcd0c27 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.replacecriteria.yml @@ -0,0 +1,50 @@ +### YamlMime:TSType +name: Excel.ReplaceCriteria +uid: excel!Excel.ReplaceCriteria:interface +package: excel! +fullName: Excel.ReplaceCriteria +summary: Represents the replace criteria to be used. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: completeMatch + uid: excel!Excel.ReplaceCriteria#completeMatch:member + package: excel! + fullName: completeMatch + summary: >- + Specifies if the match needs to be complete or partial. A complete match + matches the entire contents of the cell. A partial match matches a + substring within the content of the cell (e.g., `cat` partially matches + `caterpillar` and `scatter`). Default is `false` (partial). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'completeMatch?: boolean;' + return: + type: boolean + - name: matchCase + uid: excel!Excel.ReplaceCriteria#matchCase:member + package: excel! + fullName: matchCase + summary: >- + Specifies if the match is case-sensitive. Default is `false` + (case-insensitive). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'matchCase?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.requestcontext.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.requestcontext.yml new file mode 100644 index 0000000000..39b9ecb9e5 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.requestcontext.yml @@ -0,0 +1,86 @@ +### YamlMime:TSType +name: Excel.RequestContext +uid: excel!Excel.RequestContext:class +package: excel! +fullName: Excel.RequestContext +summary: >- + The RequestContext object facilitates requests to the Excel application. Since + the Office add-in and the Excel application run in two different processes, + the request context is required to get access to the Excel object model from + the add-in. +remarks: |- + + + #### Examples + + ```TypeScript + // *.run methods automatically create an OfficeExtension.ClientRequestContext + // object to work with the Office file. + await Excel.run(async (context: Excel.RequestContext) => { + const workbook = context.workbook; + // Interact with the Excel workbook... + }); + ``` + +isPreview: false +isDeprecated: false +type: class +constructors: + - name: (constructor)(url) + uid: excel!Excel.RequestContext:constructor(1) + package: excel! + fullName: (constructor)(url) + summary: Constructs a new instance of the `RequestContext` class + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'constructor(url?: string | Session);' + parameters: + - id: url + description: '' + type: string | +properties: + - name: application + uid: excel!Excel.RequestContext#application:member + package: excel! + fullName: application + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly application: Application;' + return: + type: + - name: runtime + uid: excel!Excel.RequestContext#runtime:member + package: excel! + fullName: runtime + summary: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly runtime: Runtime;' + return: + type: + - name: workbook + uid: excel!Excel.RequestContext#workbook:member + package: excel! + fullName: workbook + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly workbook: Workbook;' + return: + type: +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.ribbontab.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.ribbontab.yml new file mode 100644 index 0000000000..e0157fd740 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.ribbontab.yml @@ -0,0 +1,97 @@ +### YamlMime:TSEnum +name: Excel.RibbonTab +uid: excel!Excel.RibbonTab:enum +package: excel! +fullName: Excel.RibbonTab +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: addIns + uid: excel!Excel.RibbonTab.addIns:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"AddIns"' + - name: data + uid: excel!Excel.RibbonTab.data:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Data"' + - name: developer + uid: excel!Excel.RibbonTab.developer:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Developer"' + - name: draw + uid: excel!Excel.RibbonTab.draw:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Draw"' + - name: formulas + uid: excel!Excel.RibbonTab.formulas:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Formulas"' + - name: help + uid: excel!Excel.RibbonTab.help:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Help"' + - name: home + uid: excel!Excel.RibbonTab.home:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Home"' + - name: insert + uid: excel!Excel.RibbonTab.insert:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Insert"' + - name: others + uid: excel!Excel.RibbonTab.others:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Others"' + - name: pageLayout + uid: excel!Excel.RibbonTab.pageLayout:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"PageLayout"' + - name: review + uid: excel!Excel.RibbonTab.review:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Review"' + - name: view + uid: excel!Excel.RibbonTab.view:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"View"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.rootreferencecellvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.rootreferencecellvalue.yml new file mode 100644 index 0000000000..9b0d7024b9 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.rootreferencecellvalue.yml @@ -0,0 +1,70 @@ +### YamlMime:TSType +name: Excel.RootReferenceCellValue +uid: excel!Excel.RootReferenceCellValue:interface +package: excel! +fullName: Excel.RootReferenceCellValue +summary: Represents a reference to the value which contains `referencedValues`. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: basicType + uid: excel!Excel.RootReferenceCellValue#basicType:member + package: excel! + fullName: basicType + summary: >- + Represents the value that would be returned by `Range.valueTypes` for a + cell with this value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + basicType?: RangeValueType | "Boolean" | "Double" | "Error" | "Empty" | + "String"; + return: + type: >- + | "Boolean" | "Double" + | "Error" | "Empty" | "String" + - name: basicValue + uid: excel!Excel.RootReferenceCellValue#basicValue:member + package: excel! + fullName: basicValue + summary: >- + Represents the value that would be returned by `Range.values` for a cell + with this value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicValue?: boolean | number | string;' + return: + type: boolean | number | string + - name: type + uid: excel!Excel.RootReferenceCellValue#type:member + package: excel! + fullName: type + summary: Represents the type of this cell value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: ReferenceValueType.root | "Root";' + return: + type: | "Root" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.rowcolumnpivothierarchy.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.rowcolumnpivothierarchy.yml new file mode 100644 index 0000000000..57cd9f6481 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.rowcolumnpivothierarchy.yml @@ -0,0 +1,264 @@ +### YamlMime:TSType +name: Excel.RowColumnPivotHierarchy +uid: excel!Excel.RowColumnPivotHierarchy:class +package: excel! +fullName: Excel.RowColumnPivotHierarchy +summary: Represents the Excel RowColumnPivotHierarchy. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.RowColumnPivotHierarchy#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: fields + uid: excel!Excel.RowColumnPivotHierarchy#fields:member + package: excel! + fullName: fields + summary: Returns the PivotFields associated with the RowColumnPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly fields: Excel.PivotFieldCollection;' + return: + type: + - name: id + uid: excel!Excel.RowColumnPivotHierarchy#id:member + package: excel! + fullName: id + summary: ID of the RowColumnPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly id: string;' + return: + type: string + - name: name + uid: excel!Excel.RowColumnPivotHierarchy#name:member + package: excel! + fullName: name + summary: Name of the RowColumnPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name: string;' + return: + type: string + - name: position + uid: excel!Excel.RowColumnPivotHierarchy#position:member + package: excel! + fullName: position + summary: Position of the RowColumnPivotHierarchy. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'position: number;' + return: + type: number +methods: + - name: load(options) + uid: excel!Excel.RowColumnPivotHierarchy#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.RowColumnPivotHierarchyLoadOptions): + Excel.RowColumnPivotHierarchy; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.RowColumnPivotHierarchy#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.RowColumnPivotHierarchy;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.RowColumnPivotHierarchy#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.RowColumnPivotHierarchy; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.RowColumnPivotHierarchy#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.RowColumnPivotHierarchyUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.RowColumnPivotHierarchy#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.RowColumnPivotHierarchy): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: setToDefault() + uid: excel!Excel.RowColumnPivotHierarchy#setToDefault:member(1) + package: excel! + fullName: setToDefault() + summary: Reset the RowColumnPivotHierarchy back to its default values. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'setToDefault(): void;' + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.RowColumnPivotHierarchy#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.RowColumnPivotHierarchy` object is an API object, the `toJSON` + method returns a plain JavaScript object (typed as + `Excel.Interfaces.RowColumnPivotHierarchyData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.RowColumnPivotHierarchyData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.rowcolumnpivothierarchycollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.rowcolumnpivothierarchycollection.yml new file mode 100644 index 0000000000..1de74817d6 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.rowcolumnpivothierarchycollection.yml @@ -0,0 +1,258 @@ +### YamlMime:TSType +name: Excel.RowColumnPivotHierarchyCollection +uid: excel!Excel.RowColumnPivotHierarchyCollection:class +package: excel! +fullName: Excel.RowColumnPivotHierarchyCollection +summary: >- + Represents a collection of RowColumnPivotHierarchy items associated with the + PivotTable. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.RowColumnPivotHierarchyCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: excel!Excel.RowColumnPivotHierarchyCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.RowColumnPivotHierarchy[];' + return: + type: [] +methods: + - name: add(pivotHierarchy) + uid: excel!Excel.RowColumnPivotHierarchyCollection#add:member(1) + package: excel! + fullName: add(pivotHierarchy) + summary: >- + Adds the PivotHierarchy to the current axis. If the hierarchy is present + elsewhere on the row, column, or filter axis, it will be removed from that + location. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + add(pivotHierarchy: Excel.PivotHierarchy): + Excel.RowColumnPivotHierarchy; + parameters: + - id: pivotHierarchy + description: '' + type: + return: + type: + description: '' + - name: getCount() + uid: excel!Excel.RowColumnPivotHierarchyCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Gets the number of pivot hierarchies in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getItem(name) + uid: excel!Excel.RowColumnPivotHierarchyCollection#getItem:member(1) + package: excel! + fullName: getItem(name) + summary: Gets a RowColumnPivotHierarchy by its name or ID. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItem(name: string): Excel.RowColumnPivotHierarchy;' + parameters: + - id: name + description: Name of the RowColumnPivotHierarchy to be retrieved. + type: string + return: + type: + description: '' + - name: getItemOrNullObject(name) + uid: >- + excel!Excel.RowColumnPivotHierarchyCollection#getItemOrNullObject:member(1) + package: excel! + fullName: getItemOrNullObject(name) + summary: >- + Gets a RowColumnPivotHierarchy by name. If the RowColumnPivotHierarchy + does not exist, then this method returns an object with its `isNullObject` + property set to `true`. For further information, see + [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemOrNullObject(name: string): Excel.RowColumnPivotHierarchy;' + parameters: + - id: name + description: Name of the RowColumnPivotHierarchy to be retrieved. + type: string + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.RowColumnPivotHierarchyCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: + Excel.Interfaces.RowColumnPivotHierarchyCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): + Excel.RowColumnPivotHierarchyCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.RowColumnPivotHierarchyCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNames?: string | string[]): + Excel.RowColumnPivotHierarchyCollection; + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.RowColumnPivotHierarchyCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.RowColumnPivotHierarchyCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: remove(rowColumnPivotHierarchy) + uid: excel!Excel.RowColumnPivotHierarchyCollection#remove:member(1) + package: excel! + fullName: remove(rowColumnPivotHierarchy) + summary: Removes the PivotHierarchy from the current axis. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'remove(rowColumnPivotHierarchy: Excel.RowColumnPivotHierarchy): void;' + parameters: + - id: rowColumnPivotHierarchy + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.RowColumnPivotHierarchyCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.RowColumnPivotHierarchyCollection` object is an API object, the + `toJSON` method returns a plain JavaScript object (typed as + `Excel.Interfaces.RowColumnPivotHierarchyCollectionData`) that + contains an "items" array with shallow copies of any loaded properties + from the collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.RowColumnPivotHierarchyCollectionData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.rowhiddenchangetype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.rowhiddenchangetype.yml new file mode 100644 index 0000000000..7261c3ff63 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.rowhiddenchangetype.yml @@ -0,0 +1,35 @@ +### YamlMime:TSEnum +name: Excel.RowHiddenChangeType +uid: excel!Excel.RowHiddenChangeType:enum +package: excel! +fullName: Excel.RowHiddenChangeType +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: hidden + uid: excel!Excel.RowHiddenChangeType.hidden:member + package: excel! + summary: >- + `Hidden` indicates that the row is hidden. + + + * \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Hidden"' + - name: unhidden + uid: excel!Excel.RowHiddenChangeType.unhidden:member + package: excel! + summary: >- + `Unhidden` indicates that the row is not hidden. + + + * \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Unhidden"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.rowproperties.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.rowproperties.yml new file mode 100644 index 0000000000..3ff45512d2 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.rowproperties.yml @@ -0,0 +1,72 @@ +### YamlMime:TSType +name: Excel.RowProperties +uid: excel!Excel.RowProperties:interface +package: excel! +fullName: Excel.RowProperties +summary: >- + Represents the returned properties of getRowProperties. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: address + uid: excel!Excel.RowProperties#address:member + package: excel! + fullName: address + summary: >- + Represents the `address` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'address?: string;' + return: + type: string + - name: addressLocal + uid: excel!Excel.RowProperties#addressLocal:member + package: excel! + fullName: addressLocal + summary: >- + Represents the `addressLocal` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'addressLocal?: string;' + return: + type: string + - name: rowIndex + uid: excel!Excel.RowProperties#rowIndex:member + package: excel! + fullName: rowIndex + summary: >- + Represents the `rowIndex` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'rowIndex?: number;' + return: + type: number +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.rowpropertiesloadoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.rowpropertiesloadoptions.yml new file mode 100644 index 0000000000..283fac193a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.rowpropertiesloadoptions.yml @@ -0,0 +1,80 @@ +### YamlMime:TSType +name: Excel.RowPropertiesLoadOptions +uid: excel!Excel.RowPropertiesLoadOptions:interface +package: excel! +fullName: Excel.RowPropertiesLoadOptions +summary: >- + Represents which row properties to load, when used as part of a + "range.getRowProperties" method. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: format + uid: excel!Excel.RowPropertiesLoadOptions#format:member + package: excel! + fullName: format + summary: >- + Specifies whether to load on the `format` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + format?: Excel.CellPropertiesFormatLoadOptions & { + rowHeight?: boolean; + }; + return: + type: >- + & + { + rowHeight?: boolean; + } + - name: rowHidden + uid: excel!Excel.RowPropertiesLoadOptions#rowHidden:member + package: excel! + fullName: rowHidden + summary: >- + Specifies whether to load on the `rowHidden` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'rowHidden?: boolean;' + return: + type: boolean + - name: rowIndex + uid: excel!Excel.RowPropertiesLoadOptions#rowIndex:member + package: excel! + fullName: rowIndex + summary: >- + Specifies whether to load on the `rowIndex` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'rowIndex?: boolean;' + return: + type: boolean +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.runoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.runoptions.yml new file mode 100644 index 0000000000..300015ddf7 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.runoptions.yml @@ -0,0 +1,61 @@ +### YamlMime:TSType +name: Excel.RunOptions +uid: excel!Excel.RunOptions:interface +package: excel! +fullName: Excel.RunOptions +summary: '' +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: delayForCellEdit + uid: excel!Excel.RunOptions#delayForCellEdit:member + package: excel! + fullName: delayForCellEdit + summary: >- + Determines whether Excel will delay the batch request until the user exits + cell edit mode. + + + When `false`, if the user is in cell edit when the batch request + is processed by the host, the batch automatically fails. When `true`, the batch request is executed immediately if the user is not in cell + edit mode, but if the user is in cell edit mode then the batch request is + delayed until the user exits cell edit mode. The default behavior with no + `delayForCellEdit` property specified is equivalent to when it is + `false`. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'delayForCellEdit?: boolean;' + return: + type: boolean + - name: mergeUndoGroup + uid: excel!Excel.RunOptions#mergeUndoGroup:member + package: excel! + fullName: mergeUndoGroup + summary: >- + Determines whether the batch requests should be merged to one undo group. + + + When false, each `context.sync()` call creates an undo record. When true, + all `context.sync()` calls in a single `Excel.run` are merged into one + `undo` group. + remarks: >- + \[ [API set: ExcelApi + 1.20](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'mergeUndoGroup?: boolean;' + return: + type: boolean +extends: >- + <> diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.runtime.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.runtime.yml new file mode 100644 index 0000000000..be0239401f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.runtime.yml @@ -0,0 +1,220 @@ +### YamlMime:TSType +name: Excel.Runtime +uid: excel!Excel.Runtime:class +package: excel! +fullName: Excel.Runtime +summary: Represents the Excel Runtime class. +remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.Runtime#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: enableEvents + uid: excel!Excel.Runtime#enableEvents:member + package: excel! + fullName: enableEvents + summary: Toggle JavaScript events in the current task pane or content add-in. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-disable-events.yaml + + + await Excel.run(async (context) => { + context.runtime.load("enableEvents"); + await context.sync(); + + // check if events are enabled and toggle accordingly + const eventBoolean = !context.runtime.enableEvents + context.runtime.enableEvents = eventBoolean; + if (eventBoolean) { + console.log("Events are currently on."); + } else { + console.log("Events are currently off."); + } + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'enableEvents: boolean;' + return: + type: boolean +methods: + - name: load(options) + uid: excel!Excel.Runtime#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(options?: Excel.Interfaces.RuntimeLoadOptions): Excel.Runtime;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.Runtime#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.Runtime;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.Runtime#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.Runtime; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.Runtime#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.RuntimeUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.Runtime#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.Runtime): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.Runtime#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.Runtime` object + is an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Excel.Interfaces.RuntimeData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.RuntimeData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.savebehavior.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.savebehavior.yml new file mode 100644 index 0000000000..fca8dc76a3 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.savebehavior.yml @@ -0,0 +1,51 @@ +### YamlMime:TSEnum +name: Excel.SaveBehavior +uid: excel!Excel.SaveBehavior:enum +package: excel! +fullName: Excel.SaveBehavior +summary: Specifies the save behavior for `Workbook.save`. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-save-and-close.yaml + + + await Excel.run(async (context) => { + context.workbook.save(Excel.SaveBehavior.prompt); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: prompt + uid: excel!Excel.SaveBehavior.prompt:member + package: excel! + summary: >- + Prompts the "Save As" experience to the user if the workbook has not been + saved, Ignored if the workbook was previously saved. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Prompt"' + - name: save + uid: excel!Excel.SaveBehavior.save:member + package: excel! + summary: >- + Save the workbook without prompting the user. If file is not saved, it + will save it with default name in the default location. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Save"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.searchcriteria.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.searchcriteria.yml new file mode 100644 index 0000000000..c0b7737721 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.searchcriteria.yml @@ -0,0 +1,69 @@ +### YamlMime:TSType +name: Excel.SearchCriteria +uid: excel!Excel.SearchCriteria:interface +package: excel! +fullName: Excel.SearchCriteria +summary: Represents the search criteria to be used. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: completeMatch + uid: excel!Excel.SearchCriteria#completeMatch:member + package: excel! + fullName: completeMatch + summary: >- + Specifies if the match needs to be complete or partial. A complete match + matches the entire contents of the cell. A partial match matches a + substring within the content of the cell (e.g., `cat` partially matches + `caterpillar` and `scatter`). Default is `false` (partial). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'completeMatch?: boolean;' + return: + type: boolean + - name: matchCase + uid: excel!Excel.SearchCriteria#matchCase:member + package: excel! + fullName: matchCase + summary: >- + Specifies if the match is case-sensitive. Default is `false` + (case-insensitive). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'matchCase?: boolean;' + return: + type: boolean + - name: searchDirection + uid: excel!Excel.SearchCriteria#searchDirection:member + package: excel! + fullName: searchDirection + summary: >- + Specifies the search direction. Default is forward. See + `Excel.SearchDirection`. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'searchDirection?: Excel.SearchDirection | "Forward" | "Backwards";' + return: + type: >- + | "Forward" | + "Backwards" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.searchdirection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.searchdirection.yml new file mode 100644 index 0000000000..f30e68d9c6 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.searchdirection.yml @@ -0,0 +1,51 @@ +### YamlMime:TSEnum +name: Excel.SearchDirection +uid: excel!Excel.SearchDirection:enum +package: excel! +fullName: Excel.SearchDirection +summary: Specifies the search direction. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-find.yaml + + + searchDirectionToggle = searchDirectionToggle === + Excel.SearchDirection.forward ? Excel.SearchDirection.backwards : + Excel.SearchDirection.forward; + + console.log("Search direction = " + searchDirectionToggle); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: backwards + uid: excel!Excel.SearchDirection.backwards:member + package: excel! + summary: >- + Search in reverse order. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Backwards"' + - name: forward + uid: excel!Excel.SearchDirection.forward:member + package: excel! + summary: >- + Search in forward order. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Forward"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.selectionchangedeventargs.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.selectionchangedeventargs.yml new file mode 100644 index 0000000000..5a22236bd0 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.selectionchangedeventargs.yml @@ -0,0 +1,31 @@ +### YamlMime:TSType +name: Excel.SelectionChangedEventArgs +uid: excel!Excel.SelectionChangedEventArgs:interface +package: excel! +fullName: Excel.SelectionChangedEventArgs +summary: >- + Provides information about the document that raised the selection changed + event. +remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: workbook + uid: excel!Excel.SelectionChangedEventArgs#workbook:member + package: excel! + fullName: workbook + summary: Gets the workbook object that raised the selection changed event. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'workbook: Excel.Workbook;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.session.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.session.yml new file mode 100644 index 0000000000..942e6f6d8c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.session.yml @@ -0,0 +1,11 @@ +### YamlMime:TSType +name: Excel.Session +uid: excel!Excel.Session:interface +package: excel! +fullName: Excel.Session +summary: '' +remarks: '' + +isPreview: false +isDeprecated: false +type: interface diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.settablecellproperties.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.settablecellproperties.yml new file mode 100644 index 0000000000..7c639e98f1 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.settablecellproperties.yml @@ -0,0 +1,172 @@ +### YamlMime:TSType +name: Excel.SettableCellProperties +uid: excel!Excel.SettableCellProperties:interface +package: excel! +fullName: Excel.SettableCellProperties +summary: >- + Represents the input parameter of setCellProperties. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: format + uid: excel!Excel.SettableCellProperties#format:member + package: excel! + fullName: format + summary: >- + Represents the `format` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'format?: Excel.CellPropertiesFormat;' + return: + type: + - name: hyperlink + uid: excel!Excel.SettableCellProperties#hyperlink:member + package: excel! + fullName: hyperlink + summary: >- + Represents the `hyperlink` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'hyperlink?: Excel.RangeHyperlink;' + return: + type: + - name: style + uid: excel!Excel.SettableCellProperties#style:member + package: excel! + fullName: style + summary: >- + Represents the `style` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'style?: string;' + return: + type: string + description: >- + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/cell-properties.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Creating the SettableCellProperties objects to use for the range. + // In your add-in, these should be created once, outside the function. + const topHeaderProps: Excel.SettableCellProperties = { + // The style property takes a string matching the name of an Excel style. + // Built-in style names are listed in the `BuiltInStyle` enum. + // Note that a style will overwrite any formatting, + // so do not use the format property with the style property. + style: "Heading1" + }; + + const headerProps: Excel.SettableCellProperties = { + // Any subproperties of format that are not set will not be changed when these cell properties are set. + format: { + fill: { + color: "Blue" + }, + font: { + color: "White", + bold: true + } + } + }; + + const nonApplicableProps: Excel.SettableCellProperties = { + format: { + fill: { + pattern: Excel.FillPattern.gray25 + }, + font: { + color: "Gray", + italic: true + } + } + }; + + const matchupScoreProps: Excel.SettableCellProperties = { + format: { + borders: { + bottom: { + style: Excel.BorderLineStyle.continuous + }, + left: { + style: Excel.BorderLineStyle.continuous + }, + right: { + style: Excel.BorderLineStyle.continuous + }, + top: { + style: Excel.BorderLineStyle.continuous + } + } + } + }; + + const range = sheet.getRange("A1:E5"); + + // You can use empty JSON objects to avoid changing a cell's properties. + range.setCellProperties([ + [topHeaderProps, {}, {}, {}, {}], + [{}, {}, headerProps, headerProps, headerProps], + [{}, headerProps, nonApplicableProps, matchupScoreProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, nonApplicableProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, matchupScoreProps, nonApplicableProps] + ]); + + sheet.getUsedRange().format.autofitColumns(); + await context.sync(); + }); + + ``` + - name: textRuns + uid: excel!Excel.SettableCellProperties#textRuns:member + package: excel! + fullName: textRuns + summary: Represents the `textRuns` property. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textRuns?: RangeTextRun[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.settablecolumnproperties.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.settablecolumnproperties.yml new file mode 100644 index 0000000000..42adfce320 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.settablecolumnproperties.yml @@ -0,0 +1,60 @@ +### YamlMime:TSType +name: Excel.SettableColumnProperties +uid: excel!Excel.SettableColumnProperties:interface +package: excel! +fullName: Excel.SettableColumnProperties +summary: >- + Represents the input parameter of setColumnProperties. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: columnHidden + uid: excel!Excel.SettableColumnProperties#columnHidden:member + package: excel! + fullName: columnHidden + summary: >- + Represents the `columnHidden` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'columnHidden?: boolean;' + return: + type: boolean + - name: format + uid: excel!Excel.SettableColumnProperties#format:member + package: excel! + fullName: format + summary: >- + Represents the `format` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + format?: Excel.CellPropertiesFormat & { + columnWidth?: number; + }; + return: + type: |- + & { + columnWidth?: number; + } +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.settablerowproperties.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.settablerowproperties.yml new file mode 100644 index 0000000000..d68ec6fdad --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.settablerowproperties.yml @@ -0,0 +1,60 @@ +### YamlMime:TSType +name: Excel.SettableRowProperties +uid: excel!Excel.SettableRowProperties:interface +package: excel! +fullName: Excel.SettableRowProperties +summary: >- + Represents the input parameter of setRowProperties. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: format + uid: excel!Excel.SettableRowProperties#format:member + package: excel! + fullName: format + summary: >- + Represents the `format` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + format?: Excel.CellPropertiesFormat & { + rowHeight?: number; + }; + return: + type: |- + & { + rowHeight?: number; + } + - name: rowHidden + uid: excel!Excel.SettableRowProperties#rowHidden:member + package: excel! + fullName: rowHidden + summary: >- + Represents the `rowHidden` property. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'rowHidden?: boolean;' + return: + type: boolean +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.setting.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.setting.yml new file mode 100644 index 0000000000..1ba145fac6 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.setting.yml @@ -0,0 +1,257 @@ +### YamlMime:TSType +name: Excel.Setting +uid: excel!Excel.Setting:class +package: excel! +fullName: Excel.Setting +summary: >- + Setting represents a key-value pair of a setting persisted to the document + (per file, per add-in). These custom key-value pair can be used to store state + or lifecycle information needed by the content or task-pane add-in. Note that + settings are persisted in the document and hence it is not a place to store + any sensitive or protected information such as user information and password. +remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.Setting#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: key + uid: excel!Excel.Setting#key:member + package: excel! + fullName: key + summary: The key that represents the ID of the setting. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly key: string;' + return: + type: string + - name: value + uid: excel!Excel.Setting#value:member + package: excel! + fullName: value + summary: Represents the value stored for this setting. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'value: any;' + return: + type: any +methods: + - name: delete() + uid: excel!Excel.Setting#delete:member(1) + package: excel! + fullName: delete() + summary: Deletes the setting. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/create-get-change-delete-settings.yaml + + + await Excel.run(async (context) => { + const settings = context.workbook.settings; + let needsReview = settings.getItem("NeedsReview"); + needsReview.delete(); + needsReview = settings.getItemOrNullObject("NeedsReview"); + + await context.sync(); + + if (needsReview.isNullObject) { + console.log("The setting has been deleted"); + } else { + console.log("The setting was not deleted"); + } + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'delete(): void;' + return: + type: void + description: '' + - name: load(options) + uid: excel!Excel.Setting#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(options?: Excel.Interfaces.SettingLoadOptions): Excel.Setting;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.Setting#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.Setting;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.Setting#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.Setting; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.Setting#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.SettingUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.Setting#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.Setting): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.Setting#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.Setting` object + is an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Excel.Interfaces.SettingData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.SettingData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.settingcollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.settingcollection.yml new file mode 100644 index 0000000000..e4897db7fd --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.settingcollection.yml @@ -0,0 +1,319 @@ +### YamlMime:TSType +name: Excel.SettingCollection +uid: excel!Excel.SettingCollection:class +package: excel! +fullName: Excel.SettingCollection +summary: >- + Represents a collection of key-value pair setting objects that are part of the + workbook. The scope is limited to per file and add-in (task-pane or content) + combination. +remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.SettingCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: excel!Excel.SettingCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.Setting[];' + return: + type: [] +methods: + - name: add(key, value) + uid: excel!Excel.SettingCollection#add:member(1) + package: excel! + fullName: add(key, value) + summary: Sets or adds the specified setting to the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-workbook-and-worksheet-collection.yaml + + + await Excel.run(async (context) => { + const settings = context.workbook.settings; + settings.onSettingsChanged.add(onChangedSetting); + + await context.sync(); + console.log("Settings changed handler registered."); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + add(key: string, value: string | number | boolean | Date | any[] | any): + Excel.Setting; + parameters: + - id: key + description: The key of the new setting. + type: string + - id: value + description: The value for the new setting. + type: string | number | boolean | Date | any[] | any + return: + type: + description: '' + - name: getCount() + uid: excel!Excel.SettingCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Gets the number of settings in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getItem(key) + uid: excel!Excel.SettingCollection#getItem:member(1) + package: excel! + fullName: getItem(key) + summary: Gets a setting entry via the key. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItem(key: string): Excel.Setting;' + parameters: + - id: key + description: Key of the setting. + type: string + return: + type: + description: '' + - name: getItemOrNullObject(key) + uid: excel!Excel.SettingCollection#getItemOrNullObject:member(1) + package: excel! + fullName: getItemOrNullObject(key) + summary: >- + Gets a setting entry via the key. If the setting does not exist, then this + method returns an object with its `isNullObject` property set to + `true`. For further information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/create-get-change-delete-settings.yaml + + + await Excel.run(async (context) => { + const settings = context.workbook.settings; + let needsReview = settings.getItem("NeedsReview"); + needsReview.delete(); + needsReview = settings.getItemOrNullObject("NeedsReview"); + + await context.sync(); + + if (needsReview.isNullObject) { + console.log("The setting has been deleted"); + } else { + console.log("The setting was not deleted"); + } + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemOrNullObject(key: string): Excel.Setting;' + parameters: + - id: key + description: The key of the setting. + type: string + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.SettingCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.SettingCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): Excel.SettingCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.SettingCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.SettingCollection;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.SettingCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.SettingCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.SettingCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.SettingCollection` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.SettingCollectionData`) that contains an "items" + array with shallow copies of any loaded properties from the collection's + items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.SettingCollectionData;' + return: + type: + description: '' +events: + - name: onSettingsChanged + uid: excel!Excel.SettingCollection#onSettingsChanged:member + package: excel! + fullName: onSettingsChanged + summary: Occurs when the settings in the document are changed. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-workbook-and-worksheet-collection.yaml + + + await Excel.run(async (context) => { + const settings = context.workbook.settings; + settings.onSettingsChanged.add(onChangedSetting); + + await context.sync(); + console.log("Settings changed handler registered."); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onSettingsChanged: + OfficeExtension.EventHandlers; + return: + type: >- + <> +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.settingschangedeventargs.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.settingschangedeventargs.yml new file mode 100644 index 0000000000..d61bd3c2a2 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.settingschangedeventargs.yml @@ -0,0 +1,31 @@ +### YamlMime:TSType +name: Excel.SettingsChangedEventArgs +uid: excel!Excel.SettingsChangedEventArgs:interface +package: excel! +fullName: Excel.SettingsChangedEventArgs +summary: Provides information about the setting that raised the settings changed event +remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: settings + uid: excel!Excel.SettingsChangedEventArgs#settings:member + package: excel! + fullName: settings + summary: >- + Gets the `Setting` object that represents the binding that raised the + settings changed event + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'settings: Excel.SettingCollection;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.shape.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.shape.yml new file mode 100644 index 0000000000..3adfdb1c6a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.shape.yml @@ -0,0 +1,1391 @@ +### YamlMime:TSType +name: Excel.Shape +uid: excel!Excel.Shape:class +package: excel! +fullName: Excel.Shape +summary: >- + Represents a generic shape object in the worksheet. A shape could be a + geometric shape, a line, a group of shapes, etc. To learn more about the shape + object model, read [Work with shapes using the Excel JavaScript + API](https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-shapes). +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: altTextDescription + uid: excel!Excel.Shape#altTextDescription:member + package: excel! + fullName: altTextDescription + summary: Specifies the alternative description text for a `Shape` object. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'altTextDescription: string;' + return: + type: string + - name: altTextTitle + uid: excel!Excel.Shape#altTextTitle:member + package: excel! + fullName: altTextTitle + summary: Specifies the alternative title text for a `Shape` object. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'altTextTitle: string;' + return: + type: string + - name: connectionSiteCount + uid: excel!Excel.Shape#connectionSiteCount:member + package: excel! + fullName: connectionSiteCount + summary: Returns the number of connection sites on this shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly connectionSiteCount: number;' + return: + type: number + - name: context + uid: excel!Excel.Shape#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: displayName + uid: excel!Excel.Shape#displayName:member + package: excel! + fullName: displayName + summary: >- + Gets the display name of the shape. A newly created shape has a generated + name that is localized and may not match its `name`. In this + scenario, you can use this API to get the name that is displayed in the + UI. + remarks: >- + \[ [API set: ExcelApi + 1.15](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly displayName: string;' + return: + type: string + - name: fill + uid: excel!Excel.Shape#fill:member + package: excel! + fullName: fill + summary: Returns the fill formatting of this shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-create-and-delete.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Shapes"); + const shape = sheet.shapes.addGeometricShape(Excel.GeometricShapeType.smileyFace); + shape.left = 300; + shape.top = 100; + shape.height = 100; + shape.width = 100; + shape.fill.foregroundColor = "yellow" + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly fill: Excel.ShapeFill;' + return: + type: + - name: geometricShape + uid: excel!Excel.Shape#geometricShape:member + package: excel! + fullName: geometricShape + summary: >- + Returns the geometric shape associated with the shape. An error will be + thrown if the shape type is not "GeometricShape". + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly geometricShape: Excel.GeometricShape;' + return: + type: + - name: geometricShapeType + uid: excel!Excel.Shape#geometricShapeType:member + package: excel! + fullName: geometricShapeType + summary: >- + Specifies the geometric shape type of this geometric shape. See + `Excel.GeometricShapeType` for details. Returns `null` if the shape type + is not "GeometricShape". + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + geometricShapeType: Excel.GeometricShapeType | "LineInverse" | + "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" + | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | + "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | + "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" + | "Star32" | "RoundRectangle" | "Round1Rectangle" | + "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" + | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | + "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" + | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | + "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | + "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | + "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | + "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | + "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | + "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | + "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | + "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | + "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | + "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" + | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | + "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | + "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | + "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | + "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | + "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" + | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | + "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | + "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | + "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" + | "FlowChartDecision" | "FlowChartInputOutput" | + "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | + "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | + "FlowChartPreparation" | "FlowChartManualInput" | + "FlowChartManualOperation" | "FlowChartConnector" | + "FlowChartPunchedCard" | "FlowChartPunchedTape" | + "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | + "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | + "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | + "FlowChartMagneticTape" | "FlowChartMagneticDisk" | + "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | + "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | + "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | + "ActionButtonInformation" | "ActionButtonForwardNext" | + "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" + | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | + "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | + "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | + "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | + "ChartStar" | "ChartPlus"; + return: + type: >- + | "LineInverse" | + "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | + "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | + "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" + | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | + "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" + | "Round2SameRectangle" | "Round2DiagonalRectangle" | + "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | + "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | + "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | + "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | + "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | + "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" + | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | + "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | + "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" + | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | + "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | + "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | + "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | + "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | + "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | + "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | + "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" + | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | + "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | + "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | + "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" + | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | + "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | + "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | + "FlowChartInputOutput" | "FlowChartPredefinedProcess" | + "FlowChartInternalStorage" | "FlowChartDocument" | + "FlowChartMultidocument" | "FlowChartTerminator" | + "FlowChartPreparation" | "FlowChartManualInput" | + "FlowChartManualOperation" | "FlowChartConnector" | + "FlowChartPunchedCard" | "FlowChartPunchedTape" | + "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | + "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | + "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | + "FlowChartMagneticTape" | "FlowChartMagneticDisk" | + "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | + "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | + "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | + "ActionButtonInformation" | "ActionButtonForwardNext" | + "ActionButtonBackPrevious" | "ActionButtonEnd" | + "ActionButtonBeginning" | "ActionButtonReturn" | + "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | + "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | + "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | + "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | + "ChartPlus" + - name: group + uid: excel!Excel.Shape#group:member + package: excel! + fullName: group + summary: >- + Returns the shape group associated with the shape. An error will be thrown + if the shape type is not "GroupShape". + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-groups.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Shapes"); + + const shapeGroup = sheet.shapes.getItem("Group").group; + shapeGroup.ungroup(); + console.log("Shapes ungrouped"); + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly group: Excel.ShapeGroup;' + return: + type: + - name: height + uid: excel!Excel.Shape#height:member + package: excel! + fullName: height + summary: >- + Specifies the height, in points, of the shape. Throws an `InvalidArgument` + exception when set with a negative value or zero as an input. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height: number;' + return: + type: number + - name: id + uid: excel!Excel.Shape#id:member + package: excel! + fullName: id + summary: Specifies the shape identifier. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly id: string;' + return: + type: string + - name: image + uid: excel!Excel.Shape#image:member + package: excel! + fullName: image + summary: >- + Returns the image associated with the shape. An error will be thrown if + the shape type is not "Image". + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly image: Excel.Image;' + return: + type: + - name: left + uid: excel!Excel.Shape#left:member + package: excel! + fullName: left + summary: >- + The distance, in points, from the left side of the shape to the left side + of the worksheet. Throws an `InvalidArgument` exception when set with a + negative value as an input. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left: number;' + return: + type: number + - name: level + uid: excel!Excel.Shape#level:member + package: excel! + fullName: level + summary: >- + Specifies the level of the specified shape. For example, a level of 0 + means that the shape is not part of any groups, a level of 1 means the + shape is part of a top-level group, and a level of 2 means the shape is + part of a sub-group of the top level. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly level: number;' + return: + type: number + - name: line + uid: excel!Excel.Shape#line:member + package: excel! + fullName: line + summary: >- + Returns the line associated with the shape. An error will be thrown if the + shape type is not "Line". + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-lines.yaml + + + await Excel.run(async (context) => { + const shapes = context.workbook.worksheets.getItem("Shapes").shapes; + const line = shapes.getItem("StraightLine").line; + line.beginArrowheadLength = Excel.ArrowheadLength.long; + line.beginArrowheadWidth = Excel.ArrowheadWidth.wide; + line.beginArrowheadStyle = Excel.ArrowheadStyle.oval; + + line.endArrowheadLength = Excel.ArrowheadLength.long; + line.endArrowheadWidth = Excel.ArrowheadWidth.wide; + line.endArrowheadStyle = Excel.ArrowheadStyle.triangle; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly line: Excel.Line;' + return: + type: + - name: lineFormat + uid: excel!Excel.Shape#lineFormat:member + package: excel! + fullName: lineFormat + summary: Returns the line formatting of this shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly lineFormat: Excel.ShapeLineFormat;' + return: + type: + - name: lockAspectRatio + uid: excel!Excel.Shape#lockAspectRatio:member + package: excel! + fullName: lockAspectRatio + summary: Specifies if the aspect ratio of this shape is locked. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-move-and-order.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Shapes"); + const shape = sheet.shapes.getItem("Octagon") + shape.lockAspectRatio = true; + shape.scaleHeight(1.25, Excel.ShapeScaleType.currentSize); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'lockAspectRatio: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Shape#name:member + package: excel! + fullName: name + summary: Specifies the name of the shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name: string;' + return: + type: string + - name: parentGroup + uid: excel!Excel.Shape#parentGroup:member + package: excel! + fullName: parentGroup + summary: Specifies the parent group of this shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly parentGroup: Excel.Shape;' + return: + type: + - name: placement + uid: excel!Excel.Shape#placement:member + package: excel! + fullName: placement + summary: Represents how the object is attached to the cells below it. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'placement: Excel.Placement | "TwoCell" | "OneCell" | "Absolute";' + return: + type: >- + | "TwoCell" | "OneCell" | + "Absolute" + - name: rotation + uid: excel!Excel.Shape#rotation:member + package: excel! + fullName: rotation + summary: Specifies the rotation, in degrees, of the shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-create-and-delete.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Shapes"); + const shape = sheet.shapes.addGeometricShape(Excel.GeometricShapeType.triangle); + shape.left = 100; + shape.top = 300; + shape.height = 150; + shape.width = 200; + shape.rotation = 45; + shape.fill.clear(); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'rotation: number;' + return: + type: number + - name: textFrame + uid: excel!Excel.Shape#textFrame:member + package: excel! + fullName: textFrame + summary: Returns the text frame object of this shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly textFrame: Excel.TextFrame;' + return: + type: + - name: top + uid: excel!Excel.Shape#top:member + package: excel! + fullName: top + summary: >- + The distance, in points, from the top edge of the shape to the top edge of + the worksheet. Throws an `InvalidArgument` exception when set with a + negative value as an input. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top: number;' + return: + type: number + - name: type + uid: excel!Excel.Shape#type:member + package: excel! + fullName: type + summary: Returns the type of this shape. See `Excel.ShapeType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly type: Excel.ShapeType | "Unsupported" | "Image" | + "GeometricShape" | "Group" | "Line"; + return: + type: >- + | "Unsupported" | "Image" | + "GeometricShape" | "Group" | "Line" + - name: visible + uid: excel!Excel.Shape#visible:member + package: excel! + fullName: visible + summary: Specifies if the shape is visible. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible: boolean;' + return: + type: boolean + - name: width + uid: excel!Excel.Shape#width:member + package: excel! + fullName: width + summary: >- + Specifies the width, in points, of the shape. Throws an `InvalidArgument` + exception when set with a negative value or zero as an input. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width: number;' + return: + type: number + - name: zOrderPosition + uid: excel!Excel.Shape#zOrderPosition:member + package: excel! + fullName: zOrderPosition + summary: >- + Returns the position of the specified shape in the z-order, with 0 + representing the bottom of the order stack. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly zOrderPosition: number;' + return: + type: number +methods: + - name: copyTo(destinationSheet) + uid: excel!Excel.Shape#copyTo:member(1) + package: excel! + fullName: copyTo(destinationSheet) + summary: >- + Copies and pastes a `Shape` object. The pasted shape is copied to the same + pixel location as this shape. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'copyTo(destinationSheet?: Worksheet | string): Excel.Shape;' + parameters: + - id: destinationSheet + description: >- + The sheet to which the shape object will be pasted. The default + value is the copied shape's worksheet. + type: | string + return: + type: + description: '' + - name: delete() + uid: excel!Excel.Shape#delete:member(1) + package: excel! + fullName: delete() + summary: Removes the shape from the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-create-and-delete.yaml + + + await Excel.run(async (context) => { + context.workbook.worksheets.getItemOrNullObject("Shapes").delete(); + const sheet = context.workbook.worksheets.add("Shapes"); + + const shapes = sheet.shapes; + + // load all the shapes in the collection without loading their properties + shapes.load("items/$none"); + await context.sync(); + + shapes.items.forEach((shape) => shape.delete()); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'delete(): void;' + return: + type: void + description: '' + - name: getAsImage(format) + uid: excel!Excel.Shape#getAsImage:member(1) + package: excel! + fullName: getAsImage(format) + summary: >- + Converts the shape to an image and returns the image as a Base64-encoded + string. The DPI is 96. The only supported formats are + `Excel.PictureFormat.BMP`, `Excel.PictureFormat.PNG`, + `Excel.PictureFormat.JPEG`, and `Excel.PictureFormat.GIF`. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-images.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Shapes"); + const shape = sheet.shapes.getItem("Image"); + const result = shape.getAsImage(Excel.PictureFormat.png); + await context.sync(); + + const imageString = result.value; + // Your add-in would save this string as a .png file. + console.log("The image's Base64-encoded string: " + imageString); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + getAsImage(format: Excel.PictureFormat): + OfficeExtension.ClientResult; + parameters: + - id: format + description: Specifies the format of the image. + type: + return: + type: <string> + description: '' + - name: getAsImage(format) + uid: excel!Excel.Shape#getAsImage:member(2) + package: excel! + fullName: getAsImage(format) + summary: >- + Converts the shape to an image and returns the image as a Base64-encoded + string. The DPI is 96. The only supported formats are + `Excel.PictureFormat.BMP`, `Excel.PictureFormat.PNG`, + `Excel.PictureFormat.JPEG`, and `Excel.PictureFormat.GIF`. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + getAsImage(format: "UNKNOWN" | "BMP" | "JPEG" | "GIF" | "PNG" | "SVG"): + OfficeExtension.ClientResult; + parameters: + - id: format + description: Specifies the format of the image. + type: '"UNKNOWN" | "BMP" | "JPEG" | "GIF" | "PNG" | "SVG"' + return: + type: <string> + description: '' + - name: incrementLeft(increment) + uid: excel!Excel.Shape#incrementLeft:member(1) + package: excel! + fullName: incrementLeft(increment) + summary: Moves the shape horizontally by the specified number of points. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-move-and-order.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Shapes"); + const shape = sheet.shapes.getItem("Square") + shape.incrementLeft(-25); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'incrementLeft(increment: number): void;' + parameters: + - id: increment + description: >- + The increment, in points, the shape will be horizontally moved. A + positive value moves the shape to the right and a negative value + moves it to the left. If the sheet is right-to-left oriented, this + is reversed: positive values will move the shape to the left and + negative values will move it to the right. + type: number + return: + type: void + description: '' + - name: incrementRotation(increment) + uid: excel!Excel.Shape#incrementRotation:member(1) + package: excel! + fullName: incrementRotation(increment) + summary: >- + Rotates the shape clockwise around the z-axis by the specified number of + degrees. Use the `rotation` property to set the absolute rotation of the + shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-images.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Shapes"); + const shape = sheet.shapes.getItem("Image"); + shape.incrementRotation(180); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'incrementRotation(increment: number): void;' + parameters: + - id: increment + description: >- + How many degrees the shape will be rotated. A positive value rotates + the shape clockwise and a negative value rotates it + counterclockwise. + type: number + return: + type: void + description: '' + - name: incrementTop(increment) + uid: excel!Excel.Shape#incrementTop:member(1) + package: excel! + fullName: incrementTop(increment) + summary: Moves the shape vertically by the specified number of points. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-move-and-order.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Shapes"); + const shape = sheet.shapes.getItem("Pentagon") + shape.incrementTop(25); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'incrementTop(increment: number): void;' + parameters: + - id: increment + description: >- + The increment, in points, the shape will be vertically moved. A + positive value moves the shape down and a negative value moves it + up. + type: number + return: + type: void + description: '' + - name: load(options) + uid: excel!Excel.Shape#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(options?: Excel.Interfaces.ShapeLoadOptions): Excel.Shape;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.Shape#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.Shape;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.Shape#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.Shape; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: scaleHeight(scaleFactor, scaleType, scaleFrom) + uid: excel!Excel.Shape#scaleHeight:member(1) + package: excel! + fullName: scaleHeight(scaleFactor, scaleType, scaleFrom) + summary: >- + Scales the height of the shape by a specified factor. For images, you can + indicate whether you want to scale the shape relative to the original or + the current size. Shapes other than pictures are always scaled relative to + their current height. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-move-and-order.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Shapes"); + const shape = sheet.shapes.getItem("Octagon") + shape.lockAspectRatio = true; + shape.scaleHeight(1.25, Excel.ShapeScaleType.currentSize); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + scaleHeight(scaleFactor: number, scaleType: Excel.ShapeScaleType, + scaleFrom?: Excel.ShapeScaleFrom): void; + parameters: + - id: scaleFactor + description: >- + Specifies the ratio between the height of the shape after you resize + it and the current or original height. + type: number + - id: scaleType + description: >- + Specifies whether the shape is scaled relative to its original or + current size. The original size scaling option only works for + images. + type: + - id: scaleFrom + description: >- + Optional. Specifies which part of the shape retains its position + when the shape is scaled. If omitted, it represents the shape's + upper left corner retains its position. + type: + return: + type: void + description: '' + - name: scaleHeight(scaleFactor, scaleType, scaleFrom) + uid: excel!Excel.Shape#scaleHeight:member(2) + package: excel! + fullName: scaleHeight(scaleFactor, scaleType, scaleFrom) + summary: >- + Scales the height of the shape by a specified factor. For images, you can + indicate whether you want to scale the shape relative to the original or + the current size. Shapes other than pictures are always scaled relative to + their current height. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + scaleHeight(scaleFactor: number, scaleType: "CurrentSize" | + "OriginalSize", scaleFrom?: "ScaleFromTopLeft" | "ScaleFromMiddle" | + "ScaleFromBottomRight"): void; + parameters: + - id: scaleFactor + description: >- + Specifies the ratio between the height of the shape after you resize + it and the current or original height. + type: number + - id: scaleType + description: >- + Specifies whether the shape is scaled relative to its original or + current size. The original size scaling option only works for + images. + type: '"CurrentSize" | "OriginalSize"' + - id: scaleFrom + description: >- + Optional. Specifies which part of the shape retains its position + when the shape is scaled. If omitted, it represents the shape's + upper left corner retains its position. + type: '"ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"' + return: + type: void + description: '' + - name: scaleWidth(scaleFactor, scaleType, scaleFrom) + uid: excel!Excel.Shape#scaleWidth:member(1) + package: excel! + fullName: scaleWidth(scaleFactor, scaleType, scaleFrom) + summary: >- + Scales the width of the shape by a specified factor. For images, you can + indicate whether you want to scale the shape relative to the original or + the current size. Shapes other than pictures are always scaled relative to + their current width. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + scaleWidth(scaleFactor: number, scaleType: Excel.ShapeScaleType, + scaleFrom?: Excel.ShapeScaleFrom): void; + parameters: + - id: scaleFactor + description: >- + Specifies the ratio between the width of the shape after you resize + it and the current or original width. + type: number + - id: scaleType + description: >- + Specifies whether the shape is scaled relative to its original or + current size. The original size scaling option only works for + images. + type: + - id: scaleFrom + description: >- + Optional. Specifies which part of the shape retains its position + when the shape is scaled. If omitted, it represents the shape's + upper left corner retains its position. + type: + return: + type: void + description: '' + - name: scaleWidth(scaleFactor, scaleType, scaleFrom) + uid: excel!Excel.Shape#scaleWidth:member(2) + package: excel! + fullName: scaleWidth(scaleFactor, scaleType, scaleFrom) + summary: >- + Scales the width of the shape by a specified factor. For images, you can + indicate whether you want to scale the shape relative to the original or + the current size. Shapes other than pictures are always scaled relative to + their current width. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + scaleWidth(scaleFactor: number, scaleType: "CurrentSize" | + "OriginalSize", scaleFrom?: "ScaleFromTopLeft" | "ScaleFromMiddle" | + "ScaleFromBottomRight"): void; + parameters: + - id: scaleFactor + description: >- + Specifies the ratio between the width of the shape after you resize + it and the current or original width. + type: number + - id: scaleType + description: >- + Specifies whether the shape is scaled relative to its original or + current size. The original size scaling option only works for + images. + type: '"CurrentSize" | "OriginalSize"' + - id: scaleFrom + description: >- + Optional. Specifies which part of the shape retains its position + when the shape is scaled. If omitted, it represents the shape's + upper left corner retains its position. + type: '"ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"' + return: + type: void + description: '' + - name: set(properties, options) + uid: excel!Excel.Shape#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ShapeUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.Shape#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.Shape): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: setZOrder(position) + uid: excel!Excel.Shape#setZOrder:member(1) + package: excel! + fullName: setZOrder(position) + summary: >- + Moves the specified shape up or down the collection's z-order, which + shifts it in front of or behind other shapes. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-move-and-order.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Shapes"); + const shape = sheet.shapes.getItem("Octagon") + shape.setZOrder(Excel.ShapeZOrder.sendBackward); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'setZOrder(position: Excel.ShapeZOrder): void;' + parameters: + - id: position + description: >- + Where to move the shape in the z-order stack relative to the other + shapes. See `Excel.ShapeZOrder` for details. + type: + return: + type: void + description: '' + - name: setZOrder(position) + uid: excel!Excel.Shape#setZOrder:member(2) + package: excel! + fullName: setZOrder(position) + summary: >- + Moves the specified shape up or down the collection's z-order, which + shifts it in front of or behind other shapes. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + setZOrder(position: "BringToFront" | "BringForward" | "SendToBack" | + "SendBackward"): void; + parameters: + - id: position + description: >- + Where to move the shape in the z-order stack relative to the other + shapes. See `Excel.ShapeZOrder` for details. + type: '"BringToFront" | "BringForward" | "SendToBack" | "SendBackward"' + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.Shape#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.Shape` object is + an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Excel.Interfaces.ShapeData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ShapeData;' + return: + type: + description: '' +events: + - name: onActivated + uid: excel!Excel.Shape#onActivated:member + package: excel! + fullName: onActivated + summary: Occurs when the shape is activated. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onActivated: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onDeactivated + uid: excel!Excel.Shape#onDeactivated:member + package: excel! + fullName: onDeactivated + summary: Occurs when the shape is deactivated. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onDeactivated: + OfficeExtension.EventHandlers; + return: + type: >- + <> +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.shapeactivatedeventargs.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapeactivatedeventargs.yml new file mode 100644 index 0000000000..c5d6f704f6 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapeactivatedeventargs.yml @@ -0,0 +1,59 @@ +### YamlMime:TSType +name: Excel.ShapeActivatedEventArgs +uid: excel!Excel.ShapeActivatedEventArgs:interface +package: excel! +fullName: Excel.ShapeActivatedEventArgs +summary: Provides information about the shape that raised the activated event. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: shapeId + uid: excel!Excel.ShapeActivatedEventArgs#shapeId:member + package: excel! + fullName: shapeId + summary: Gets the ID of the activated shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'shapeId: string;' + return: + type: string + - name: type + uid: excel!Excel.ShapeActivatedEventArgs#type:member + package: excel! + fullName: type + summary: Gets the type of the event. See `Excel.EventType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: "ShapeActivated";' + return: + type: '"ShapeActivated"' + - name: worksheetId + uid: excel!Excel.ShapeActivatedEventArgs#worksheetId:member + package: excel! + fullName: worksheetId + summary: Gets the ID of the worksheet in which the shape is activated. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheetId: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.shapeautosize.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapeautosize.yml new file mode 100644 index 0000000000..8840e5ad0a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapeautosize.yml @@ -0,0 +1,72 @@ +### YamlMime:TSEnum +name: Excel.ShapeAutoSize +uid: excel!Excel.ShapeAutoSize:enum +package: excel! +fullName: Excel.ShapeAutoSize +summary: Determines the type of automatic sizing allowed. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-textboxes.yaml + + + await Excel.run(async (context) => { + const shapes = context.workbook.worksheets.getItem("Shapes").shapes; + const textbox = shapes.getItem("Textbox"); + textbox.textFrame.autoSizeSetting = Excel.ShapeAutoSize.autoSizeShapeToFitText; + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: autoSizeMixed + uid: excel!Excel.ShapeAutoSize.autoSizeMixed:member + package: excel! + summary: >- + A combination of automatic sizing schemes are used. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"AutoSizeMixed"' + - name: autoSizeNone + uid: excel!Excel.ShapeAutoSize.autoSizeNone:member + package: excel! + summary: >- + No autosizing. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"AutoSizeNone"' + - name: autoSizeShapeToFitText + uid: excel!Excel.ShapeAutoSize.autoSizeShapeToFitText:member + package: excel! + summary: >- + The shape is adjusted to fit the text. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"AutoSizeShapeToFitText"' + - name: autoSizeTextToFitShape + uid: excel!Excel.ShapeAutoSize.autoSizeTextToFitShape:member + package: excel! + summary: >- + The text is adjusted to fit the shape. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"AutoSizeTextToFitShape"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.shapecollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapecollection.yml new file mode 100644 index 0000000000..db4ed08d19 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapecollection.yml @@ -0,0 +1,658 @@ +### YamlMime:TSType +name: Excel.ShapeCollection +uid: excel!Excel.ShapeCollection:class +package: excel! +fullName: Excel.ShapeCollection +summary: Represents a collection of all the shapes in the worksheet. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.ShapeCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: excel!Excel.ShapeCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.Shape[];' + return: + type: [] +methods: + - name: addGeometricShape(geometricShapeType) + uid: excel!Excel.ShapeCollection#addGeometricShape:member(1) + package: excel! + fullName: addGeometricShape(geometricShapeType) + summary: >- + Adds a geometric shape to the worksheet. Returns a `Shape` object that + represents the new shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-create-and-delete.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Shapes"); + const shape = sheet.shapes.addGeometricShape(Excel.GeometricShapeType.hexagon); + shape.left = 5; + shape.top = 5; + shape.height = 175; + shape.width = 200; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + addGeometricShape(geometricShapeType: Excel.GeometricShapeType): + Excel.Shape; + parameters: + - id: geometricShapeType + description: >- + Represents the type of the geometric shape. See + `Excel.GeometricShapeType` for details. + type: + return: + type: + description: '' + - name: addGeometricShape(geometricShapeType) + uid: excel!Excel.ShapeCollection#addGeometricShape:member(2) + package: excel! + fullName: addGeometricShape(geometricShapeType) + summary: >- + Adds a geometric shape to the worksheet. Returns a `Shape` object that + represents the new shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + addGeometricShape(geometricShapeType: "LineInverse" | "Triangle" | + "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | + "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | + "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | + "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" + | "Star32" | "RoundRectangle" | "Round1Rectangle" | + "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" + | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | + "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" + | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | + "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | + "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | + "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | + "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | + "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | + "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | + "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | + "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | + "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | + "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" + | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | + "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | + "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | + "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | + "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | + "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" + | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | + "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | + "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | + "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" + | "FlowChartDecision" | "FlowChartInputOutput" | + "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | + "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | + "FlowChartPreparation" | "FlowChartManualInput" | + "FlowChartManualOperation" | "FlowChartConnector" | + "FlowChartPunchedCard" | "FlowChartPunchedTape" | + "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | + "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | + "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | + "FlowChartMagneticTape" | "FlowChartMagneticDisk" | + "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | + "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | + "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | + "ActionButtonInformation" | "ActionButtonForwardNext" | + "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" + | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | + "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | + "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | + "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | + "ChartStar" | "ChartPlus"): Excel.Shape; + parameters: + - id: geometricShapeType + description: >- + Represents the type of the geometric shape. See + `Excel.GeometricShapeType` for details. + type: >- + "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | + "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" + | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | + "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | + "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | + "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | + "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" + | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | + "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | + "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | + "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | + "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | + "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | + "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | + "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" + | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" + | "LeftCircularArrow" | "LeftRightCircularArrow" | + "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | + "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" + | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | + "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" + | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | + "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | + "BracePair" | "Callout1" | "Callout2" | "Callout3" | + "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | + "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | + "AccentBorderCallout1" | "AccentBorderCallout2" | + "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | + "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | + "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | + "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | + "Plus" | "FlowChartProcess" | "FlowChartDecision" | + "FlowChartInputOutput" | "FlowChartPredefinedProcess" | + "FlowChartInternalStorage" | "FlowChartDocument" | + "FlowChartMultidocument" | "FlowChartTerminator" | + "FlowChartPreparation" | "FlowChartManualInput" | + "FlowChartManualOperation" | "FlowChartConnector" | + "FlowChartPunchedCard" | "FlowChartPunchedTape" | + "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | + "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | + "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | + "FlowChartMagneticTape" | "FlowChartMagneticDisk" | + "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | + "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | + "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | + "ActionButtonInformation" | "ActionButtonForwardNext" | + "ActionButtonBackPrevious" | "ActionButtonEnd" | + "ActionButtonBeginning" | "ActionButtonReturn" | + "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | + "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | + "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | + "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" + | "ChartPlus" + return: + type: + description: '' + - name: addGroup(values) + uid: excel!Excel.ShapeCollection#addGroup:member(1) + package: excel! + fullName: addGroup(values) + summary: >- + Groups a subset of shapes in this collection's worksheet. Returns a + `Shape` object that represents the new group of shapes. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-groups.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Shapes"); + const square = sheet.shapes.getItem("Square"); + const pentagon = sheet.shapes.getItem("Pentagon"); + const octagon = sheet.shapes.getItem("Octagon"); + + const shapeGroup = sheet.shapes.addGroup([square, pentagon, octagon]); + shapeGroup.name = "Group"; + console.log("Shapes grouped"); + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'addGroup(values: Array): Excel.Shape;' + parameters: + - id: values + description: An array of shape IDs or shape objects. + type: Array<string | > + return: + type: + description: '' + - name: addImage(base64ImageString) + uid: excel!Excel.ShapeCollection#addImage:member(1) + package: excel! + fullName: addImage(base64ImageString) + summary: >- + Creates an image from a Base64-encoded string and adds it to the + worksheet. Returns the `Shape` object that represents the new image. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-images.yaml + + + const myFile = document.getElementById("selectedFile") as + HTMLInputElement; + + const reader = new FileReader(); + + + reader.onload = (event) => { + Excel.run((context) => { + const startIndex = reader.result.toString().indexOf("base64,"); + const myBase64 = reader.result.toString().substr(startIndex + 7); + const sheet = context.workbook.worksheets.getItem("Shapes"); + const image = sheet.shapes.addImage(myBase64); + image.name = "Image"; + return context.sync(); + }); + }; + + + // Read in the image file as a data URL. + + reader.readAsDataURL(myFile.files[0]); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'addImage(base64ImageString: string): Excel.Shape;' + parameters: + - id: base64ImageString + description: >- + A Base64-encoded string representing an image in either JPEG or PNG + format. + type: string + return: + type: + description: '' + - name: addLine(startLeft, startTop, endLeft, endTop, connectorType) + uid: excel!Excel.ShapeCollection#addLine:member(1) + package: excel! + fullName: addLine(startLeft, startTop, endLeft, endTop, connectorType) + summary: >- + Adds a line to worksheet. Returns a `Shape` object that represents the new + line. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-lines.yaml + + + await Excel.run(async (context) => { + const shapes = context.workbook.worksheets.getItem("Shapes").shapes; + const line = shapes.addLine(200, 50, 300, 150, Excel.ConnectorType.straight); + line.name = "StraightLine"; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + addLine(startLeft: number, startTop: number, endLeft: number, endTop: + number, connectorType?: Excel.ConnectorType): Excel.Shape; + parameters: + - id: startLeft + description: >- + The distance, in points, from the start of the line to the left side + of the worksheet. + type: number + - id: startTop + description: >- + The distance, in points, from the start of the line to the top of + the worksheet. + type: number + - id: endLeft + description: >- + The distance, in points, from the end of the line to the left of the + worksheet. + type: number + - id: endTop + description: >- + The distance, in points, from the end of the line to the top of the + worksheet. + type: number + - id: connectorType + description: >- + Represents the connector type. See `Excel.ConnectorType` for + details. + type: + return: + type: + description: '' + - name: addLine(startLeft, startTop, endLeft, endTop, connectorType) + uid: excel!Excel.ShapeCollection#addLine:member(2) + package: excel! + fullName: addLine(startLeft, startTop, endLeft, endTop, connectorType) + summary: >- + Adds a line to worksheet. Returns a `Shape` object that represents the new + line. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + addLine(startLeft: number, startTop: number, endLeft: number, endTop: + number, connectorType?: "Straight" | "Elbow" | "Curve"): Excel.Shape; + parameters: + - id: startLeft + description: >- + The distance, in points, from the start of the line to the left side + of the worksheet. + type: number + - id: startTop + description: >- + The distance, in points, from the start of the line to the top of + the worksheet. + type: number + - id: endLeft + description: >- + The distance, in points, from the end of the line to the left of the + worksheet. + type: number + - id: endTop + description: >- + The distance, in points, from the end of the line to the top of the + worksheet. + type: number + - id: connectorType + description: >- + Represents the connector type. See `Excel.ConnectorType` for + details. + type: '"Straight" | "Elbow" | "Curve"' + return: + type: + description: '' + - name: addTextBox(text) + uid: excel!Excel.ShapeCollection#addTextBox:member(1) + package: excel! + fullName: addTextBox(text) + summary: >- + Adds a text box to the worksheet with the provided text as the content. + Returns a `Shape` object that represents the new text box. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-textboxes.yaml + + + await Excel.run(async (context) => { + const shapes = context.workbook.worksheets.getItem("Shapes").shapes; + const textbox = shapes.addTextBox("A box with text"); + textbox.left = 100; + textbox.top = 100; + textbox.height = 20; + textbox.width = 175; + textbox.name = "Textbox"; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'addTextBox(text?: string): Excel.Shape;' + parameters: + - id: text + description: Represents the text that will be shown in the created text box. + type: string + return: + type: + description: '' + - name: getCount() + uid: excel!Excel.ShapeCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Returns the number of shapes in the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getItem(key) + uid: excel!Excel.ShapeCollection#getItem:member(1) + package: excel! + fullName: getItem(key) + summary: Gets a shape using its name or ID. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItem(key: string): Excel.Shape;' + parameters: + - id: key + description: The name or ID of the shape to be retrieved. + type: string + return: + type: + description: '' + - name: getItemAt(index) + uid: excel!Excel.ShapeCollection#getItemAt:member(1) + package: excel! + fullName: getItemAt(index) + summary: Gets a shape using its position in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemAt(index: number): Excel.Shape;' + parameters: + - id: index + description: The zero-based index of the shape to be retrieved. + type: number + return: + type: + description: '' + - name: getItemOrNullObject(key) + uid: excel!Excel.ShapeCollection#getItemOrNullObject:member(1) + package: excel! + fullName: getItemOrNullObject(key) + summary: >- + Gets a shape using its name or ID. If the shape object does not exist, + then this method returns an object with its `isNullObject` property set to + `true`. For further information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemOrNullObject(key: string): Excel.Shape;' + parameters: + - id: key + description: The name or ID of the shape to be retrieved. + type: string + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.ShapeCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ShapeCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): Excel.ShapeCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ShapeCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ShapeCollection;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ShapeCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.ShapeCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.ShapeCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.ShapeCollection` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.ShapeCollectionData`) that + contains an "items" array with shallow copies of any loaded properties + from the collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ShapeCollectionData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.shapedeactivatedeventargs.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapedeactivatedeventargs.yml new file mode 100644 index 0000000000..108e83eafc --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapedeactivatedeventargs.yml @@ -0,0 +1,59 @@ +### YamlMime:TSType +name: Excel.ShapeDeactivatedEventArgs +uid: excel!Excel.ShapeDeactivatedEventArgs:interface +package: excel! +fullName: Excel.ShapeDeactivatedEventArgs +summary: Provides information about the shape that raised the deactivated event. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: shapeId + uid: excel!Excel.ShapeDeactivatedEventArgs#shapeId:member + package: excel! + fullName: shapeId + summary: Gets the ID of the shape deactivated shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'shapeId: string;' + return: + type: string + - name: type + uid: excel!Excel.ShapeDeactivatedEventArgs#type:member + package: excel! + fullName: type + summary: Gets the type of the event. See `Excel.EventType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: "ShapeDeactivated";' + return: + type: '"ShapeDeactivated"' + - name: worksheetId + uid: excel!Excel.ShapeDeactivatedEventArgs#worksheetId:member + package: excel! + fullName: worksheetId + summary: Gets the ID of the worksheet in which the shape is deactivated. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheetId: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.shapefill.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapefill.yml new file mode 100644 index 0000000000..4502679e9b --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapefill.yml @@ -0,0 +1,273 @@ +### YamlMime:TSType +name: Excel.ShapeFill +uid: excel!Excel.ShapeFill:class +package: excel! +fullName: Excel.ShapeFill +summary: Represents the fill formatting of a shape object. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.ShapeFill#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: foregroundColor + uid: excel!Excel.ShapeFill#foregroundColor:member + package: excel! + fullName: foregroundColor + summary: >- + Represents the shape fill foreground color in HTML color format, in the + form \#RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange") + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'foregroundColor: string;' + return: + type: string + - name: transparency + uid: excel!Excel.ShapeFill#transparency:member + package: excel! + fullName: transparency + summary: >- + Specifies the transparency percentage of the fill as a value from 0.0 + (opaque) through 1.0 (clear). Returns `null` if the shape type does not + support transparency or the shape fill has inconsistent transparency, such + as with a gradient fill type. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'transparency: number;' + return: + type: number + - name: type + uid: excel!Excel.ShapeFill#type:member + package: excel! + fullName: type + summary: Returns the fill type of the shape. See `Excel.ShapeFillType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly type: Excel.ShapeFillType | "NoFill" | "Solid" | "Gradient" | + "Pattern" | "PictureAndTexture" | "Mixed"; + return: + type: >- + | "NoFill" | "Solid" | + "Gradient" | "Pattern" | "PictureAndTexture" | "Mixed" +methods: + - name: clear() + uid: excel!Excel.ShapeFill#clear:member(1) + package: excel! + fullName: clear() + summary: Clears the fill formatting of this shape. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'clear(): void;' + return: + type: void + description: '' + - name: load(options) + uid: excel!Excel.ShapeFill#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(options?: Excel.Interfaces.ShapeFillLoadOptions): Excel.ShapeFill;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ShapeFill#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ShapeFill;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ShapeFill#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ShapeFill; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ShapeFill#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ShapeFillUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ShapeFill#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ShapeFill): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: setSolidColor(color) + uid: excel!Excel.ShapeFill#setSolidColor:member(1) + package: excel! + fullName: setSolidColor(color) + summary: >- + Sets the fill formatting of the shape to a uniform color. This changes the + fill type to "Solid". + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'setSolidColor(color: string): void;' + parameters: + - id: color + description: >- + A string that represents the fill color in HTML color format, in the + form \#RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., + "orange"). + type: string + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ShapeFill#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.ShapeFill` object + is an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Excel.Interfaces.ShapeFillData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ShapeFillData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.shapefilltype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapefilltype.yml new file mode 100644 index 0000000000..413befe700 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapefilltype.yml @@ -0,0 +1,73 @@ +### YamlMime:TSEnum +name: Excel.ShapeFillType +uid: excel!Excel.ShapeFillType:enum +package: excel! +fullName: Excel.ShapeFillType +summary: Specifies a shape's fill type. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: gradient + uid: excel!Excel.ShapeFillType.gradient:member + package: excel! + summary: >- + Gradient fill. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Gradient"' + - name: mixed + uid: excel!Excel.ShapeFillType.mixed:member + package: excel! + summary: >- + Mixed fill. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Mixed"' + - name: noFill + uid: excel!Excel.ShapeFillType.noFill:member + package: excel! + summary: >- + No fill. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"NoFill"' + - name: pattern + uid: excel!Excel.ShapeFillType.pattern:member + package: excel! + summary: >- + Pattern fill. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Pattern"' + - name: pictureAndTexture + uid: excel!Excel.ShapeFillType.pictureAndTexture:member + package: excel! + summary: >- + Picture and texture fill. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"PictureAndTexture"' + - name: solid + uid: excel!Excel.ShapeFillType.solid:member + package: excel! + summary: >- + Solid fill. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Solid"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.shapefont.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapefont.yml new file mode 100644 index 0000000000..146087a7fc --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapefont.yml @@ -0,0 +1,293 @@ +### YamlMime:TSType +name: Excel.ShapeFont +uid: excel!Excel.ShapeFont:class +package: excel! +fullName: Excel.ShapeFont +summary: >- + Represents the font attributes, such as font name, font size, and color, for a + shape's `TextRange` object. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: bold + uid: excel!Excel.ShapeFont#bold:member + package: excel! + fullName: bold + summary: >- + Represents the bold status of font. Returns `null` if the `TextRange` + includes both bold and non-bold text fragments. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'bold: boolean;' + return: + type: boolean + - name: color + uid: excel!Excel.ShapeFont#color:member + package: excel! + fullName: color + summary: >- + HTML color code representation of the text color (e.g., "\#FF0000" + represents red). Returns `null` if the `TextRange` includes text fragments + with different colors. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color: string;' + return: + type: string + - name: context + uid: excel!Excel.ShapeFont#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: italic + uid: excel!Excel.ShapeFont#italic:member + package: excel! + fullName: italic + summary: >- + Represents the italic status of font. Returns `null` if the `TextRange` + includes both italic and non-italic text fragments. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'italic: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.ShapeFont#name:member + package: excel! + fullName: name + summary: >- + Represents font name (e.g., "Calibri"). If the text is a Complex Script or + East Asian language, this is the corresponding font name; otherwise it is + the Latin font name. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name: string;' + return: + type: string + - name: size + uid: excel!Excel.ShapeFont#size:member + package: excel! + fullName: size + summary: >- + Represents font size in points (e.g., 11). Returns `null` if the + `TextRange` includes text fragments with different font sizes. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'size: number;' + return: + type: number + - name: underline + uid: excel!Excel.ShapeFont#underline:member + package: excel! + fullName: underline + summary: >- + Type of underline applied to the font. Returns `null` if the `TextRange` + includes text fragments with different underline styles. See + `Excel.ShapeFontUnderlineStyle` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + underline: Excel.ShapeFontUnderlineStyle | "None" | "Single" | "Double" + | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" + | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | + "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble"; + return: + type: >- + | "None" | + "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | + "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | + "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | + "WavyHeavy" | "WavyDouble" +methods: + - name: load(options) + uid: excel!Excel.ShapeFont#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(options?: Excel.Interfaces.ShapeFontLoadOptions): Excel.ShapeFont;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ShapeFont#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ShapeFont;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ShapeFont#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ShapeFont; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ShapeFont#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ShapeFontUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ShapeFont#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ShapeFont): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ShapeFont#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.ShapeFont` object + is an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Excel.Interfaces.ShapeFontData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ShapeFontData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.shapefontunderlinestyle.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapefontunderlinestyle.yml new file mode 100644 index 0000000000..0b53aca634 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapefontunderlinestyle.yml @@ -0,0 +1,132 @@ +### YamlMime:TSEnum +name: Excel.ShapeFontUnderlineStyle +uid: excel!Excel.ShapeFontUnderlineStyle:enum +package: excel! +fullName: Excel.ShapeFontUnderlineStyle +summary: The type of underline applied to a font. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: dash + uid: excel!Excel.ShapeFontUnderlineStyle.dash:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Dash"' + - name: dashHeavy + uid: excel!Excel.ShapeFontUnderlineStyle.dashHeavy:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"DashHeavy"' + - name: dashLong + uid: excel!Excel.ShapeFontUnderlineStyle.dashLong:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"DashLong"' + - name: dashLongHeavy + uid: excel!Excel.ShapeFontUnderlineStyle.dashLongHeavy:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"DashLongHeavy"' + - name: dotDash + uid: excel!Excel.ShapeFontUnderlineStyle.dotDash:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"DotDash"' + - name: dotDashHeavy + uid: excel!Excel.ShapeFontUnderlineStyle.dotDashHeavy:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"DotDashHeavy"' + - name: dotDotDash + uid: excel!Excel.ShapeFontUnderlineStyle.dotDotDash:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"DotDotDash"' + - name: dotDotDashHeavy + uid: excel!Excel.ShapeFontUnderlineStyle.dotDotDashHeavy:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"DotDotDashHeavy"' + - name: dotted + uid: excel!Excel.ShapeFontUnderlineStyle.dotted:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Dotted"' + - name: dottedHeavy + uid: excel!Excel.ShapeFontUnderlineStyle.dottedHeavy:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"DottedHeavy"' + - name: double + uid: excel!Excel.ShapeFontUnderlineStyle.double:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Double"' + - name: heavy + uid: excel!Excel.ShapeFontUnderlineStyle.heavy:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Heavy"' + - name: none + uid: excel!Excel.ShapeFontUnderlineStyle.none:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"None"' + - name: single + uid: excel!Excel.ShapeFontUnderlineStyle.single:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Single"' + - name: wavy + uid: excel!Excel.ShapeFontUnderlineStyle.wavy:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Wavy"' + - name: wavyDouble + uid: excel!Excel.ShapeFontUnderlineStyle.wavyDouble:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"WavyDouble"' + - name: wavyHeavy + uid: excel!Excel.ShapeFontUnderlineStyle.wavyHeavy:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"WavyHeavy"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.shapegroup.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapegroup.yml new file mode 100644 index 0000000000..4075b0433c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapegroup.yml @@ -0,0 +1,215 @@ +### YamlMime:TSType +name: Excel.ShapeGroup +uid: excel!Excel.ShapeGroup:class +package: excel! +fullName: Excel.ShapeGroup +summary: >- + Represents a shape group inside a worksheet. To get the corresponding `Shape` + object, use `ShapeGroup.shape`. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.ShapeGroup#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: id + uid: excel!Excel.ShapeGroup#id:member + package: excel! + fullName: id + summary: Specifies the shape identifier. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly id: string;' + return: + type: string + - name: shape + uid: excel!Excel.ShapeGroup#shape:member + package: excel! + fullName: shape + summary: Returns the `Shape` object associated with the group. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly shape: Excel.Shape;' + return: + type: + - name: shapes + uid: excel!Excel.ShapeGroup#shapes:member + package: excel! + fullName: shapes + summary: Returns the collection of `Shape` objects. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly shapes: Excel.GroupShapeCollection;' + return: + type: +methods: + - name: load(options) + uid: excel!Excel.ShapeGroup#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ShapeGroupLoadOptions): + Excel.ShapeGroup; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ShapeGroup#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ShapeGroup;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ShapeGroup#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ShapeGroup; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.ShapeGroup#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.ShapeGroup` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.ShapeGroupData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ShapeGroupData;' + return: + type: + description: '' + - name: ungroup() + uid: excel!Excel.ShapeGroup#ungroup:member(1) + package: excel! + fullName: ungroup() + summary: Ungroups any grouped shapes in the specified shape group. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-groups.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Shapes"); + + const shapeGroup = sheet.shapes.getItem("Group").group; + shapeGroup.ungroup(); + console.log("Shapes ungrouped"); + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'ungroup(): void;' + return: + type: void + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.shapelinedashstyle.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapelinedashstyle.yml new file mode 100644 index 0000000000..3699e70b59 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapelinedashstyle.yml @@ -0,0 +1,97 @@ +### YamlMime:TSEnum +name: Excel.ShapeLineDashStyle +uid: excel!Excel.ShapeLineDashStyle:enum +package: excel! +fullName: Excel.ShapeLineDashStyle +summary: The dash style for a line. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: dash + uid: excel!Excel.ShapeLineDashStyle.dash:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Dash"' + - name: dashDot + uid: excel!Excel.ShapeLineDashStyle.dashDot:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"DashDot"' + - name: dashDotDot + uid: excel!Excel.ShapeLineDashStyle.dashDotDot:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"DashDotDot"' + - name: longDash + uid: excel!Excel.ShapeLineDashStyle.longDash:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LongDash"' + - name: longDashDot + uid: excel!Excel.ShapeLineDashStyle.longDashDot:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LongDashDot"' + - name: longDashDotDot + uid: excel!Excel.ShapeLineDashStyle.longDashDotDot:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LongDashDotDot"' + - name: roundDot + uid: excel!Excel.ShapeLineDashStyle.roundDot:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"RoundDot"' + - name: solid + uid: excel!Excel.ShapeLineDashStyle.solid:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Solid"' + - name: squareDot + uid: excel!Excel.ShapeLineDashStyle.squareDot:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"SquareDot"' + - name: systemDash + uid: excel!Excel.ShapeLineDashStyle.systemDash:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"SystemDash"' + - name: systemDashDot + uid: excel!Excel.ShapeLineDashStyle.systemDashDot:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"SystemDashDot"' + - name: systemDot + uid: excel!Excel.ShapeLineDashStyle.systemDot:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"SystemDot"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.shapelineformat.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapelineformat.yml new file mode 100644 index 0000000000..54b34b7f80 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapelineformat.yml @@ -0,0 +1,302 @@ +### YamlMime:TSType +name: Excel.ShapeLineFormat +uid: excel!Excel.ShapeLineFormat:class +package: excel! +fullName: Excel.ShapeLineFormat +summary: >- + Represents the line formatting for the shape object. For images and geometric + shapes, line formatting represents the border of the shape. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: color + uid: excel!Excel.ShapeLineFormat#color:member + package: excel! + fullName: color + summary: >- + Represents the line color in HTML color format, in the form \#RRGGBB + (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color: string;' + return: + type: string + - name: context + uid: excel!Excel.ShapeLineFormat#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: dashStyle + uid: excel!Excel.ShapeLineFormat#dashStyle:member + package: excel! + fullName: dashStyle + summary: >- + Represents the line style of the shape. Returns `null` when the line is + not visible or there are inconsistent dash styles. See + `Excel.ShapeLineDashStyle` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + dashStyle: Excel.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" + | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | + "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot"; + return: + type: >- + | "Dash" | + "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | + "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" + | "SystemDashDot" + - name: style + uid: excel!Excel.ShapeLineFormat#style:member + package: excel! + fullName: style + summary: >- + Represents the line style of the shape. Returns `null` when the line is + not visible or there are inconsistent styles. See `Excel.ShapeLineStyle` + for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + style: Excel.ShapeLineStyle | "Single" | "ThickBetweenThin" | + "ThickThin" | "ThinThick" | "ThinThin"; + return: + type: >- + | "Single" | + "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin" + - name: transparency + uid: excel!Excel.ShapeLineFormat#transparency:member + package: excel! + fullName: transparency + summary: >- + Represents the degree of transparency of the specified line as a value + from 0.0 (opaque) through 1.0 (clear). Returns `null` when the shape has + inconsistent transparencies. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'transparency: number;' + return: + type: number + - name: visible + uid: excel!Excel.ShapeLineFormat#visible:member + package: excel! + fullName: visible + summary: >- + Specifies if the line formatting of a shape element is visible. Returns + `null` when the shape has inconsistent visibilities. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visible: boolean;' + return: + type: boolean + - name: weight + uid: excel!Excel.ShapeLineFormat#weight:member + package: excel! + fullName: weight + summary: >- + Represents the weight of the line, in points. Returns `null` when the line + is not visible or there are inconsistent line weights. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'weight: number;' + return: + type: number +methods: + - name: load(options) + uid: excel!Excel.ShapeLineFormat#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.ShapeLineFormatLoadOptions): + Excel.ShapeLineFormat; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.ShapeLineFormat#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.ShapeLineFormat;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.ShapeLineFormat#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ShapeLineFormat; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.ShapeLineFormat#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ShapeLineFormatUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.ShapeLineFormat#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.ShapeLineFormat): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.ShapeLineFormat#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.ShapeLineFormat` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.ShapeLineFormatData`) that + contains shallow copies of any loaded child properties from the original + object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.ShapeLineFormatData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.shapelinestyle.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapelinestyle.yml new file mode 100644 index 0000000000..0e964245d5 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapelinestyle.yml @@ -0,0 +1,67 @@ +### YamlMime:TSEnum +name: Excel.ShapeLineStyle +uid: excel!Excel.ShapeLineStyle:enum +package: excel! +fullName: Excel.ShapeLineStyle +summary: The style for a line. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: single + uid: excel!Excel.ShapeLineStyle.single:member + package: excel! + summary: >- + Single line. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Single"' + - name: thickBetweenThin + uid: excel!Excel.ShapeLineStyle.thickBetweenThin:member + package: excel! + summary: >- + Thick line with a thin line on each side. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ThickBetweenThin"' + - name: thickThin + uid: excel!Excel.ShapeLineStyle.thickThin:member + package: excel! + summary: >- + Thick line next to thin line. For horizontal lines, the thick line is + above the thin line. For vertical lines, the thick line is to the left of + the thin line. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ThickThin"' + - name: thinThick + uid: excel!Excel.ShapeLineStyle.thinThick:member + package: excel! + summary: >- + Thick line next to thin line. For horizontal lines, the thick line is + below the thin line. For vertical lines, the thick line is to the right of + the thin line. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ThinThick"' + - name: thinThin + uid: excel!Excel.ShapeLineStyle.thinThin:member + package: excel! + summary: >- + Two thin lines. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ThinThin"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.shapescalefrom.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapescalefrom.yml new file mode 100644 index 0000000000..4d818fa941 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapescalefrom.yml @@ -0,0 +1,36 @@ +### YamlMime:TSEnum +name: Excel.ShapeScaleFrom +uid: excel!Excel.ShapeScaleFrom:enum +package: excel! +fullName: Excel.ShapeScaleFrom +summary: >- + Specifies which part of the shape retains its position when the shape is + scaled. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: scaleFromBottomRight + uid: excel!Excel.ShapeScaleFrom.scaleFromBottomRight:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ScaleFromBottomRight"' + - name: scaleFromMiddle + uid: excel!Excel.ShapeScaleFrom.scaleFromMiddle:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ScaleFromMiddle"' + - name: scaleFromTopLeft + uid: excel!Excel.ShapeScaleFrom.scaleFromTopLeft:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ScaleFromTopLeft"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.shapescaletype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapescaletype.yml new file mode 100644 index 0000000000..95cea352ae --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapescaletype.yml @@ -0,0 +1,49 @@ +### YamlMime:TSEnum +name: Excel.ShapeScaleType +uid: excel!Excel.ShapeScaleType:enum +package: excel! +fullName: Excel.ShapeScaleType +summary: >- + Specifies whether the shape is scaled relative to its original or current + size. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-move-and-order.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Shapes"); + const shape = sheet.shapes.getItem("Octagon") + shape.lockAspectRatio = true; + shape.scaleHeight(1.25, Excel.ShapeScaleType.currentSize); + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: currentSize + uid: excel!Excel.ShapeScaleType.currentSize:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"CurrentSize"' + - name: originalSize + uid: excel!Excel.ShapeScaleType.originalSize:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"OriginalSize"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.shapetexthorizontalalignment.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapetexthorizontalalignment.yml new file mode 100644 index 0000000000..9ce108d0ad --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapetexthorizontalalignment.yml @@ -0,0 +1,81 @@ +### YamlMime:TSEnum +name: Excel.ShapeTextHorizontalAlignment +uid: excel!Excel.ShapeTextHorizontalAlignment:enum +package: excel! +fullName: Excel.ShapeTextHorizontalAlignment +summary: Specifies the horizontal alignment for the text frame in a shape. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-textboxes.yaml + + + await Excel.run(async (context) => { + const shapes = context.workbook.worksheets.getItem("Shapes").shapes; + const textbox = shapes.getItem("Textbox"); + textbox.textFrame.horizontalAlignment = Excel.ShapeTextHorizontalAlignment.center; + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: center + uid: excel!Excel.ShapeTextHorizontalAlignment.center:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Center"' + - name: distributed + uid: excel!Excel.ShapeTextHorizontalAlignment.distributed:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Distributed"' + - name: justify + uid: excel!Excel.ShapeTextHorizontalAlignment.justify:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Justify"' + - name: justifyLow + uid: excel!Excel.ShapeTextHorizontalAlignment.justifyLow:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"JustifyLow"' + - name: left + uid: excel!Excel.ShapeTextHorizontalAlignment.left:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Left"' + - name: right + uid: excel!Excel.ShapeTextHorizontalAlignment.right:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Right"' + - name: thaiDistributed + uid: excel!Excel.ShapeTextHorizontalAlignment.thaiDistributed:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ThaiDistributed"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.shapetexthorizontaloverflow.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapetexthorizontaloverflow.yml new file mode 100644 index 0000000000..124ce9dfea --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapetexthorizontaloverflow.yml @@ -0,0 +1,27 @@ +### YamlMime:TSEnum +name: Excel.ShapeTextHorizontalOverflow +uid: excel!Excel.ShapeTextHorizontalOverflow:enum +package: excel! +fullName: Excel.ShapeTextHorizontalOverflow +summary: Specifies the horizontal overflow for the text frame in a shape. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: clip + uid: excel!Excel.ShapeTextHorizontalOverflow.clip:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Clip"' + - name: overflow + uid: excel!Excel.ShapeTextHorizontalOverflow.overflow:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Overflow"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.shapetextorientation.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapetextorientation.yml new file mode 100644 index 0000000000..10eb51260e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapetextorientation.yml @@ -0,0 +1,62 @@ +### YamlMime:TSEnum +name: Excel.ShapeTextOrientation +uid: excel!Excel.ShapeTextOrientation:enum +package: excel! +fullName: Excel.ShapeTextOrientation +summary: Specifies the orientation for the text frame in a shape. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: eastAsianVertical + uid: excel!Excel.ShapeTextOrientation.eastAsianVertical:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"EastAsianVertical"' + - name: horizontal + uid: excel!Excel.ShapeTextOrientation.horizontal:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Horizontal"' + - name: mongolianVertical + uid: excel!Excel.ShapeTextOrientation.mongolianVertical:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"MongolianVertical"' + - name: vertical + uid: excel!Excel.ShapeTextOrientation.vertical:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Vertical"' + - name: vertical270 + uid: excel!Excel.ShapeTextOrientation.vertical270:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Vertical270"' + - name: wordArtVertical + uid: excel!Excel.ShapeTextOrientation.wordArtVertical:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"WordArtVertical"' + - name: wordArtVerticalRTL + uid: excel!Excel.ShapeTextOrientation.wordArtVerticalRTL:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"WordArtVerticalRTL"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.shapetextreadingorder.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapetextreadingorder.yml new file mode 100644 index 0000000000..0ca24b87cb --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapetextreadingorder.yml @@ -0,0 +1,27 @@ +### YamlMime:TSEnum +name: Excel.ShapeTextReadingOrder +uid: excel!Excel.ShapeTextReadingOrder:enum +package: excel! +fullName: Excel.ShapeTextReadingOrder +summary: Specifies the reading order for the text frame in a shape. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: leftToRight + uid: excel!Excel.ShapeTextReadingOrder.leftToRight:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LeftToRight"' + - name: rightToLeft + uid: excel!Excel.ShapeTextReadingOrder.rightToLeft:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"RightToLeft"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.shapetextverticalalignment.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapetextverticalalignment.yml new file mode 100644 index 0000000000..4d7104bba2 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapetextverticalalignment.yml @@ -0,0 +1,48 @@ +### YamlMime:TSEnum +name: Excel.ShapeTextVerticalAlignment +uid: excel!Excel.ShapeTextVerticalAlignment:enum +package: excel! +fullName: Excel.ShapeTextVerticalAlignment +summary: Specifies the vertical alignment for the text frame in a shape. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: bottom + uid: excel!Excel.ShapeTextVerticalAlignment.bottom:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Bottom"' + - name: distributed + uid: excel!Excel.ShapeTextVerticalAlignment.distributed:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Distributed"' + - name: justified + uid: excel!Excel.ShapeTextVerticalAlignment.justified:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Justified"' + - name: middle + uid: excel!Excel.ShapeTextVerticalAlignment.middle:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Middle"' + - name: top + uid: excel!Excel.ShapeTextVerticalAlignment.top:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Top"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.shapetextverticaloverflow.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapetextverticaloverflow.yml new file mode 100644 index 0000000000..477022fa96 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapetextverticaloverflow.yml @@ -0,0 +1,45 @@ +### YamlMime:TSEnum +name: Excel.ShapeTextVerticalOverflow +uid: excel!Excel.ShapeTextVerticalOverflow:enum +package: excel! +fullName: Excel.ShapeTextVerticalOverflow +summary: Specifies the vertical overflow for the text frame in a shape. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: clip + uid: excel!Excel.ShapeTextVerticalOverflow.clip:member + package: excel! + summary: >- + Hide text that does not fit vertically within the text frame. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Clip"' + - name: ellipsis + uid: excel!Excel.ShapeTextVerticalOverflow.ellipsis:member + package: excel! + summary: >- + Hide text that does not fit vertically within the text frame, and add an + ellipsis (...) at the end of the visible text. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Ellipsis"' + - name: overflow + uid: excel!Excel.ShapeTextVerticalOverflow.overflow:member + package: excel! + summary: >- + Allow text to overflow the text frame vertically (can be from the top, + bottom, or both depending on the text alignment). + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Overflow"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.shapetype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapetype.yml new file mode 100644 index 0000000000..db3eb42abb --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapetype.yml @@ -0,0 +1,48 @@ +### YamlMime:TSEnum +name: Excel.ShapeType +uid: excel!Excel.ShapeType:enum +package: excel! +fullName: Excel.ShapeType +summary: Specifies the type of a shape. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: geometricShape + uid: excel!Excel.ShapeType.geometricShape:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"GeometricShape"' + - name: group + uid: excel!Excel.ShapeType.group:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Group"' + - name: image + uid: excel!Excel.ShapeType.image:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Image"' + - name: line + uid: excel!Excel.ShapeType.line:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Line"' + - name: unsupported + uid: excel!Excel.ShapeType.unsupported:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Unsupported"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.shapezorder.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapezorder.yml new file mode 100644 index 0000000000..404d5ef2bd --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.shapezorder.yml @@ -0,0 +1,62 @@ +### YamlMime:TSEnum +name: Excel.ShapeZOrder +uid: excel!Excel.ShapeZOrder:enum +package: excel! +fullName: Excel.ShapeZOrder +summary: >- + Specifies where in the z-order a shape should be moved relative to other + shapes. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-move-and-order.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Shapes"); + const shape = sheet.shapes.getItem("Octagon") + shape.setZOrder(Excel.ShapeZOrder.sendBackward); + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: bringForward + uid: excel!Excel.ShapeZOrder.bringForward:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"BringForward"' + - name: bringToFront + uid: excel!Excel.ShapeZOrder.bringToFront:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"BringToFront"' + - name: sendBackward + uid: excel!Excel.ShapeZOrder.sendBackward:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"SendBackward"' + - name: sendToBack + uid: excel!Excel.ShapeZOrder.sendToBack:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"SendToBack"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.sheetvisibility.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.sheetvisibility.yml new file mode 100644 index 0000000000..718fab41d9 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.sheetvisibility.yml @@ -0,0 +1,62 @@ +### YamlMime:TSEnum +name: Excel.SheetVisibility +uid: excel!Excel.SheetVisibility:enum +package: excel! +fullName: Excel.SheetVisibility +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-visibility.yaml + + + await Excel.run(async (context) => { + + const visibleSheets = await filterWorksheetsByVisibility(context, Excel.SheetVisibility.visible); + + if (visibleSheets.length > 1) { + console.log(`Hiding worksheet named "${visibleSheets[0].name}"...`); + + visibleSheets[0].visibility = Excel.SheetVisibility.hidden; + + await context.sync(); + + } else { + console.log("Cannot hide the only visible worksheet"); + } + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: hidden + uid: excel!Excel.SheetVisibility.hidden:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Hidden"' + - name: veryHidden + uid: excel!Excel.SheetVisibility.veryHidden:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"VeryHidden"' + - name: visible + uid: excel!Excel.SheetVisibility.visible:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Visible"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.showascalculation.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.showascalculation.yml new file mode 100644 index 0000000000..ee68e129d1 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.showascalculation.yml @@ -0,0 +1,208 @@ +### YamlMime:TSEnum +name: Excel.ShowAsCalculation +uid: excel!Excel.ShowAsCalculation:enum +package: excel! +fullName: Excel.ShowAsCalculation +summary: The ShowAs calculation function for the DataPivotField. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-calculations.yaml + + + await Excel.run(async (context) => { + const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales"); + const farmDataHierarchy: Excel.DataPivotHierarchy = pivotTable.dataHierarchies.getItem("Sum of Crates Sold at Farm"); + const wholesaleDataHierarchy: Excel.DataPivotHierarchy = pivotTable.dataHierarchies.getItem("Sum of Crates Sold Wholesale"); + + farmDataHierarchy.load("showAs"); + wholesaleDataHierarchy.load("showAs"); + await context.sync(); + + // Show the crates of each fruit type sold at the farm as a percentage of the column's total. + let farmShowAs = farmDataHierarchy.showAs; + farmShowAs.calculation = Excel.ShowAsCalculation.percentOfColumnTotal; + farmShowAs.baseField = pivotTable.rowHierarchies.getItem("Type").fields.getItem("Type"); + farmDataHierarchy.showAs = farmShowAs; + + let wholesaleShowAs = wholesaleDataHierarchy.showAs; + wholesaleShowAs.calculation = Excel.ShowAsCalculation.percentOfColumnTotal; + wholesaleShowAs.baseField = pivotTable.rowHierarchies.getItem("Type").fields.getItem("Type"); + wholesaleDataHierarchy.showAs = wholesaleShowAs; + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: differenceFrom + uid: excel!Excel.ShowAsCalculation.differenceFrom:member + package: excel! + summary: >- + Difference from the specified Base field and Base item. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"DifferenceFrom"' + - name: index + uid: excel!Excel.ShowAsCalculation.index:member + package: excel! + summary: >- + Calculates the values as follows: ((value in cell) x (Grand Total of Grand + Totals)) / ((Grand Row Total) x (Grand Column Total)) + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Index"' + - name: none + uid: excel!Excel.ShowAsCalculation.none:member + package: excel! + summary: >- + No calculation is applied. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"None"' + - name: percentDifferenceFrom + uid: excel!Excel.ShowAsCalculation.percentDifferenceFrom:member + package: excel! + summary: >- + Difference from the specified Base field and Base item. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"PercentDifferenceFrom"' + - name: percentOf + uid: excel!Excel.ShowAsCalculation.percentOf:member + package: excel! + summary: >- + Percent of the specified Base field and Base item. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"PercentOf"' + - name: percentOfColumnTotal + uid: excel!Excel.ShowAsCalculation.percentOfColumnTotal:member + package: excel! + summary: >- + Percent of the column total. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"PercentOfColumnTotal"' + - name: percentOfGrandTotal + uid: excel!Excel.ShowAsCalculation.percentOfGrandTotal:member + package: excel! + summary: >- + Percent of the grand total. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"PercentOfGrandTotal"' + - name: percentOfParentColumnTotal + uid: excel!Excel.ShowAsCalculation.percentOfParentColumnTotal:member + package: excel! + summary: >- + Percent of the column total for the specified Base field. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"PercentOfParentColumnTotal"' + - name: percentOfParentRowTotal + uid: excel!Excel.ShowAsCalculation.percentOfParentRowTotal:member + package: excel! + summary: >- + Percent of the row total for the specified Base field. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"PercentOfParentRowTotal"' + - name: percentOfParentTotal + uid: excel!Excel.ShowAsCalculation.percentOfParentTotal:member + package: excel! + summary: >- + Percent of the grand total for the specified Base field. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"PercentOfParentTotal"' + - name: percentOfRowTotal + uid: excel!Excel.ShowAsCalculation.percentOfRowTotal:member + package: excel! + summary: >- + Percent of the row total. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"PercentOfRowTotal"' + - name: percentRunningTotal + uid: excel!Excel.ShowAsCalculation.percentRunningTotal:member + package: excel! + summary: >- + Percent running total of the specified Base field. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"PercentRunningTotal"' + - name: rankAscending + uid: excel!Excel.ShowAsCalculation.rankAscending:member + package: excel! + summary: >- + Ascending rank of the specified Base field. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"RankAscending"' + - name: rankDecending + uid: excel!Excel.ShowAsCalculation.rankDecending:member + package: excel! + summary: >- + Descending rank of the specified Base field. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"RankDecending"' + - name: runningTotal + uid: excel!Excel.ShowAsCalculation.runningTotal:member + package: excel! + summary: >- + Running total of the specified Base field. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"RunningTotal"' + - name: unknown + uid: excel!Excel.ShowAsCalculation.unknown:member + package: excel! + summary: >- + Calculation is unknown or unsupported. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Unknown"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.showasrule.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.showasrule.yml new file mode 100644 index 0000000000..a81575b8e9 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.showasrule.yml @@ -0,0 +1,114 @@ +### YamlMime:TSType +name: Excel.ShowAsRule +uid: excel!Excel.ShowAsRule:interface +package: excel! +fullName: Excel.ShowAsRule +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: baseField + uid: excel!Excel.ShowAsRule#baseField:member + package: excel! + fullName: baseField + summary: >- + The PivotField to base the `ShowAs` calculation on, if applicable + according to the `ShowAsCalculation` type, else `null`. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'baseField?: Excel.PivotField;' + return: + type: + - name: baseItem + uid: excel!Excel.ShowAsRule#baseItem:member + package: excel! + fullName: baseItem + summary: >- + The item to base the `ShowAs` calculation on, if applicable according to + the `ShowAsCalculation` type, else `null`. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-calculations.yaml + + + await Excel.run(async (context) => { + const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales"); + const farmDataHierarchy: Excel.DataPivotHierarchy = pivotTable.dataHierarchies.getItem("Sum of Crates Sold at Farm"); + const wholesaleDataHierarchy: Excel.DataPivotHierarchy = pivotTable.dataHierarchies.getItem("Sum of Crates Sold Wholesale"); + + farmDataHierarchy.load("showAs"); + wholesaleDataHierarchy.load("showAs"); + await context.sync(); + + // Show the difference between crate sales of the "A Farms" and the other farms. + // This difference is both aggregated and shown for individual fruit types (where applicable). + let farmShowAs = farmDataHierarchy.showAs; + farmShowAs.calculation = Excel.ShowAsCalculation.differenceFrom; + farmShowAs.baseField = pivotTable.rowHierarchies.getItem("Farm").fields.getItem("Farm"); + farmShowAs.baseItem = pivotTable.rowHierarchies.getItem("Farm").fields.getItem("Farm").items.getItem("A Farms"); + farmDataHierarchy.showAs = farmShowAs; + + let wholesaleShowAs = wholesaleDataHierarchy.showAs; + wholesaleShowAs.calculation = Excel.ShowAsCalculation.differenceFrom; + wholesaleShowAs.baseField = pivotTable.rowHierarchies.getItem("Farm").fields.getItem("Farm"); + wholesaleShowAs.baseItem = pivotTable.rowHierarchies.getItem("Farm").fields.getItem("Farm").items.getItem("A Farms"); + wholesaleDataHierarchy.showAs = wholesaleShowAs; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'baseItem?: Excel.PivotItem;' + return: + type: + - name: calculation + uid: excel!Excel.ShowAsRule#calculation:member + package: excel! + fullName: calculation + summary: >- + The `ShowAs` calculation to use for the PivotField. See + `Excel.ShowAsCalculation` for details. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + calculation: Excel.ShowAsCalculation | "Unknown" | "None" | + "PercentOfGrandTotal" | "PercentOfRowTotal" | "PercentOfColumnTotal" | + "PercentOfParentRowTotal" | "PercentOfParentColumnTotal" | + "PercentOfParentTotal" | "PercentOf" | "RunningTotal" | + "PercentRunningTotal" | "DifferenceFrom" | "PercentDifferenceFrom" | + "RankAscending" | "RankDecending" | "Index"; + return: + type: >- + | "Unknown" | "None" + | "PercentOfGrandTotal" | "PercentOfRowTotal" | "PercentOfColumnTotal" + | "PercentOfParentRowTotal" | "PercentOfParentColumnTotal" | + "PercentOfParentTotal" | "PercentOf" | "RunningTotal" | + "PercentRunningTotal" | "DifferenceFrom" | "PercentDifferenceFrom" | + "RankAscending" | "RankDecending" | "Index" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.slicer.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.slicer.yml new file mode 100644 index 0000000000..bd7db40880 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.slicer.yml @@ -0,0 +1,541 @@ +### YamlMime:TSType +name: Excel.Slicer +uid: excel!Excel.Slicer:class +package: excel! +fullName: Excel.Slicer +summary: Represents a `Slicer` object in the workbook. +remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: caption + uid: excel!Excel.Slicer#caption:member + package: excel! + fullName: caption + summary: Represents the caption of the slicer. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'caption: string;' + return: + type: string + - name: context + uid: excel!Excel.Slicer#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: height + uid: excel!Excel.Slicer#height:member + package: excel! + fullName: height + summary: >- + Specifies the height, in points, of the slicer. Throws an + `InvalidArgument` exception when set with a negative value or zero as an + input. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'height: number;' + return: + type: number + - name: id + uid: excel!Excel.Slicer#id:member + package: excel! + fullName: id + summary: Represents the unique ID of the slicer. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly id: string;' + return: + type: string + - name: isFilterCleared + uid: excel!Excel.Slicer#isFilterCleared:member + package: excel! + fullName: isFilterCleared + summary: >- + Value is `true` if all filters currently applied on the slicer are + cleared. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly isFilterCleared: boolean;' + return: + type: boolean + - name: left + uid: excel!Excel.Slicer#left:member + package: excel! + fullName: left + summary: >- + Represents the distance, in points, from the left side of the slicer to + the left of the worksheet. Throws an `InvalidArgument` error when set with + a negative value as an input. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'left: number;' + return: + type: number + - name: name + uid: excel!Excel.Slicer#name:member + package: excel! + fullName: name + summary: Represents the name of the slicer. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name: string;' + return: + type: string + - name: slicerItems + uid: excel!Excel.Slicer#slicerItems:member + package: excel! + fullName: slicerItems + summary: Represents the collection of slicer items that are part of the slicer. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly slicerItems: Excel.SlicerItemCollection;' + return: + type: + - name: sortBy + uid: excel!Excel.Slicer#sortBy:member + package: excel! + fullName: sortBy + summary: >- + Specifies the sort order of the items in the slicer. Possible values are: + "DataSourceOrder", "Ascending", "Descending". + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + sortBy: Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | + "Descending"; + return: + type: >- + | "DataSourceOrder" | + "Ascending" | "Descending" + - name: style + uid: excel!Excel.Slicer#style:member + package: excel! + fullName: style + summary: >- + Constant value that represents the slicer style. Possible values are: + "SlicerStyleLight1" through "SlicerStyleLight6", "TableStyleOther1" + through "TableStyleOther2", "SlicerStyleDark1" through "SlicerStyleDark6". + A custom user-defined style present in the workbook can also be specified. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-slicer.yaml + + + await Excel.run(async (context) => { + const slicer = context.workbook.slicers.getItem("Fruit Slicer"); + slicer.style = "SlicerStyleLight6"; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'style: string;' + return: + type: string + - name: top + uid: excel!Excel.Slicer#top:member + package: excel! + fullName: top + summary: >- + Represents the distance, in points, from the top edge of the slicer to the + top of the worksheet. Throws an `InvalidArgument` error when set with a + negative value as an input. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'top: number;' + return: + type: number + - name: width + uid: excel!Excel.Slicer#width:member + package: excel! + fullName: width + summary: >- + Represents the width, in points, of the slicer. Throws an + `InvalidArgument` error when set with a negative value or zero as an + input. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'width: number;' + return: + type: number + - name: worksheet + uid: excel!Excel.Slicer#worksheet:member + package: excel! + fullName: worksheet + summary: Represents the worksheet containing the slicer. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly worksheet: Excel.Worksheet;' + return: + type: +methods: + - name: clearFilters() + uid: excel!Excel.Slicer#clearFilters:member(1) + package: excel! + fullName: clearFilters() + summary: Clears all the filters currently applied on the slicer. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-slicer.yaml + + + await Excel.run(async (context) => { + const slicer = context.workbook.slicers.getItem("Fruit Slicer"); + slicer.clearFilters(); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'clearFilters(): void;' + return: + type: void + description: '' + - name: delete() + uid: excel!Excel.Slicer#delete:member(1) + package: excel! + fullName: delete() + summary: Deletes the slicer. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-slicer.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + sheet.slicers.getItemAt(0).delete(); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'delete(): void;' + return: + type: void + description: '' + - name: getSelectedItems() + uid: excel!Excel.Slicer#getSelectedItems:member(1) + package: excel! + fullName: getSelectedItems() + summary: Returns an array of selected items' keys. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getSelectedItems(): OfficeExtension.ClientResult;' + return: + type: >- + <string[]> + description: '' + - name: load(options) + uid: excel!Excel.Slicer#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(options?: Excel.Interfaces.SlicerLoadOptions): Excel.Slicer;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.Slicer#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.Slicer;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.Slicer#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.Slicer; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: selectItems(items) + uid: excel!Excel.Slicer#selectItems:member(1) + package: excel! + fullName: selectItems(items) + summary: >- + Selects slicer items based on their keys. The previous selections are + cleared. All items will be selected by default if the array is empty. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-slicer.yaml + + + await Excel.run(async (context) => { + const slicer = context.workbook.slicers.getItem("Fruit Slicer"); + slicer.selectItems(["Lemon", "Lime", "Orange"]); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'selectItems(items?: string[]): void;' + parameters: + - id: items + description: Optional. The specified slicer item names to be selected. + type: string[] + return: + type: void + description: '' + - name: set(properties, options) + uid: excel!Excel.Slicer#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.SlicerUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.Slicer#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.Slicer): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.Slicer#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.Slicer` object is + an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Excel.Interfaces.SlicerData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.SlicerData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.slicercollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.slicercollection.yml new file mode 100644 index 0000000000..3213e24964 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.slicercollection.yml @@ -0,0 +1,318 @@ +### YamlMime:TSType +name: Excel.SlicerCollection +uid: excel!Excel.SlicerCollection:class +package: excel! +fullName: Excel.SlicerCollection +summary: >- + Represents a collection of all the slicer objects in the workbook or a + worksheet. +remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.SlicerCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: excel!Excel.SlicerCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.Slicer[];' + return: + type: [] +methods: + - name: add(slicerSource, sourceField, slicerDestination) + uid: excel!Excel.SlicerCollection#add:member(1) + package: excel! + fullName: add(slicerSource, sourceField, slicerDestination) + summary: Adds a new slicer to the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-slicer.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Pivot"); + const slicer = sheet.slicers.add( + "Farm Sales", /* The slicer data source. For PivotTables, this can be the PivotTable object reference or name. */ + "Type" /* The field in the data source to filter by. For PivotTables, this can be a PivotField object reference or ID. */ + ); + slicer.name = "Fruit Slicer"; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + add(slicerSource: string | PivotTable | Table, sourceField: string | + PivotField | number | TableColumn, slicerDestination?: string | + Worksheet): Excel.Slicer; + parameters: + - id: slicerSource + description: >- + The data source that the new slicer will be based on. It can be a + `PivotTable` object, a `Table` object, or a string. When a + PivotTable object is passed, the data source is the source of the + `PivotTable` object. When a `Table` object is passed, the data + source is the `Table` object. When a string is passed, it is + interpreted as the name or ID of a PivotTable or table. + type: >- + string | | + - id: sourceField + description: >- + The field in the data source to filter by. It can be a `PivotField` + object, a `TableColumn` object, the ID of a `PivotField` or the name + or ID of a `TableColumn`. + type: >- + string | | number | + + - id: slicerDestination + description: >- + Optional. The worksheet in which the new slicer will be created. It + can be a `Worksheet` object or the name or ID of a worksheet. This + parameter can be omitted if the slicer collection is retrieved from + a worksheet. + type: string | + return: + type: + description: The new slicer. + - name: getCount() + uid: excel!Excel.SlicerCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Returns the number of slicers in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getItem(key) + uid: excel!Excel.SlicerCollection#getItem:member(1) + package: excel! + fullName: getItem(key) + summary: Gets a slicer object using its name or ID. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-slicer.yaml + + + await Excel.run(async (context) => { + const slicer = context.workbook.slicers.getItem("Fruit Slicer"); + slicer.caption = "Fruit Types"; + slicer.left = 395; + slicer.top = 15; + slicer.height = 135; + slicer.width = 150; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getItem(key: string): Excel.Slicer;' + parameters: + - id: key + description: The name or ID of the slicer. + type: string + return: + type: + description: '' + - name: getItemAt(index) + uid: excel!Excel.SlicerCollection#getItemAt:member(1) + package: excel! + fullName: getItemAt(index) + summary: Gets a slicer based on its position in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemAt(index: number): Excel.Slicer;' + parameters: + - id: index + description: Index value of the object to be retrieved. Zero-indexed. + type: number + return: + type: + description: '' + - name: getItemOrNullObject(key) + uid: excel!Excel.SlicerCollection#getItemOrNullObject:member(1) + package: excel! + fullName: getItemOrNullObject(key) + summary: >- + Gets a slicer using its name or ID. If the slicer doesn't exist, then this + method returns an object with its `isNullObject` property set to + `true`. For further information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemOrNullObject(key: string): Excel.Slicer;' + parameters: + - id: key + description: Name or ID of the slicer to be retrieved. + type: string + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.SlicerCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.SlicerCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): Excel.SlicerCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.SlicerCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.SlicerCollection;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.SlicerCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.SlicerCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.SlicerCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.SlicerCollection` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.SlicerCollectionData`) that + contains an "items" array with shallow copies of any loaded properties + from the collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.SlicerCollectionData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.sliceritem.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.sliceritem.yml new file mode 100644 index 0000000000..5ec0a108ad --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.sliceritem.yml @@ -0,0 +1,249 @@ +### YamlMime:TSType +name: Excel.SlicerItem +uid: excel!Excel.SlicerItem:class +package: excel! +fullName: Excel.SlicerItem +summary: Represents a slicer item in a slicer. +remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.SlicerItem#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: hasData + uid: excel!Excel.SlicerItem#hasData:member + package: excel! + fullName: hasData + summary: Value is `true` if the slicer item has data. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly hasData: boolean;' + return: + type: boolean + - name: isSelected + uid: excel!Excel.SlicerItem#isSelected:member + package: excel! + fullName: isSelected + summary: >- + Value is `true` if the slicer item is selected. Setting this value will + not clear the selected state of other slicer items. By default, if the + slicer item is the only one selected, when it is deselected, all items + will be selected. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'isSelected: boolean;' + return: + type: boolean + - name: key + uid: excel!Excel.SlicerItem#key:member + package: excel! + fullName: key + summary: Represents the unique value representing the slicer item. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly key: string;' + return: + type: string + - name: name + uid: excel!Excel.SlicerItem#name:member + package: excel! + fullName: name + summary: Represents the title displayed in the Excel UI. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly name: string;' + return: + type: string +methods: + - name: load(options) + uid: excel!Excel.SlicerItem#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.SlicerItemLoadOptions): + Excel.SlicerItem; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.SlicerItem#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.SlicerItem;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.SlicerItem#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.SlicerItem; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.SlicerItem#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.SlicerItemUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.SlicerItem#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.SlicerItem): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.SlicerItem#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.SlicerItem` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.SlicerItemData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.SlicerItemData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.sliceritemcollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.sliceritemcollection.yml new file mode 100644 index 0000000000..9d1fd3b3dd --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.sliceritemcollection.yml @@ -0,0 +1,229 @@ +### YamlMime:TSType +name: Excel.SlicerItemCollection +uid: excel!Excel.SlicerItemCollection:class +package: excel! +fullName: Excel.SlicerItemCollection +summary: Represents a collection of all the slicer item objects in the slicer. +remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.SlicerItemCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: excel!Excel.SlicerItemCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.SlicerItem[];' + return: + type: [] +methods: + - name: getCount() + uid: excel!Excel.SlicerItemCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Returns the number of slicer items in the slicer. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getItem(key) + uid: excel!Excel.SlicerItemCollection#getItem:member(1) + package: excel! + fullName: getItem(key) + summary: Gets a slicer item object using its key or name. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItem(key: string): Excel.SlicerItem;' + parameters: + - id: key + description: The key or name of the slicer item. + type: string + return: + type: + description: '' + - name: getItemAt(index) + uid: excel!Excel.SlicerItemCollection#getItemAt:member(1) + package: excel! + fullName: getItemAt(index) + summary: Gets a slicer item based on its position in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemAt(index: number): Excel.SlicerItem;' + parameters: + - id: index + description: Index value of the object to be retrieved. Zero-indexed. + type: number + return: + type: + description: '' + - name: getItemOrNullObject(key) + uid: excel!Excel.SlicerItemCollection#getItemOrNullObject:member(1) + package: excel! + fullName: getItemOrNullObject(key) + summary: >- + Gets a slicer item using its key or name. If the slicer item doesn't + exist, then this method returns an object with its `isNullObject` property + set to `true`. For further information, see [*OrNullObject + methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemOrNullObject(key: string): Excel.SlicerItem;' + parameters: + - id: key + description: Key or name of the slicer to be retrieved. + type: string + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.SlicerItemCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.SlicerItemCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): Excel.SlicerItemCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.SlicerItemCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.SlicerItemCollection;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.SlicerItemCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.SlicerItemCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.SlicerItemCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.SlicerItemCollection` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.SlicerItemCollectionData`) that contains an + "items" array with shallow copies of any loaded properties from the + collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.SlicerItemCollectionData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.slicersorttype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.slicersorttype.yml new file mode 100644 index 0000000000..ac546df129 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.slicersorttype.yml @@ -0,0 +1,46 @@ +### YamlMime:TSEnum +name: Excel.SlicerSortType +uid: excel!Excel.SlicerSortType:enum +package: excel! +fullName: Excel.SlicerSortType +summary: Specifies the slicer sort behavior for `Slicer.sortBy`. +remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: ascending + uid: excel!Excel.SlicerSortType.ascending:member + package: excel! + summary: >- + Sort slicer items in ascending order by item captions. + + + * \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Ascending"' + - name: dataSourceOrder + uid: excel!Excel.SlicerSortType.dataSourceOrder:member + package: excel! + summary: >- + Sort slicer items in the order provided by the data source. + + + * \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"DataSourceOrder"' + - name: descending + uid: excel!Excel.SlicerSortType.descending:member + package: excel! + summary: >- + Sort slicer items in descending order by item captions. + + + * \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Descending"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.slicerstyle.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.slicerstyle.yml new file mode 100644 index 0000000000..d8c697e8fe --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.slicerstyle.yml @@ -0,0 +1,255 @@ +### YamlMime:TSType +name: Excel.SlicerStyle +uid: excel!Excel.SlicerStyle:class +package: excel! +fullName: Excel.SlicerStyle +summary: >- + Represents a slicer style, which defines style elements by region of the + slicer. +remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.SlicerStyle#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: name + uid: excel!Excel.SlicerStyle#name:member + package: excel! + fullName: name + summary: Specifies the name of the slicer style. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name: string;' + return: + type: string + - name: readOnly + uid: excel!Excel.SlicerStyle#readOnly:member + package: excel! + fullName: readOnly + summary: Specifies if this `SlicerStyle` object is read-only. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly readOnly: boolean;' + return: + type: boolean +methods: + - name: delete() + uid: excel!Excel.SlicerStyle#delete:member(1) + package: excel! + fullName: delete() + summary: Deletes the slicer style. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'delete(): void;' + return: + type: void + description: '' + - name: duplicate() + uid: excel!Excel.SlicerStyle#duplicate:member(1) + package: excel! + fullName: duplicate() + summary: >- + Creates a duplicate of this slicer style with copies of all the style + elements. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'duplicate(): Excel.SlicerStyle;' + return: + type: + description: >- + The new `SlicerStyle` object that has been duplicated from this slicer + style. + - name: load(options) + uid: excel!Excel.SlicerStyle#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.SlicerStyleLoadOptions): + Excel.SlicerStyle; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.SlicerStyle#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.SlicerStyle;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.SlicerStyle#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.SlicerStyle; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.SlicerStyle#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.SlicerStyleUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.SlicerStyle#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.SlicerStyle): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.SlicerStyle#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.SlicerStyle` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.SlicerStyleData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.SlicerStyleData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.slicerstylecollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.slicerstylecollection.yml new file mode 100644 index 0000000000..9bb32e2de4 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.slicerstylecollection.yml @@ -0,0 +1,275 @@ +### YamlMime:TSType +name: Excel.SlicerStyleCollection +uid: excel!Excel.SlicerStyleCollection:class +package: excel! +fullName: Excel.SlicerStyleCollection +summary: Represents a collection of `SlicerStyle` objects. +remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.SlicerStyleCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: excel!Excel.SlicerStyleCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.SlicerStyle[];' + return: + type: [] +methods: + - name: add(name, makeUniqueName) + uid: excel!Excel.SlicerStyleCollection#add:member(1) + package: excel! + fullName: add(name, makeUniqueName) + summary: Creates a blank slicer style with the specified name. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'add(name: string, makeUniqueName?: boolean): Excel.SlicerStyle;' + parameters: + - id: name + description: >- + The unique name for the new slicer style. Will throw an + `InvalidArgument` exception if the name is already in use. + type: string + - id: makeUniqueName + description: >- + Optional. Defaults to `false`. If `true`, will + append numbers to the name in order to make it unique, if needed. + type: boolean + return: + type: + description: The newly created `SlicerStyle`. + - name: getCount() + uid: excel!Excel.SlicerStyleCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Gets the number of slicer styles in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getDefault() + uid: excel!Excel.SlicerStyleCollection#getDefault:member(1) + package: excel! + fullName: getDefault() + summary: Gets the default `SlicerStyle` for the parent object's scope. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getDefault(): Excel.SlicerStyle;' + return: + type: + description: The `SlicerStyle` object that is the current default slicer style. + - name: getItem(name) + uid: excel!Excel.SlicerStyleCollection#getItem:member(1) + package: excel! + fullName: getItem(name) + summary: Gets a `SlicerStyle` by name. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItem(name: string): Excel.SlicerStyle;' + parameters: + - id: name + description: Name of the slicer style to be retrieved. + type: string + return: + type: + description: The `SlicerStyle` object whose name matches the input. + - name: getItemOrNullObject(name) + uid: excel!Excel.SlicerStyleCollection#getItemOrNullObject:member(1) + package: excel! + fullName: getItemOrNullObject(name) + summary: >- + Gets a `SlicerStyle` by name. If the slicer style doesn't exist, then this + method returns an object with its `isNullObject` property set to + `true`. For further information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemOrNullObject(name: string): Excel.SlicerStyle;' + parameters: + - id: name + description: Name of the slicer style to be retrieved. + type: string + return: + type: + description: The `SlicerStyle` object whose name matches the input. + - name: load(options) + uid: excel!Excel.SlicerStyleCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.SlicerStyleCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): Excel.SlicerStyleCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.SlicerStyleCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.SlicerStyleCollection;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.SlicerStyleCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.SlicerStyleCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: setDefault(newDefaultStyle) + uid: excel!Excel.SlicerStyleCollection#setDefault:member(1) + package: excel! + fullName: setDefault(newDefaultStyle) + summary: Sets the default slicer style for use in the parent object's scope. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'setDefault(newDefaultStyle: SlicerStyle | string): void;' + parameters: + - id: newDefaultStyle + description: >- + The `SlicerStyle` object, or name of the `SlicerStyle` object, that + should be the new default. + type: | string + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.SlicerStyleCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.SlicerStyleCollection` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.SlicerStyleCollectionData`) that contains an + "items" array with shallow copies of any loaded properties from the + collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.SlicerStyleCollectionData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.sortby.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.sortby.yml new file mode 100644 index 0000000000..5736dfd0b1 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.sortby.yml @@ -0,0 +1,33 @@ +### YamlMime:TSEnum +name: Excel.SortBy +uid: excel!Excel.SortBy:enum +package: excel! +fullName: Excel.SortBy +summary: Represents the sort direction. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: ascending + uid: excel!Excel.SortBy.ascending:member + package: excel! + summary: >- + Ascending sort. Smallest to largest or A to Z. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Ascending"' + - name: descending + uid: excel!Excel.SortBy.descending:member + package: excel! + summary: >- + Descending sort. Largest to smallest or Z to A. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Descending"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.sortdataoption.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.sortdataoption.yml new file mode 100644 index 0000000000..286a7374a0 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.sortdataoption.yml @@ -0,0 +1,27 @@ +### YamlMime:TSEnum +name: Excel.SortDataOption +uid: excel!Excel.SortDataOption:enum +package: excel! +fullName: Excel.SortDataOption +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: normal + uid: excel!Excel.SortDataOption.normal:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Normal"' + - name: textAsNumber + uid: excel!Excel.SortDataOption.textAsNumber:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"TextAsNumber"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.sortfield.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.sortfield.yml new file mode 100644 index 0000000000..b8e40304e5 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.sortfield.yml @@ -0,0 +1,131 @@ +### YamlMime:TSType +name: Excel.SortField +uid: excel!Excel.SortField:interface +package: excel! +fullName: Excel.SortField +summary: Represents a condition in a sorting operation. +remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: ascending + uid: excel!Excel.SortField#ascending:member + package: excel! + fullName: ascending + summary: Specifies if the sorting is done in an ascending fashion. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'ascending?: boolean;' + return: + type: boolean + - name: color + uid: excel!Excel.SortField#color:member + package: excel! + fullName: color + summary: >- + Specifies the color that is the target of the condition if the sorting is + on font or cell color. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'color?: string;' + return: + type: string + - name: dataOption + uid: excel!Excel.SortField#dataOption:member + package: excel! + fullName: dataOption + summary: Represents additional sorting options for this field. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'dataOption?: Excel.SortDataOption | "Normal" | "TextAsNumber";' + return: + type: >- + | "Normal" | + "TextAsNumber" + - name: icon + uid: excel!Excel.SortField#icon:member + package: excel! + fullName: icon + summary: >- + Specifies the icon that is the target of the condition, if the sorting is + on the cell's icon. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'icon?: Excel.Icon;' + return: + type: + - name: key + uid: excel!Excel.SortField#key:member + package: excel! + fullName: key + summary: >- + Specifies the column (or row, depending on the sort orientation) that the + condition is on. Represented as an offset from the first column (or row). + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'key: number;' + return: + type: number + - name: sortOn + uid: excel!Excel.SortField#sortOn:member + package: excel! + fullName: sortOn + summary: Specifies the type of sorting of this condition. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'sortOn?: Excel.SortOn | "Value" | "CellColor" | "FontColor" | "Icon";' + return: + type: >- + | "Value" | "CellColor" | + "FontColor" | "Icon" + - name: subField + uid: excel!Excel.SortField#subField:member + package: excel! + fullName: subField + summary: >- + Specifies the subfield that is the target property name of a rich value to + sort on. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'subField?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.sortmethod.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.sortmethod.yml new file mode 100644 index 0000000000..e70f9c9b04 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.sortmethod.yml @@ -0,0 +1,27 @@ +### YamlMime:TSEnum +name: Excel.SortMethod +uid: excel!Excel.SortMethod:enum +package: excel! +fullName: Excel.SortMethod +summary: Represents the ordering method to be used when sorting Chinese characters. +remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: pinYin + uid: excel!Excel.SortMethod.pinYin:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"PinYin"' + - name: strokeCount + uid: excel!Excel.SortMethod.strokeCount:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"StrokeCount"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.sorton.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.sorton.yml new file mode 100644 index 0000000000..fc3cc16840 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.sorton.yml @@ -0,0 +1,78 @@ +### YamlMime:TSEnum +name: Excel.SortOn +uid: excel!Excel.SortOn:enum +package: excel! +fullName: Excel.SortOn +summary: Represents the part of the cell used as the sorting criteria. +remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/event-column-and-row-sort.yaml + + + async function sortTopToBottom(criteria: string) { + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + const range = sheet.getRange("A1:E5"); + + // Find the column header that provides the sort criteria. + const header = range.find(criteria, {}); + header.load("columnIndex"); + await context.sync(); + + range.sort.apply( + [ + { + key: header.columnIndex, + sortOn: Excel.SortOn.value + } + ], + false /*matchCase*/, + true /*hasHeaders*/, + Excel.SortOrientation.rows + ); + await context.sync(); + }); + } + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: cellColor + uid: excel!Excel.SortOn.cellColor:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"CellColor"' + - name: fontColor + uid: excel!Excel.SortOn.fontColor:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"FontColor"' + - name: icon + uid: excel!Excel.SortOn.icon:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Icon"' + - name: value + uid: excel!Excel.SortOn.value:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Value"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.sortorientation.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.sortorientation.yml new file mode 100644 index 0000000000..002cd6461e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.sortorientation.yml @@ -0,0 +1,64 @@ +### YamlMime:TSEnum +name: Excel.SortOrientation +uid: excel!Excel.SortOrientation:enum +package: excel! +fullName: Excel.SortOrientation +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/event-column-and-row-sort.yaml + + + async function sortLeftToRight(criteria: string) { + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + const range = sheet.getRange("A1:E5"); + + // Find the row header that provides the sort criteria. + const header = range.find(criteria, {}); + header.load("rowIndex"); + await context.sync(); + + range.sort.apply( + [ + { + key: header.rowIndex, + sortOn: Excel.SortOn.value + } + ], + false /*matchCase*/, + true /*hasHeaders*/, + Excel.SortOrientation.columns + ); + await context.sync(); + }); + } + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: columns + uid: excel!Excel.SortOrientation.columns:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Columns"' + - name: rows + uid: excel!Excel.SortOrientation.rows:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Rows"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.specialcelltype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.specialcelltype.yml new file mode 100644 index 0000000000..dc4b22ac9c --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.specialcelltype.yml @@ -0,0 +1,94 @@ +### YamlMime:TSEnum +name: Excel.SpecialCellType +uid: excel!Excel.SpecialCellType:enum +package: excel! +fullName: Excel.SpecialCellType +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: blanks + uid: excel!Excel.SpecialCellType.blanks:member + package: excel! + summary: >- + Cells with no content. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Blanks"' + - name: conditionalFormats + uid: excel!Excel.SpecialCellType.conditionalFormats:member + package: excel! + summary: >- + All cells with conditional formats. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ConditionalFormats"' + - name: constants + uid: excel!Excel.SpecialCellType.constants:member + package: excel! + summary: >- + Cells containing constants. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Constants"' + - name: dataValidations + uid: excel!Excel.SpecialCellType.dataValidations:member + package: excel! + summary: >- + Cells with validation criteria. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"DataValidations"' + - name: formulas + uid: excel!Excel.SpecialCellType.formulas:member + package: excel! + summary: >- + Cells containing formulas. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Formulas"' + - name: sameConditionalFormat + uid: excel!Excel.SpecialCellType.sameConditionalFormat:member + package: excel! + summary: >- + Cells with the same conditional format as the first cell in the range. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"SameConditionalFormat"' + - name: sameDataValidation + uid: excel!Excel.SpecialCellType.sameDataValidation:member + package: excel! + summary: >- + Cells with the same data validation criteria as the first cell in the + range. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"SameDataValidation"' + - name: visible + uid: excel!Excel.SpecialCellType.visible:member + package: excel! + summary: >- + Cells that are visible. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Visible"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.specialcellvaluetype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.specialcellvaluetype.yml new file mode 100644 index 0000000000..b40f897c29 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.specialcellvaluetype.yml @@ -0,0 +1,163 @@ +### YamlMime:TSEnum +name: Excel.SpecialCellValueType +uid: excel!Excel.SpecialCellValueType:enum +package: excel! +fullName: Excel.SpecialCellValueType +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: all + uid: excel!Excel.SpecialCellValueType.all:member + package: excel! + summary: >- + Cells that have errors, boolean, numeric, or string values. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"All"' + - name: errors + uid: excel!Excel.SpecialCellValueType.errors:member + package: excel! + summary: >- + Cells that have errors. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Errors"' + - name: errorsLogical + uid: excel!Excel.SpecialCellValueType.errorsLogical:member + package: excel! + summary: >- + Cells that have errors or boolean values. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ErrorsLogical"' + - name: errorsLogicalNumber + uid: excel!Excel.SpecialCellValueType.errorsLogicalNumber:member + package: excel! + summary: >- + Cells that have errors, boolean, or numeric values. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ErrorsLogicalNumber"' + - name: errorsLogicalText + uid: excel!Excel.SpecialCellValueType.errorsLogicalText:member + package: excel! + summary: >- + Cells that have errors, boolean, or string values. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ErrorsLogicalText"' + - name: errorsNumbers + uid: excel!Excel.SpecialCellValueType.errorsNumbers:member + package: excel! + summary: >- + Cells that have errors or numeric values. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ErrorsNumbers"' + - name: errorsNumberText + uid: excel!Excel.SpecialCellValueType.errorsNumberText:member + package: excel! + summary: >- + Cells that have errors, numeric, or string values. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ErrorsNumberText"' + - name: errorsText + uid: excel!Excel.SpecialCellValueType.errorsText:member + package: excel! + summary: >- + Cells that have errors or string values. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"ErrorsText"' + - name: logical + uid: excel!Excel.SpecialCellValueType.logical:member + package: excel! + summary: >- + Cells that have a boolean value. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Logical"' + - name: logicalNumbers + uid: excel!Excel.SpecialCellValueType.logicalNumbers:member + package: excel! + summary: >- + Cells that have a boolean or numeric value. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LogicalNumbers"' + - name: logicalNumbersText + uid: excel!Excel.SpecialCellValueType.logicalNumbersText:member + package: excel! + summary: >- + Cells that have a boolean, numeric, or string value. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LogicalNumbersText"' + - name: logicalText + uid: excel!Excel.SpecialCellValueType.logicalText:member + package: excel! + summary: >- + Cells that have a boolean or string value. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"LogicalText"' + - name: numbers + uid: excel!Excel.SpecialCellValueType.numbers:member + package: excel! + summary: >- + Cells that have a numeric value. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Numbers"' + - name: numbersText + uid: excel!Excel.SpecialCellValueType.numbersText:member + package: excel! + summary: >- + Cells that have a numeric or string value. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"NumbersText"' + - name: text + uid: excel!Excel.SpecialCellValueType.text:member + package: excel! + summary: >- + Cells that have a string value. + + + * \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Text"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.spillerrorcellvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.spillerrorcellvalue.yml new file mode 100644 index 0000000000..6a122e0de5 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.spillerrorcellvalue.yml @@ -0,0 +1,143 @@ +### YamlMime:TSType +name: Excel.SpillErrorCellValue +uid: excel!Excel.SpillErrorCellValue:interface +package: excel! +fullName: Excel.SpillErrorCellValue +summary: Represents the value of a cell containing a \#SPILL! error. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: basicType + uid: excel!Excel.SpillErrorCellValue#basicType:member + package: excel! + fullName: basicType + summary: >- + Represents the value that would be returned by `Range.valueTypes` for a + cell with this value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicType?: RangeValueType.error | "Error";' + return: + type: | "Error" + - name: basicValue + uid: excel!Excel.SpillErrorCellValue#basicValue:member + package: excel! + fullName: basicValue + summary: >- + Represents the value that would be returned by `Range.values` for a cell + with this value. When accessed through a `valuesAsJson` property, this + string value aligns with the en-US locale. When accessed through a + `valuesAsJsonLocal` property, this string value aligns with the user's + display locale. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicValue?: "#SPILL!" | string;' + return: + type: '"#SPILL!" | string' + - name: columnCount + uid: excel!Excel.SpillErrorCellValue#columnCount:member + package: excel! + fullName: columnCount + summary: >- + Represents the number of columns that would spill if there were no + \#SPILL! error. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'columnCount?: number;' + return: + type: number + - name: errorSubType + uid: excel!Excel.SpillErrorCellValue#errorSubType:member + package: excel! + fullName: errorSubType + summary: Represents the type of `SpillErrorCellValue`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + errorSubType?: SpillErrorCellValueSubType | "Unknown" | "Collision" | + "IndeterminateSize" | "WorksheetEdge" | "OutOfMemoryWhileCalc" | "Table" + | "MergedCell"; + return: + type: >- + | "Unknown" + | "Collision" | "IndeterminateSize" | "WorksheetEdge" | + "OutOfMemoryWhileCalc" | "Table" | "MergedCell" + - name: errorType + uid: excel!Excel.SpillErrorCellValue#errorType:member + package: excel! + fullName: errorType + summary: Represents the type of `ErrorCellValue`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'errorType?: ErrorCellValueType.spill | "Spill";' + return: + type: | "Spill" + - name: rowCount + uid: excel!Excel.SpillErrorCellValue#rowCount:member + package: excel! + fullName: rowCount + summary: >- + Represents the number of rows that would spill if there were no \#SPILL! + error. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rowCount?: number;' + return: + type: number + - name: type + uid: excel!Excel.SpillErrorCellValue#type:member + package: excel! + fullName: type + summary: Represents the type of this cell value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: CellValueType.error | "Error";' + return: + type: | "Error" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.spillerrorcellvaluesubtype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.spillerrorcellvaluesubtype.yml new file mode 100644 index 0000000000..208a05b44e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.spillerrorcellvaluesubtype.yml @@ -0,0 +1,96 @@ +### YamlMime:TSEnum +name: Excel.SpillErrorCellValueSubType +uid: excel!Excel.SpillErrorCellValueSubType:enum +package: excel! +fullName: Excel.SpillErrorCellValueSubType +summary: Represents types of \#SPILL! errors. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: collision + uid: excel!Excel.SpillErrorCellValueSubType.collision:member + package: excel! + summary: >- + An error caused by a dynamic array attempting to spill data into a cell + that isn't empty. Displays as error type \#SPILL! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Collision"' + - name: indeterminateSize + uid: excel!Excel.SpillErrorCellValueSubType.indeterminateSize:member + package: excel! + summary: >- + An error caused by a dynamic array formula that can't be evaluated in a + single calculation. Displays as error type \#SPILL! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"IndeterminateSize"' + - name: mergedCell + uid: excel!Excel.SpillErrorCellValueSubType.mergedCell:member + package: excel! + summary: >- + An error caused by a merged cell blocking a dynamic array. Displays as + error type \#SPILL! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"MergedCell"' + - name: outOfMemoryWhileCalc + uid: excel!Excel.SpillErrorCellValueSubType.outOfMemoryWhileCalc:member + package: excel! + summary: >- + An error caused by insufficient memory when attempting to calculate a + dynamic array formula. Displays as error type \#SPILL! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"OutOfMemoryWhileCalc"' + - name: table + uid: excel!Excel.SpillErrorCellValueSubType.table:member + package: excel! + summary: >- + An error caused by entering a dynamic array formula in a table. Displays + as error type \#SPILL! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Table"' + - name: unknown + uid: excel!Excel.SpillErrorCellValueSubType.unknown:member + package: excel! + summary: >- + An unknown type of error. Displays as error type \#SPILL! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Unknown"' + - name: worksheetEdge + uid: excel!Excel.SpillErrorCellValueSubType.worksheetEdge:member + package: excel! + summary: >- + An error caused by a dynamic array attempting to spill over the edge of + the worksheet. Displays as error type \#SPILL! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"WorksheetEdge"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.stringcellvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.stringcellvalue.yml new file mode 100644 index 0000000000..6227c58f7b --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.stringcellvalue.yml @@ -0,0 +1,141 @@ +### YamlMime:TSType +name: Excel.StringCellValue +uid: excel!Excel.StringCellValue:interface +package: excel! +fullName: Excel.StringCellValue +summary: Represents the value of a cell containing a string. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: basicType + uid: excel!Excel.StringCellValue#basicType:member + package: excel! + fullName: basicType + summary: >- + Represents the value that would be returned by `Range.valueTypes` for a + cell with this value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicType?: RangeValueType.string | "String";' + return: + type: | "String" + - name: basicValue + uid: excel!Excel.StringCellValue#basicValue:member + package: excel! + fullName: basicValue + summary: >- + Represents the value that would be returned by `Range.values` for a cell + with this value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicValue: string;' + return: + type: string + - name: layouts + uid: excel!Excel.StringCellValue#layouts:member + package: excel! + fullName: layouts + summary: Represents layout information for views of this string value. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'layouts?: BasicViewLayouts;' + return: + type: + - name: properties + uid: excel!Excel.StringCellValue#properties:member + package: excel! + fullName: properties + summary: Represents additional properties of this string value. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: |- + properties?: { + [key: string]: EntityPropertyType; + }; + return: + type: |- + { + [key: string]: ; + } + - name: provider + uid: excel!Excel.StringCellValue#provider:member + package: excel! + fullName: provider + summary: >- + Represents information that describes the service that provided the data + in this `StringCellValue`. This information can be used for + branding in card view. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'provider?: CellValueProviderAttributes;' + return: + type: + - name: referencedValues + uid: excel!Excel.StringCellValue#referencedValues:member + package: excel! + fullName: referencedValues + summary: >- + Represents the cell values which are referenced within + `StringCellValue.properties`. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'referencedValues?: ReferencedValue[];' + return: + type: [] + - name: type + uid: excel!Excel.StringCellValue#type:member + package: excel! + fullName: type + summary: Represents the type of this cell value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: CellValueType.string | "String";' + return: + type: | "String" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.style.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.style.yml new file mode 100644 index 0000000000..057abec5a8 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.style.yml @@ -0,0 +1,678 @@ +### YamlMime:TSType +name: Excel.Style +uid: excel!Excel.Style:class +package: excel! +fullName: Excel.Style +summary: An object encapsulating a style's format and other properties. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: autoIndent + uid: excel!Excel.Style#autoIndent:member + package: excel! + fullName: autoIndent + summary: >- + Specifies if text is automatically indented when the text alignment in a + cell is set to equal distribution. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'autoIndent: boolean;' + return: + type: boolean + - name: borders + uid: excel!Excel.Style#borders:member + package: excel! + fullName: borders + summary: >- + A collection of four border objects that represent the style of the four + borders. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly borders: Excel.RangeBorderCollection;' + return: + type: + - name: builtIn + uid: excel!Excel.Style#builtIn:member + package: excel! + fullName: builtIn + summary: Specifies if the style is a built-in style. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly builtIn: boolean;' + return: + type: boolean + - name: context + uid: excel!Excel.Style#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: fill + uid: excel!Excel.Style#fill:member + package: excel! + fullName: fill + summary: The fill of the style. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly fill: Excel.RangeFill;' + return: + type: + - name: font + uid: excel!Excel.Style#font:member + package: excel! + fullName: font + summary: A `Font` object that represents the font of the style. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml + + + await Excel.run(async (context) => { + let style = context.workbook.styles.getItem("Normal"); + style.font.load("bold, color, italic, name, size"); + style.fill.load("color"); + + await context.sync(); + + console.log("Bold: " + style.font.bold); + console.log("Font color: " + style.font.color); + console.log("Italic: " + style.font.italic); + console.log("Name: " + style.font.name); + console.log("Size: " + style.font.size); + console.log("Fill color: " + style.fill.color); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly font: Excel.RangeFont;' + return: + type: + - name: formulaHidden + uid: excel!Excel.Style#formulaHidden:member + package: excel! + fullName: formulaHidden + summary: Specifies if the formula will be hidden when the worksheet is protected. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulaHidden: boolean;' + return: + type: boolean + - name: horizontalAlignment + uid: excel!Excel.Style#horizontalAlignment:member + package: excel! + fullName: horizontalAlignment + summary: >- + Represents the horizontal alignment for the style. See + `Excel.HorizontalAlignment` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml + + + await Excel.run(async (context) => { + let worksheet = context.workbook.worksheets.getItem("Sample"); + let range = worksheet.getRange("A1:E1"); + + // Apply built-in style. + // Styles are in the Home tab ribbon. + range.style = Excel.BuiltInStyle.neutral; + range.format.horizontalAlignment = "Right"; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + horizontalAlignment: Excel.HorizontalAlignment | "General" | "Left" | + "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | + "Distributed"; + return: + type: >- + | "General" | + "Left" | "Center" | "Right" | "Fill" | "Justify" | + "CenterAcrossSelection" | "Distributed" + - name: includeAlignment + uid: excel!Excel.Style#includeAlignment:member + package: excel! + fullName: includeAlignment + summary: >- + Specifies if the style includes the auto indent, horizontal alignment, + vertical alignment, wrap text, indent level, and text orientation + properties. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'includeAlignment: boolean;' + return: + type: boolean + - name: includeBorder + uid: excel!Excel.Style#includeBorder:member + package: excel! + fullName: includeBorder + summary: >- + Specifies if the style includes the color, color index, line style, and + weight border properties. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'includeBorder: boolean;' + return: + type: boolean + - name: includeFont + uid: excel!Excel.Style#includeFont:member + package: excel! + fullName: includeFont + summary: >- + Specifies if the style includes the background, bold, color, color index, + font style, italic, name, size, strikethrough, subscript, superscript, and + underline font properties. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'includeFont: boolean;' + return: + type: boolean + - name: includeNumber + uid: excel!Excel.Style#includeNumber:member + package: excel! + fullName: includeNumber + summary: Specifies if the style includes the number format property. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'includeNumber: boolean;' + return: + type: boolean + - name: includePatterns + uid: excel!Excel.Style#includePatterns:member + package: excel! + fullName: includePatterns + summary: >- + Specifies if the style includes the color, color index, invert if + negative, pattern, pattern color, and pattern color index interior + properties. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'includePatterns: boolean;' + return: + type: boolean + - name: includeProtection + uid: excel!Excel.Style#includeProtection:member + package: excel! + fullName: includeProtection + summary: >- + Specifies if the style includes the formula hidden and locked protection + properties. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'includeProtection: boolean;' + return: + type: boolean + - name: indentLevel + uid: excel!Excel.Style#indentLevel:member + package: excel! + fullName: indentLevel + summary: An integer from 0 to 250 that indicates the indent level for the style. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'indentLevel: number;' + return: + type: number + - name: locked + uid: excel!Excel.Style#locked:member + package: excel! + fullName: locked + summary: Specifies if the object is locked when the worksheet is protected. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'locked: boolean;' + return: + type: boolean + - name: name + uid: excel!Excel.Style#name:member + package: excel! + fullName: name + summary: The name of the style. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly name: string;' + return: + type: string + - name: numberFormat + uid: excel!Excel.Style#numberFormat:member + package: excel! + fullName: numberFormat + summary: The format code of the number format for the style. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormat: string;' + return: + type: string + - name: numberFormatLocal + uid: excel!Excel.Style#numberFormatLocal:member + package: excel! + fullName: numberFormatLocal + summary: The localized format code of the number format for the style. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'numberFormatLocal: string;' + return: + type: string + - name: readingOrder + uid: excel!Excel.Style#readingOrder:member + package: excel! + fullName: readingOrder + summary: The reading order for the style. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readingOrder: Excel.ReadingOrder | "Context" | "LeftToRight" | + "RightToLeft"; + return: + type: >- + | "Context" | + "LeftToRight" | "RightToLeft" + - name: shrinkToFit + uid: excel!Excel.Style#shrinkToFit:member + package: excel! + fullName: shrinkToFit + summary: >- + Specifies if text automatically shrinks to fit in the available column + width. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'shrinkToFit: boolean;' + return: + type: boolean + - name: textOrientation + uid: excel!Excel.Style#textOrientation:member + package: excel! + fullName: textOrientation + summary: The text orientation for the style. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'textOrientation: number;' + return: + type: number + - name: verticalAlignment + uid: excel!Excel.Style#verticalAlignment:member + package: excel! + fullName: verticalAlignment + summary: >- + Specifies the vertical alignment for the style. See + `Excel.VerticalAlignment` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + verticalAlignment: Excel.VerticalAlignment | "Top" | "Center" | "Bottom" + | "Justify" | "Distributed"; + return: + type: >- + | "Top" | "Center" | + "Bottom" | "Justify" | "Distributed" + - name: wrapText + uid: excel!Excel.Style#wrapText:member + package: excel! + fullName: wrapText + summary: Specifies if Excel wraps the text in the object. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'wrapText: boolean;' + return: + type: boolean +methods: + - name: delete() + uid: excel!Excel.Style#delete:member(1) + package: excel! + fullName: delete() + summary: Deletes this style. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml + + + await Excel.run(async (context) => { + let style = context.workbook.styles.getItem("Diagonal Orientation Style"); + + // Delete the diagonal orientation style from the style collection. + // Styles are in the Home tab ribbon. + style.delete(); + + await context.sync(); + + console.log("Successfully deleted the diagonal orientation style from the Home tab ribbon."); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'delete(): void;' + return: + type: void + description: '' + - name: load(options) + uid: excel!Excel.Style#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(options?: Excel.Interfaces.StyleLoadOptions): Excel.Style;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: >- + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml + + + await Excel.run(async (context) => { + let style = context.workbook.styles.getItem("Diagonal Orientation Style"); + style.load("textOrientation, horizontalAlignment, autoIndent, readingOrder, wrapText, includeProtection, shrinkToFit, locked"); + + await context.sync(); + + console.log("Orientation: " + style.textOrientation); + console.log("Horizontal alignment: " + style.horizontalAlignment); + console.log("Add indent: " + style.autoIndent); + console.log("Reading order: " + style.readingOrder); + console.log("Wrap text: " + style.wrapText); + console.log("Include protection: " + style.includeProtection); + console.log("Shrink to fit: " + style.shrinkToFit); + console.log("Style locked: " + style.locked); + }); + + ``` + - name: load(propertyNames) + uid: excel!Excel.Style#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.Style;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.Style#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.Style; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.Style#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.StyleUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.Style#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.Style): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.Style#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.Style` object is + an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Excel.Interfaces.StyleData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.StyleData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.stylecollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.stylecollection.yml new file mode 100644 index 0000000000..2e923ced29 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.stylecollection.yml @@ -0,0 +1,308 @@ +### YamlMime:TSType +name: Excel.StyleCollection +uid: excel!Excel.StyleCollection:class +package: excel! +fullName: Excel.StyleCollection +summary: Represents a collection of all the styles. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.StyleCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: excel!Excel.StyleCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.Style[];' + return: + type: [] +methods: + - name: add(name) + uid: excel!Excel.StyleCollection#add:member(1) + package: excel! + fullName: add(name) + summary: Adds a new style to the collection. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml + + + await Excel.run(async (context) => { + let styles = context.workbook.styles; + + // Add a new style to the style collection. + // Styles is in the Home tab ribbon. + styles.add("Diagonal Orientation Style"); + + let newStyle = styles.getItem("Diagonal Orientation Style"); + + // The "Diagonal Orientation Style" properties. + newStyle.textOrientation = 38; + newStyle.autoIndent = true; + newStyle.includeProtection = true; + newStyle.shrinkToFit = true; + newStyle.locked = false; + + await context.sync(); + + console.log("Successfully added a new style with diagonal orientation to the Home tab ribbon."); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'add(name: string): void;' + parameters: + - id: name + description: Name of the style to be added. + type: string + return: + type: void + description: '' + - name: getCount() + uid: excel!Excel.StyleCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Gets the number of styles in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getItem(name) + uid: excel!Excel.StyleCollection#getItem:member(1) + package: excel! + fullName: getItem(name) + summary: Gets a `Style` by name. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml + + + await Excel.run(async (context) => { + let styles = context.workbook.styles; + + // Add a new style to the style collection. + // Styles is in the Home tab ribbon. + styles.add("Diagonal Orientation Style"); + + let newStyle = styles.getItem("Diagonal Orientation Style"); + + // The "Diagonal Orientation Style" properties. + newStyle.textOrientation = 38; + newStyle.autoIndent = true; + newStyle.includeProtection = true; + newStyle.shrinkToFit = true; + newStyle.locked = false; + + await context.sync(); + + console.log("Successfully added a new style with diagonal orientation to the Home tab ribbon."); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getItem(name: string): Excel.Style;' + parameters: + - id: name + description: Name of the style to be retrieved. + type: string + return: + type: + description: '' + - name: getItemAt(index) + uid: excel!Excel.StyleCollection#getItemAt:member(1) + package: excel! + fullName: getItemAt(index) + summary: Gets a style based on its position in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemAt(index: number): Excel.Style;' + parameters: + - id: index + description: Index value of the style object to be retrieved. Zero-indexed. + type: number + return: + type: + description: '' + - name: getItemOrNullObject(name) + uid: excel!Excel.StyleCollection#getItemOrNullObject:member(1) + package: excel! + fullName: getItemOrNullObject(name) + summary: >- + Gets a style by name. If the style object does not exist, then this method + returns an object with its `isNullObject` property set to `true`. + For further information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemOrNullObject(name: string): Excel.Style;' + parameters: + - id: name + description: Name of the style to be retrieved. + type: string + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.StyleCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.StyleCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): Excel.StyleCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.StyleCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.StyleCollection;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.StyleCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.StyleCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.StyleCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.StyleCollection` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.StyleCollectionData`) that + contains an "items" array with shallow copies of any loaded properties + from the collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.StyleCollectionData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.subtotallocationtype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.subtotallocationtype.yml new file mode 100644 index 0000000000..06459e659e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.subtotallocationtype.yml @@ -0,0 +1,43 @@ +### YamlMime:TSEnum +name: Excel.SubtotalLocationType +uid: excel!Excel.SubtotalLocationType:enum +package: excel! +fullName: Excel.SubtotalLocationType +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: atBottom + uid: excel!Excel.SubtotalLocationType.atBottom:member + package: excel! + summary: >- + Subtotals are at the bottom. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"AtBottom"' + - name: atTop + uid: excel!Excel.SubtotalLocationType.atTop:member + package: excel! + summary: >- + Subtotals are at the top. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"AtTop"' + - name: 'off' + uid: excel!Excel.SubtotalLocationType.off:member + package: excel! + summary: >- + Subtotals are off. + + + * \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Off"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.subtotals.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.subtotals.yml new file mode 100644 index 0000000000..e171707507 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.subtotals.yml @@ -0,0 +1,174 @@ +### YamlMime:TSType +name: Excel.Subtotals +uid: excel!Excel.Subtotals:interface +package: excel! +fullName: Excel.Subtotals +summary: Subtotals for the Pivot Field. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: automatic + uid: excel!Excel.Subtotals#automatic:member + package: excel! + fullName: automatic + summary: >- + If `Automatic` is set to `true`, then all other values will be + ignored when setting the `Subtotals`. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'automatic?: boolean;' + return: + type: boolean + - name: average + uid: excel!Excel.Subtotals#average:member + package: excel! + fullName: average + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'average?: boolean;' + return: + type: boolean + - name: count + uid: excel!Excel.Subtotals#count:member + package: excel! + fullName: count + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'count?: boolean;' + return: + type: boolean + - name: countNumbers + uid: excel!Excel.Subtotals#countNumbers:member + package: excel! + fullName: countNumbers + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'countNumbers?: boolean;' + return: + type: boolean + - name: max + uid: excel!Excel.Subtotals#max:member + package: excel! + fullName: max + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'max?: boolean;' + return: + type: boolean + - name: min + uid: excel!Excel.Subtotals#min:member + package: excel! + fullName: min + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'min?: boolean;' + return: + type: boolean + - name: product + uid: excel!Excel.Subtotals#product:member + package: excel! + fullName: product + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'product?: boolean;' + return: + type: boolean + - name: standardDeviation + uid: excel!Excel.Subtotals#standardDeviation:member + package: excel! + fullName: standardDeviation + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'standardDeviation?: boolean;' + return: + type: boolean + - name: standardDeviationP + uid: excel!Excel.Subtotals#standardDeviationP:member + package: excel! + fullName: standardDeviationP + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'standardDeviationP?: boolean;' + return: + type: boolean + - name: sum + uid: excel!Excel.Subtotals#sum:member + package: excel! + fullName: sum + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'sum?: boolean;' + return: + type: boolean + - name: variance + uid: excel!Excel.Subtotals#variance:member + package: excel! + fullName: variance + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'variance?: boolean;' + return: + type: boolean + - name: varianceP + uid: excel!Excel.Subtotals#varianceP:member + package: excel! + fullName: varianceP + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'varianceP?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.table.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.table.yml new file mode 100644 index 0000000000..d5fc38469f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.table.yml @@ -0,0 +1,841 @@ +### YamlMime:TSType +name: Excel.Table +uid: excel!Excel.Table:class +package: excel! +fullName: Excel.Table +summary: >- + Represents an Excel table. To learn more about the table object model, read + [Work with tables using the Excel JavaScript + API](https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-tables). +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: autoFilter + uid: excel!Excel.Table#autoFilter:member + package: excel! + fullName: autoFilter + summary: Represents the `AutoFilter` object of the table. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly autoFilter: Excel.AutoFilter;' + return: + type: + - name: columns + uid: excel!Excel.Table#columns:member + package: excel! + fullName: columns + summary: Represents a collection of all the columns in the table. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly columns: Excel.TableColumnCollection;' + return: + type: + - name: context + uid: excel!Excel.Table#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: highlightFirstColumn + uid: excel!Excel.Table#highlightFirstColumn:member + package: excel! + fullName: highlightFirstColumn + summary: Specifies if the first column contains special formatting. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'highlightFirstColumn: boolean;' + return: + type: boolean + - name: highlightLastColumn + uid: excel!Excel.Table#highlightLastColumn:member + package: excel! + fullName: highlightLastColumn + summary: Specifies if the last column contains special formatting. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'highlightLastColumn: boolean;' + return: + type: boolean + - name: id + uid: excel!Excel.Table#id:member + package: excel! + fullName: id + summary: >- + Returns a value that uniquely identifies the table in a given workbook. + The value of the identifier remains the same even when the table is + renamed. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly id: string;' + return: + type: string + - name: legacyId + uid: excel!Excel.Table#legacyId:member + package: excel! + fullName: legacyId + summary: Returns a numeric ID. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly legacyId: string;' + return: + type: string + - name: name + uid: excel!Excel.Table#name:member + package: excel! + fullName: name + summary: >- + Name of the table. + + + The set name of the table must follow the guidelines specified in the + [Rename an Excel + table](https://support.microsoft.com/office/fbf49a4f-82a3-43eb-8ba2-44d21233b114) + article. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name: string;' + return: + type: string + - name: rows + uid: excel!Excel.Table#rows:member + package: excel! + fullName: rows + summary: Represents a collection of all the rows in the table. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly rows: Excel.TableRowCollection;' + return: + type: + - name: showBandedColumns + uid: excel!Excel.Table#showBandedColumns:member + package: excel! + fullName: showBandedColumns + summary: >- + Specifies if the columns show banded formatting in which odd columns are + highlighted differently from even ones, to make reading the table easier. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showBandedColumns: boolean;' + return: + type: boolean + - name: showBandedRows + uid: excel!Excel.Table#showBandedRows:member + package: excel! + fullName: showBandedRows + summary: >- + Specifies if the rows show banded formatting in which odd rows are + highlighted differently from even ones, to make reading the table easier. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showBandedRows: boolean;' + return: + type: boolean + - name: showFilterButton + uid: excel!Excel.Table#showFilterButton:member + package: excel! + fullName: showFilterButton + summary: >- + Specifies if the filter buttons are visible at the top of each column + header. Setting this is only allowed if the table contains a header row. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showFilterButton: boolean;' + return: + type: boolean + - name: showHeaders + uid: excel!Excel.Table#showHeaders:member + package: excel! + fullName: showHeaders + summary: >- + Specifies if the header row is visible. This value can be set to show or + remove the header row. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showHeaders: boolean;' + return: + type: boolean + - name: showTotals + uid: excel!Excel.Table#showTotals:member + package: excel! + fullName: showTotals + summary: >- + Specifies if the total row is visible. This value can be set to show or + remove the total row. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showTotals: boolean;' + return: + type: boolean + - name: sort + uid: excel!Excel.Table#sort:member + package: excel! + fullName: sort + summary: Represents the sorting for the table. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly sort: Excel.TableSort;' + return: + type: + - name: style + uid: excel!Excel.Table#style:member + package: excel! + fullName: style + summary: >- + Constant value that represents the table style. Possible values are: + "TableStyleLight1" through "TableStyleLight21", "TableStyleMedium1" + through "TableStyleMedium28", "TableStyleDark1" through + "TableStyleDark11". A custom user-defined style present in the workbook + can also be specified. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Set table style. + + await Excel.run(async (context) => { + const tableName = 'Table1'; + const table = context.workbook.tables.getItem(tableName); + table.name = 'Table1-Renamed'; + table.showTotals = false; + table.style = 'TableStyleMedium2'; + table.load('tableStyle'); + await context.sync(); + + console.log(table.style); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'style: string;' + return: + type: string + - name: worksheet + uid: excel!Excel.Table#worksheet:member + package: excel! + fullName: worksheet + summary: The worksheet containing the current table. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly worksheet: Excel.Worksheet;' + return: + type: +methods: + - name: clearFilters() + uid: excel!Excel.Table#clearFilters:member(1) + package: excel! + fullName: clearFilters() + summary: Clears all the filters currently applied on the table. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'clearFilters(): void;' + return: + type: void + description: '' + - name: convertToRange() + uid: excel!Excel.Table#convertToRange:member(1) + package: excel! + fullName: convertToRange() + summary: Converts the table into a normal range of cells. All data is preserved. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const tableName = 'Table1'; + const table = context.workbook.tables.getItem(tableName); + table.convertToRange(); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'convertToRange(): Excel.Range;' + return: + type: + description: '' + - name: delete() + uid: excel!Excel.Table#delete:member(1) + package: excel! + fullName: delete() + summary: Deletes the table. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const tableName = 'Table1'; + const table = context.workbook.tables.getItem(tableName); + table.delete(); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'delete(): void;' + return: + type: void + description: '' + - name: getDataBodyRange() + uid: excel!Excel.Table#getDataBodyRange:member(1) + package: excel! + fullName: getDataBodyRange() + summary: Gets the range object associated with the data body of the table. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const tableName = 'Table1'; + const table = context.workbook.tables.getItem(tableName); + const tableDataRange = table.getDataBodyRange(); + tableDataRange.load('address') + await context.sync(); + + console.log(tableDataRange.address); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getDataBodyRange(): Excel.Range;' + return: + type: + description: '' + - name: getHeaderRowRange() + uid: excel!Excel.Table#getHeaderRowRange:member(1) + package: excel! + fullName: getHeaderRowRange() + summary: Gets the range object associated with the header row of the table. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const tableName = 'Table1'; + const table = context.workbook.tables.getItem(tableName); + const tableHeaderRange = table.getHeaderRowRange(); + tableHeaderRange.load('address'); + await context.sync(); + + console.log(tableHeaderRange.address); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getHeaderRowRange(): Excel.Range;' + return: + type: + description: '' + - name: getRange() + uid: excel!Excel.Table#getRange:member(1) + package: excel! + fullName: getRange() + summary: Gets the range object associated with the entire table. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const tableName = 'Table1'; + const table = context.workbook.tables.getItem(tableName); + const tableRange = table.getRange(); + tableRange.load('address'); + await context.sync(); + + console.log(tableRange.address); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getRange(): Excel.Range;' + return: + type: + description: '' + - name: getTotalRowRange() + uid: excel!Excel.Table#getTotalRowRange:member(1) + package: excel! + fullName: getTotalRowRange() + summary: Gets the range object associated with the totals row of the table. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const tableName = 'Table1'; + const table = context.workbook.tables.getItem(tableName); + const tableTotalsRange = table.getTotalRowRange(); + tableTotalsRange.load('address'); + await context.sync(); + + console.log(tableTotalsRange.address); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getTotalRowRange(): Excel.Range;' + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.Table#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(options?: Excel.Interfaces.TableLoadOptions): Excel.Table;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.Table#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.Table;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: |- + + + #### Examples + + ```TypeScript + // Get a table by name. + await Excel.run(async (context) => { + const tableName = 'Table1'; + const table = context.workbook.tables.getItem(tableName); + table.load('id') + await context.sync(); + + console.log(table.id); + }); + ``` + - name: load(propertyNamesAndPaths) + uid: excel!Excel.Table#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.Table; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: reapplyFilters() + uid: excel!Excel.Table#reapplyFilters:member(1) + package: excel! + fullName: reapplyFilters() + summary: Reapplies all the filters currently on the table. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'reapplyFilters(): void;' + return: + type: void + description: '' + - name: resize(newRange) + uid: excel!Excel.Table#resize:member(1) + package: excel! + fullName: resize(newRange) + summary: >- + Resize the table to the new range. The new range must overlap with the + original table range and the headers (or the top of the table) must be in + the same row. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/46-table/resize-table.yaml + + + await Excel.run(async (context) => { + // Retrieve the worksheet and a table on that worksheet. + const sheet = context.workbook.worksheets.getItem("Sample"); + const expensesTable = sheet.tables.getItem("ExpensesTable"); + + // Resize the table. + expensesTable.resize("A1:D20"); + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'resize(newRange: Range | string): void;' + parameters: + - id: newRange + description: >- + The range object or range address that will be used to determine the + new size of the table. + type: | string + return: + type: void + description: '' + - name: set(properties, options) + uid: excel!Excel.Table#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.TableUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.Table#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.Table): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.Table#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.Table` object is + an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Excel.Interfaces.TableData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.TableData;' + return: + type: + description: '' +events: + - name: onChanged + uid: excel!Excel.Table#onChanged:member + package: excel! + fullName: onChanged + summary: Occurs when data in cells changes on a specific table. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-table-changed.yaml + + + await Excel.run(async (context) => { + let table = context.workbook.tables.getItemAt(0); + table.onChanged.add(onChange); + + await context.sync(); + console.log("A handler has been registered for the onChanged event"); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onChanged: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onSelectionChanged + uid: excel!Excel.Table#onSelectionChanged:member + package: excel! + fullName: onSelectionChanged + summary: Occurs when the selection changes on a specific table. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-table-changed.yaml + + + await Excel.run(async (context) => { + let table = context.workbook.tables.getItemAt(0); + table.onSelectionChanged.add(onSelectionChange); + + await context.sync(); + console.log("A handler has been registered for table onSelectionChanged event"); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onSelectionChanged: + OfficeExtension.EventHandlers; + return: + type: >- + <> +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.tableaddedeventargs.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.tableaddedeventargs.yml new file mode 100644 index 0000000000..3ce7130f90 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.tableaddedeventargs.yml @@ -0,0 +1,74 @@ +### YamlMime:TSType +name: Excel.TableAddedEventArgs +uid: excel!Excel.TableAddedEventArgs:interface +package: excel! +fullName: Excel.TableAddedEventArgs +summary: Provides information about the table that raised the added event. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: source + uid: excel!Excel.TableAddedEventArgs#source:member + package: excel! + fullName: source + summary: Gets the source of the event. See `Excel.EventSource` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'source: Excel.EventSource | "Local" | "Remote";' + return: + type: | "Local" | "Remote" + - name: tableId + uid: excel!Excel.TableAddedEventArgs#tableId:member + package: excel! + fullName: tableId + summary: Gets the ID of the table that is added. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tableId: string;' + return: + type: string + - name: type + uid: excel!Excel.TableAddedEventArgs#type:member + package: excel! + fullName: type + summary: Gets the type of the event. See `Excel.EventType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: "TableAdded";' + return: + type: '"TableAdded"' + - name: worksheetId + uid: excel!Excel.TableAddedEventArgs#worksheetId:member + package: excel! + fullName: worksheetId + summary: Gets the ID of the worksheet in which the table is added. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheetId: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.tablechangedeventargs.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.tablechangedeventargs.yml new file mode 100644 index 0000000000..5c598356fc --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.tablechangedeventargs.yml @@ -0,0 +1,256 @@ +### YamlMime:TSType +name: Excel.TableChangedEventArgs +uid: excel!Excel.TableChangedEventArgs:interface +package: excel! +fullName: Excel.TableChangedEventArgs +summary: Provides information about the table that raised the changed event. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: address + uid: excel!Excel.TableChangedEventArgs#address:member + package: excel! + fullName: address + summary: >- + Gets the address that represents the changed area of a table on a specific + worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'address: string;' + return: + type: string + - name: changeType + uid: excel!Excel.TableChangedEventArgs#changeType:member + package: excel! + fullName: changeType + summary: >- + Gets the change type that represents how the changed event is triggered. + See `Excel.DataChangeType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + changeType: Excel.DataChangeType | "Unknown" | "RangeEdited" | + "RowInserted" | "RowDeleted" | "ColumnInserted" | "ColumnDeleted" | + "CellInserted" | "CellDeleted"; + return: + type: >- + | "Unknown" | + "RangeEdited" | "RowInserted" | "RowDeleted" | "ColumnInserted" | + "ColumnDeleted" | "CellInserted" | "CellDeleted" + - name: details + uid: excel!Excel.TableChangedEventArgs#details:member + package: excel! + fullName: details + summary: >- + Gets the information about the change detail. This property can be + retrieved when the changed event is triggered on a single cell. If the + changed event is triggered on multiple cells, this property cannot be + retrieved. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/data-change-event-details.yaml + + + async function onTableChanged(eventArgs: Excel.TableChangedEventArgs) { + await Excel.run(async (context) => { + const details = eventArgs.details; + const address = eventArgs.address; + + console.log(`Change at ${address}: was ${details.valueBefore}(${details.valueTypeBefore}),` + + ` now is ${details.valueAfter}(${details.valueTypeAfter})`); + }); + } + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'details: Excel.ChangedEventDetail;' + return: + type: + - name: source + uid: excel!Excel.TableChangedEventArgs#source:member + package: excel! + fullName: source + summary: Gets the source of the event. See `Excel.EventSource` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'source: Excel.EventSource | "Local" | "Remote";' + return: + type: | "Local" | "Remote" + - name: tableId + uid: excel!Excel.TableChangedEventArgs#tableId:member + package: excel! + fullName: tableId + summary: Gets the ID of the table in which the data changed. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-tablecollection-changed.yaml + + + async function onChange(event) { + await Excel.run(async (context) => { + let table = context.workbook.tables.getItem(event.tableId); + let worksheet = context.workbook.worksheets.getItem(event.worksheetId); + worksheet.load("name"); + + await context.sync(); + + console.log("Handler for table collection onChanged event has been triggered. Data changed address: " + event.address); + console.log("Table Id : " + event.tableId); + console.log("Worksheet Id : " + worksheet.name); + }); + } + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'tableId: string;' + return: + type: string + - name: type + uid: excel!Excel.TableChangedEventArgs#type:member + package: excel! + fullName: type + summary: Gets the type of the event. See `Excel.EventType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: "TableChanged";' + return: + type: '"TableChanged"' + - name: worksheetId + uid: excel!Excel.TableChangedEventArgs#worksheetId:member + package: excel! + fullName: worksheetId + summary: Gets the ID of the worksheet in which the data changed. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-tablecollection-changed.yaml + + + async function onChange(event) { + await Excel.run(async (context) => { + let table = context.workbook.tables.getItem(event.tableId); + let worksheet = context.workbook.worksheets.getItem(event.worksheetId); + worksheet.load("name"); + + await context.sync(); + + console.log("Handler for table collection onChanged event has been triggered. Data changed address: " + event.address); + console.log("Table Id : " + event.tableId); + console.log("Worksheet Id : " + worksheet.name); + }); + } + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheetId: string;' + return: + type: string +methods: + - name: getRange(ctx) + uid: excel!Excel.TableChangedEventArgs#getRange:member(1) + package: excel! + fullName: getRange(ctx) + summary: >- + Gets the range that represents the changed area of a table on a specific + worksheet. + + + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'getRange(ctx: Excel.RequestContext): Excel.Range;' + parameters: + - id: ctx + description: '' + type: + return: + type: + description: '' + - name: getRangeOrNullObject(ctx) + uid: excel!Excel.TableChangedEventArgs#getRangeOrNullObject:member(1) + package: excel! + fullName: getRangeOrNullObject(ctx) + summary: >- + Gets the range that represents the changed area of a table on a specific + worksheet. It might return null object. + + + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'getRangeOrNullObject(ctx: Excel.RequestContext): Excel.Range;' + parameters: + - id: ctx + description: '' + type: + return: + type: + description: '' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.tablecollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.tablecollection.yml new file mode 100644 index 0000000000..c256c5aa62 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.tablecollection.yml @@ -0,0 +1,466 @@ +### YamlMime:TSType +name: Excel.TableCollection +uid: excel!Excel.TableCollection:class +package: excel! +fullName: Excel.TableCollection +summary: >- + Represents a collection of all the tables that are part of the workbook or + worksheet, depending on how it was reached. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml + + + // Add checkboxes to the table. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Get the second column in the table, without the header. + const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange(); + + // Change the boolean values to checkboxes. + range.control = { + type: Excel.CellControlType.checkbox + }; + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.TableCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: count + uid: excel!Excel.TableCollection#count:member + package: excel! + fullName: count + summary: Returns the number of tables in the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly count: number;' + return: + type: number + - name: items + uid: excel!Excel.TableCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.Table[];' + return: + type: [] +methods: + - name: add(address, hasHeaders) + uid: excel!Excel.TableCollection#add:member(1) + package: excel! + fullName: add(address, hasHeaders) + summary: >- + Creates a new table. The range object or source address determines the + worksheet under which the table will be added. If the table cannot be + added (e.g., because the address is invalid, or the table would overlap + with another table), an error will be thrown. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const table = context.workbook.tables.add('Sheet1!A1:E7', true); + table.load('name'); + await context.sync(); + + console.log(table.name); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'add(address: Range | string, hasHeaders: boolean): Excel.Table;' + parameters: + - id: address + description: >- + A `Range` object, or a string address or name of the range + representing the data source. If the address does not contain a + sheet name, the currently-active sheet is used. \[Api set: ExcelApi + 1.1 / 1.3. Prior to ExcelApi 1.3, this parameter must be a string. + Starting with Excel Api 1.3, this parameter may be a Range object or + a string.\] + type: | string + - id: hasHeaders + description: >- + A boolean value that indicates whether the data being imported has + column labels. If the source does not contain headers (i.e., when + this property set to `false`), Excel will automatically + generate a header and shift the data down by one row. + type: boolean + return: + type: + description: '' + - name: getCount() + uid: excel!Excel.TableCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Gets the number of tables in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getItem(key) + uid: excel!Excel.TableCollection#getItem:member(1) + package: excel! + fullName: getItem(key) + summary: Gets a table by name or ID. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const tableName = 'Table1'; + const table = context.workbook.tables.getItem(tableName); + table.load('name'); + await context.sync(); + + console.log(table.name); + }); + + ``` + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml + + + // Remove checkboxes from the table. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Get the second column in the table, without the header. + const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange(); + + // Change the checkboxes back to boolean values. + range.control = { + type: Excel.CellControlType.empty + }; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getItem(key: string): Excel.Table;' + parameters: + - id: key + description: Name or ID of the table to be retrieved. + type: string + return: + type: + description: '' + - name: getItemAt(index) + uid: excel!Excel.TableCollection#getItemAt:member(1) + package: excel! + fullName: getItemAt(index) + summary: Gets a table based on its position in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const table = context.workbook.tables.getItemAt(0); + table.load('name'); + await context.sync(); + + console.log(table.name); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemAt(index: number): Excel.Table;' + parameters: + - id: index + description: Index value of the object to be retrieved. Zero-indexed. + type: number + return: + type: + description: '' + - name: getItemOrNullObject(key) + uid: excel!Excel.TableCollection#getItemOrNullObject:member(1) + package: excel! + fullName: getItemOrNullObject(key) + summary: >- + Gets a table by name or ID. If the table doesn't exist, then this method + returns an object with its `isNullObject` property set to `true`. + For further information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemOrNullObject(key: string): Excel.Table;' + parameters: + - id: key + description: Name or ID of the table to be retrieved. + type: string + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.TableCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.TableCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): Excel.TableCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.TableCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.TableCollection;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: |- + + + #### Examples + + ```TypeScript + // Get the number of tables. + await Excel.run(async (context) => { + const tables = context.workbook.tables; + tables.load('count'); + await context.sync(); + + console.log(tables.count); + }); + ``` + - name: load(propertyNamesAndPaths) + uid: excel!Excel.TableCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.TableCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.TableCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.TableCollection` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.TableCollectionData`) that + contains an "items" array with shallow copies of any loaded properties + from the collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.TableCollectionData;' + return: + type: + description: '' +events: + - name: onAdded + uid: excel!Excel.TableCollection#onAdded:member + package: excel! + fullName: onAdded + summary: Occurs when a new table is added in a workbook. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onAdded: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onChanged + uid: excel!Excel.TableCollection#onChanged:member + package: excel! + fullName: onChanged + summary: Occurs when data changes on any table in a workbook, or a worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-tablecollection-changed.yaml + + + await Excel.run(async (context) => { + let tables = context.workbook.tables; + tables.onChanged.add(onChange); + + await context.sync(); + console.log("A handler has been registered for the table collection onChanged event"); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onChanged: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onDeleted + uid: excel!Excel.TableCollection#onDeleted:member + package: excel! + fullName: onDeleted + summary: Occurs when the specified table is deleted in a workbook. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onDeleted: + OfficeExtension.EventHandlers; + return: + type: >- + <> +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.tablecolumn.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.tablecolumn.yml new file mode 100644 index 0000000000..f9f6585276 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.tablecolumn.yml @@ -0,0 +1,514 @@ +### YamlMime:TSType +name: Excel.TableColumn +uid: excel!Excel.TableColumn:class +package: excel! +fullName: Excel.TableColumn +summary: Represents a column in a table. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.TableColumn#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: filter + uid: excel!Excel.TableColumn#filter:member + package: excel! + fullName: filter + summary: Retrieves the filter applied to the column. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly filter: Excel.Filter;' + return: + type: + - name: id + uid: excel!Excel.TableColumn#id:member + package: excel! + fullName: id + summary: Returns a unique key that identifies the column within the table. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly id: number;' + return: + type: number + - name: index + uid: excel!Excel.TableColumn#index:member + package: excel! + fullName: index + summary: >- + Returns the index number of the column within the columns collection of + the table. Zero-indexed. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly index: number;' + return: + type: number + - name: name + uid: excel!Excel.TableColumn#name:member + package: excel! + fullName: name + summary: Specifies the name of the table column. + remarks: >- + \[ [API set: ExcelApi 1.1 for getting the name; 1.4 for setting + it.](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name: string;' + return: + type: string + - name: values + uid: excel!Excel.TableColumn#values:member + package: excel! + fullName: values + summary: >- + Represents the raw values of the specified range. The data returned could + be a string, number, or boolean. Cells that contain an error will return + the error string. If the returned value starts with a plus ("+"), minus + ("-"), or equal sign ("="), Excel interprets this value as a formula. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'values: any[][];' + return: + type: any[][] + - name: valuesAsJson + uid: excel!Excel.TableColumn#valuesAsJson:member + package: excel! + fullName: valuesAsJson + summary: >- + A JSON representation of the values in the cells in this table column. + Unlike `TableColumn.values`, `TableColumn.valuesAsJson` supports + all data types which can be in a cell. Examples include formatted number + values and web images, in addition to the standard boolean, number, and + string values. Data returned from this API always aligns with the en-US + locale. To retrieve data in the user's display locale, use + `TableColumn.valuesAsJsonLocal`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJson: CellValue[][];' + return: + type: [][] + - name: valuesAsJsonLocal + uid: excel!Excel.TableColumn#valuesAsJsonLocal:member + package: excel! + fullName: valuesAsJsonLocal + summary: >- + A JSON representation of the values in the cells in this table column. + Unlike `TableColumn.values`, `TableColumn.valuesAsJsonLocal` + supports all data types which can be in a cell. Examples include formatted + number values and web images, in addition to the standard boolean, number, + and string values. Data returned from this API always aligns with the + user's display locale. To retrieve data independent of locale, use + `TableColumn.valuesAsJson`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJsonLocal: CellValue[][];' + return: + type: [][] +methods: + - name: delete() + uid: excel!Excel.TableColumn#delete:member(1) + package: excel! + fullName: delete() + summary: Deletes the column from the table. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const tableName = 'Table1'; + const column = context.workbook.tables.getItem(tableName).columns.getItemAt(2); + column.delete(); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'delete(): void;' + return: + type: void + description: '' + - name: getDataBodyRange() + uid: excel!Excel.TableColumn#getDataBodyRange:member(1) + package: excel! + fullName: getDataBodyRange() + summary: Gets the range object associated with the data body of the column. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const tableName = 'Table1'; + const column = context.workbook.tables.getItem(tableName).columns.getItemAt(0); + const dataBodyRange = column.getDataBodyRange(); + dataBodyRange.load('address'); + await context.sync(); + + console.log(dataBodyRange.address); + }); + + ``` + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml + + + // Add checkboxes to the table. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Get the second column in the table, without the header. + const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange(); + + // Change the boolean values to checkboxes. + range.control = { + type: Excel.CellControlType.checkbox + }; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getDataBodyRange(): Excel.Range;' + return: + type: + description: '' + - name: getHeaderRowRange() + uid: excel!Excel.TableColumn#getHeaderRowRange:member(1) + package: excel! + fullName: getHeaderRowRange() + summary: Gets the range object associated with the header row of the column. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const tableName = 'Table1'; + const columns = context.workbook.tables.getItem(tableName).columns.getItemAt(0); + const headerRowRange = columns.getHeaderRowRange(); + headerRowRange.load('address'); + await context.sync(); + + console.log(headerRowRange.address); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getHeaderRowRange(): Excel.Range;' + return: + type: + description: '' + - name: getRange() + uid: excel!Excel.TableColumn#getRange:member(1) + package: excel! + fullName: getRange() + summary: Gets the range object associated with the entire column. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const tableName = 'Table1'; + const columns = context.workbook.tables.getItem(tableName).columns.getItemAt(0); + const columnRange = columns.getRange(); + columnRange.load('address'); + await context.sync(); + + console.log(columnRange.address); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getRange(): Excel.Range;' + return: + type: + description: '' + - name: getTotalRowRange() + uid: excel!Excel.TableColumn#getTotalRowRange:member(1) + package: excel! + fullName: getTotalRowRange() + summary: Gets the range object associated with the totals row of the column. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const tableName = 'Table1'; + const columns = context.workbook.tables.getItem(tableName).columns.getItemAt(0); + const totalRowRange = columns.getTotalRowRange(); + totalRowRange.load('address'); + await context.sync(); + + console.log(totalRowRange.address); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getTotalRowRange(): Excel.Range;' + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.TableColumn#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.TableColumnLoadOptions): + Excel.TableColumn; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.TableColumn#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.TableColumn;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: |- + + + #### Examples + + ```TypeScript + await Excel.run(async (context) => { + const tableName = 'Table1'; + const column = context.workbook.tables.getItem(tableName).columns.getItem(0); + column.load('index'); + await context.sync(); + + console.log(column.index); + }); + ``` + - name: load(propertyNamesAndPaths) + uid: excel!Excel.TableColumn#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.TableColumn; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.TableColumn#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.TableColumnUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.TableColumn#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.TableColumn): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.TableColumn#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.TableColumn` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.TableColumnData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.TableColumnData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.tablecolumncollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.tablecolumncollection.yml new file mode 100644 index 0000000000..3a94e3f35e --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.tablecolumncollection.yml @@ -0,0 +1,425 @@ +### YamlMime:TSType +name: Excel.TableColumnCollection +uid: excel!Excel.TableColumnCollection:class +package: excel! +fullName: Excel.TableColumnCollection +summary: Represents a collection of all the columns that are part of the table. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml + + + // Add checkboxes to the table. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Get the second column in the table, without the header. + const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange(); + + // Change the boolean values to checkboxes. + range.control = { + type: Excel.CellControlType.checkbox + }; + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.TableColumnCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: count + uid: excel!Excel.TableColumnCollection#count:member + package: excel! + fullName: count + summary: Returns the number of columns in the table. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly count: number;' + return: + type: number + - name: items + uid: excel!Excel.TableColumnCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.TableColumn[];' + return: + type: [] +methods: + - name: add(index, values, name) + uid: excel!Excel.TableColumnCollection#add:member(1) + package: excel! + fullName: add(index, values, name) + summary: Adds a new column to the table. + remarks: >- + \[ [API set: ExcelApi 1.1 requires an index smaller than the total column + count; 1.4 allows index to be optional (null or -1) and will append a + column at the end; 1.4 allows name parameter at creation + time.](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const tables = context.workbook.tables; + const values = [["Sample"], ["Values"], ["For"], ["New"], ["Column"]]; + const column = tables.getItem("Table1").columns.add(null, values); + column.load('name'); + await context.sync(); + + console.log(column.name); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + add(index?: number, values?: Array> | + boolean | string | number, name?: string): Excel.TableColumn; + parameters: + - id: index + description: >- + Optional. Specifies the relative position of the new column. If null + or -1, the addition happens at the end. Columns with a higher index + will be shifted to the side. Zero-indexed. + type: number + - id: values + description: Optional. A 2D array of unformatted values of the table column. + type: >- + Array<Array<boolean | string | number>> | boolean | + string | number + - id: name + description: >- + Optional. Specifies the name of the new column. If `null`, + the default name will be used. + type: string + return: + type: + description: '' + - name: addAsJson(index, values, name) + uid: excel!Excel.TableColumnCollection#addAsJson:member(1) + package: excel! + fullName: addAsJson(index, values, name) + summary: >- + Adds a new column to the table. Unlike `add()`, `addAsJson()` + takes any type of cell value, such as image or entity data types. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + addAsJson(index?: number, values?: CellValue[][], name?: string): + Excel.TableColumn; + parameters: + - id: index + description: >- + Optional. Specifies the relative position of the new column. If null + or -1, the addition happens at the end. Columns with a higher index + will be shifted to the side. Zero-indexed. + type: number + - id: values + description: Optional. A 2D array of cell values of the table column. + type: [][] + - id: name + description: >- + Optional. Specifies the name of the new column. If `null`, + the default name will be used. + type: string + return: + type: + description: '' + - name: getCount() + uid: excel!Excel.TableColumnCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Gets the number of columns in the table. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getItem(key) + uid: excel!Excel.TableColumnCollection#getItem:member(1) + package: excel! + fullName: getItem(key) + summary: Gets a column object by name or ID. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const tableColumn = context.workbook.tables.getItem('Table1').columns.getItem(0); + tableColumn.load('name'); + await context.sync(); + console.log(tableColumn.name); + }); + + ``` + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml + + + // Remove all content from the Analysis column. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Get the second column in the table, without the header. + const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange(); + + // Clear all the data from the second column. + range.clearOrResetContents(); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getItem(key: number | string): Excel.TableColumn;' + parameters: + - id: key + description: Column name or ID. + type: number | string + return: + type: + description: '' + - name: getItemAt(index) + uid: excel!Excel.TableColumnCollection#getItemAt:member(1) + package: excel! + fullName: getItemAt(index) + summary: Gets a column based on its position in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const tableColumn = context.workbook.tables.getItem['Table1'].columns.getItemAt(0); + tableColumn.load('name'); + await context.sync(); + console.log(tableColumn.name); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemAt(index: number): Excel.TableColumn;' + parameters: + - id: index + description: Index value of the object to be retrieved. Zero-indexed. + type: number + return: + type: + description: '' + - name: getItemOrNullObject(key) + uid: excel!Excel.TableColumnCollection#getItemOrNullObject:member(1) + package: excel! + fullName: getItemOrNullObject(key) + summary: >- + Gets a column object by name or ID. If the column doesn't exist, then this + method returns an object with its `isNullObject` property set to + `true`. For further information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemOrNullObject(key: number | string): Excel.TableColumn;' + parameters: + - id: key + description: Column name or ID. + type: number | string + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.TableColumnCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.TableColumnCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): Excel.TableColumnCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.TableColumnCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.TableColumnCollection;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: |- + + + #### Examples + + ```TypeScript + await Excel.run(async (context) => { + const tableColumns = context.workbook.tables.getItem('Table1').columns; + tableColumns.load('items'); + await context.sync(); + + console.log("tableColumns Count: " + tableColumns.count); + for (let i = 0; i < tableColumns.items.length; i++) { + console.log(tableColumns.items[i].name); + } + }); + ``` + - name: load(propertyNamesAndPaths) + uid: excel!Excel.TableColumnCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.TableColumnCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.TableColumnCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.TableColumnCollection` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.TableColumnCollectionData`) that contains an + "items" array with shallow copies of any loaded properties from the + collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.TableColumnCollectionData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.tabledeletedeventargs.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.tabledeletedeventargs.yml new file mode 100644 index 0000000000..988746598a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.tabledeletedeventargs.yml @@ -0,0 +1,89 @@ +### YamlMime:TSType +name: Excel.TableDeletedEventArgs +uid: excel!Excel.TableDeletedEventArgs:interface +package: excel! +fullName: Excel.TableDeletedEventArgs +summary: Provides information about the table that raised the deleted event. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: source + uid: excel!Excel.TableDeletedEventArgs#source:member + package: excel! + fullName: source + summary: Gets the source of the event. See `Excel.EventSource` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'source: Excel.EventSource | "Local" | "Remote";' + return: + type: | "Local" | "Remote" + - name: tableId + uid: excel!Excel.TableDeletedEventArgs#tableId:member + package: excel! + fullName: tableId + summary: Gets the ID of the table that is deleted. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tableId: string;' + return: + type: string + - name: tableName + uid: excel!Excel.TableDeletedEventArgs#tableName:member + package: excel! + fullName: tableName + summary: Gets the name of the table that is deleted. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tableName: string;' + return: + type: string + - name: type + uid: excel!Excel.TableDeletedEventArgs#type:member + package: excel! + fullName: type + summary: Gets the type of the event. See `Excel.EventType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: "TableDeleted";' + return: + type: '"TableDeleted"' + - name: worksheetId + uid: excel!Excel.TableDeletedEventArgs#worksheetId:member + package: excel! + fullName: worksheetId + summary: Gets the ID of the worksheet in which the table is deleted. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheetId: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.tablerow.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.tablerow.yml new file mode 100644 index 0000000000..192f09c908 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.tablerow.yml @@ -0,0 +1,346 @@ +### YamlMime:TSType +name: Excel.TableRow +uid: excel!Excel.TableRow:class +package: excel! +fullName: Excel.TableRow +summary: >- + Represents a row in a table. + + + Note that unlike ranges or columns, which will adjust if new rows or columns + are added before them, a `TableRow` object represents the physical location of + the table row, but not the data. That is, if the data is sorted or if new rows + are added, a table row will continue to point at the index for which it was + created. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.TableRow#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: index + uid: excel!Excel.TableRow#index:member + package: excel! + fullName: index + summary: >- + Returns the index number of the row within the rows collection of the + table. Zero-indexed. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly index: number;' + return: + type: number + - name: values + uid: excel!Excel.TableRow#values:member + package: excel! + fullName: values + summary: >- + Represents the raw values of the specified range. The data returned could + be a string, number, or boolean. Cells that contain an error will return + the error string. If the returned value starts with a plus ("+"), minus + ("-"), or equal sign ("="), Excel interprets this value as a formula. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'values: any[][];' + return: + type: any[][] + - name: valuesAsJson + uid: excel!Excel.TableRow#valuesAsJson:member + package: excel! + fullName: valuesAsJson + summary: >- + A JSON representation of the values in the cells in this table row. Unlike + `TableRow.values`, `TableRow.valuesAsJson` supports all data types + which can be in a cell. Examples include formatted number values and web + images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the en-US locale. To + retrieve data in the user's display locale, use + `TableRow.valuesAsJsonLocal`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJson: CellValue[][];' + return: + type: [][] + - name: valuesAsJsonLocal + uid: excel!Excel.TableRow#valuesAsJsonLocal:member + package: excel! + fullName: valuesAsJsonLocal + summary: >- + A JSON representation of the values in the cells in this table row. Unlike + `TableRow.values`, `TableRow.valuesAsJsonLocal` supports all data + types which can be in a cell. Examples include formatted number values and + web images, in addition to the standard boolean, number, and string + values. Data returned from this API always aligns with the user's display + locale. To retrieve data independent of locale, use + `TableRow.valuesAsJson`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'valuesAsJsonLocal: CellValue[][];' + return: + type: [][] +methods: + - name: delete() + uid: excel!Excel.TableRow#delete:member(1) + package: excel! + fullName: delete() + summary: Deletes the row from the table. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const tableName = 'Table1'; + const row = context.workbook.tables.getItem(tableName).rows.getItemAt(2); + row.delete(); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'delete(): void;' + return: + type: void + description: '' + - name: getRange() + uid: excel!Excel.TableRow#getRange:member(1) + package: excel! + fullName: getRange() + summary: Returns the range object associated with the entire row. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const tableName = 'Table1'; + const row = context.workbook.tables.getItem(tableName).rows.getItemAt(0); + const rowRange = row.getRange(); + rowRange.load('address'); + await context.sync(); + + console.log(rowRange.address); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getRange(): Excel.Range;' + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.TableRow#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(options?: Excel.Interfaces.TableRowLoadOptions): Excel.TableRow;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.TableRow#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.TableRow;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: |- + + + #### Examples + + ```TypeScript + await Excel.run(async (context) => { + const tableName = 'Table1'; + const row = context.workbook.tables.getItem(tableName).rows.getItemAt(0); + row.load('index'); + await context.sync(); + + console.log(row.index); + }); + ``` + - name: load(propertyNamesAndPaths) + uid: excel!Excel.TableRow#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.TableRow; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.TableRow#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.TableRowUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.TableRow#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.TableRow): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.TableRow#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.TableRow` object + is an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Excel.Interfaces.TableRowData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.TableRowData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.tablerowcollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.tablerowcollection.yml new file mode 100644 index 0000000000..07268a5523 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.tablerowcollection.yml @@ -0,0 +1,351 @@ +### YamlMime:TSType +name: Excel.TableRowCollection +uid: excel!Excel.TableRowCollection:class +package: excel! +fullName: Excel.TableRowCollection +summary: >- + Represents a collection of all the rows that are part of the table. + + + Note that unlike ranges or columns, which will adjust if new rows or columns + are added before them, a `TableRow` object represents the physical location of + the table row, but not the data. That is, if the data is sorted or if new rows + are added, a table row will continue to point at the index for which it was + created. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.TableRowCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: count + uid: excel!Excel.TableRowCollection#count:member + package: excel! + fullName: count + summary: Returns the number of rows in the table. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly count: number;' + return: + type: number + - name: items + uid: excel!Excel.TableRowCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.TableRow[];' + return: + type: [] +methods: + - name: add(index, values, alwaysInsert) + uid: excel!Excel.TableRowCollection#add:member(1) + package: excel! + fullName: add(index, values, alwaysInsert) + summary: >- + Adds one or more rows to the table. The return object will be the top of + the newly added row(s). + + + Note that unlike ranges or columns, which will adjust if new rows or + columns are added before them, a `TableRow` object represents the physical + location of the table row, but not the data. That is, if the data is + sorted or if new rows are added, a table row will continue to point at the + index for which it was created. + remarks: >- + \[ [API set: ExcelApi 1.1 for adding a single row; 1.4 allows adding of + multiple rows; 1.15 for adding `alwaysInsert` + parameter.](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const tables = context.workbook.tables; + const values = [["Sample", "Values", "For", "New", "Row"]]; + const row = tables.getItem("Table1").rows.add(null, values); + row.load('index'); + await context.sync(); + + console.log(row.index); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + add(index?: number, values?: Array> | + boolean | string | number, alwaysInsert?: boolean): Excel.TableRow; + parameters: + - id: index + description: >- + Optional. Specifies the relative position of the new row. If null or + -1, the addition happens at the end. Any rows below the inserted row + are shifted downwards. Zero-indexed. + type: number + - id: values + description: Optional. A 2D array of unformatted values of the table row. + type: >- + Array<Array<boolean | string | number>> | boolean | + string | number + - id: alwaysInsert + description: >- + Optional. Specifies whether the new rows will be inserted into the + table when new rows are added. If `true`, the new rows will + be inserted into the table. If `false`, the new rows will be + added below the table. Default is `true`. + type: boolean + return: + type: + description: '' + - name: addAsJson(index, values, alwaysInsert) + uid: excel!Excel.TableRowCollection#addAsJson:member(1) + package: excel! + fullName: addAsJson(index, values, alwaysInsert) + summary: >- + Adds one or more rows to the table. The returned object will be the top + row of the newly added row or rows. Unlike `add()`, `addAsJson()` + takes any type of cell value, such as image or entity data types. + + + Note that unlike ranges or columns, which will adjust if new rows or + columns are added before them, a `TableRow` object represents the physical + location of the table row, but not the data. That is, if the data is + sorted or if new rows are added, a table row will continue to point at the + index for which it was created. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + addAsJson(index?: number, values?: CellValue[][], alwaysInsert?: + boolean): Excel.TableRow; + parameters: + - id: index + description: >- + Optional. Specifies the relative position of the new row. If null or + -1, the addition happens at the end. Any rows below the inserted row + are shifted downwards. Zero-indexed. + type: number + - id: values + description: Optional. A 2D array of cell values of the table row. + type: [][] + - id: alwaysInsert + description: >- + Optional. Specifies whether the new rows will be inserted into the + table when new rows are added. If `true`, the new rows will + be inserted into the table. If `false`, the new rows will be + added below the table. Default is `true`. + type: boolean + return: + type: + description: '' + - name: getCount() + uid: excel!Excel.TableRowCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Gets the number of rows in the table. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getItemAt(index) + uid: excel!Excel.TableRowCollection#getItemAt:member(1) + package: excel! + fullName: getItemAt(index) + summary: >- + Gets a row based on its position in the collection. + + + Note that unlike ranges or columns, which will adjust if new rows or + columns are added before them, a `TableRow` object represents the physical + location of the table row, but not the data. That is, if the data is + sorted or if new rows are added, a table row will continue to point at the + index for which it was created. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const tablerow = context.workbook.tables.getItem('Table1').rows.getItemAt(0); + tablerow.load('values'); + await context.sync(); + console.log(tablerow.values); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemAt(index: number): Excel.TableRow;' + parameters: + - id: index + description: Index value of the object to be retrieved. Zero-indexed. + type: number + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.TableRowCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.TableRowCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): Excel.TableRowCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.TableRowCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.TableRowCollection;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: |- + + + #### Examples + + ```TypeScript + await Excel.run(async (context) => { + const tablerows = context.workbook.tables.getItem('Table1').rows; + tablerows.load('items'); + await context.sync(); + + console.log("tablerows Count: " + tablerows.count); + for (let i = 0; i < tablerows.items.length; i++) { + console.log(tablerows.items[i].index); + } + }); + ``` + - name: load(propertyNamesAndPaths) + uid: excel!Excel.TableRowCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.TableRowCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.TableRowCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.TableRowCollection` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.TableRowCollectionData`) that contains an + "items" array with shallow copies of any loaded properties from the + collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.TableRowCollectionData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.tablescopedcollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.tablescopedcollection.yml new file mode 100644 index 0000000000..a9d7052d78 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.tablescopedcollection.yml @@ -0,0 +1,227 @@ +### YamlMime:TSType +name: Excel.TableScopedCollection +uid: excel!Excel.TableScopedCollection:class +package: excel! +fullName: Excel.TableScopedCollection +summary: >- + Represents a scoped collection of tables. For each table its top-left corner + is considered its anchor location, and the tables are sorted top-to-bottom and + then left-to-right. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.TableScopedCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: excel!Excel.TableScopedCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.Table[];' + return: + type: [] +methods: + - name: getCount() + uid: excel!Excel.TableScopedCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Gets the number of tables in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getFirst() + uid: excel!Excel.TableScopedCollection#getFirst:member(1) + package: excel! + fullName: getFirst() + summary: >- + Gets the first table in the collection. The tables in the collection are + sorted top-to-bottom and left-to-right, such that top-left table is the + first table in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getFirst(): Excel.Table;' + return: + type: + description: '' + - name: getItem(key) + uid: excel!Excel.TableScopedCollection#getItem:member(1) + package: excel! + fullName: getItem(key) + summary: Gets a table by name or ID. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItem(key: string): Excel.Table;' + parameters: + - id: key + description: Name or ID of the table to be retrieved. + type: string + return: + type: + description: '' + - name: getItemOrNullObject(key) + uid: excel!Excel.TableScopedCollection#getItemOrNullObject:member(1) + package: excel! + fullName: getItemOrNullObject(key) + summary: >- + Gets a table by name or ID. If the table object does not exist, then this + method returns an object with its `isNullObject` property set to + `true`. For further information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemOrNullObject(key: string): Excel.Table;' + parameters: + - id: key + description: Name or ID of the table to be retrieved. + type: string + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.TableScopedCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.TableScopedCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): Excel.TableScopedCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.TableScopedCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.TableScopedCollection;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.TableScopedCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.TableScopedCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.TableScopedCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.TableScopedCollection` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.TableScopedCollectionData`) that contains an + "items" array with shallow copies of any loaded properties from the + collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.TableScopedCollectionData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.tableselectionchangedeventargs.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.tableselectionchangedeventargs.yml new file mode 100644 index 0000000000..4671578fb5 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.tableselectionchangedeventargs.yml @@ -0,0 +1,111 @@ +### YamlMime:TSType +name: Excel.TableSelectionChangedEventArgs +uid: excel!Excel.TableSelectionChangedEventArgs:interface +package: excel! +fullName: Excel.TableSelectionChangedEventArgs +summary: Provides information about the table that raised the selection changed event. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: address + uid: excel!Excel.TableSelectionChangedEventArgs#address:member + package: excel! + fullName: address + summary: >- + Gets the range address that represents the selected area of the table on a + specific worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-table-changed.yaml + + + async function onSelectionChange(args) { + await Excel.run(async (context) => { + console.log("Handler for table onSelectionChanged event has been triggered. The new selection is: " + args.address); + }); + } + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'address: string;' + return: + type: string + - name: isInsideTable + uid: excel!Excel.TableSelectionChangedEventArgs#isInsideTable:member + package: excel! + fullName: isInsideTable + summary: >- + Specifies if the selection is inside a table. `IsInsideTable` must be set + to `true` for the address to be useful. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'isInsideTable: boolean;' + return: + type: boolean + - name: tableId + uid: excel!Excel.TableSelectionChangedEventArgs#tableId:member + package: excel! + fullName: tableId + summary: Gets the ID of the table in which the selection changed. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'tableId: string;' + return: + type: string + - name: type + uid: excel!Excel.TableSelectionChangedEventArgs#type:member + package: excel! + fullName: type + summary: Gets the type of the event. See `Excel.EventType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: "TableSelectionChanged";' + return: + type: '"TableSelectionChanged"' + - name: worksheetId + uid: excel!Excel.TableSelectionChangedEventArgs#worksheetId:member + package: excel! + fullName: worksheetId + summary: Gets the ID of the worksheet in which the selection changed. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheetId: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.tablesort.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.tablesort.yml new file mode 100644 index 0000000000..89bc664568 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.tablesort.yml @@ -0,0 +1,283 @@ +### YamlMime:TSType +name: Excel.TableSort +uid: excel!Excel.TableSort:class +package: excel! +fullName: Excel.TableSort +summary: Manages sorting operations on `Table` objects. +remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.TableSort#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: fields + uid: excel!Excel.TableSort#fields:member + package: excel! + fullName: fields + summary: Specifies the current conditions used to last sort the table. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly fields: Excel.SortField[];' + return: + type: [] + - name: matchCase + uid: excel!Excel.TableSort#matchCase:member + package: excel! + fullName: matchCase + summary: Specifies if the casing impacts the last sort of the table. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly matchCase: boolean;' + return: + type: boolean + - name: method + uid: excel!Excel.TableSort#method:member + package: excel! + fullName: method + summary: >- + Represents the Chinese character ordering method last used to sort the + table. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly method: Excel.SortMethod | "PinYin" | "StrokeCount";' + return: + type: | "PinYin" | "StrokeCount" +methods: + - name: apply(fields, matchCase, method) + uid: excel!Excel.TableSort#apply:member(1) + package: excel! + fullName: apply(fields, matchCase, method) + summary: Perform a sort operation. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const tableName = 'Table1'; + const table = context.workbook.tables.getItem(tableName); + table.sort.apply([ + { + key: 2, + ascending: true + }, + ], true); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + apply(fields: Excel.SortField[], matchCase?: boolean, method?: + Excel.SortMethod): void; + parameters: + - id: fields + description: The list of conditions to sort on. + type: [] + - id: matchCase + description: Optional. Whether to have the casing impact string ordering. + type: boolean + - id: method + description: Optional. The ordering method used for Chinese characters. + type: + return: + type: void + description: '' + - name: apply(fields, matchCase, method) + uid: excel!Excel.TableSort#apply:member(2) + package: excel! + fullName: apply(fields, matchCase, method) + summary: Perform a sort operation. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + apply(fields: Excel.SortField[], matchCase?: boolean, method?: "PinYin" + | "StrokeCount"): void; + parameters: + - id: fields + description: The list of conditions to sort on. + type: [] + - id: matchCase + description: Optional. Whether to have the casing impact string ordering. + type: boolean + - id: method + description: Optional. The ordering method used for Chinese characters. + type: '"PinYin" | "StrokeCount"' + return: + type: void + description: '' + - name: clear() + uid: excel!Excel.TableSort#clear:member(1) + package: excel! + fullName: clear() + summary: >- + Clears the sorting that is currently on the table. While this doesn't + modify the table's ordering, it clears the state of the header buttons. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'clear(): void;' + return: + type: void + description: '' + - name: load(options) + uid: excel!Excel.TableSort#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(options?: Excel.Interfaces.TableSortLoadOptions): Excel.TableSort;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.TableSort#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.TableSort;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.TableSort#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.TableSort; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: reapply() + uid: excel!Excel.TableSort#reapply:member(1) + package: excel! + fullName: reapply() + summary: Reapplies the current sorting parameters to the table. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'reapply(): void;' + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.TableSort#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.TableSort` object + is an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Excel.Interfaces.TableSortData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.TableSortData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.tablestyle.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.tablestyle.yml new file mode 100644 index 0000000000..2f1332fbe0 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.tablestyle.yml @@ -0,0 +1,253 @@ +### YamlMime:TSType +name: Excel.TableStyle +uid: excel!Excel.TableStyle:class +package: excel! +fullName: Excel.TableStyle +summary: >- + Represents a table style, which defines the style elements by region of the + table. +remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.TableStyle#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: name + uid: excel!Excel.TableStyle#name:member + package: excel! + fullName: name + summary: Specifies the name of the table style. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name: string;' + return: + type: string + - name: readOnly + uid: excel!Excel.TableStyle#readOnly:member + package: excel! + fullName: readOnly + summary: Specifies if this `TableStyle` object is read-only. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly readOnly: boolean;' + return: + type: boolean +methods: + - name: delete() + uid: excel!Excel.TableStyle#delete:member(1) + package: excel! + fullName: delete() + summary: Deletes the table style. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'delete(): void;' + return: + type: void + description: '' + - name: duplicate() + uid: excel!Excel.TableStyle#duplicate:member(1) + package: excel! + fullName: duplicate() + summary: >- + Creates a duplicate of this table style with copies of all the style + elements. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'duplicate(): Excel.TableStyle;' + return: + type: + description: >- + The new `TableStyle` object that has been duplicated from this table + style. + - name: load(options) + uid: excel!Excel.TableStyle#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.TableStyleLoadOptions): + Excel.TableStyle; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.TableStyle#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.TableStyle;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.TableStyle#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.TableStyle; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.TableStyle#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.TableStyleUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.TableStyle#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.TableStyle): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.TableStyle#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.TableStyle` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.TableStyleData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.TableStyleData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.tablestylecollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.tablestylecollection.yml new file mode 100644 index 0000000000..54f8508b97 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.tablestylecollection.yml @@ -0,0 +1,275 @@ +### YamlMime:TSType +name: Excel.TableStyleCollection +uid: excel!Excel.TableStyleCollection:class +package: excel! +fullName: Excel.TableStyleCollection +summary: Represents a collection of table styles. +remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.TableStyleCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: excel!Excel.TableStyleCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.TableStyle[];' + return: + type: [] +methods: + - name: add(name, makeUniqueName) + uid: excel!Excel.TableStyleCollection#add:member(1) + package: excel! + fullName: add(name, makeUniqueName) + summary: Creates a blank `TableStyle` with the specified name. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'add(name: string, makeUniqueName?: boolean): Excel.TableStyle;' + parameters: + - id: name + description: >- + The unique name for the new table style. Will throw an + `InvalidArgument` error if the name is already in use. + type: string + - id: makeUniqueName + description: >- + Optional. Defaults to `false`. If `true`, will + append numbers to the name in order to make it unique, if needed. + type: boolean + return: + type: + description: The newly created `TableStyle`. + - name: getCount() + uid: excel!Excel.TableStyleCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Gets the number of table styles in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getDefault() + uid: excel!Excel.TableStyleCollection#getDefault:member(1) + package: excel! + fullName: getDefault() + summary: Gets the default table style for the parent object's scope. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getDefault(): Excel.TableStyle;' + return: + type: + description: The `TableStyle` object that is the current default table style. + - name: getItem(name) + uid: excel!Excel.TableStyleCollection#getItem:member(1) + package: excel! + fullName: getItem(name) + summary: Gets a `TableStyle` by name. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItem(name: string): Excel.TableStyle;' + parameters: + - id: name + description: Name of the table style to be retrieved. + type: string + return: + type: + description: The `TableStyle` object whose name matches the input. + - name: getItemOrNullObject(name) + uid: excel!Excel.TableStyleCollection#getItemOrNullObject:member(1) + package: excel! + fullName: getItemOrNullObject(name) + summary: >- + Gets a `TableStyle` by name. If the table style does not exist, then this + method returns an object with its `isNullObject` property set to + `true`. For further information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemOrNullObject(name: string): Excel.TableStyle;' + parameters: + - id: name + description: Name of the table style to be retrieved. + type: string + return: + type: + description: The `TableStyle` object whose name matches the input. + - name: load(options) + uid: excel!Excel.TableStyleCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.TableStyleCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): Excel.TableStyleCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.TableStyleCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.TableStyleCollection;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.TableStyleCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.TableStyleCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: setDefault(newDefaultStyle) + uid: excel!Excel.TableStyleCollection#setDefault:member(1) + package: excel! + fullName: setDefault(newDefaultStyle) + summary: Sets the default table style for use in the parent object's scope. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'setDefault(newDefaultStyle: TableStyle | string): void;' + parameters: + - id: newDefaultStyle + description: >- + The `TableStyle` object, or name of the `TableStyle` object, that + should be the new default. + type: | string + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.TableStyleCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.TableStyleCollection` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.TableStyleCollectionData`) that contains an + "items" array with shallow copies of any loaded properties from the + collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.TableStyleCollectionData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.textconditionalformat.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.textconditionalformat.yml new file mode 100644 index 0000000000..8902c03bed --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.textconditionalformat.yml @@ -0,0 +1,266 @@ +### YamlMime:TSType +name: Excel.TextConditionalFormat +uid: excel!Excel.TextConditionalFormat:class +package: excel! +fullName: Excel.TextConditionalFormat +summary: Represents a specific text conditional format. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.TextConditionalFormat#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: format + uid: excel!Excel.TextConditionalFormat#format:member + package: excel! + fullName: format + summary: >- + Returns a format object, encapsulating the conditional format's font, + fill, borders, and other properties. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const range = sheet.getRange("B16:D18"); + const conditionalFormat = range.conditionalFormats + .add(Excel.ConditionalFormatType.containsText); + conditionalFormat.textComparison.format.font.color = "red"; + conditionalFormat.textComparison.rule = { operator: Excel.ConditionalTextOperator.contains, text: "Delayed" }; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly format: Excel.ConditionalRangeFormat;' + return: + type: + - name: rule + uid: excel!Excel.TextConditionalFormat#rule:member + package: excel! + fullName: rule + summary: The rule of the conditional format. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const range = sheet.getRange("B16:D18"); + const conditionalFormat = range.conditionalFormats + .add(Excel.ConditionalFormatType.containsText); + conditionalFormat.textComparison.format.font.color = "red"; + conditionalFormat.textComparison.rule = { operator: Excel.ConditionalTextOperator.contains, text: "Delayed" }; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'rule: Excel.ConditionalTextComparisonRule;' + return: + type: +methods: + - name: load(options) + uid: excel!Excel.TextConditionalFormat#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.TextConditionalFormatLoadOptions): + Excel.TextConditionalFormat; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.TextConditionalFormat#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.TextConditionalFormat;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.TextConditionalFormat#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.TextConditionalFormat; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.TextConditionalFormat#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.TextConditionalFormatUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.TextConditionalFormat#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.TextConditionalFormat): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.TextConditionalFormat#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.TextConditionalFormat` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.TextConditionalFormatData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.TextConditionalFormatData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.textframe.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.textframe.yml new file mode 100644 index 0000000000..013fee0467 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.textframe.yml @@ -0,0 +1,457 @@ +### YamlMime:TSType +name: Excel.TextFrame +uid: excel!Excel.TextFrame:class +package: excel! +fullName: Excel.TextFrame +summary: Represents the text frame of a shape object. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: autoSizeSetting + uid: excel!Excel.TextFrame#autoSizeSetting:member + package: excel! + fullName: autoSizeSetting + summary: >- + The automatic sizing settings for the text frame. A text frame can be set + to automatically fit the text to the text frame, to automatically fit the + text frame to the text, or not perform any automatic sizing. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + autoSizeSetting: Excel.ShapeAutoSize | "AutoSizeNone" | + "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed"; + return: + type: >- + | "AutoSizeNone" | + "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed" + - name: bottomMargin + uid: excel!Excel.TextFrame#bottomMargin:member + package: excel! + fullName: bottomMargin + summary: Represents the bottom margin, in points, of the text frame. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'bottomMargin: number;' + return: + type: number + - name: context + uid: excel!Excel.TextFrame#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: hasText + uid: excel!Excel.TextFrame#hasText:member + package: excel! + fullName: hasText + summary: Specifies if the text frame contains text. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly hasText: boolean;' + return: + type: boolean + - name: horizontalAlignment + uid: excel!Excel.TextFrame#horizontalAlignment:member + package: excel! + fullName: horizontalAlignment + summary: >- + Represents the horizontal alignment of the text frame. See + `Excel.ShapeTextHorizontalAlignment` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + horizontalAlignment: Excel.ShapeTextHorizontalAlignment | "Left" | + "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | + "ThaiDistributed"; + return: + type: >- + | "Left" + | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | + "ThaiDistributed" + - name: horizontalOverflow + uid: excel!Excel.TextFrame#horizontalOverflow:member + package: excel! + fullName: horizontalOverflow + summary: >- + Represents the horizontal overflow behavior of the text frame. See + `Excel.ShapeTextHorizontalOverflow` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + horizontalOverflow: Excel.ShapeTextHorizontalOverflow | "Overflow" | + "Clip"; + return: + type: >- + | + "Overflow" | "Clip" + - name: leftMargin + uid: excel!Excel.TextFrame#leftMargin:member + package: excel! + fullName: leftMargin + summary: Represents the left margin, in points, of the text frame. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'leftMargin: number;' + return: + type: number + - name: orientation + uid: excel!Excel.TextFrame#orientation:member + package: excel! + fullName: orientation + summary: >- + Represents the angle to which the text is oriented for the text frame. See + `Excel.ShapeTextOrientation` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + orientation: Excel.ShapeTextOrientation | "Horizontal" | "Vertical" | + "Vertical270" | "WordArtVertical" | "EastAsianVertical" | + "MongolianVertical" | "WordArtVerticalRTL"; + return: + type: >- + | "Horizontal" | + "Vertical" | "Vertical270" | "WordArtVertical" | "EastAsianVertical" | + "MongolianVertical" | "WordArtVerticalRTL" + - name: readingOrder + uid: excel!Excel.TextFrame#readingOrder:member + package: excel! + fullName: readingOrder + summary: >- + Represents the reading order of the text frame, either left-to-right or + right-to-left. See `Excel.ShapeTextReadingOrder` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readingOrder: Excel.ShapeTextReadingOrder | "LeftToRight" | + "RightToLeft"; + return: + type: >- + | "LeftToRight" + | "RightToLeft" + - name: rightMargin + uid: excel!Excel.TextFrame#rightMargin:member + package: excel! + fullName: rightMargin + summary: Represents the right margin, in points, of the text frame. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rightMargin: number;' + return: + type: number + - name: textRange + uid: excel!Excel.TextFrame#textRange:member + package: excel! + fullName: textRange + summary: >- + Represents the text that is attached to a shape in the text frame, and + properties and methods for manipulating the text. See `Excel.TextRange` + for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly textRange: Excel.TextRange;' + return: + type: + - name: topMargin + uid: excel!Excel.TextFrame#topMargin:member + package: excel! + fullName: topMargin + summary: Represents the top margin, in points, of the text frame. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'topMargin: number;' + return: + type: number + - name: verticalAlignment + uid: excel!Excel.TextFrame#verticalAlignment:member + package: excel! + fullName: verticalAlignment + summary: >- + Represents the vertical alignment of the text frame. See + `Excel.ShapeTextVerticalAlignment` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + verticalAlignment: Excel.ShapeTextVerticalAlignment | "Top" | "Middle" | + "Bottom" | "Justified" | "Distributed"; + return: + type: >- + | "Top" | + "Middle" | "Bottom" | "Justified" | "Distributed" + - name: verticalOverflow + uid: excel!Excel.TextFrame#verticalOverflow:member + package: excel! + fullName: verticalOverflow + summary: >- + Represents the vertical overflow behavior of the text frame. See + `Excel.ShapeTextVerticalOverflow` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + verticalOverflow: Excel.ShapeTextVerticalOverflow | "Overflow" | + "Ellipsis" | "Clip"; + return: + type: >- + | "Overflow" + | "Ellipsis" | "Clip" +methods: + - name: deleteText() + uid: excel!Excel.TextFrame#deleteText:member(1) + package: excel! + fullName: deleteText() + summary: Deletes all the text in the text frame. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-textboxes.yaml + + + await Excel.run(async (context) => { + const shapes = context.workbook.worksheets.getItem("Shapes").shapes; + const textbox = shapes.getItem("Textbox"); + textbox.textFrame.deleteText(); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'deleteText(): void;' + return: + type: void + description: '' + - name: load(options) + uid: excel!Excel.TextFrame#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(options?: Excel.Interfaces.TextFrameLoadOptions): Excel.TextFrame;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.TextFrame#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.TextFrame;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.TextFrame#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.TextFrame; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.TextFrame#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.TextFrameUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.TextFrame#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.TextFrame): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.TextFrame#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.TextFrame` object + is an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Excel.Interfaces.TextFrameData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.TextFrameData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.textrange.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.textrange.yml new file mode 100644 index 0000000000..1f98384147 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.textrange.yml @@ -0,0 +1,239 @@ +### YamlMime:TSType +name: Excel.TextRange +uid: excel!Excel.TextRange:class +package: excel! +fullName: Excel.TextRange +summary: >- + Contains the text that is attached to a shape, in addition to properties and + methods for manipulating the text. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.TextRange#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: font + uid: excel!Excel.TextRange#font:member + package: excel! + fullName: font + summary: >- + Returns a `ShapeFont` object that represents the font attributes for the + text range. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly font: Excel.ShapeFont;' + return: + type: + - name: text + uid: excel!Excel.TextRange#text:member + package: excel! + fullName: text + summary: Represents the plain text content of the text range. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'text: string;' + return: + type: string +methods: + - name: getSubstring(start, length) + uid: excel!Excel.TextRange#getSubstring:member(1) + package: excel! + fullName: getSubstring(start, length) + summary: Returns a TextRange object for the substring in the given range. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getSubstring(start: number, length?: number): Excel.TextRange;' + parameters: + - id: start + description: >- + The zero-based index of the first character to get from the text + range. + type: number + - id: length + description: >- + Optional. The number of characters to be returned in the new text + range. If length is omitted, all the characters from start to the + end of the text range's last paragraph will be returned. + type: number + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.TextRange#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(options?: Excel.Interfaces.TextRangeLoadOptions): Excel.TextRange;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.TextRange#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.TextRange;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.TextRange#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.TextRange; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.TextRange#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.TextRangeUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.TextRange#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.TextRange): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.TextRange#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.TextRange` object + is an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Excel.Interfaces.TextRangeData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.TextRangeData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.threearrowsgrayset.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.threearrowsgrayset.yml new file mode 100644 index 0000000000..4b965c0f21 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.threearrowsgrayset.yml @@ -0,0 +1,53 @@ +### YamlMime:TSType +name: Excel.ThreeArrowsGraySet +uid: excel!Excel.ThreeArrowsGraySet:interface +package: excel! +fullName: Excel.ThreeArrowsGraySet +summary: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: grayDownArrow + uid: excel!Excel.ThreeArrowsGraySet#grayDownArrow:member + package: excel! + fullName: grayDownArrow + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'grayDownArrow: Icon;' + return: + type: + - name: graySideArrow + uid: excel!Excel.ThreeArrowsGraySet#graySideArrow:member + package: excel! + fullName: graySideArrow + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'graySideArrow: Icon;' + return: + type: + - name: grayUpArrow + uid: excel!Excel.ThreeArrowsGraySet#grayUpArrow:member + package: excel! + fullName: grayUpArrow + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'grayUpArrow: Icon;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.threearrowsset.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.threearrowsset.yml new file mode 100644 index 0000000000..0ce333c31a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.threearrowsset.yml @@ -0,0 +1,53 @@ +### YamlMime:TSType +name: Excel.ThreeArrowsSet +uid: excel!Excel.ThreeArrowsSet:interface +package: excel! +fullName: Excel.ThreeArrowsSet +summary: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: greenUpArrow + uid: excel!Excel.ThreeArrowsSet#greenUpArrow:member + package: excel! + fullName: greenUpArrow + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'greenUpArrow: Icon;' + return: + type: + - name: redDownArrow + uid: excel!Excel.ThreeArrowsSet#redDownArrow:member + package: excel! + fullName: redDownArrow + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'redDownArrow: Icon;' + return: + type: + - name: yellowSideArrow + uid: excel!Excel.ThreeArrowsSet#yellowSideArrow:member + package: excel! + fullName: yellowSideArrow + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'yellowSideArrow: Icon;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.threeflagsset.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.threeflagsset.yml new file mode 100644 index 0000000000..df53b419d0 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.threeflagsset.yml @@ -0,0 +1,53 @@ +### YamlMime:TSType +name: Excel.ThreeFlagsSet +uid: excel!Excel.ThreeFlagsSet:interface +package: excel! +fullName: Excel.ThreeFlagsSet +summary: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: greenFlag + uid: excel!Excel.ThreeFlagsSet#greenFlag:member + package: excel! + fullName: greenFlag + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'greenFlag: Icon;' + return: + type: + - name: redFlag + uid: excel!Excel.ThreeFlagsSet#redFlag:member + package: excel! + fullName: redFlag + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'redFlag: Icon;' + return: + type: + - name: yellowFlag + uid: excel!Excel.ThreeFlagsSet#yellowFlag:member + package: excel! + fullName: yellowFlag + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'yellowFlag: Icon;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.threesignsset.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.threesignsset.yml new file mode 100644 index 0000000000..f9164ddaec --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.threesignsset.yml @@ -0,0 +1,53 @@ +### YamlMime:TSType +name: Excel.ThreeSignsSet +uid: excel!Excel.ThreeSignsSet:interface +package: excel! +fullName: Excel.ThreeSignsSet +summary: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: greenCircle + uid: excel!Excel.ThreeSignsSet#greenCircle:member + package: excel! + fullName: greenCircle + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'greenCircle: Icon;' + return: + type: + - name: redDiamond + uid: excel!Excel.ThreeSignsSet#redDiamond:member + package: excel! + fullName: redDiamond + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'redDiamond: Icon;' + return: + type: + - name: yellowTriangle + uid: excel!Excel.ThreeSignsSet#yellowTriangle:member + package: excel! + fullName: yellowTriangle + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'yellowTriangle: Icon;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.threestarsset.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.threestarsset.yml new file mode 100644 index 0000000000..0eebfa60f4 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.threestarsset.yml @@ -0,0 +1,53 @@ +### YamlMime:TSType +name: Excel.ThreeStarsSet +uid: excel!Excel.ThreeStarsSet:interface +package: excel! +fullName: Excel.ThreeStarsSet +summary: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: goldStar + uid: excel!Excel.ThreeStarsSet#goldStar:member + package: excel! + fullName: goldStar + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'goldStar: Icon;' + return: + type: + - name: halfGoldStar + uid: excel!Excel.ThreeStarsSet#halfGoldStar:member + package: excel! + fullName: halfGoldStar + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'halfGoldStar: Icon;' + return: + type: + - name: silverStar + uid: excel!Excel.ThreeStarsSet#silverStar:member + package: excel! + fullName: silverStar + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'silverStar: Icon;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.threesymbols2set.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.threesymbols2set.yml new file mode 100644 index 0000000000..7ca19a7f80 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.threesymbols2set.yml @@ -0,0 +1,53 @@ +### YamlMime:TSType +name: Excel.ThreeSymbols2Set +uid: excel!Excel.ThreeSymbols2Set:interface +package: excel! +fullName: Excel.ThreeSymbols2Set +summary: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: greenCheck + uid: excel!Excel.ThreeSymbols2Set#greenCheck:member + package: excel! + fullName: greenCheck + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'greenCheck: Icon;' + return: + type: + - name: redCross + uid: excel!Excel.ThreeSymbols2Set#redCross:member + package: excel! + fullName: redCross + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'redCross: Icon;' + return: + type: + - name: yellowExclamation + uid: excel!Excel.ThreeSymbols2Set#yellowExclamation:member + package: excel! + fullName: yellowExclamation + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'yellowExclamation: Icon;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.threesymbolsset.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.threesymbolsset.yml new file mode 100644 index 0000000000..a986c6d8a5 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.threesymbolsset.yml @@ -0,0 +1,53 @@ +### YamlMime:TSType +name: Excel.ThreeSymbolsSet +uid: excel!Excel.ThreeSymbolsSet:interface +package: excel! +fullName: Excel.ThreeSymbolsSet +summary: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: greenCheckSymbol + uid: excel!Excel.ThreeSymbolsSet#greenCheckSymbol:member + package: excel! + fullName: greenCheckSymbol + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'greenCheckSymbol: Icon;' + return: + type: + - name: redCrossSymbol + uid: excel!Excel.ThreeSymbolsSet#redCrossSymbol:member + package: excel! + fullName: redCrossSymbol + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'redCrossSymbol: Icon;' + return: + type: + - name: yellowExclamationSymbol + uid: excel!Excel.ThreeSymbolsSet#yellowExclamationSymbol:member + package: excel! + fullName: yellowExclamationSymbol + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'yellowExclamationSymbol: Icon;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.threetrafficlights1set.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.threetrafficlights1set.yml new file mode 100644 index 0000000000..17c0f3a0ae --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.threetrafficlights1set.yml @@ -0,0 +1,53 @@ +### YamlMime:TSType +name: Excel.ThreeTrafficLights1Set +uid: excel!Excel.ThreeTrafficLights1Set:interface +package: excel! +fullName: Excel.ThreeTrafficLights1Set +summary: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: greenCircle + uid: excel!Excel.ThreeTrafficLights1Set#greenCircle:member + package: excel! + fullName: greenCircle + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'greenCircle: Icon;' + return: + type: + - name: redCircleWithBorder + uid: excel!Excel.ThreeTrafficLights1Set#redCircleWithBorder:member + package: excel! + fullName: redCircleWithBorder + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'redCircleWithBorder: Icon;' + return: + type: + - name: yellowCircle + uid: excel!Excel.ThreeTrafficLights1Set#yellowCircle:member + package: excel! + fullName: yellowCircle + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'yellowCircle: Icon;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.threetrafficlights2set.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.threetrafficlights2set.yml new file mode 100644 index 0000000000..c8897fd117 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.threetrafficlights2set.yml @@ -0,0 +1,53 @@ +### YamlMime:TSType +name: Excel.ThreeTrafficLights2Set +uid: excel!Excel.ThreeTrafficLights2Set:interface +package: excel! +fullName: Excel.ThreeTrafficLights2Set +summary: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: greenTrafficLight + uid: excel!Excel.ThreeTrafficLights2Set#greenTrafficLight:member + package: excel! + fullName: greenTrafficLight + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'greenTrafficLight: Icon;' + return: + type: + - name: redTrafficLight + uid: excel!Excel.ThreeTrafficLights2Set#redTrafficLight:member + package: excel! + fullName: redTrafficLight + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'redTrafficLight: Icon;' + return: + type: + - name: yellowTrafficLight + uid: excel!Excel.ThreeTrafficLights2Set#yellowTrafficLight:member + package: excel! + fullName: yellowTrafficLight + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'yellowTrafficLight: Icon;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.threetrianglesset.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.threetrianglesset.yml new file mode 100644 index 0000000000..7471d104e2 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.threetrianglesset.yml @@ -0,0 +1,53 @@ +### YamlMime:TSType +name: Excel.ThreeTrianglesSet +uid: excel!Excel.ThreeTrianglesSet:interface +package: excel! +fullName: Excel.ThreeTrianglesSet +summary: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: greenUpTriangle + uid: excel!Excel.ThreeTrianglesSet#greenUpTriangle:member + package: excel! + fullName: greenUpTriangle + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'greenUpTriangle: Icon;' + return: + type: + - name: redDownTriangle + uid: excel!Excel.ThreeTrianglesSet#redDownTriangle:member + package: excel! + fullName: redDownTriangle + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'redDownTriangle: Icon;' + return: + type: + - name: yellowDash + uid: excel!Excel.ThreeTrianglesSet#yellowDash:member + package: excel! + fullName: yellowDash + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'yellowDash: Icon;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.timelinestyle.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.timelinestyle.yml new file mode 100644 index 0000000000..7614ac2139 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.timelinestyle.yml @@ -0,0 +1,256 @@ +### YamlMime:TSType +name: Excel.TimelineStyle +uid: excel!Excel.TimelineStyle:class +package: excel! +fullName: Excel.TimelineStyle +summary: >- + Represents a `TimelineStyle`, which defines style elements by region + in the timeline. +remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.TimelineStyle#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: name + uid: excel!Excel.TimelineStyle#name:member + package: excel! + fullName: name + summary: Specifies the name of the timeline style. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name: string;' + return: + type: string + - name: readOnly + uid: excel!Excel.TimelineStyle#readOnly:member + package: excel! + fullName: readOnly + summary: Specifies if this `TimelineStyle` object is read-only. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly readOnly: boolean;' + return: + type: boolean +methods: + - name: delete() + uid: excel!Excel.TimelineStyle#delete:member(1) + package: excel! + fullName: delete() + summary: Deletes the table style. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'delete(): void;' + return: + type: void + description: '' + - name: duplicate() + uid: excel!Excel.TimelineStyle#duplicate:member(1) + package: excel! + fullName: duplicate() + summary: >- + Creates a duplicate of this timeline style with copies of all the style + elements. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'duplicate(): Excel.TimelineStyle;' + return: + type: + description: >- + The new `TimelineStyle` object that has been duplicated from this + timeline style. + - name: load(options) + uid: excel!Excel.TimelineStyle#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.TimelineStyleLoadOptions): + Excel.TimelineStyle; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.TimelineStyle#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.TimelineStyle;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.TimelineStyle#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.TimelineStyle; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.TimelineStyle#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.TimelineStyleUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.TimelineStyle#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.TimelineStyle): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.TimelineStyle#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.TimelineStyle` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.TimelineStyleData`) that + contains shallow copies of any loaded child properties from the original + object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.TimelineStyleData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.timelinestylecollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.timelinestylecollection.yml new file mode 100644 index 0000000000..2cf30f035a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.timelinestylecollection.yml @@ -0,0 +1,275 @@ +### YamlMime:TSType +name: Excel.TimelineStyleCollection +uid: excel!Excel.TimelineStyleCollection:class +package: excel! +fullName: Excel.TimelineStyleCollection +summary: Represents a collection of timeline styles. +remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.TimelineStyleCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: excel!Excel.TimelineStyleCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.TimelineStyle[];' + return: + type: [] +methods: + - name: add(name, makeUniqueName) + uid: excel!Excel.TimelineStyleCollection#add:member(1) + package: excel! + fullName: add(name, makeUniqueName) + summary: Creates a blank `TimelineStyle` with the specified name. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'add(name: string, makeUniqueName?: boolean): Excel.TimelineStyle;' + parameters: + - id: name + description: >- + The unique name for the new timeline style. Will throw an + `InvalidArgument` error if the name is already in use. + type: string + - id: makeUniqueName + description: >- + Optional. Defaults to `false`. If `true`, will + append numbers to the name in order to make it unique, if needed. + type: boolean + return: + type: + description: The newly created `TimelineStyle`. + - name: getCount() + uid: excel!Excel.TimelineStyleCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Gets the number of timeline styles in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getDefault() + uid: excel!Excel.TimelineStyleCollection#getDefault:member(1) + package: excel! + fullName: getDefault() + summary: Gets the default timeline style for the parent object's scope. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getDefault(): Excel.TimelineStyle;' + return: + type: + description: The `TimelineStyle` object that is the current default timeline style. + - name: getItem(name) + uid: excel!Excel.TimelineStyleCollection#getItem:member(1) + package: excel! + fullName: getItem(name) + summary: Gets a `TimelineStyle` by name. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItem(name: string): Excel.TimelineStyle;' + parameters: + - id: name + description: Name of the timeline style to be retrieved. + type: string + return: + type: + description: The `TimelineStyle` object whose name matches the input. + - name: getItemOrNullObject(name) + uid: excel!Excel.TimelineStyleCollection#getItemOrNullObject:member(1) + package: excel! + fullName: getItemOrNullObject(name) + summary: >- + Gets a `TimelineStyle` by name. If the timeline style doesn't exist, then + this method returns an object with its `isNullObject` property set to + `true`. For further information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemOrNullObject(name: string): Excel.TimelineStyle;' + parameters: + - id: name + description: Name of the timeline style to be retrieved. + type: string + return: + type: + description: The `TimelineStyle` object whose name matches the input. + - name: load(options) + uid: excel!Excel.TimelineStyleCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.TimelineStyleCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): Excel.TimelineStyleCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.TimelineStyleCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.TimelineStyleCollection;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.TimelineStyleCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.TimelineStyleCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: setDefault(newDefaultStyle) + uid: excel!Excel.TimelineStyleCollection#setDefault:member(1) + package: excel! + fullName: setDefault(newDefaultStyle) + summary: Sets the default timeline style for use in the parent object's scope. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'setDefault(newDefaultStyle: TimelineStyle | string): void;' + parameters: + - id: newDefaultStyle + description: >- + The `TimelineStyle` object, or name of the `TimelineStyle` object, + that should be the new default. + type: | string + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.TimelineStyleCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.TimelineStyleCollection` object is an API object, the `toJSON` + method returns a plain JavaScript object (typed as + `Excel.Interfaces.TimelineStyleCollectionData`) that contains an + "items" array with shallow copies of any loaded properties from the + collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.TimelineStyleCollectionData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.topbottomconditionalformat.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.topbottomconditionalformat.yml new file mode 100644 index 0000000000..66d363aa4f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.topbottomconditionalformat.yml @@ -0,0 +1,223 @@ +### YamlMime:TSType +name: Excel.TopBottomConditionalFormat +uid: excel!Excel.TopBottomConditionalFormat:class +package: excel! +fullName: Excel.TopBottomConditionalFormat +summary: Represents a top/bottom conditional format. +remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.TopBottomConditionalFormat#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: format + uid: excel!Excel.TopBottomConditionalFormat#format:member + package: excel! + fullName: format + summary: >- + Returns a format object, encapsulating the conditional format's font, + fill, borders, and other properties. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly format: Excel.ConditionalRangeFormat;' + return: + type: + - name: rule + uid: excel!Excel.TopBottomConditionalFormat#rule:member + package: excel! + fullName: rule + summary: The criteria of the top/bottom conditional format. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'rule: Excel.ConditionalTopBottomRule;' + return: + type: +methods: + - name: load(options) + uid: excel!Excel.TopBottomConditionalFormat#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.TopBottomConditionalFormatLoadOptions): + Excel.TopBottomConditionalFormat; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.TopBottomConditionalFormat#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNames?: string | string[]): + Excel.TopBottomConditionalFormat; + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.TopBottomConditionalFormat#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.TopBottomConditionalFormat; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.TopBottomConditionalFormat#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.TopBottomConditionalFormatUpdateData, + options?: OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.TopBottomConditionalFormat#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.TopBottomConditionalFormat): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.TopBottomConditionalFormat#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.TopBottomConditionalFormat` object is an API object, the `toJSON` + method returns a plain JavaScript object (typed as + `Excel.Interfaces.TopBottomConditionalFormatData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.TopBottomConditionalFormatData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.topbottomselectiontype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.topbottomselectiontype.yml new file mode 100644 index 0000000000..c56554c515 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.topbottomselectiontype.yml @@ -0,0 +1,48 @@ +### YamlMime:TSEnum +name: Excel.TopBottomSelectionType +uid: excel!Excel.TopBottomSelectionType:enum +package: excel! +fullName: Excel.TopBottomSelectionType +summary: >- + A simple enum for top/bottom filters to select whether to filter by the top N + or bottom N percent, number, or sum of values. +remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: items + uid: excel!Excel.TopBottomSelectionType.items:member + package: excel! + summary: >- + Filter the top/bottom N number of items as measured by the chosen value. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Items"' + - name: percent + uid: excel!Excel.TopBottomSelectionType.percent:member + package: excel! + summary: >- + Filter the top/bottom N percent of items as measured by the chosen value. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Percent"' + - name: sum + uid: excel!Excel.TopBottomSelectionType.sum:member + package: excel! + summary: >- + Filter the top/bottom N sum as measured by the chosen value. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Sum"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.unknowncellcontrol.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.unknowncellcontrol.yml new file mode 100644 index 0000000000..d542936022 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.unknowncellcontrol.yml @@ -0,0 +1,30 @@ +### YamlMime:TSType +name: Excel.UnknownCellControl +uid: excel!Excel.UnknownCellControl:interface +package: excel! +fullName: Excel.UnknownCellControl +summary: >- + Represents an unknown cell control. This represents a control that was added + in a future version of Excel, and the current version of Excel doesn't know + how to display this control. +remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: type + uid: excel!Excel.UnknownCellControl#type:member + package: excel! + fullName: type + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'type: CellControlType.unknown;' + return: + type: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.valueerrorcellvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.valueerrorcellvalue.yml new file mode 100644 index 0000000000..1fc5b76261 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.valueerrorcellvalue.yml @@ -0,0 +1,123 @@ +### YamlMime:TSType +name: Excel.ValueErrorCellValue +uid: excel!Excel.ValueErrorCellValue:interface +package: excel! +fullName: Excel.ValueErrorCellValue +summary: Represents the value of a cell containing a \#VALUE! error. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: basicType + uid: excel!Excel.ValueErrorCellValue#basicType:member + package: excel! + fullName: basicType + summary: >- + Represents the value that would be returned by `Range.valueTypes` for a + cell with this value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicType?: RangeValueType.error | "Error";' + return: + type: | "Error" + - name: basicValue + uid: excel!Excel.ValueErrorCellValue#basicValue:member + package: excel! + fullName: basicValue + summary: >- + Represents the value that would be returned by `Range.values` for a cell + with this value. When accessed through a `valuesAsJson` property, this + string value aligns with the en-US locale. When accessed through a + `valuesAsJsonLocal` property, this string value aligns with the user's + display locale. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicValue?: "#VALUE!" | string;' + return: + type: '"#VALUE!" | string' + - name: errorSubType + uid: excel!Excel.ValueErrorCellValue#errorSubType:member + package: excel! + fullName: errorSubType + summary: Represents the type of `ValueErrorCellValue`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + errorSubType?: ValueErrorCellValueSubType | "Unknown" | + "VlookupColumnIndexLessThanOne" | "VlookupResultNotFound" | + "HlookupRowIndexLessThanOne" | "HlookupResultNotFound" | + "CoerceStringToNumberInvalid" | "CoerceStringToBoolInvalid" | + "CoerceStringToInvalidType" | "SubArrayStartRowMissingEndRowNot" | + "SubArrayStartColumnMissingEndColumnNot" | "InvalidImageUrl" | + "StockHistoryNonTradingDays" | "StockHistoryNotAStock" | + "StockHistoryInvalidDate" | "StockHistoryEndBeforeStart" | + "StockHistoryStartInFuture" | "StockHistoryInvalidEnum" | + "StockHistoryOnlyDateRequested" | "StockHistoryNotFound" | + "LambdaWrongParamCount"; + return: + type: >- + | "Unknown" + | "VlookupColumnIndexLessThanOne" | "VlookupResultNotFound" | + "HlookupRowIndexLessThanOne" | "HlookupResultNotFound" | + "CoerceStringToNumberInvalid" | "CoerceStringToBoolInvalid" | + "CoerceStringToInvalidType" | "SubArrayStartRowMissingEndRowNot" | + "SubArrayStartColumnMissingEndColumnNot" | "InvalidImageUrl" | + "StockHistoryNonTradingDays" | "StockHistoryNotAStock" | + "StockHistoryInvalidDate" | "StockHistoryEndBeforeStart" | + "StockHistoryStartInFuture" | "StockHistoryInvalidEnum" | + "StockHistoryOnlyDateRequested" | "StockHistoryNotFound" | + "LambdaWrongParamCount" + - name: errorType + uid: excel!Excel.ValueErrorCellValue#errorType:member + package: excel! + fullName: errorType + summary: Represents the type of `ErrorCellValue`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'errorType?: ErrorCellValueType.value | "Value";' + return: + type: | "Value" + - name: type + uid: excel!Excel.ValueErrorCellValue#type:member + package: excel! + fullName: type + summary: Represents the type of this cell value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: CellValueType.error | "Error";' + return: + type: | "Error" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.valueerrorcellvaluesubtype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.valueerrorcellvaluesubtype.yml new file mode 100644 index 0000000000..d141740cf8 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.valueerrorcellvaluesubtype.yml @@ -0,0 +1,260 @@ +### YamlMime:TSEnum +name: Excel.ValueErrorCellValueSubType +uid: excel!Excel.ValueErrorCellValueSubType:enum +package: excel! +fullName: Excel.ValueErrorCellValueSubType +summary: Represents types of \#VALUE! errors. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +fields: + - name: coerceStringToBoolInvalid + uid: excel!Excel.ValueErrorCellValueSubType.coerceStringToBoolInvalid:member + package: excel! + summary: >- + An error caused by encountering a string where a boolean was expected, and + that string not being coercible to a boolean. Displays as error type + \#VALUE! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CoerceStringToBoolInvalid"' + - name: coerceStringToInvalidType + uid: excel!Excel.ValueErrorCellValueSubType.coerceStringToInvalidType:member + package: excel! + summary: >- + An error caused by conversion of a string to a type other than a boolean + or number. Displays as error type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CoerceStringToInvalidType"' + - name: coerceStringToNumberInvalid + uid: excel!Excel.ValueErrorCellValueSubType.coerceStringToNumberInvalid:member + package: excel! + summary: >- + An error caused by encountering a string where a number was expected, and + that string not being coercible to a number. Displays as error type + \#VALUE! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"CoerceStringToNumberInvalid"' + - name: hlookupResultNotFound + uid: excel!Excel.ValueErrorCellValueSubType.hlookupResultNotFound:member + package: excel! + summary: >- + An error caused by HLOOKUP not finding its lookup\_value parameter. + Displays as error type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"HlookupResultNotFound"' + - name: hlookupRowIndexLessThanOne + uid: excel!Excel.ValueErrorCellValueSubType.hlookupRowIndexLessThanOne:member + package: excel! + summary: >- + An error caused by a row\_index\_num parameter of HLOOKUP of less than 1. + Displays as error type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"HlookupRowIndexLessThanOne"' + - name: invalidImageUrl + uid: excel!Excel.ValueErrorCellValueSubType.invalidImageUrl:member + package: excel! + summary: >- + An error caused by a `WebImageValue` with an invalid URL. Displays as + error type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"InvalidImageUrl"' + - name: lambdaWrongParamCount + uid: excel!Excel.ValueErrorCellValueSubType.lambdaWrongParamCount:member + package: excel! + summary: >- + An error caused by passing the incorrect number of parameters to a lambda + value. Displays as error type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"LambdaWrongParamCount"' + - name: stockHistoryEndBeforeStart + uid: excel!Excel.ValueErrorCellValueSubType.stockHistoryEndBeforeStart:member + package: excel! + summary: >- + An error caused by passing an end\_date parameter that precedes the + start\_date parameter to STOCKHISTORY. Displays as error type \#VALUE! in + Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"StockHistoryEndBeforeStart"' + - name: stockHistoryInvalidDate + uid: excel!Excel.ValueErrorCellValueSubType.stockHistoryInvalidDate:member + package: excel! + summary: >- + An error caused by passing an invalid date to STOCKHISTORY. Displays as + error type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"StockHistoryInvalidDate"' + - name: stockHistoryInvalidEnum + uid: excel!Excel.ValueErrorCellValueSubType.stockHistoryInvalidEnum:member + package: excel! + summary: >- + An error caused by invalid interval or header parameters for STOCKHISTORY. + Displays as error type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"StockHistoryInvalidEnum"' + - name: stockHistoryNonTradingDays + uid: excel!Excel.ValueErrorCellValueSubType.stockHistoryNonTradingDays:member + package: excel! + summary: >- + An error caused by STOCKHISTORY having a date range which only contains + days that don't have stock trading. Displays as error type \#VALUE! in + Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"StockHistoryNonTradingDays"' + - name: stockHistoryNotAStock + uid: excel!Excel.ValueErrorCellValueSubType.stockHistoryNotAStock:member + package: excel! + summary: >- + An error caused by passing a stock parameter which is not a stock to + STOCKHISTORY. Displays as error type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"StockHistoryNotAStock"' + - name: stockHistoryNotFound + uid: excel!Excel.ValueErrorCellValueSubType.stockHistoryNotFound:member + package: excel! + summary: >- + An error caused by STOCKHISTORY not finding the history of the specified + stock. Displays as error type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"StockHistoryNotFound"' + - name: stockHistoryOnlyDateRequested + uid: >- + excel!Excel.ValueErrorCellValueSubType.stockHistoryOnlyDateRequested:member + package: excel! + summary: >- + An error caused by STOCKHISTORY parameters that request only the date and + no other fields. Displays as error type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"StockHistoryOnlyDateRequested"' + - name: stockHistoryStartInFuture + uid: excel!Excel.ValueErrorCellValueSubType.stockHistoryStartInFuture:member + package: excel! + summary: >- + An error caused by passing a future start\_date parameter to STOCKHISTORY. + Displays as error type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"StockHistoryStartInFuture"' + - name: subArrayStartColumnMissingEndColumnNot + uid: >- + excel!Excel.ValueErrorCellValueSubType.subArrayStartColumnMissingEndColumnNot:member + package: excel! + summary: >- + An error caused by SUBARRAY missing a start column. Displays as error type + \#VALUE! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"SubArrayStartColumnMissingEndColumnNot"' + - name: subArrayStartRowMissingEndRowNot + uid: >- + excel!Excel.ValueErrorCellValueSubType.subArrayStartRowMissingEndRowNot:member + package: excel! + summary: >- + An error caused by SUBARRAY missing a start row. Displays as error type + \#VALUE! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"SubArrayStartRowMissingEndRowNot"' + - name: unknown + uid: excel!Excel.ValueErrorCellValueSubType.unknown:member + package: excel! + summary: >- + An unknown type of error. Displays as error type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Unknown"' + - name: vlookupColumnIndexLessThanOne + uid: >- + excel!Excel.ValueErrorCellValueSubType.vlookupColumnIndexLessThanOne:member + package: excel! + summary: >- + An error caused by a column\_index\_num parameter of VLOOKUP of less than + 1. Displays as error type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"VlookupColumnIndexLessThanOne"' + - name: vlookupResultNotFound + uid: excel!Excel.ValueErrorCellValueSubType.vlookupResultNotFound:member + package: excel! + summary: >- + An error caused by VLOOKUP not finding its lookup\_value parameter. + Displays as error type \#VALUE! in Excel. + + + * \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"VlookupResultNotFound"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.valuefiltercondition.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.valuefiltercondition.yml new file mode 100644 index 0000000000..4612a6fdd1 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.valuefiltercondition.yml @@ -0,0 +1,180 @@ +### YamlMime:TSEnum +name: Excel.ValueFilterCondition +uid: excel!Excel.ValueFilterCondition:enum +package: excel! +fullName: Excel.ValueFilterCondition +summary: >- + Enum representing all accepted conditions by which a value filter can be + applied. Used to configure the type of PivotFilter that is applied to the + field. `PivotFilter.exclusive` can be set to `true` to invert many of these + conditions. +remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotfilters.yaml + + + await Excel.run(async (context) => { + // Add a PivotFilter to filter on the values correlated with a row. + + // Get the PivotTable. + const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales"); + + // Get the "Farm" field. + const field = pivotTable.hierarchies.getItem("Farm").fields.getItem("Farm"); + + // Filter to only include rows with more than 500 wholesale crates sold. + const filter: Excel.PivotValueFilter = { + condition: Excel.ValueFilterCondition.greaterThan, + comparator: 500, + value: "Sum of Crates Sold Wholesale" + }; + + // Apply the value filter to the field. + field.applyFilter({ valueFilter: filter }); + + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: between + uid: excel!Excel.ValueFilterCondition.between:member + package: excel! + summary: >- + Between `lowerBound` and `upperBound` criteria. + + + Required Criteria: {`value`, `lowerBound`, + `upperBound`}. Optional Criteria: {`exclusive`}. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Between"' + - name: bottomN + uid: excel!Excel.ValueFilterCondition.bottomN:member + package: excel! + summary: >- + In bottom N (`threshold`) \[items, percent, sum\] of value + category. + + + Required Criteria: {`value`, `threshold`, + `selectionType`}. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"BottomN"' + - name: equals + uid: excel!Excel.ValueFilterCondition.equals:member + package: excel! + summary: >- + Equals comparator criterion. + + + Required Criteria: {`value`, `comparator`}. + Optional Criteria: {`exclusive`}. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Equals"' + - name: greaterThan + uid: excel!Excel.ValueFilterCondition.greaterThan:member + package: excel! + summary: >- + Greater than comparator criterion. + + + Required Criteria: {`value`, `comparator`}. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"GreaterThan"' + - name: greaterThanOrEqualTo + uid: excel!Excel.ValueFilterCondition.greaterThanOrEqualTo:member + package: excel! + summary: >- + Greater than or equal to comparator criterion. + + + Required Criteria: {`value`, `comparator`}. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"GreaterThanOrEqualTo"' + - name: lessThan + uid: excel!Excel.ValueFilterCondition.lessThan:member + package: excel! + summary: >- + Less than comparator criterion. + + + Required Criteria: {`value`, `comparator`}. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"LessThan"' + - name: lessThanOrEqualTo + uid: excel!Excel.ValueFilterCondition.lessThanOrEqualTo:member + package: excel! + summary: >- + Less than or equal to comparator criterion. + + + Required Criteria: {`value`, `comparator`}. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"LessThanOrEqualTo"' + - name: topN + uid: excel!Excel.ValueFilterCondition.topN:member + package: excel! + summary: >- + In top N (`threshold`) \[items, percent, sum\] of value category. + + + Required Criteria: {`value`, `threshold`, + `selectionType`}. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"TopN"' + - name: unknown + uid: excel!Excel.ValueFilterCondition.unknown:member + package: excel! + summary: >- + `ValueFilterCondition` is unknown or unsupported. + + + * \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + value: '"Unknown"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.valuetypenotavailablecellvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.valuetypenotavailablecellvalue.yml new file mode 100644 index 0000000000..79f3684611 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.valuetypenotavailablecellvalue.yml @@ -0,0 +1,75 @@ +### YamlMime:TSType +name: Excel.ValueTypeNotAvailableCellValue +uid: excel!Excel.ValueTypeNotAvailableCellValue:interface +package: excel! +fullName: Excel.ValueTypeNotAvailableCellValue +summary: >- + Represents the value of a cell containing a type of value which cannot be + serialized. For example, an \#UNKNOWN! error which represents a type of rich + value not known to this version of Excel. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: basicType + uid: excel!Excel.ValueTypeNotAvailableCellValue#basicType:member + package: excel! + fullName: basicType + summary: >- + Represents the value that would be returned by `Range.valueTypes` for a + cell with this value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + basicType: RangeValueType | "Boolean" | "Double" | "Error" | "Empty" | + "String"; + return: + type: >- + | "Boolean" | "Double" + | "Error" | "Empty" | "String" + - name: basicValue + uid: excel!Excel.ValueTypeNotAvailableCellValue#basicValue:member + package: excel! + fullName: basicValue + summary: >- + Represents the value that would be returned by `Range.values` for a cell + with this value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicValue: boolean | number | string;' + return: + type: boolean | number | string + - name: type + uid: excel!Excel.ValueTypeNotAvailableCellValue#type:member + package: excel! + fullName: type + summary: Represents the type of this cell value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: CellValueType.notAvailable | "NotAvailable";' + return: + type: >- + | + "NotAvailable" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.verticalalignment.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.verticalalignment.yml new file mode 100644 index 0000000000..6e360e1322 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.verticalalignment.yml @@ -0,0 +1,70 @@ +### YamlMime:TSEnum +name: Excel.VerticalAlignment +uid: excel!Excel.VerticalAlignment:enum +package: excel! +fullName: Excel.VerticalAlignment +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml + + + await Excel.run(async (context) => { + let worksheet = context.workbook.worksheets.getItem("Sample"); + let range = worksheet.getRange("A1:E1"); + // Apply new style. + range.style = ("Diagonal Orientation Style"); + range.format.verticalAlignment = "Justify"; + + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: bottom + uid: excel!Excel.VerticalAlignment.bottom:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Bottom"' + - name: center + uid: excel!Excel.VerticalAlignment.center:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Center"' + - name: distributed + uid: excel!Excel.VerticalAlignment.distributed:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Distributed"' + - name: justify + uid: excel!Excel.VerticalAlignment.justify:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Justify"' + - name: top + uid: excel!Excel.VerticalAlignment.top:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Top"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.webimagecellvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.webimagecellvalue.yml new file mode 100644 index 0000000000..19847e42d3 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.webimagecellvalue.yml @@ -0,0 +1,240 @@ +### YamlMime:TSType +name: Excel.WebImageCellValue +uid: excel!Excel.WebImageCellValue:interface +package: excel! +fullName: Excel.WebImageCellValue +summary: >- + Represents the value of a cell containing an image downloaded from the + internet. +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: address + uid: excel!Excel.WebImageCellValue#address:member + package: excel! + fullName: address + summary: >- + Represents the URL from which the image will be downloaded. This image + must be hosted on a server that supports HTTPS. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-web-image.yaml + + + // This function retrieves the image URL from the selected cell and opens + that image in a new browser tab. + + await Excel.run(async (context) => { + // Load the active cell information. + const activeCell = context.workbook.getActiveCell(); + activeCell.load("valuesAsJson"); + await context.sync(); + + // Get image URL from the active cell. + const values = activeCell.valuesAsJson; + const webImageData = values[0][0] as Excel.WebImageCellValue; + const webImageUrl = webImageData.address; + + if (!webImageUrl) { + console.log("The selected cell is missing an image URL. Select a cell that contains an image."); + return; + } + + // Open the image URL in a new browser tab. + const tab = window.open(webImageData.address, "_blank"); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'address: string;' + return: + type: string + - name: altText + uid: excel!Excel.WebImageCellValue#altText:member + package: excel! + fullName: altText + summary: >- + Represents the alternate text that can be used in accessibility scenarios + to describe what the image represents. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'altText?: string;' + return: + type: string + - name: attribution + uid: excel!Excel.WebImageCellValue#attribution:member + package: excel! + fullName: attribution + summary: >- + Represents attribution information to describe the source and license + requirements for using this image. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'attribution?: CellValueAttributionAttributes[];' + return: + type: [] + - name: basicType + uid: excel!Excel.WebImageCellValue#basicType:member + package: excel! + fullName: basicType + summary: >- + Represents the value that would be returned by `Range.valueTypes` for a + cell with this value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicType?: RangeValueType.error | "Error";' + return: + type: | "Error" + - name: basicValue + uid: excel!Excel.WebImageCellValue#basicValue:member + package: excel! + fullName: basicValue + summary: >- + Represents the value that would be returned by `Range.values` for a cell + with this value. When accessed through a `valuesAsJson` property, this + string value aligns with the en-US locale. When accessed through a + `valuesAsJsonLocal` property, this string value aligns with the user's + display locale. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'basicValue?: "#VALUE!" | string;' + return: + type: '"#VALUE!" | string' + - name: provider + uid: excel!Excel.WebImageCellValue#provider:member + package: excel! + fullName: provider + summary: >- + Represents information that describes the entity or individual who + provided the image. This information can be used for branding in image + cards. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'provider?: CellValueProviderAttributes;' + return: + type: + - name: relatedImagesAddress + uid: excel!Excel.WebImageCellValue#relatedImagesAddress:member + package: excel! + fullName: relatedImagesAddress + summary: >- + Represents the URL of a webpage with images that are considered related to + this `WebImageCellValue`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'relatedImagesAddress?: string;' + return: + type: string + - name: type + uid: excel!Excel.WebImageCellValue#type:member + package: excel! + fullName: type + summary: Represents the type of this cell value. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-web-image.yaml + + + // This function inserts a web image into the currently selected cell. + + await Excel.run(async (context) => { + // Retrieve image data from the task pane and then clear the input fields. + const imageUrl = (document.getElementById("url") as HTMLInputElement).value; + const imageAltText = (document.getElementById("alt-text") as HTMLInputElement).value; + clearForm(); + + // Load the active cell. + const activeCell = context.workbook.getActiveCell(); + activeCell.load(); + await context.sync(); + + if (!imageUrl) { + console.log("Please enter an image URL."); + return; + } + + // Create a web image object and assign the image details. + const webImage: Excel.WebImageCellValue = { + type: "WebImage", /* The string equivalent of `Excel.CellValueType.webImage`. */ + address: imageUrl, + altText: imageAltText + }; + + // Insert web image into the active cell. + activeCell.valuesAsJson = [[webImage]]; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'type: CellValueType.webImage | "WebImage";' + return: + type: | "WebImage" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.workbook.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.workbook.yml new file mode 100644 index 0000000000..bc73fc30d6 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.workbook.yml @@ -0,0 +1,1385 @@ +### YamlMime:TSType +name: Excel.Workbook +uid: excel!Excel.Workbook:class +package: excel! +fullName: Excel.Workbook +summary: >- + Workbook is the top level object which contains related workbook objects such + as worksheets, tables, and ranges. To learn more about the workbook object + model, read [Work with workbooks using the Excel JavaScript + API](https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-workbooks). +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: application + uid: excel!Excel.Workbook#application:member + package: excel! + fullName: application + summary: Represents the Excel application instance that contains this workbook. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly application: Excel.Application;' + return: + type: + - name: autoSave + uid: excel!Excel.Workbook#autoSave:member + package: excel! + fullName: autoSave + summary: Specifies if the workbook is in AutoSave mode. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly autoSave: boolean;' + return: + type: boolean + - name: bindings + uid: excel!Excel.Workbook#bindings:member + package: excel! + fullName: bindings + summary: Represents a collection of bindings that are part of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly bindings: Excel.BindingCollection;' + return: + type: + - name: calculationEngineVersion + uid: excel!Excel.Workbook#calculationEngineVersion:member + package: excel! + fullName: calculationEngineVersion + summary: Returns a number about the version of Excel Calculation Engine. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly calculationEngineVersion: number;' + return: + type: number + - name: chartDataPointTrack + uid: excel!Excel.Workbook#chartDataPointTrack:member + package: excel! + fullName: chartDataPointTrack + summary: >- + True if all charts in the workbook are tracking the actual data points to + which they are attached. False if the charts track the index of the data + points. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'chartDataPointTrack: boolean;' + return: + type: boolean + - name: comments + uid: excel!Excel.Workbook#comments:member + package: excel! + fullName: comments + summary: Represents a collection of comments associated with the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly comments: Excel.CommentCollection;' + return: + type: + - name: context + uid: excel!Excel.Workbook#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: customXmlParts + uid: excel!Excel.Workbook#customXmlParts:member + package: excel! + fullName: customXmlParts + summary: Represents the collection of custom XML parts contained by this workbook. + remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly customXmlParts: Excel.CustomXmlPartCollection;' + return: + type: + - name: dataConnections + uid: excel!Excel.Workbook#dataConnections:member + package: excel! + fullName: dataConnections + summary: Represents all data connections in the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly dataConnections: Excel.DataConnectionCollection;' + return: + type: + - name: functions + uid: excel!Excel.Workbook#functions:member + package: excel! + fullName: functions + summary: >- + Represents a collection of worksheet functions that can be used for + computation. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly functions: Excel.Functions;' + return: + type: + - name: isDirty + uid: excel!Excel.Workbook#isDirty:member + package: excel! + fullName: isDirty + summary: >- + Specifies if changes have been made since the workbook was last saved. You + can set this property to `true` if you want to close a modified workbook + without either saving it or being prompted to save it. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'isDirty: boolean;' + return: + type: boolean + - name: linkedEntityDataDomains + uid: excel!Excel.Workbook#linkedEntityDataDomains:member + package: excel! + fullName: linkedEntityDataDomains + summary: >- + Returns a collection of linked entity data domains that are available in + the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly linkedEntityDataDomains: + Excel.LinkedEntityDataDomainCollection; + return: + type: + - name: name + uid: excel!Excel.Workbook#name:member + package: excel! + fullName: name + summary: Gets the workbook name. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly name: string;' + return: + type: string + - name: names + uid: excel!Excel.Workbook#names:member + package: excel! + fullName: names + summary: >- + Represents a collection of workbook-scoped named items (named ranges and + constants). + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly names: Excel.NamedItemCollection;' + return: + type: + - name: notes + uid: excel!Excel.Workbook#notes:member + package: excel! + fullName: notes + summary: Returns a collection of all the notes objects in the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly notes: Excel.NoteCollection;' + return: + type: + - name: pivotTables + uid: excel!Excel.Workbook#pivotTables:member + package: excel! + fullName: pivotTables + summary: Represents a collection of PivotTables associated with the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-get-pivottables.yaml + + + await Excel.run(async (context) => { + // Get the names of all the PivotTables in the workbook. + const pivotTables = context.workbook.pivotTables; + pivotTables.load("name"); + await context.sync(); + + // Display the names in the console. + console.log("PivotTables in the workbook:") + pivotTables.items.forEach((pivotTable) => { + console.log(`\t${pivotTable.name}`); + }); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly pivotTables: Excel.PivotTableCollection;' + return: + type: + - name: pivotTableStyles + uid: excel!Excel.Workbook#pivotTableStyles:member + package: excel! + fullName: pivotTableStyles + summary: Represents a collection of PivotTableStyles associated with the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly pivotTableStyles: Excel.PivotTableStyleCollection;' + return: + type: + - name: previouslySaved + uid: excel!Excel.Workbook#previouslySaved:member + package: excel! + fullName: previouslySaved + summary: Specifies if the workbook has ever been saved locally or online. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly previouslySaved: boolean;' + return: + type: boolean + - name: properties + uid: excel!Excel.Workbook#properties:member + package: excel! + fullName: properties + summary: Gets the workbook properties. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/26-document/properties.yaml + + + await Excel.run(async (context) => { + let titleValue = "Excel document properties API"; + let subjectValue = "Set and get document properties"; + let keywordsValue = "Set and get operations"; + let commentsValue = "This is an Excel document properties API code sample"; + let categoryValue = "Office Add-ins"; + let managerValue = "John"; + let companyValue = "Microsoft"; + + let docProperties = context.workbook.properties; + + // Set the writeable document properties. + docProperties.title = titleValue; + docProperties.subject = subjectValue; + docProperties.keywords = keywordsValue; + docProperties.comments = commentsValue; + docProperties.category = categoryValue; + docProperties.manager = managerValue; + docProperties.company = companyValue; + + await context.sync(); + + console.log("Set the following document properties: title, subject, keywords, comments, category, manager, company."); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly properties: Excel.DocumentProperties;' + return: + type: + - name: protection + uid: excel!Excel.Workbook#protection:member + package: excel! + fullName: protection + summary: Returns the protection object for a workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly protection: Excel.WorkbookProtection;' + return: + type: + - name: queries + uid: excel!Excel.Workbook#queries:member + package: excel! + fullName: queries + summary: Returns a collection of Power Query queries that are part of the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly queries: Excel.QueryCollection;' + return: + type: + - name: readOnly + uid: excel!Excel.Workbook#readOnly:member + package: excel! + fullName: readOnly + summary: Returns `true` if the workbook is open in read-only mode. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly readOnly: boolean;' + return: + type: boolean + - name: settings + uid: excel!Excel.Workbook#settings:member + package: excel! + fullName: settings + summary: Represents a collection of settings associated with the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly settings: Excel.SettingCollection;' + return: + type: + - name: slicers + uid: excel!Excel.Workbook#slicers:member + package: excel! + fullName: slicers + summary: Represents a collection of slicers associated with the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly slicers: Excel.SlicerCollection;' + return: + type: + - name: slicerStyles + uid: excel!Excel.Workbook#slicerStyles:member + package: excel! + fullName: slicerStyles + summary: Represents a collection of SlicerStyles associated with the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly slicerStyles: Excel.SlicerStyleCollection;' + return: + type: + - name: styles + uid: excel!Excel.Workbook#styles:member + package: excel! + fullName: styles + summary: Represents a collection of styles associated with the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml + + + await Excel.run(async (context) => { + let styles = context.workbook.styles; + + // Add a new style to the style collection. + // Styles is in the Home tab ribbon. + styles.add("Diagonal Orientation Style"); + + let newStyle = styles.getItem("Diagonal Orientation Style"); + + // The "Diagonal Orientation Style" properties. + newStyle.textOrientation = 38; + newStyle.autoIndent = true; + newStyle.includeProtection = true; + newStyle.shrinkToFit = true; + newStyle.locked = false; + + await context.sync(); + + console.log("Successfully added a new style with diagonal orientation to the Home tab ribbon."); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly styles: Excel.StyleCollection;' + return: + type: + - name: tables + uid: excel!Excel.Workbook#tables:member + package: excel! + fullName: tables + summary: Represents a collection of tables associated with the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly tables: Excel.TableCollection;' + return: + type: + - name: tableStyles + uid: excel!Excel.Workbook#tableStyles:member + package: excel! + fullName: tableStyles + summary: Represents a collection of TableStyles associated with the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly tableStyles: Excel.TableStyleCollection;' + return: + type: + - name: timelineStyles + uid: excel!Excel.Workbook#timelineStyles:member + package: excel! + fullName: timelineStyles + summary: Represents a collection of TimelineStyles associated with the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly timelineStyles: Excel.TimelineStyleCollection;' + return: + type: + - name: usePrecisionAsDisplayed + uid: excel!Excel.Workbook#usePrecisionAsDisplayed:member + package: excel! + fullName: usePrecisionAsDisplayed + summary: >- + True if calculations in this workbook will be done using only the + precision of the numbers as they're displayed. Data will permanently lose + accuracy when switching this property from `false` to `true`. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'usePrecisionAsDisplayed: boolean;' + return: + type: boolean + - name: worksheets + uid: excel!Excel.Workbook#worksheets:member + package: excel! + fullName: worksheets + summary: Represents a collection of worksheets associated with the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly worksheets: Excel.WorksheetCollection;' + return: + type: +methods: + - name: close(closeBehavior) + uid: excel!Excel.Workbook#close:member(1) + package: excel! + fullName: close(closeBehavior) + summary: Close current workbook. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-save-and-close.yaml + + + await Excel.run(async (context) => { + context.workbook.close(Excel.CloseBehavior.save); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'close(closeBehavior?: Excel.CloseBehavior): void;' + parameters: + - id: closeBehavior + description: workbook close behavior. + type: + return: + type: void + description: '' + - name: close(closeBehavior) + uid: excel!Excel.Workbook#close:member(2) + package: excel! + fullName: close(closeBehavior) + summary: Close current workbook. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'close(closeBehavior?: "Save" | "SkipSave"): void;' + parameters: + - id: closeBehavior + description: workbook close behavior. + type: '"Save" | "SkipSave"' + return: + type: void + description: '' + - name: getActiveCell() + uid: excel!Excel.Workbook#getActiveCell:member(1) + package: excel! + fullName: getActiveCell() + summary: Gets the currently active cell from the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-get-active-cell.yaml + + + await Excel.run(async (context) => { + + let myWorkbook = context.workbook; + let activeCell = myWorkbook.getActiveCell(); + activeCell.load("address"); + + await context.sync(); + + console.log("The active cell is " + activeCell.address); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getActiveCell(): Excel.Range;' + return: + type: + description: '' + - name: getActiveChart() + uid: excel!Excel.Workbook#getActiveChart:member(1) + package: excel! + fullName: getActiveChart() + summary: >- + Gets the currently active chart in the workbook. If there is no active + chart, an `ItemNotFound` exception is thrown. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getActiveChart(): Excel.Chart;' + return: + type: + description: '' + - name: getActiveChartOrNullObject() + uid: excel!Excel.Workbook#getActiveChartOrNullObject:member(1) + package: excel! + fullName: getActiveChartOrNullObject() + summary: >- + Gets the currently active chart in the workbook. If there is no active + chart, then this method returns an object with its `isNullObject` property + set to `true`. For further information, see [*OrNullObject + methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getActiveChartOrNullObject(): Excel.Chart;' + return: + type: + description: '' + - name: getActiveShape() + uid: excel!Excel.Workbook#getActiveShape:member(1) + package: excel! + fullName: getActiveShape() + summary: >- + Gets the active shape in the workbook. Throws an `ItemNotFound` if there + is no active shape. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getActiveShape(): Excel.Shape;' + return: + type: + description: '' + - name: getActiveShapeOrNullObject() + uid: excel!Excel.Workbook#getActiveShapeOrNullObject:member(1) + package: excel! + fullName: getActiveShapeOrNullObject() + summary: >- + Gets the active shape in the workbook. If there is no active shape, then + this method returns an object with its `isNullObject` property set to + `true`. For more information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-get-active.yaml + + + // This method gets the active shape and displays it as an image in the + task pane. + + await Excel.run(async (context) => { + // Get the currently active shape, if any. + const activeShape = context.workbook.getActiveShapeOrNullObject(); + + if (activeShape) { + // Convert the active shape to an image. + const shapeImage = activeShape.getAsImage(Excel.PictureFormat.png); + await context.sync(); + + // Display the image in the task pane. + const imageContainer = document.getElementById("image"); + imageContainer.innerHTML = ''; // Clear the container before adding a new image. + const imageElement = document.createElement("img"); + imageElement.src = "data:image/png;base64," + shapeImage.value; + imageContainer.appendChild(imageElement); + } else { + console.log("No active shape"); + } + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getActiveShapeOrNullObject(): Excel.Shape;' + return: + type: + description: '' + - name: getActiveSlicer() + uid: excel!Excel.Workbook#getActiveSlicer:member(1) + package: excel! + fullName: getActiveSlicer() + summary: >- + Gets the currently active slicer in the workbook. If there is no active + slicer, an `ItemNotFound` exception is thrown. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getActiveSlicer(): Excel.Slicer;' + return: + type: + description: '' + - name: getActiveSlicerOrNullObject() + uid: excel!Excel.Workbook#getActiveSlicerOrNullObject:member(1) + package: excel! + fullName: getActiveSlicerOrNullObject() + summary: >- + Gets the currently active slicer in the workbook. If there is no active + slicer, then this method returns an object with its `isNullObject` + property set to `true`. For further information, see + [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getActiveSlicerOrNullObject(): Excel.Slicer;' + return: + type: + description: '' + - name: getIsActiveCollabSession() + uid: excel!Excel.Workbook#getIsActiveCollabSession:member(1) + package: excel! + fullName: getIsActiveCollabSession() + summary: >- + Returns `true` if the workbook is being edited by multiple users (through + co-authoring). Please be aware there might be some delay between when the + workbook status changes and when the changes are reflected on the result + of the method. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getIsActiveCollabSession(): OfficeExtension.ClientResult;' + return: + type: >- + <boolean> + description: '' + - name: getLinkedEntityCellValue(linkedEntityCellValueId) + uid: excel!Excel.Workbook#getLinkedEntityCellValue:member(1) + package: excel! + fullName: getLinkedEntityCellValue(linkedEntityCellValueId) + summary: >- + Returns a `LinkedEntityCellValue` based on the provided + `LinkedEntityId`. + remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + getLinkedEntityCellValue(linkedEntityCellValueId: LinkedEntityId): + OfficeExtension.ClientResult; + parameters: + - id: linkedEntityCellValueId + description: >- + An identifier that specifies an individual + `LinkedEntityCellValue`. + type: + return: + type: >- + <> + description: '' + - name: getSelectedRange() + uid: excel!Excel.Workbook#getSelectedRange:member(1) + package: excel! + fullName: getSelectedRange() + summary: >- + Gets the currently selected single range from the workbook. If there are + multiple ranges selected, this method will throw an error. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const selectedRange = context.workbook.getSelectedRange(); + selectedRange.load('address'); + await context.sync(); + console.log(selectedRange.address); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getSelectedRange(): Excel.Range;' + return: + type: + description: '' + - name: getSelectedRanges() + uid: excel!Excel.Workbook#getSelectedRanges:member(1) + package: excel! + fullName: getSelectedRanges() + summary: >- + Gets the currently selected one or more ranges from the workbook. Unlike + `getSelectedRange()`, this method returns a `RangeAreas` object + that represents all the selected ranges. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-areas.yaml + + + await Excel.run(async (context) => { + + const selectedRanges = context.workbook.getSelectedRanges(); + selectedRanges.format.fill.color = "lightblue"; + + await context.sync(); + }) + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getSelectedRanges(): Excel.RangeAreas;' + return: + type: + description: '' + - name: insertWorksheetsFromBase64(base64File, options) + uid: excel!Excel.Workbook#insertWorksheetsFromBase64:member(1) + package: excel! + fullName: insertWorksheetsFromBase64(base64File, options) + summary: >- + Inserts the specified worksheets from a source workbook into the current + workbook. The `extensionHardening` Windows registry key affects this API. + The file extension defined by the `base64File` param must match the real + file type of the inserted file. If `extensionHardening` is set to deny + mismatches and the file extension does not match the real file type, this + API throws the following error: "This operation is not allowed due to the + extension hardening policy." + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + This API is currently only supported for Office on Windows, Mac, and the + web. + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-insert-external-worksheets.yaml + + + // Retrieve the file and set up an HTML FileReader element. + + const myFile = document.getElementById("file") as HTMLInputElement; + + const reader = new FileReader(); + + + reader.onload = (event) => { + // Remove the metadata before the Base64-encoded string. + const startIndex = reader.result.toString().indexOf("base64,"); + externalWorkbook = reader.result.toString().substr(startIndex + 7); + }; + + + // Read the file as a data URL so that we can parse the Base64-encoded + string. + + reader.readAsDataURL(myFile.files[0]); + + + ... + + + await Excel.run(async (context) => { + // Retrieve the source workbook. + const workbook = context.workbook; + + // Set up the insert options. + const options = { + sheetNamesToInsert: [], // Insert all the worksheets from the source workbook. + positionType: Excel.WorksheetPositionType.after, // Insert after the `relativeTo` sheet. + relativeTo: "Sheet1" // The sheet relative to which the other worksheets will be inserted. Used with `positionType`. + }; + + // Insert the new worksheets. + workbook.insertWorksheetsFromBase64(externalWorkbook, options); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + insertWorksheetsFromBase64(base64File: string, options?: + Excel.InsertWorksheetOptions): OfficeExtension.ClientResult; + parameters: + - id: base64File + description: >- + Required. The Base64-encoded string representing the source workbook + file. + type: string + - id: options + description: >- + Optional. The options that define which worksheets to insert and + where in the workbook the new worksheets will be inserted. By + default, all the worksheets from the source workbook are inserted at + the end of the current workbook. + type: + return: + type: >- + <string[]> + description: An array of IDs corresponding to each newly inserted worksheet. + - name: load(options) + uid: excel!Excel.Workbook#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(options?: Excel.Interfaces.WorkbookLoadOptions): Excel.Workbook;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.Workbook#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.Workbook;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.Workbook#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.Workbook; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: save(saveBehavior) + uid: excel!Excel.Workbook#save:member(1) + package: excel! + fullName: save(saveBehavior) + summary: Save current workbook. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-save-and-close.yaml + + + await Excel.run(async (context) => { + context.workbook.save(Excel.SaveBehavior.save); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'save(saveBehavior?: Excel.SaveBehavior): void;' + parameters: + - id: saveBehavior + description: >- + The save behavior must be "Save" or "Prompt". Default value is + "Save". + type: + return: + type: void + description: '' + - name: save(saveBehavior) + uid: excel!Excel.Workbook#save:member(2) + package: excel! + fullName: save(saveBehavior) + summary: Save current workbook. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'save(saveBehavior?: "Save" | "Prompt"): void;' + parameters: + - id: saveBehavior + description: >- + The save behavior must be "Save" or "Prompt". Default value is + "Save". + type: '"Save" | "Prompt"' + return: + type: void + description: '' + - name: set(properties, options) + uid: excel!Excel.Workbook#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.WorkbookUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.Workbook#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.Workbook): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.Workbook#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.Workbook` object + is an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Excel.Interfaces.WorkbookData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.WorkbookData;' + return: + type: + description: '' +events: + - name: onActivated + uid: excel!Excel.Workbook#onActivated:member + package: excel! + fullName: onActivated + summary: >- + Occurs when the workbook is activated. Note: This event will not fire when + the workbook is opened. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-workbook-activated.yaml + + + async function workbookActivated(event: Excel.WorkbookActivatedEventArgs) + { + await Excel.run(async (context) => { + // Callback function for when the workbook is activated. + console.log("The workbook was activated."); + }); + } + + + ... + + + await Excel.run(async (context) => { + const workbook = context.workbook; + + // Register the workbook activated event handler. + workbook.onActivated.add(workbookActivated); + + await context.sync(); + console.log("Added event handler for workbook activated."); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onActivated: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onAutoSaveSettingChanged + uid: excel!Excel.Workbook#onAutoSaveSettingChanged:member + package: excel! + fullName: onAutoSaveSettingChanged + summary: Occurs when the AutoSave setting is changed on the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onAutoSaveSettingChanged: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onSelectionChanged + uid: excel!Excel.Workbook#onSelectionChanged:member + package: excel! + fullName: onSelectionChanged + summary: Occurs when the selection in the document is changed. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onSelectionChanged: + OfficeExtension.EventHandlers; + return: + type: >- + <> +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.workbookactivatedeventargs.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.workbookactivatedeventargs.yml new file mode 100644 index 0000000000..77a1c4c8b9 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.workbookactivatedeventargs.yml @@ -0,0 +1,30 @@ +### YamlMime:TSType +name: Excel.WorkbookActivatedEventArgs +uid: excel!Excel.WorkbookActivatedEventArgs:interface +package: excel! +fullName: Excel.WorkbookActivatedEventArgs +summary: Provides information about the workbook that raised the activated event. +remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: type + uid: excel!Excel.WorkbookActivatedEventArgs#type:member + package: excel! + fullName: type + summary: Gets the type of the event. See `Excel.EventType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: "WorkbookActivated";' + return: + type: '"WorkbookActivated"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.workbookautosavesettingchangedeventargs.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.workbookautosavesettingchangedeventargs.yml new file mode 100644 index 0000000000..7e3668bb39 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.workbookautosavesettingchangedeventargs.yml @@ -0,0 +1,29 @@ +### YamlMime:TSType +name: Excel.WorkbookAutoSaveSettingChangedEventArgs +uid: excel!Excel.WorkbookAutoSaveSettingChangedEventArgs:interface +package: excel! +fullName: Excel.WorkbookAutoSaveSettingChangedEventArgs +summary: Provides information about the workbook's `onAutoSaveSettingChanged` event. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: type + uid: excel!Excel.WorkbookAutoSaveSettingChangedEventArgs#type:member + package: excel! + fullName: type + summary: Gets the type of the event. See `Excel.EventType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: "WorkbookAutoSaveSettingChanged";' + return: + type: '"WorkbookAutoSaveSettingChanged"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.workbookcreated.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.workbookcreated.yml new file mode 100644 index 0000000000..4d6a59b24b --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.workbookcreated.yml @@ -0,0 +1,110 @@ +### YamlMime:TSType +name: Excel.WorkbookCreated +uid: excel!Excel.WorkbookCreated:class +package: excel! +fullName: Excel.WorkbookCreated +summary: >- + The `WorkbookCreated` object is the top level object created by + `Application.CreateWorkbook`. A `WorkbookCreated` object is a special + Workbook object. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.WorkbookCreated#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: +methods: + - name: load(propertyNames) + uid: excel!Excel.WorkbookCreated#load:member(1) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.WorkbookCreated;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.WorkbookCreated#load:member(2) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.WorkbookCreated; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.WorkbookCreated#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.WorkbookCreated` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Excel.Interfaces.WorkbookCreatedData`) that + contains shallow copies of any loaded child properties from the original + object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.WorkbookCreatedData;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.workbookprotection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.workbookprotection.yml new file mode 100644 index 0000000000..f09253a3f8 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.workbookprotection.yml @@ -0,0 +1,235 @@ +### YamlMime:TSType +name: Excel.WorkbookProtection +uid: excel!Excel.WorkbookProtection:class +package: excel! +fullName: Excel.WorkbookProtection +summary: Represents the protection of a workbook object. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.WorkbookProtection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: protected + uid: excel!Excel.WorkbookProtection#protected:member + package: excel! + fullName: protected + summary: Specifies if the workbook is protected. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly protected: boolean;' + return: + type: boolean +methods: + - name: load(options) + uid: excel!Excel.WorkbookProtection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.WorkbookProtectionLoadOptions): + Excel.WorkbookProtection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.WorkbookProtection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.WorkbookProtection;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.WorkbookProtection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.WorkbookProtection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: protect(password) + uid: excel!Excel.WorkbookProtection#protect:member(1) + package: excel! + fullName: protect(password) + summary: Protects the workbook. Fails if the workbook has been protected. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/data-protection.yaml + + + let password = await passwordHandler(); + + passwordHelper(password); + + await Excel.run(async (context) => { + let workbook = context.workbook; + workbook.load("protection/protected"); + + await context.sync(); + + if (!workbook.protection.protected) { + workbook.protection.protect(password); + } + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'protect(password?: string): void;' + parameters: + - id: password + description: Workbook protection password. + type: string + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.WorkbookProtection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.WorkbookProtection` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.WorkbookProtectionData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.WorkbookProtectionData;' + return: + type: + description: '' + - name: unprotect(password) + uid: excel!Excel.WorkbookProtection#unprotect:member(1) + package: excel! + fullName: unprotect(password) + summary: Unprotects the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/data-protection.yaml + + + let password = await passwordHandler(); + + passwordHelper(password); + + await Excel.run(async (context) => { + let workbook = context.workbook; + workbook.protection.unprotect(password); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'unprotect(password?: string): void;' + parameters: + - id: password + description: Workbook protection password. + type: string + return: + type: void + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.workbookrangeareas.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.workbookrangeareas.yml new file mode 100644 index 0000000000..f8e1f60a4f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.workbookrangeareas.yml @@ -0,0 +1,312 @@ +### YamlMime:TSType +name: Excel.WorkbookRangeAreas +uid: excel!Excel.WorkbookRangeAreas:class +package: excel! +fullName: Excel.WorkbookRangeAreas +summary: >- + Represents a collection of one or more rectangular ranges in multiple + worksheets. +remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: addresses + uid: excel!Excel.WorkbookRangeAreas#addresses:member + package: excel! + fullName: addresses + summary: >- + Returns an array of addresses in A1-style. Address values contain the + worksheet name for each rectangular block of cells (e.g., "Sheet1!A1:B4, + Sheet1!D1:D4"). Read-only. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly addresses: string[];' + return: + type: string[] + - name: areas + uid: excel!Excel.WorkbookRangeAreas#areas:member + package: excel! + fullName: areas + summary: >- + Returns the `RangeAreasCollection` object. Each `RangeAreas` in the + collection represent one or more rectangle ranges in one worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/precedents.yaml + + + await Excel.run(async (context) => { + // Precedents are cells referenced by the formula in a cell. + // A "direct precedent" is a cell directly referenced by the selected formula. + let range = context.workbook.getActiveCell(); + let directPrecedents = range.getDirectPrecedents(); + range.load("address"); + directPrecedents.areas.load("address"); + await context.sync(); + + console.log(`Direct precedent cells of ${range.address}:`); + + // Use the direct precedents API to loop through precedents of the active cell. + for (let i = 0; i < directPrecedents.areas.items.length; i++) { + // Highlight and console the address of each precedent cell. + directPrecedents.areas.items[i].format.fill.color = "Yellow"; + console.log(` ${directPrecedents.areas.items[i].address}`); + } + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly areas: Excel.RangeAreasCollection;' + return: + type: + - name: context + uid: excel!Excel.WorkbookRangeAreas#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: ranges + uid: excel!Excel.WorkbookRangeAreas#ranges:member + package: excel! + fullName: ranges + summary: Returns ranges that comprise this object in a `RangeCollection` object. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly ranges: Excel.RangeCollection;' + return: + type: +methods: + - name: getRangeAreasBySheet(key) + uid: excel!Excel.WorkbookRangeAreas#getRangeAreasBySheet:member(1) + package: excel! + fullName: getRangeAreasBySheet(key) + summary: >- + Returns the `RangeAreas` object based on worksheet ID or name in the + collection. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getRangeAreasBySheet(key: string): Excel.RangeAreas;' + parameters: + - id: key + description: The name or ID of the worksheet. + type: string + return: + type: + description: '' + - name: getRangeAreasOrNullObjectBySheet(key) + uid: excel!Excel.WorkbookRangeAreas#getRangeAreasOrNullObjectBySheet:member(1) + package: excel! + fullName: getRangeAreasOrNullObjectBySheet(key) + summary: >- + Returns the `RangeAreas` object based on worksheet name or ID in the + collection. If the worksheet does not exist, then this method returns an + object with its `isNullObject` property set to `true`. For further + information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getRangeAreasOrNullObjectBySheet(key: string): Excel.RangeAreas;' + parameters: + - id: key + description: The name or ID of the worksheet. + type: string + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.WorkbookRangeAreas#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.WorkbookRangeAreasLoadOptions): + Excel.WorkbookRangeAreas; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.WorkbookRangeAreas#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.WorkbookRangeAreas;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.WorkbookRangeAreas#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.WorkbookRangeAreas; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.WorkbookRangeAreas#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.WorkbookRangeAreas` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.WorkbookRangeAreasData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.WorkbookRangeAreasData;' + return: + type: + description: '' + - name: track() + uid: excel!Excel.WorkbookRangeAreas#track:member(1) + package: excel! + fullName: track() + summary: >- + Track the object for automatic adjustment based on surrounding changes in + the document. This call is a shorthand for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). If you're using this object across `.sync` calls and outside the + sequential execution of a ".run" batch, and get an "InvalidObjectPath" + error when setting a property or invoking a method on the object, you need + to add the object to the tracked object collection when the object was + first created. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'track(): Excel.WorkbookRangeAreas;' + return: + type: + description: '' + - name: untrack() + uid: excel!Excel.WorkbookRangeAreas#untrack:member(1) + package: excel! + fullName: untrack() + summary: >- + Release the memory associated with this object, if it has previously been + tracked. This call is shorthand for + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). Having many tracked objects slows down the host application, so + please remember to free any objects you add, once you're done using them. + You'll need to call `context.sync()` before the memory release takes + effect. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'untrack(): Excel.WorkbookRangeAreas;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheet.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheet.yml new file mode 100644 index 0000000000..f280acb006 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheet.yml @@ -0,0 +1,2213 @@ +### YamlMime:TSType +name: Excel.Worksheet +uid: excel!Excel.Worksheet:class +package: excel! +fullName: Excel.Worksheet +summary: >- + An Excel worksheet is a grid of cells. It can contain data, tables, charts, + etc. To learn more about the worksheet object model, read [Work with + worksheets using the Excel JavaScript + API](https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-worksheets). +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Get a Worksheet object by its name and activate it. + + await Excel.run(async (context) => { + const wSheetName = 'Sheet1'; + const worksheet = context.workbook.worksheets.getItem(wSheetName); + worksheet.activate(); + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +type: class +properties: + - name: autoFilter + uid: excel!Excel.Worksheet#autoFilter:member + package: excel! + fullName: autoFilter + summary: Represents the `AutoFilter` object of the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-auto-filter.yaml + + + // This function adds a percentage AutoFilter to the active worksheet + + // and applies the filter to a column of the used range. + + await Excel.run(async (context) => { + // Retrieve the active worksheet and the used range on that worksheet. + const sheet = context.workbook.worksheets.getActiveWorksheet(); + const farmData = sheet.getUsedRange(); + + // Add a filter that will only show the rows with the top 50% of values in column 3. + sheet.autoFilter.apply(farmData, 3, { + criterion1: "50", + filterOn: Excel.FilterOn.topPercent + }); + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly autoFilter: Excel.AutoFilter;' + return: + type: + - name: charts + uid: excel!Excel.Worksheet#charts:member + package: excel! + fullName: charts + summary: Returns a collection of charts that are part of the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly charts: Excel.ChartCollection;' + return: + type: + - name: comments + uid: excel!Excel.Worksheet#comments:member + package: excel! + fullName: comments + summary: Returns a collection of all the Comments objects on the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly comments: Excel.CommentCollection;' + return: + type: + - name: context + uid: excel!Excel.Worksheet#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: customProperties + uid: excel!Excel.Worksheet#customProperties:member + package: excel! + fullName: customProperties + summary: Gets a collection of worksheet-level custom properties. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/26-document/custom-properties.yaml + + + await Excel.run(async (context) => { + // Load the keys and values of all custom properties in the current worksheet. + const customWorksheetProperties = context.workbook.worksheets.getActiveWorksheet().customProperties; + customWorksheetProperties.load(["key", "value"]); + await context.sync(); + + // Log each custom property to the console. + // Note that your document may have more properties than those you have set using this snippet. + customWorksheetProperties.items.forEach((property) => { + console.log(`${property.key}:${property.value}`); + }); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly customProperties: Excel.WorksheetCustomPropertyCollection;' + return: + type: + - name: enableCalculation + uid: excel!Excel.Worksheet#enableCalculation:member + package: excel! + fullName: enableCalculation + summary: >- + Determines if Excel should recalculate the worksheet when necessary. True + if Excel recalculates the worksheet when necessary. False if Excel doesn't + recalculate the sheet. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'enableCalculation: boolean;' + return: + type: boolean + - name: freezePanes + uid: excel!Excel.Worksheet#freezePanes:member + package: excel! + fullName: freezePanes + summary: >- + Gets an object that can be used to manipulate frozen panes on the + worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly freezePanes: Excel.WorksheetFreezePanes;' + return: + type: + - name: horizontalPageBreaks + uid: excel!Excel.Worksheet#horizontalPageBreaks:member + package: excel! + fullName: horizontalPageBreaks + summary: >- + Gets the horizontal page break collection for the worksheet. This + collection only contains manual page breaks. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly horizontalPageBreaks: Excel.PageBreakCollection;' + return: + type: + - name: id + uid: excel!Excel.Worksheet#id:member + package: excel! + fullName: id + summary: >- + Returns a value that uniquely identifies the worksheet in a given + workbook. The value of the identifier remains the same even when the + worksheet is renamed or moved. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly id: string;' + return: + type: string + - name: name + uid: excel!Excel.Worksheet#name:member + package: excel! + fullName: name + summary: >- + The display name of the worksheet. The name must be fewer than 32 + characters. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'name: string;' + return: + type: string + - name: names + uid: excel!Excel.Worksheet#names:member + package: excel! + fullName: names + summary: Collection of names scoped to the current worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly names: Excel.NamedItemCollection;' + return: + type: + - name: notes + uid: excel!Excel.Worksheet#notes:member + package: excel! + fullName: notes + summary: Returns a collection of all the notes objects in the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly notes: Excel.NoteCollection;' + return: + type: + - name: pageLayout + uid: excel!Excel.Worksheet#pageLayout:member + package: excel! + fullName: pageLayout + summary: Gets the `PageLayout` object of the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly pageLayout: Excel.PageLayout;' + return: + type: + - name: pivotTables + uid: excel!Excel.Worksheet#pivotTables:member + package: excel! + fullName: pivotTables + summary: Collection of PivotTables that are part of the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-get-pivottables.yaml + + + await Excel.run(async (context) => { + // Get the names of all the PivotTables in the current worksheet. + const pivotTables = context.workbook.worksheets.getActiveWorksheet().pivotTables; + pivotTables.load("name"); + await context.sync(); + + // Display the names in the console. + console.log("PivotTables in the current worksheet:") + pivotTables.items.forEach((pivotTable) => { + console.log(`\t${pivotTable.name}`); + }); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly pivotTables: Excel.PivotTableCollection;' + return: + type: + - name: position + uid: excel!Excel.Worksheet#position:member + package: excel! + fullName: position + summary: The zero-based position of the worksheet within the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Set worksheet position. + + await Excel.run(async (context) => { + const wSheetName = 'Sheet1'; + const worksheet = context.workbook.worksheets.getItem(wSheetName); + worksheet.position = 2; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'position: number;' + return: + type: number + - name: protection + uid: excel!Excel.Worksheet#protection:member + package: excel! + fullName: protection + summary: Returns the sheet protection object for a worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Unprotecting a worksheet with unprotect() will remove all + + // WorksheetProtectionOptions options applied to a worksheet. + + // To remove only a subset of WorksheetProtectionOptions use the + + // protect() method and set the options you wish to remove to true. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sheet1"); + sheet.protection.protect({ + allowInsertRows: false, // Protect row insertion + allowDeleteRows: true // Unprotect row deletion + }); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly protection: Excel.WorksheetProtection;' + return: + type: + - name: shapes + uid: excel!Excel.Worksheet#shapes:member + package: excel! + fullName: shapes + summary: Returns the collection of all the Shape objects on the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly shapes: Excel.ShapeCollection;' + return: + type: + - name: showDataTypeIcons + uid: excel!Excel.Worksheet#showDataTypeIcons:member + package: excel! + fullName: showDataTypeIcons + summary: >- + Specifies if data type icons are visible on the worksheet. By default, + data type icons are visible. + remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showDataTypeIcons: boolean;' + return: + type: boolean + - name: showGridlines + uid: excel!Excel.Worksheet#showGridlines:member + package: excel! + fullName: showGridlines + summary: Specifies if gridlines are visible to the user. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/gridlines.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + sheet.showGridlines = true; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'showGridlines: boolean;' + return: + type: boolean + - name: showHeadings + uid: excel!Excel.Worksheet#showHeadings:member + package: excel! + fullName: showHeadings + summary: Specifies if headings are visible to the user. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'showHeadings: boolean;' + return: + type: boolean + - name: slicers + uid: excel!Excel.Worksheet#slicers:member + package: excel! + fullName: slicers + summary: Returns a collection of slicers that are part of the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-slicer.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Pivot"); + const slicer = sheet.slicers.add( + "Farm Sales", /* The slicer data source. For PivotTables, this can be the PivotTable object reference or name. */ + "Type" /* The field in the data source to filter by. For PivotTables, this can be a PivotField object reference or ID. */ + ); + slicer.name = "Fruit Slicer"; + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly slicers: Excel.SlicerCollection;' + return: + type: + - name: standardHeight + uid: excel!Excel.Worksheet#standardHeight:member + package: excel! + fullName: standardHeight + summary: >- + Returns the standard (default) height of all the rows in the worksheet, in + points. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly standardHeight: number;' + return: + type: number + - name: standardWidth + uid: excel!Excel.Worksheet#standardWidth:member + package: excel! + fullName: standardWidth + summary: >- + Specifies the standard (default) width of all the columns in the + worksheet. One unit of column width is equal to the width of one character + in the Normal style. For proportional fonts, the width of the character 0 + (zero) is used. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'standardWidth: number;' + return: + type: number + - name: tabColor + uid: excel!Excel.Worksheet#tabColor:member + package: excel! + fullName: tabColor + summary: >- + The tab color of the worksheet. When retrieving the tab color, if the + worksheet is invisible, the value will be `null`. If the worksheet + is visible but the tab color is set to auto, an empty string will be + returned. Otherwise, the property will be set to a color, in the form + \#RRGGBB (e.g., "FFA500"). When setting the color, use an empty-string to + set an "auto" color, or a real color otherwise. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/tab-color.yaml + + + await Excel.run(async (context) => { + const activeSheet = context.workbook.worksheets.getActiveWorksheet(); + activeSheet.tabColor = "#FF0000"; + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'tabColor: string;' + return: + type: string + - name: tabId + uid: excel!Excel.Worksheet#tabId:member + package: excel! + fullName: tabId + summary: >- + Returns a value representing this worksheet that can be read by Open + Office XML. This is an integer value, which is different from + `worksheet.id` (which returns a globally unique identifier) and + `worksheet.name` (which returns a value such as "Sheet1"). + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly tabId: number;' + return: + type: number + - name: tables + uid: excel!Excel.Worksheet#tables:member + package: excel! + fullName: tables + summary: Collection of tables that are part of the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly tables: Excel.TableCollection;' + return: + type: + - name: verticalPageBreaks + uid: excel!Excel.Worksheet#verticalPageBreaks:member + package: excel! + fullName: verticalPageBreaks + summary: >- + Gets the vertical page break collection for the worksheet. This collection + only contains manual page breaks. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly verticalPageBreaks: Excel.PageBreakCollection;' + return: + type: + - name: visibility + uid: excel!Excel.Worksheet#visibility:member + package: excel! + fullName: visibility + summary: The visibility of the worksheet. + remarks: >- + \[ [API set: ExcelApi 1.1 for reading visibility; 1.2 for setting + it.](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'visibility: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden";' + return: + type: >- + | "Visible" | "Hidden" + | "VeryHidden" +methods: + - name: activate() + uid: excel!Excel.Worksheet#activate:member(1) + package: excel! + fullName: activate() + summary: Activate the worksheet in the Excel UI. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const wSheetName = 'Sheet1'; + const worksheet = context.workbook.worksheets.getItem(wSheetName); + worksheet.activate(); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'activate(): void;' + return: + type: void + description: '' + - name: calculate(markAllDirty) + uid: excel!Excel.Worksheet#calculate:member(1) + package: excel! + fullName: calculate(markAllDirty) + summary: Calculates all cells on a worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'calculate(markAllDirty: boolean): void;' + parameters: + - id: markAllDirty + description: True, to mark all as dirty. + type: boolean + return: + type: void + description: '' + - name: copy(positionType, relativeTo) + uid: excel!Excel.Worksheet#copy:member(1) + package: excel! + fullName: copy(positionType, relativeTo) + summary: Copies a worksheet and places it at the specified position. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-copy.yaml + + + await Excel.run(async (context) => { + + let myWorkbook = context.workbook; + let sampleSheet = myWorkbook.worksheets.getActiveWorksheet(); + let copiedSheet = sampleSheet.copy("End") + + sampleSheet.load("name"); + copiedSheet.load("name"); + + await context.sync(); + + console.log("'" + sampleSheet.name + "' was copied to '" + copiedSheet.name + "'") + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + copy(positionType?: Excel.WorksheetPositionType, relativeTo?: + Excel.Worksheet): Excel.Worksheet; + parameters: + - id: positionType + description: >- + The location in the workbook to place the newly created worksheet. + The default value is "None", which inserts the worksheet at the + beginning of the worksheet. + type: + - id: relativeTo + description: >- + The existing worksheet which determines the newly created + worksheet's position. This is only needed if `positionType` is + "Before" or "After". + type: + return: + type: + description: The newly created worksheet. + - name: copy(positionType, relativeTo) + uid: excel!Excel.Worksheet#copy:member(2) + package: excel! + fullName: copy(positionType, relativeTo) + summary: Copies a worksheet and places it at the specified position. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + copy(positionType?: "None" | "Before" | "After" | "Beginning" | "End", + relativeTo?: Excel.Worksheet): Excel.Worksheet; + parameters: + - id: positionType + description: >- + The location in the workbook to place the newly created worksheet. + The default value is "None", which inserts the worksheet at the + beginning of the worksheet. + type: '"None" | "Before" | "After" | "Beginning" | "End"' + - id: relativeTo + description: >- + The existing worksheet which determines the newly created + worksheet's position. This is only needed if `positionType` is + "Before" or "After". + type: + return: + type: + description: The newly created worksheet. + - name: delete() + uid: excel!Excel.Worksheet#delete:member(1) + package: excel! + fullName: delete() + summary: >- + Deletes the worksheet from the workbook. Note that if the worksheet's + visibility is set to "VeryHidden", the delete operation will fail with an + `InvalidOperation` exception. You should first change its visibility to + hidden or visible before deleting it. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const wSheetName = 'Sheet1'; + const worksheet = context.workbook.worksheets.getItem(wSheetName); + worksheet.delete(); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'delete(): void;' + return: + type: void + description: '' + - name: findAll(text, criteria) + uid: excel!Excel.Worksheet#findAll:member(1) + package: excel! + fullName: findAll(text, criteria) + summary: >- + Finds all occurrences of the given string based on the criteria specified + and returns them as a `RangeAreas` object, comprising one or more + rectangular ranges. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + findAll(text: string, criteria: Excel.WorksheetSearchCriteria): + Excel.RangeAreas; + parameters: + - id: text + description: The string to find. + type: string + - id: criteria + description: >- + Additional search criteria, including whether the search needs to + match the entire cell or be case-sensitive. + type: + return: + type: + description: >- + A `RangeAreas` object, comprising one or more rectangular ranges, that + matches the search criteria. If no cells meet this criteria, an + `ItemNotFound` error will be thrown. + - name: findAllOrNullObject(text, criteria) + uid: excel!Excel.Worksheet#findAllOrNullObject:member(1) + package: excel! + fullName: findAllOrNullObject(text, criteria) + summary: >- + Finds all occurrences of the given string based on the criteria specified + and returns them as a `RangeAreas` object, comprising one or more + rectangular ranges. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-find-all.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const foundRanges = sheet.findAllOrNullObject("Complete", { + completeMatch: true, + matchCase: false + }); + + await context.sync(); + + if (foundRanges.isNullObject) { + console.log("No complete projects"); + } else { + foundRanges.format.fill.color = "green" + } + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + findAllOrNullObject(text: string, criteria: + Excel.WorksheetSearchCriteria): Excel.RangeAreas; + parameters: + - id: text + description: The string to find. + type: string + - id: criteria + description: >- + Additional search criteria, including whether the search needs to + match the entire cell or be case-sensitive. + type: + return: + type: + description: >- + A `RangeAreas` object, comprising one or more rectangular ranges, that + matches the search criteria. If there are no matches, then this method + returns an object with its `isNullObject` property set to `true`. For further information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + - name: getCell(row, column) + uid: excel!Excel.Worksheet#getCell:member(1) + package: excel! + fullName: getCell(row, column) + summary: >- + Gets the `Range` object containing the single cell based on row and column + numbers. The cell can be outside the bounds of its parent range, so long + as it stays within the worksheet grid. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const sheetName = "Sheet1"; + const rangeAddress = "A1:F8"; + const worksheet = context.workbook.worksheets.getItem(sheetName); + const cell = worksheet.getCell(0,0); + cell.load('address'); + await context.sync(); + + console.log(cell.address); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getCell(row: number, column: number): Excel.Range;' + parameters: + - id: row + description: The row number of the cell to be retrieved. Zero-indexed. + type: number + - id: column + description: The column number of the cell to be retrieved. Zero-indexed. + type: number + return: + type: + description: '' + - name: getNext(visibleOnly) + uid: excel!Excel.Worksheet#getNext:member(1) + package: excel! + fullName: getNext(visibleOnly) + summary: >- + Gets the worksheet that follows this one. If there are no worksheets + following this one, this method will throw an error. + remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/reference-worksheets-by-relative-position.yaml + + + await Excel.run(async (context) => { + const sheets = context.workbook.worksheets; + + // We don't want to include the default worksheet that was created + // when the workbook was created, so our "firstSheet" will be the one + // after the literal first. Note chaining of navigation methods. + const firstSheet = sheets.getFirst().getNext(); + const lastSheet = sheets.getLast(); + const firstTaxRateRange = firstSheet.getRange("B2"); + const lastTaxRateRange = lastSheet.getRange("B2"); + + firstSheet.load("name"); + lastSheet.load("name"); + firstTaxRateRange.load("text"); + lastTaxRateRange.load("text"); + + await context.sync(); + + let firstYear = firstSheet.name.substr(5, 4); + let lastYear = lastSheet.name.substr(5, 4); + console.log(`Tax Rate change from ${firstYear} to ${lastYear}`, `Tax rate for ${firstYear}: ${firstTaxRateRange.text[0][0]}\nTax rate for ${lastYear}: ${lastTaxRateRange.text[0][0]}`) + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getNext(visibleOnly?: boolean): Excel.Worksheet;' + parameters: + - id: visibleOnly + description: >- + Optional. If `true`, considers only visible worksheets, + skipping over any hidden ones. + type: boolean + return: + type: + description: '' + - name: getNextOrNullObject(visibleOnly) + uid: excel!Excel.Worksheet#getNextOrNullObject:member(1) + package: excel! + fullName: getNextOrNullObject(visibleOnly) + summary: >- + Gets the worksheet that follows this one. If there are no worksheets + following this one, then this method returns an object with its + `isNullObject` property set to `true`. For further information, + see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getNextOrNullObject(visibleOnly?: boolean): Excel.Worksheet;' + parameters: + - id: visibleOnly + description: >- + Optional. If `true`, considers only visible worksheets, + skipping over any hidden ones. + type: boolean + return: + type: + description: '' + - name: getPrevious(visibleOnly) + uid: excel!Excel.Worksheet#getPrevious:member(1) + package: excel! + fullName: getPrevious(visibleOnly) + summary: >- + Gets the worksheet that precedes this one. If there are no previous + worksheets, this method will throw an error. + remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/reference-worksheets-by-relative-position.yaml + + + await Excel.run(async (context) => { + const sheets = context.workbook.worksheets; + const currentSheet = sheets.getActiveWorksheet(); + const previousYearSheet = currentSheet.getPrevious(); + const currentTaxDueRange = currentSheet.getRange("C2"); + const previousTaxDueRange = previousYearSheet.getRange("C2"); + + currentSheet.load("name"); + previousYearSheet.load("name"); + currentTaxDueRange.load("text"); + previousTaxDueRange.load("text"); + + await context.sync(); + + let currentYear = currentSheet.name.substr(5, 4); + let previousYear = previousYearSheet.name.substr(5, 4); + console.log("Two Year Tax Due Comparison", `Tax due for ${currentYear} was ${currentTaxDueRange.text[0][0]}\nTax due for ${previousYear} was ${previousTaxDueRange.text[0][0]}`) + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getPrevious(visibleOnly?: boolean): Excel.Worksheet;' + parameters: + - id: visibleOnly + description: >- + Optional. If `true`, considers only visible worksheets, + skipping over any hidden ones. + type: boolean + return: + type: + description: '' + - name: getPreviousOrNullObject(visibleOnly) + uid: excel!Excel.Worksheet#getPreviousOrNullObject:member(1) + package: excel! + fullName: getPreviousOrNullObject(visibleOnly) + summary: >- + Gets the worksheet that precedes this one. If there are no previous + worksheets, then this method returns an object with its `isNullObject` + property set to `true`. For further information, see + [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getPreviousOrNullObject(visibleOnly?: boolean): Excel.Worksheet;' + parameters: + - id: visibleOnly + description: >- + Optional. If `true`, considers only visible worksheets, + skipping over any hidden ones. + type: boolean + return: + type: + description: '' + - name: getRange(address) + uid: excel!Excel.Worksheet#getRange:member(1) + package: excel! + fullName: getRange(address) + summary: >- + Gets the `Range` object, representing a single rectangular block of cells, + specified by the address or name. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Use the range address to get the range object. + + await Excel.run(async (context) => { + const sheetName = "Sheet1"; + const rangeAddress = "A1:F8"; + const worksheet = context.workbook.worksheets.getItem(sheetName); + const range = worksheet.getRange(rangeAddress); + range.load('cellCount'); + await context.sync(); + + console.log(range.cellCount); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getRange(address?: string): Excel.Range;' + parameters: + - id: address + description: >- + Optional. The string representing the address or name of the range. + For example, "A1:B2". If not specified, the entire worksheet range + is returned. The `address` has a limit of 8192 characters. If the + address exceeds the character limit, this method returns an + `InvalidArgument` error. + type: string + return: + type: + description: '' + - name: getRangeByIndexes(startRow, startColumn, rowCount, columnCount) + uid: excel!Excel.Worksheet#getRangeByIndexes:member(1) + package: excel! + fullName: getRangeByIndexes(startRow, startColumn, rowCount, columnCount) + summary: >- + Gets the `Range` object beginning at a particular row index and column + index, and spanning a certain number of rows and columns. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + getRangeByIndexes(startRow: number, startColumn: number, rowCount: + number, columnCount: number): Excel.Range; + parameters: + - id: startRow + description: Start row (zero-indexed). + type: number + - id: startColumn + description: Start column (zero-indexed). + type: number + - id: rowCount + description: Number of rows to include in the range. + type: number + - id: columnCount + description: Number of columns to include in the range. + type: number + return: + type: + description: '' + - name: getRanges(address) + uid: excel!Excel.Worksheet#getRanges:member(1) + package: excel! + fullName: getRanges(address) + summary: >- + Gets the `RangeAreas` object, representing one or more blocks of + rectangular ranges, specified by the address or name. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-areas.yaml + + + await Excel.run(async (context) => { + + const sheet = context.workbook.worksheets.getActiveWorksheet(); + const specifiedRanges = sheet.getRanges("D3:D5, G3:G5"); + specifiedRanges.format.fill.color = "pink"; + + await context.sync(); + }) + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getRanges(address?: string): Excel.RangeAreas;' + parameters: + - id: address + description: >- + Optional. A string containing the comma-separated or + semicolon-separated addresses or names of the individual ranges. For + example, "A1:B2, A5:B5" or "A1:B2; A5:B5". If not specified, a + `RangeAreas` object for the entire worksheet is returned. + type: string + return: + type: + description: '' + - name: getUsedRange(valuesOnly) + uid: excel!Excel.Worksheet#getUsedRange:member(1) + package: excel! + fullName: getUsedRange(valuesOnly) + summary: >- + The used range is the smallest range that encompasses any cells that have + a value or formatting assigned to them. If the entire worksheet is blank, + this function will return the top left cell (i.e. it will *not* throw an + error). + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const wSheetName = 'Sheet1'; + const worksheet = context.workbook.worksheets.getItem(wSheetName); + const usedRange = worksheet.getUsedRange(); + usedRange.load('address'); + await context.sync(); + + console.log(usedRange.address); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getUsedRange(valuesOnly?: boolean): Excel.Range;' + parameters: + - id: valuesOnly + description: >- + Optional. If `true`, considers only cells with values as + used cells (ignoring formatting). \[Api set: ExcelApi 1.2\] + type: boolean + return: + type: + description: '' + - name: getUsedRangeOrNullObject(valuesOnly) + uid: excel!Excel.Worksheet#getUsedRangeOrNullObject:member(1) + package: excel! + fullName: getUsedRangeOrNullObject(valuesOnly) + summary: >- + The used range is the smallest range that encompasses any cells that have + a value or formatting assigned to them. If the entire worksheet is blank, + then this method returns an object with its `isNullObject` property set to + `true`. For further information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getUsedRangeOrNullObject(valuesOnly?: boolean): Excel.Range;' + parameters: + - id: valuesOnly + description: Optional. Considers only cells with values as used cells. + type: boolean + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.Worksheet#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(options?: Excel.Interfaces.WorksheetLoadOptions): Excel.Worksheet;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.Worksheet#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.Worksheet;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: |- + + + #### Examples + + ```TypeScript + // Get worksheet properties based on sheet name. + await Excel.run(async (context) => { + const wSheetName = 'Sheet1'; + const worksheet = context.workbook.worksheets.getItem(wSheetName); + worksheet.load('position') + await context.sync(); + + console.log(worksheet.position); + }); + ``` + - name: load(propertyNamesAndPaths) + uid: excel!Excel.Worksheet#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.Worksheet; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: replaceAll(text, replacement, criteria) + uid: excel!Excel.Worksheet#replaceAll:member(1) + package: excel! + fullName: replaceAll(text, replacement, criteria) + summary: >- + Finds and replaces the given string based on the criteria specified within + the current worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + replaceAll(text: string, replacement: string, criteria: + Excel.ReplaceCriteria): OfficeExtension.ClientResult; + parameters: + - id: text + description: String to find. + type: string + - id: replacement + description: The string that replaces the original string. + type: string + - id: criteria + description: Additional replacement criteria. + type: + return: + type: <number> + description: The number of replacements performed. + - name: set(properties, options) + uid: excel!Excel.Worksheet#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.WorksheetUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: |- + + + #### Examples + + ```TypeScript + // Set the color and name of the current worksheet. + await Excel.run(async (context) => { + const activeSheet = context.workbook.worksheets.getActiveWorksheet(); + activeSheet.set({ + tabColor: "yellow", + name: "MySheet" + }); + + await context.sync(); + }); + ``` + - name: set(properties) + uid: excel!Excel.Worksheet#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.Worksheet): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: showOutlineLevels(rowLevels, columnLevels) + uid: excel!Excel.Worksheet#showOutlineLevels:member(1) + package: excel! + fullName: showOutlineLevels(rowLevels, columnLevels) + summary: >- + Shows row or column groups by their outline levels. Outlines groups and + summarizes a list of data in the worksheet. The `rowLevels` and + `columnLevels` parameters specify how many levels of the outline will be + displayed. The acceptable argument range is between 0 and 8. A value of 0 + does not change the current display. A value greater than the current + number of levels displays all the levels. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/outline.yaml + + + Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // This shows the top 3 outline levels; collapsing any additional sublevels. + sheet.showOutlineLevels(3, 3); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'showOutlineLevels(rowLevels: number, columnLevels: number): void;' + parameters: + - id: rowLevels + description: The number of row levels of an outline to display. + type: number + - id: columnLevels + description: The number of column levels of an outline to display. + type: number + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.Worksheet#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original `Excel.Worksheet` object + is an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Excel.Interfaces.WorksheetData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.WorksheetData;' + return: + type: + description: '' +events: + - name: onActivated + uid: excel!Excel.Worksheet#onActivated:member + package: excel! + fullName: onActivated + summary: Occurs when the worksheet is activated. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + sheet.onActivated.add(function (event) { + return Excel.run(async (context) => { + console.log("The activated worksheet ID is: " + event.worksheetId); + await context.sync(); + }); + }); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onActivated: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onCalculated + uid: excel!Excel.Worksheet#onCalculated:member + package: excel! + fullName: onCalculated + summary: Occurs when the worksheet is calculated. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + sheet.onCalculated.add(function (event) { + return Excel.run(async (context) => { + console.log("The worksheet has recalculated."); + await context.sync(); + }); + }); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onCalculated: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onChanged + uid: excel!Excel.Worksheet#onChanged:member + package: excel! + fullName: onChanged + summary: Occurs when data changes in a specific worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-worksheet.yaml + + + await Excel.run(async (context) => { + let sheet = context.workbook.worksheets.getItem("Sample"); + sheet.onChanged.add(onChange); + await context.sync(); + + console.log("Added a worksheet-level data-changed event handler."); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onChanged: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onColumnSorted + uid: excel!Excel.Worksheet#onColumnSorted:member + package: excel! + fullName: onColumnSorted + summary: >- + Occurs when one or more columns have been sorted. This happens as the + result of a left to right sort operation. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/event-column-and-row-sort.yaml + + + await Excel.run(async (context) => { + console.log("Adding column handler"); + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // This will fire whenever a column has been moved as the result of a sort action. + sheet.onColumnSorted.add((event) => { + return Excel.run((context) => { + console.log("Column sorted: " + event.address); + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Clear formatting for section, then highlight the sorted area. + sheet.getRange("A1:E5").format.fill.clear(); + if (event.address !== "") { + sheet.getRanges(event.address).format.fill.color = "yellow"; + } + + return context.sync(); + }); + }); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onColumnSorted: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onDeactivated + uid: excel!Excel.Worksheet#onDeactivated:member + package: excel! + fullName: onDeactivated + summary: Occurs when the worksheet is deactivated. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + sheet.onDeactivated.add(function (event) { + return Excel.run(async (context) => { + console.log("The deactivated worksheet is: " + event.worksheetId); + await context.sync(); + }); + }); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onDeactivated: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onFormatChanged + uid: excel!Excel.Worksheet#onFormatChanged:member + package: excel! + fullName: onFormatChanged + summary: Occurs when format changed on a specific worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onFormatChanged: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onFormulaChanged + uid: excel!Excel.Worksheet#onFormulaChanged:member + package: excel! + fullName: onFormulaChanged + summary: >- + Occurs when one or more formulas are changed in this worksheet. This event + is for when the formula itself changes, not the data value resulting from + the formula's calculation. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-formula-changed.yaml + + + await Excel.run(async (context) => { + // Retrieve the worksheet named "Sample". + let sheet = context.workbook.worksheets.getItem("Sample"); + + // Register the formula changed event handler for this worksheet. + sheet.onFormulaChanged.add(formulaChangeHandler); + await context.sync(); + + console.log("Registered a formula changed event handler for this worksheet."); + }); + + + ... + + + async function formulaChangeHandler(event: + Excel.WorksheetFormulaChangedEventArgs) { + await Excel.run(async (context) => { + // Retrieve details about the formula change event. + const cellAddress = event.formulaDetails[0].cellAddress; + const previousFormula = event.formulaDetails[0].previousFormula; + const source = event.source; + + // Print out the change event details. + console.log( + `The formula in cell ${cellAddress} changed. + The previous formula was: ${previousFormula}. + The source of the change was: ${source}.` + ); + }); + } + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onFormulaChanged: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onNameChanged + uid: excel!Excel.Worksheet#onNameChanged:member + package: excel! + fullName: onNameChanged + summary: Occurs when the worksheet name is changed. + remarks: >- + \[ [API set: ExcelApi + 1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onNameChanged: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onProtectionChanged + uid: excel!Excel.Worksheet#onProtectionChanged:member + package: excel! + fullName: onProtectionChanged + summary: Occurs when the worksheet protection state is changed. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-worksheet-protection.yaml + + + // This function registers an event handler for the onProtectionChanged + event of a worksheet. + + await Excel.run(async (context) => { + // Set "Sample" as the active worksheet. + context.workbook.worksheets.getItemOrNullObject("Sample").delete(); + const sheet = context.workbook.worksheets.add("Sample"); + sheet.activate(); + + // Register the onProtectionChanged event handler. + sheet.onProtectionChanged.add(checkProtection); + await context.sync(); + console.log("Added a worksheet protection change event handler."); + }); + + + ... + + + async function checkProtection(event: + Excel.WorksheetProtectionChangedEventArgs) { + // This function is an event handler that returns the protection status of a worksheet + // and information about the changed worksheet. + await Excel.run(async (context) => { + const protectionStatus = event.isProtected; + const worksheetId = event.worksheetId; + const source = event.source; + console.log("Protection status changed. Protection status is now: " + protectionStatus + "."); + console.log(" ID of changed worksheet: " + worksheetId + "."); + console.log(" Source of change event: " + source + "."); + }); + } + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onProtectionChanged: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onRowHiddenChanged + uid: excel!Excel.Worksheet#onRowHiddenChanged:member + package: excel! + fullName: onRowHiddenChanged + summary: >- + Occurs when the hidden state of one or more rows has changed on a specific + worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + sheet.onRowHiddenChanged.add(function (event) { + return Excel.run(async (context) => { + console.log(`Row ${event.address} is now ${event.changeType}`); + await context.sync(); + }); + }); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onRowHiddenChanged: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onRowSorted + uid: excel!Excel.Worksheet#onRowSorted:member + package: excel! + fullName: onRowSorted + summary: >- + Occurs when one or more rows have been sorted. This happens as the result + of a top-to-bottom sort operation. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/event-column-and-row-sort.yaml + + + await Excel.run(async (context) => { + console.log("Adding row handler"); + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // This will fire whenever a row has been moved as the result of a sort action. + sheet.onRowSorted.add((event) => { + return Excel.run((context) => { + console.log("Row sorted: " + event.address); + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Clear formatting for section, then highlight the sorted area. + sheet.getRange("A1:E5").format.fill.clear(); + if (event.address !== "") { + sheet.getRanges(event.address).format.fill.color = "yellow"; + } + + return context.sync(); + }); + }); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onRowSorted: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onSelectionChanged + uid: excel!Excel.Worksheet#onSelectionChanged:member + package: excel! + fullName: onSelectionChanged + summary: Occurs when the selection changes on a specific worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + sheet.onSelectionChanged.add(function (event) { + return Excel.run(async (context) => { + console.log("The selected range has changed to: " + event.address); + await context.sync(); + }); + }); + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onSelectionChanged: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onSingleClicked + uid: excel!Excel.Worksheet#onSingleClicked:member + package: excel! + fullName: onSingleClicked + summary: >- + Occurs when a left-clicked/tapped action happens in the worksheet. This + event will not be fired when clicking in the following cases: + + + - The user drags the mouse for multi-selection. + + + - The user selects a cell in the mode when cell arguments are selected for + formula references. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/event-worksheet-single-click.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + sheet.onSingleClicked.add((event) => { + return Excel.run((context) => { + console.log(`Click detected at ${event.address} (pixel offset from upper-left cell corner: ${event.offsetX}, ${event.offsetY})`); + return context.sync(); + }); + }); + + console.log("The worksheet click handler is registered."); + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onSingleClicked: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onVisibilityChanged + uid: excel!Excel.Worksheet#onVisibilityChanged:member + package: excel! + fullName: onVisibilityChanged + summary: Occurs when the worksheet visibility is changed. + remarks: >- + \[ [API set: ExcelApi + 1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onVisibilityChanged: + OfficeExtension.EventHandlers; + return: + type: >- + <> +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetactivatedeventargs.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetactivatedeventargs.yml new file mode 100644 index 0000000000..8d5b9db655 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetactivatedeventargs.yml @@ -0,0 +1,44 @@ +### YamlMime:TSType +name: Excel.WorksheetActivatedEventArgs +uid: excel!Excel.WorksheetActivatedEventArgs:interface +package: excel! +fullName: Excel.WorksheetActivatedEventArgs +summary: Provides information about the worksheet that raised the activated event. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: type + uid: excel!Excel.WorksheetActivatedEventArgs#type:member + package: excel! + fullName: type + summary: Gets the type of the event. See `Excel.EventType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: "WorksheetActivated";' + return: + type: '"WorksheetActivated"' + - name: worksheetId + uid: excel!Excel.WorksheetActivatedEventArgs#worksheetId:member + package: excel! + fullName: worksheetId + summary: Gets the ID of the worksheet that is activated. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheetId: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetaddedeventargs.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetaddedeventargs.yml new file mode 100644 index 0000000000..66bbcd03b9 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetaddedeventargs.yml @@ -0,0 +1,80 @@ +### YamlMime:TSType +name: Excel.WorksheetAddedEventArgs +uid: excel!Excel.WorksheetAddedEventArgs:interface +package: excel! +fullName: Excel.WorksheetAddedEventArgs +summary: Provides information about the worksheet that raised the added event. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: source + uid: excel!Excel.WorksheetAddedEventArgs#source:member + package: excel! + fullName: source + summary: Gets the source of the event. See `Excel.EventSource` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'source: Excel.EventSource | "Local" | "Remote";' + return: + type: | "Local" | "Remote" + - name: type + uid: excel!Excel.WorksheetAddedEventArgs#type:member + package: excel! + fullName: type + summary: Gets the type of the event. See `Excel.EventType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: "WorksheetAdded";' + return: + type: '"WorksheetAdded"' + - name: worksheetId + uid: excel!Excel.WorksheetAddedEventArgs#worksheetId:member + package: excel! + fullName: worksheetId + summary: Gets the ID of the worksheet that is added to the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-workbook-and-worksheet-collection.yaml + + + async function onWorksheetAdd(event) { + await Excel.run(async (context) => { + console.log( + "Handler for worksheet onAdded event has been triggered. Newly added worksheet Id : " + + event.worksheetId + ); + }); + } + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheetId: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetcalculatedeventargs.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetcalculatedeventargs.yml new file mode 100644 index 0000000000..077c4b4092 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetcalculatedeventargs.yml @@ -0,0 +1,63 @@ +### YamlMime:TSType +name: Excel.WorksheetCalculatedEventArgs +uid: excel!Excel.WorksheetCalculatedEventArgs:interface +package: excel! +fullName: Excel.WorksheetCalculatedEventArgs +summary: Provides information about the worksheet that raised the calculated event. +remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: address + uid: excel!Excel.WorksheetCalculatedEventArgs#address:member + package: excel! + fullName: address + summary: >- + The address of the range that completed calculation. If multiple ranges + completed calculation, the string is a comma-separated list of those range + addresses. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'address: string;' + return: + type: string + - name: type + uid: excel!Excel.WorksheetCalculatedEventArgs#type:member + package: excel! + fullName: type + summary: Gets the type of the event. See `Excel.EventType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: "WorksheetCalculated";' + return: + type: '"WorksheetCalculated"' + - name: worksheetId + uid: excel!Excel.WorksheetCalculatedEventArgs#worksheetId:member + package: excel! + fullName: worksheetId + summary: Gets the ID of the worksheet in which the calculation occurred. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheetId: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetchangedeventargs.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetchangedeventargs.yml new file mode 100644 index 0000000000..2d99ffe749 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetchangedeventargs.yml @@ -0,0 +1,321 @@ +### YamlMime:TSType +name: Excel.WorksheetChangedEventArgs +uid: excel!Excel.WorksheetChangedEventArgs:interface +package: excel! +fullName: Excel.WorksheetChangedEventArgs +summary: Provides information about the worksheet that raised the changed event. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: address + uid: excel!Excel.WorksheetChangedEventArgs#address:member + package: excel! + fullName: address + summary: >- + Gets the range address that represents the changed area of a specific + worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'address: string;' + return: + type: string + - name: changeDirectionState + uid: excel!Excel.WorksheetChangedEventArgs#changeDirectionState:member + package: excel! + fullName: changeDirectionState + summary: >- + Represents a change to the direction that the cells in a worksheet will + shift when a cell or cells are deleted or inserted. This includes the + following two scenarios. 1. The direction (such as down or to the right) + that existing cells will shift when a new cell or cells are inserted into + a worksheet. 2. The direction (such as up or to the left) that the + remaining cells will shift when a cell or cells are deleted from a + worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-worksheet.yaml + + + async function onChange(event: Excel.WorksheetChangedEventArgs) { + // This function is an event handler that returns the address, trigger source, + // and insert or delete shift directions of the change. + await Excel.run(async (context) => { + // Return the address where change occurred. + console.log(`Handler for worksheet onChanged event has been triggered.`); + console.log(` Data changed address: ` + event.address); + + // Return the source of the event that triggered the change. + console.log(` Data change trigger source: ` + event.triggerSource); + + // Note：insertShiftDirection and deleteShiftDirection are exclusive and both enums can't have a value at the same time. + // If one has a value, then the other will return undefined. + + // If the insert shift direction is defined, return it. + if (event.changeDirectionState.insertShiftDirection) { + console.log(` Cells inserted shift direction: ` + event.changeDirectionState.insertShiftDirection); + } + + // If the delete shift direction is defined, return it. + if (event.changeDirectionState.deleteShiftDirection) { + console.log(` Cells deleted shift direction: ` + event.changeDirectionState.deleteShiftDirection); + } + }); + } + + + ... + + + // This function deletes data from a range and sets the delete shift + direction to "up". + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const range = sheet.getRange("A5:F5"); + range.delete(Excel.DeleteShiftDirection.up); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'changeDirectionState: Excel.ChangeDirectionState;' + return: + type: + - name: changeType + uid: excel!Excel.WorksheetChangedEventArgs#changeType:member + package: excel! + fullName: changeType + summary: >- + Gets the change type that represents how the changed event is triggered. + See `Excel.DataChangeType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + changeType: Excel.DataChangeType | "Unknown" | "RangeEdited" | + "RowInserted" | "RowDeleted" | "ColumnInserted" | "ColumnDeleted" | + "CellInserted" | "CellDeleted"; + return: + type: >- + | "Unknown" | + "RangeEdited" | "RowInserted" | "RowDeleted" | "ColumnInserted" | + "ColumnDeleted" | "CellInserted" | "CellDeleted" + - name: details + uid: excel!Excel.WorksheetChangedEventArgs#details:member + package: excel! + fullName: details + summary: >- + Represents the information about the change detail. This property can be + retrieved when the changed event is triggered on a single cell. If the + changed event is triggered on multiple cells, this property cannot be + retrieved. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // This function would be used as an event handler for the + Worksheet.onChanged event. + + async function onWorksheetChanged(eventArgs) { + await Excel.run(async (context) => { + const details = eventArgs.details; + const address = eventArgs.address; + + // Print the before and after types and values to the console. + console.log(`Change at ${address}: was ${details.valueBefore}(${details.valueTypeBefore}),` + + ` now is ${details.valueAfter}(${details.valueTypeAfter})`); + await context.sync(); + }); + } + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'details: Excel.ChangedEventDetail;' + return: + type: + - name: source + uid: excel!Excel.WorksheetChangedEventArgs#source:member + package: excel! + fullName: source + summary: Gets the source of the event. See `Excel.EventSource` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'source: Excel.EventSource | "Local" | "Remote";' + return: + type: | "Local" | "Remote" + - name: triggerSource + uid: excel!Excel.WorksheetChangedEventArgs#triggerSource:member + package: excel! + fullName: triggerSource + summary: >- + Represents the trigger source of the event. For example, identifies + whether this local add-in triggers the event. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-worksheet.yaml + + + async function onChange(event: Excel.WorksheetChangedEventArgs) { + // This function is an event handler that returns the address, trigger source, + // and insert or delete shift directions of the change. + await Excel.run(async (context) => { + // Return the address where change occurred. + console.log(`Handler for worksheet onChanged event has been triggered.`); + console.log(` Data changed address: ` + event.address); + + // Return the source of the event that triggered the change. + console.log(` Data change trigger source: ` + event.triggerSource); + + // Note：insertShiftDirection and deleteShiftDirection are exclusive and both enums can't have a value at the same time. + // If one has a value, then the other will return undefined. + + // If the insert shift direction is defined, return it. + if (event.changeDirectionState.insertShiftDirection) { + console.log(` Cells inserted shift direction: ` + event.changeDirectionState.insertShiftDirection); + } + + // If the delete shift direction is defined, return it. + if (event.changeDirectionState.deleteShiftDirection) { + console.log(` Cells deleted shift direction: ` + event.changeDirectionState.deleteShiftDirection); + } + }); + } + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'triggerSource: Excel.EventTriggerSource | "Unknown" | "ThisLocalAddin";' + return: + type: >- + | "Unknown" | + "ThisLocalAddin" + - name: type + uid: excel!Excel.WorksheetChangedEventArgs#type:member + package: excel! + fullName: type + summary: Gets the type of the event. See `Excel.EventType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: "WorksheetChanged";' + return: + type: '"WorksheetChanged"' + - name: worksheetId + uid: excel!Excel.WorksheetChangedEventArgs#worksheetId:member + package: excel! + fullName: worksheetId + summary: Gets the ID of the worksheet in which the data changed. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheetId: string;' + return: + type: string +methods: + - name: getRange(ctx) + uid: excel!Excel.WorksheetChangedEventArgs#getRange:member(1) + package: excel! + fullName: getRange(ctx) + summary: >- + Gets the range that represents the changed area of a specific worksheet. + + + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'getRange(ctx: Excel.RequestContext): Excel.Range;' + parameters: + - id: ctx + description: '' + type: + return: + type: + description: '' + - name: getRangeOrNullObject(ctx) + uid: excel!Excel.WorksheetChangedEventArgs#getRangeOrNullObject:member(1) + package: excel! + fullName: getRangeOrNullObject(ctx) + summary: >- + Gets the range that represents the changed area of a specific worksheet. + It might return null object. + + + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'getRangeOrNullObject(ctx: Excel.RequestContext): Excel.Range;' + parameters: + - id: ctx + description: '' + type: + return: + type: + description: '' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetcollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetcollection.yml new file mode 100644 index 0000000000..05527d504a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetcollection.yml @@ -0,0 +1,832 @@ +### YamlMime:TSType +name: Excel.WorksheetCollection +uid: excel!Excel.WorksheetCollection:class +package: excel! +fullName: Excel.WorksheetCollection +summary: Represents a collection of worksheet objects that are part of the workbook. +remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.WorksheetCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: excel!Excel.WorksheetCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.Worksheet[];' + return: + type: [] +methods: + - name: add(name) + uid: excel!Excel.WorksheetCollection#add:member(1) + package: excel! + fullName: add(name) + summary: >- + Adds a new worksheet to the workbook. The worksheet will be added at the + end of existing worksheets. If you wish to activate the newly added + worksheet, call `.activate()` on it. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const wSheetName = 'Sample Name'; + const worksheet = context.workbook.worksheets.add(wSheetName); + worksheet.load('name'); + await context.sync(); + + console.log(worksheet.name); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'add(name?: string): Excel.Worksheet;' + parameters: + - id: name + description: >- + Optional. The name of the worksheet to be added. If specified, the + name should be unique. If not specified, Excel determines the name + of the new worksheet. + type: string + return: + type: + description: '' + - name: getActiveWorksheet() + uid: excel!Excel.WorksheetCollection#getActiveWorksheet:member(1) + package: excel! + fullName: getActiveWorksheet() + summary: Gets the currently active worksheet in the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + await Excel.run(async (context) => { + const activeWorksheet = context.workbook.worksheets.getActiveWorksheet(); + activeWorksheet.load('name'); + await context.sync(); + console.log(activeWorksheet.name); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getActiveWorksheet(): Excel.Worksheet;' + return: + type: + description: '' + - name: getCount(visibleOnly) + uid: excel!Excel.WorksheetCollection#getCount:member(1) + package: excel! + fullName: getCount(visibleOnly) + summary: Gets the number of worksheets in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(visibleOnly?: boolean): OfficeExtension.ClientResult;' + parameters: + - id: visibleOnly + description: >- + Optional. If `true`, considers only visible worksheets, + skipping over any hidden ones. + type: boolean + return: + type: <number> + description: '' + - name: getFirst(visibleOnly) + uid: excel!Excel.WorksheetCollection#getFirst:member(1) + package: excel! + fullName: getFirst(visibleOnly) + summary: Gets the first worksheet in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/reference-worksheets-by-relative-position.yaml + + + await Excel.run(async (context) => { + const sheets = context.workbook.worksheets; + + // We don't want to include the default worksheet that was created + // when the workbook was created, so our "firstSheet" will be the one + // after the literal first. Note chaining of navigation methods. + const firstSheet = sheets.getFirst().getNext(); + const lastSheet = sheets.getLast(); + const firstTaxRateRange = firstSheet.getRange("B2"); + const lastTaxRateRange = lastSheet.getRange("B2"); + + firstSheet.load("name"); + lastSheet.load("name"); + firstTaxRateRange.load("text"); + lastTaxRateRange.load("text"); + + await context.sync(); + + let firstYear = firstSheet.name.substr(5, 4); + let lastYear = lastSheet.name.substr(5, 4); + console.log(`Tax Rate change from ${firstYear} to ${lastYear}`, `Tax rate for ${firstYear}: ${firstTaxRateRange.text[0][0]}\nTax rate for ${lastYear}: ${lastTaxRateRange.text[0][0]}`) + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getFirst(visibleOnly?: boolean): Excel.Worksheet;' + parameters: + - id: visibleOnly + description: >- + Optional. If `true`, considers only visible worksheets, + skipping over any hidden ones. + type: boolean + return: + type: + description: '' + - name: getItem(key) + uid: excel!Excel.WorksheetCollection#getItem:member(1) + package: excel! + fullName: getItem(key) + summary: Gets a worksheet object using its name or ID. + remarks: >- + \[ [API set: ExcelApi + 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItem(key: string): Excel.Worksheet;' + parameters: + - id: key + description: The name or ID of the worksheet. + type: string + return: + type: + description: '' + - name: getItemOrNullObject(key) + uid: excel!Excel.WorksheetCollection#getItemOrNullObject:member(1) + package: excel! + fullName: getItemOrNullObject(key) + summary: >- + Gets a worksheet object using its name or ID. If the worksheet does not + exist, then this method returns an object with its `isNullObject` property + set to `true`. For further information, see [*OrNullObject + methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemOrNullObject(key: string): Excel.Worksheet;' + parameters: + - id: key + description: The name or ID of the worksheet. + type: string + return: + type: + description: '' + - name: getLast(visibleOnly) + uid: excel!Excel.WorksheetCollection#getLast:member(1) + package: excel! + fullName: getLast(visibleOnly) + summary: Gets the last worksheet in the collection. + remarks: >- + \[ [API set: ExcelApi + 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/reference-worksheets-by-relative-position.yaml + + + await Excel.run(async (context) => { + const sheets = context.workbook.worksheets; + + // We don't want to include the default worksheet that was created + // when the workbook was created, so our "firstSheet" will be the one + // after the literal first. Note chaining of navigation methods. + const firstSheet = sheets.getFirst().getNext(); + const lastSheet = sheets.getLast(); + const firstTaxRateRange = firstSheet.getRange("B2"); + const lastTaxRateRange = lastSheet.getRange("B2"); + + firstSheet.load("name"); + lastSheet.load("name"); + firstTaxRateRange.load("text"); + lastTaxRateRange.load("text"); + + await context.sync(); + + let firstYear = firstSheet.name.substr(5, 4); + let lastYear = lastSheet.name.substr(5, 4); + console.log(`Tax Rate change from ${firstYear} to ${lastYear}`, `Tax rate for ${firstYear}: ${firstTaxRateRange.text[0][0]}\nTax rate for ${lastYear}: ${lastTaxRateRange.text[0][0]}`) + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getLast(visibleOnly?: boolean): Excel.Worksheet;' + parameters: + - id: visibleOnly + description: >- + Optional. If `true`, considers only visible worksheets, + skipping over any hidden ones. + type: boolean + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.WorksheetCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.WorksheetCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): Excel.WorksheetCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.WorksheetCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.WorksheetCollection;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: |- + + + #### Examples + + ```TypeScript + await Excel.run(async (context) => { + const worksheets = context.workbook.worksheets; + worksheets.load('items'); + await context.sync(); + + for (let i = 0; i < worksheets.items.length; i++) { + console.log(worksheets.items[i].name); + } + }); + ``` + - name: load(propertyNamesAndPaths) + uid: excel!Excel.WorksheetCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.WorksheetCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.WorksheetCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.WorksheetCollection` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.WorksheetCollectionData`) that contains an + "items" array with shallow copies of any loaded properties from the + collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.WorksheetCollectionData;' + return: + type: >- + + description: '' +events: + - name: onActivated + uid: excel!Excel.WorksheetCollection#onActivated:member + package: excel! + fullName: onActivated + summary: Occurs when any worksheet in the workbook is activated. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-workbook-and-worksheet-collection.yaml + + + await Excel.run(async (context) => { + let sheets = context.workbook.worksheets; + sheets.onActivated.add(onActivate); + + await context.sync(); + console.log("A handler has been registered for the OnActivate event."); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onActivated: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onAdded + uid: excel!Excel.WorksheetCollection#onAdded:member + package: excel! + fullName: onAdded + summary: Occurs when a new worksheet is added to the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-workbook-and-worksheet-collection.yaml + + + await Excel.run(async (context) => { + let sheet = context.workbook.worksheets; + sheet.onAdded.add(onWorksheetAdd); + + await context.sync(); + console.log("A handler has been registered for the OnAdded event."); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onAdded: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onCalculated + uid: excel!Excel.WorksheetCollection#onCalculated:member + package: excel! + fullName: onCalculated + summary: Occurs when any worksheet in the workbook is calculated. + remarks: >- + \[ [API set: ExcelApi + 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onCalculated: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onChanged + uid: excel!Excel.WorksheetCollection#onChanged:member + package: excel! + fullName: onChanged + summary: Occurs when any worksheet in the workbook is changed. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onChanged: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onColumnSorted + uid: excel!Excel.WorksheetCollection#onColumnSorted:member + package: excel! + fullName: onColumnSorted + summary: >- + Occurs when one or more columns have been sorted. This happens as the + result of a left-to-right sort operation. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onColumnSorted: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onDeactivated + uid: excel!Excel.WorksheetCollection#onDeactivated:member + package: excel! + fullName: onDeactivated + summary: Occurs when any worksheet in the workbook is deactivated. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-workbook-and-worksheet-collection.yaml + + + await Excel.run(async (context) => { + let sheets = context.workbook.worksheets; + sheets.onDeactivated.add(onDeactivate); + + await context.sync(); + console.log("A handler has been registered for the OnDeactivate event."); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onDeactivated: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onDeleted + uid: excel!Excel.WorksheetCollection#onDeleted:member + package: excel! + fullName: onDeleted + summary: Occurs when a worksheet is deleted from the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onDeleted: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onFormatChanged + uid: excel!Excel.WorksheetCollection#onFormatChanged:member + package: excel! + fullName: onFormatChanged + summary: Occurs when any worksheet in the workbook has a format changed. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onFormatChanged: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onFormulaChanged + uid: excel!Excel.WorksheetCollection#onFormulaChanged:member + package: excel! + fullName: onFormulaChanged + summary: >- + Occurs when one or more formulas are changed in any worksheet of this + collection. This event is for when the formula itself changes, not the + data value resulting from the formula's calculation. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onFormulaChanged: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onMoved + uid: excel!Excel.WorksheetCollection#onMoved:member + package: excel! + fullName: onMoved + summary: >- + Occurs when a worksheet is moved within a workbook. This event only + triggers when a worksheet is directly moved within a workbook. This event + doesn't trigger when the position of a worksheet is indirectly changed, + such as when a new worksheet is inserted and causes existing worksheets to + change positions. + remarks: >- + \[ [API set: ExcelApi + 1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onMoved: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onNameChanged + uid: excel!Excel.WorksheetCollection#onNameChanged:member + package: excel! + fullName: onNameChanged + summary: Occurs when the worksheet name is changed in the worksheet collection. + remarks: >- + \[ [API set: ExcelApi + 1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onNameChanged: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onProtectionChanged + uid: excel!Excel.WorksheetCollection#onProtectionChanged:member + package: excel! + fullName: onProtectionChanged + summary: Occurs when the worksheet protection state is changed. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onProtectionChanged: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onRowHiddenChanged + uid: excel!Excel.WorksheetCollection#onRowHiddenChanged:member + package: excel! + fullName: onRowHiddenChanged + summary: >- + Occurs when the hidden state of one or more rows has changed on a specific + worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onRowHiddenChanged: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onRowSorted + uid: excel!Excel.WorksheetCollection#onRowSorted:member + package: excel! + fullName: onRowSorted + summary: >- + Occurs when one or more rows have been sorted. This happens as the result + of a top-to-bottom sort operation. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onRowSorted: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onSelectionChanged + uid: excel!Excel.WorksheetCollection#onSelectionChanged:member + package: excel! + fullName: onSelectionChanged + summary: Occurs when the selection changes on any worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onSelectionChanged: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onSingleClicked + uid: excel!Excel.WorksheetCollection#onSingleClicked:member + package: excel! + fullName: onSingleClicked + summary: >- + Occurs when left-clicked/tapped operation happens in the worksheet + collection. This event will not be fired when clicking in the following + cases: - The user drags the mouse for multi-selection. - The user selects + a cell in the mode when cell arguments are selected for formula + references. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onSingleClicked: + OfficeExtension.EventHandlers; + return: + type: >- + <> + - name: onVisibilityChanged + uid: excel!Excel.WorksheetCollection#onVisibilityChanged:member + package: excel! + fullName: onVisibilityChanged + summary: >- + Occurs when the worksheet visibility is changed in the worksheet + collection. + remarks: >- + \[ [API set: ExcelApi + 1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + readonly onVisibilityChanged: + OfficeExtension.EventHandlers; + return: + type: >- + <> +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetcolumnsortedeventargs.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetcolumnsortedeventargs.yml new file mode 100644 index 0000000000..a3f273e49d --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetcolumnsortedeventargs.yml @@ -0,0 +1,81 @@ +### YamlMime:TSType +name: Excel.WorksheetColumnSortedEventArgs +uid: excel!Excel.WorksheetColumnSortedEventArgs:interface +package: excel! +fullName: Excel.WorksheetColumnSortedEventArgs +summary: Provides information about the column-sorted event and its related worksheet. +remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: address + uid: excel!Excel.WorksheetColumnSortedEventArgs#address:member + package: excel! + fullName: address + summary: >- + Gets the range address that represents the sorted areas of a specific + worksheet. Only columns changed as a result of the sort operation are + returned. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'address: string;' + return: + type: string + - name: source + uid: excel!Excel.WorksheetColumnSortedEventArgs#source:member + package: excel! + fullName: source + summary: Gets the source of the event. See `Excel.EventSource` for details. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'source: Excel.EventSource | "Local" | "Remote";' + return: + type: | "Local" | "Remote" + - name: type + uid: excel!Excel.WorksheetColumnSortedEventArgs#type:member + package: excel! + fullName: type + summary: Gets the type of the event. See `Excel.EventType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: "WorksheetColumnSorted";' + return: + type: '"WorksheetColumnSorted"' + - name: worksheetId + uid: excel!Excel.WorksheetColumnSortedEventArgs#worksheetId:member + package: excel! + fullName: worksheetId + summary: Gets the ID of the worksheet where the sorting happened. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheetId: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetcustomproperty.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetcustomproperty.yml new file mode 100644 index 0000000000..a8aee874f8 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetcustomproperty.yml @@ -0,0 +1,240 @@ +### YamlMime:TSType +name: Excel.WorksheetCustomProperty +uid: excel!Excel.WorksheetCustomProperty:class +package: excel! +fullName: Excel.WorksheetCustomProperty +summary: Represents a worksheet-level custom property. +remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.WorksheetCustomProperty#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: key + uid: excel!Excel.WorksheetCustomProperty#key:member + package: excel! + fullName: key + summary: >- + Gets the key of the custom property. Custom property keys are + case-insensitive. The key is limited to 255 characters (larger values will + cause an `InvalidArgument` error to be thrown.) + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly key: string;' + return: + type: string + - name: value + uid: excel!Excel.WorksheetCustomProperty#value:member + package: excel! + fullName: value + summary: Gets or sets the value of the custom property. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'value: string;' + return: + type: string +methods: + - name: delete() + uid: excel!Excel.WorksheetCustomProperty#delete:member(1) + package: excel! + fullName: delete() + summary: Deletes the custom property. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'delete(): void;' + return: + type: void + description: '' + - name: load(options) + uid: excel!Excel.WorksheetCustomProperty#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.WorksheetCustomPropertyLoadOptions): + Excel.WorksheetCustomProperty; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.WorksheetCustomProperty#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.WorksheetCustomProperty;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.WorksheetCustomProperty#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.WorksheetCustomProperty; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: set(properties, options) + uid: excel!Excel.WorksheetCustomProperty#set:member(1) + package: excel! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.WorksheetCustomPropertyUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: excel!Excel.WorksheetCustomProperty#set:member(2) + package: excel! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'set(properties: Excel.WorksheetCustomProperty): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.WorksheetCustomProperty#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.WorksheetCustomProperty` object is an API object, the `toJSON` + method returns a plain JavaScript object (typed as + `Excel.Interfaces.WorksheetCustomPropertyData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.WorksheetCustomPropertyData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetcustompropertycollection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetcustompropertycollection.yml new file mode 100644 index 0000000000..dbb8b348ec --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetcustompropertycollection.yml @@ -0,0 +1,275 @@ +### YamlMime:TSType +name: Excel.WorksheetCustomPropertyCollection +uid: excel!Excel.WorksheetCustomPropertyCollection:class +package: excel! +fullName: Excel.WorksheetCustomPropertyCollection +summary: Contains the collection of worksheet-level custom property. +remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.WorksheetCustomPropertyCollection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: excel!Excel.WorksheetCustomPropertyCollection#items:member + package: excel! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Excel.WorksheetCustomProperty[];' + return: + type: [] +methods: + - name: add(key, value) + uid: excel!Excel.WorksheetCustomPropertyCollection#add:member(1) + package: excel! + fullName: add(key, value) + summary: >- + Adds a new custom property that maps to the provided key. This overwrites + existing custom properties with that key. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/26-document/custom-properties.yaml + + + await Excel.run(async (context) => { + // Get the key/value pair from the task pane. + const userKey = document.getElementById("key").textContent; + const userValue = document.getElementById("value").textContent; + + // Add the custom property. + const customWorksheetProperties = context.workbook.worksheets.getActiveWorksheet().customProperties; + customWorksheetProperties.add(userKey, userValue); + + await context.sync(); + + console.log(`Successfully set custom worksheet property ${userKey}:${userValue}.`); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'add(key: string, value: string): Excel.WorksheetCustomProperty;' + parameters: + - id: key + description: >- + The key that identifies the custom property object. It is + case-insensitive.The key is limited to 255 characters (larger values + will cause an `InvalidArgument` error to be thrown.) + type: string + - id: value + description: The value of this custom property. + type: string + return: + type: + description: '' + - name: getCount() + uid: excel!Excel.WorksheetCustomPropertyCollection#getCount:member(1) + package: excel! + fullName: getCount() + summary: Gets the number of custom properties on this worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getItem(key) + uid: excel!Excel.WorksheetCustomPropertyCollection#getItem:member(1) + package: excel! + fullName: getItem(key) + summary: >- + Gets a custom property object by its key, which is case-insensitive. + Throws an error if the custom property does not exist. + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItem(key: string): Excel.WorksheetCustomProperty;' + parameters: + - id: key + description: >- + The key that identifies the custom property object. It is + case-insensitive. + type: string + return: + type: + description: '' + - name: getItemOrNullObject(key) + uid: >- + excel!Excel.WorksheetCustomPropertyCollection#getItemOrNullObject:member(1) + package: excel! + fullName: getItemOrNullObject(key) + summary: >- + Gets a custom property object by its key, which is case-insensitive. If + the custom property doesn't exist, then this method returns an object with + its `isNullObject` property set to `true`. For further + information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getItemOrNullObject(key: string): Excel.WorksheetCustomProperty;' + parameters: + - id: key + description: >- + The key that identifies the custom property object. It is + case-insensitive. + type: string + return: + type: + description: '' + - name: load(options) + uid: excel!Excel.WorksheetCustomPropertyCollection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: + Excel.Interfaces.WorksheetCustomPropertyCollectionLoadOptions & + Excel.Interfaces.CollectionLoadOptions): + Excel.WorksheetCustomPropertyCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.WorksheetCustomPropertyCollection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNames?: string | string[]): + Excel.WorksheetCustomPropertyCollection; + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.WorksheetCustomPropertyCollection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Excel.WorksheetCustomPropertyCollection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.WorksheetCustomPropertyCollection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.WorksheetCustomPropertyCollection` object is an API object, the + `toJSON` method returns a plain JavaScript object (typed as + `Excel.Interfaces.WorksheetCustomPropertyCollectionData`) that + contains an "items" array with shallow copies of any loaded properties + from the collection's items. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.WorksheetCustomPropertyCollectionData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetdeactivatedeventargs.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetdeactivatedeventargs.yml new file mode 100644 index 0000000000..793ca679f4 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetdeactivatedeventargs.yml @@ -0,0 +1,44 @@ +### YamlMime:TSType +name: Excel.WorksheetDeactivatedEventArgs +uid: excel!Excel.WorksheetDeactivatedEventArgs:interface +package: excel! +fullName: Excel.WorksheetDeactivatedEventArgs +summary: Provides information about the worksheet that raised the deactivated event. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: type + uid: excel!Excel.WorksheetDeactivatedEventArgs#type:member + package: excel! + fullName: type + summary: Gets the type of the event. See `Excel.EventType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: "WorksheetDeactivated";' + return: + type: '"WorksheetDeactivated"' + - name: worksheetId + uid: excel!Excel.WorksheetDeactivatedEventArgs#worksheetId:member + package: excel! + fullName: worksheetId + summary: Gets the ID of the worksheet that is deactivated. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheetId: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetdeletedeventargs.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetdeletedeventargs.yml new file mode 100644 index 0000000000..d00f47359d --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetdeletedeventargs.yml @@ -0,0 +1,59 @@ +### YamlMime:TSType +name: Excel.WorksheetDeletedEventArgs +uid: excel!Excel.WorksheetDeletedEventArgs:interface +package: excel! +fullName: Excel.WorksheetDeletedEventArgs +summary: Provides information about the worksheet that raised the deleted event. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: source + uid: excel!Excel.WorksheetDeletedEventArgs#source:member + package: excel! + fullName: source + summary: Gets the source of the event. See `Excel.EventSource` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'source: Excel.EventSource | "Local" | "Remote";' + return: + type: | "Local" | "Remote" + - name: type + uid: excel!Excel.WorksheetDeletedEventArgs#type:member + package: excel! + fullName: type + summary: Gets the type of the event. See `Excel.EventType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: "WorksheetDeleted";' + return: + type: '"WorksheetDeleted"' + - name: worksheetId + uid: excel!Excel.WorksheetDeletedEventArgs#worksheetId:member + package: excel! + fullName: worksheetId + summary: Gets the ID of the worksheet that is deleted from the workbook. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheetId: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetformatchangedeventargs.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetformatchangedeventargs.yml new file mode 100644 index 0000000000..2b05aeb9ef --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetformatchangedeventargs.yml @@ -0,0 +1,124 @@ +### YamlMime:TSType +name: Excel.WorksheetFormatChangedEventArgs +uid: excel!Excel.WorksheetFormatChangedEventArgs:interface +package: excel! +fullName: Excel.WorksheetFormatChangedEventArgs +summary: Provides information about the worksheet format change event. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: address + uid: excel!Excel.WorksheetFormatChangedEventArgs#address:member + package: excel! + fullName: address + summary: >- + Gets the range address that represents the changed area of a specific + worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'address: string;' + return: + type: string + - name: source + uid: excel!Excel.WorksheetFormatChangedEventArgs#source:member + package: excel! + fullName: source + summary: Gets the source of the event. See `Excel.EventSource` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'source: Excel.EventSource | "Local" | "Remote";' + return: + type: | "Local" | "Remote" + - name: type + uid: excel!Excel.WorksheetFormatChangedEventArgs#type:member + package: excel! + fullName: type + summary: Gets the type of the event. See `Excel.EventType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: "WorksheetFormatChanged";' + return: + type: '"WorksheetFormatChanged"' + - name: worksheetId + uid: excel!Excel.WorksheetFormatChangedEventArgs#worksheetId:member + package: excel! + fullName: worksheetId + summary: Gets the ID of the worksheet in which the data changed. + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheetId: string;' + return: + type: string +methods: + - name: getRange(ctx) + uid: excel!Excel.WorksheetFormatChangedEventArgs#getRange:member(1) + package: excel! + fullName: getRange(ctx) + summary: >- + Gets the range that represents the changed area of a specific worksheet. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'getRange(ctx: Excel.RequestContext): Excel.Range;' + parameters: + - id: ctx + description: '' + type: + return: + type: + description: '' + - name: getRangeOrNullObject(ctx) + uid: excel!Excel.WorksheetFormatChangedEventArgs#getRangeOrNullObject:member(1) + package: excel! + fullName: getRangeOrNullObject(ctx) + summary: >- + Gets the range that represents the changed area of a specific worksheet. + It might return null object. + + + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'getRangeOrNullObject(ctx: Excel.RequestContext): Excel.Range;' + parameters: + - id: ctx + description: '' + type: + return: + type: + description: '' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetformulachangedeventargs.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetformulachangedeventargs.yml new file mode 100644 index 0000000000..3986bc3a5d --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetformulachangedeventargs.yml @@ -0,0 +1,82 @@ +### YamlMime:TSType +name: Excel.WorksheetFormulaChangedEventArgs +uid: excel!Excel.WorksheetFormulaChangedEventArgs:interface +package: excel! +fullName: Excel.WorksheetFormulaChangedEventArgs +summary: >- + Provides information about the worksheet and formulas that raised the formula + changed event. +remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: formulaDetails + uid: excel!Excel.WorksheetFormulaChangedEventArgs#formulaDetails:member + package: excel! + fullName: formulaDetails + summary: >- + Gets an array of `FormulaChangedEventDetail` objects, which contain the + details about the all of the changed formulas. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'formulaDetails: Excel.FormulaChangedEventDetail[];' + return: + type: [] + - name: source + uid: excel!Excel.WorksheetFormulaChangedEventArgs#source:member + package: excel! + fullName: source + summary: The source of the event. It can be local or remote (through co-authoring). + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'source: Excel.EventSource | "Local" | "Remote";' + return: + type: | "Local" | "Remote" + - name: type + uid: excel!Excel.WorksheetFormulaChangedEventArgs#type:member + package: excel! + fullName: type + summary: Gets the type of the event. See `Excel.EventType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: "WorksheetFormulaChanged";' + return: + type: '"WorksheetFormulaChanged"' + - name: worksheetId + uid: excel!Excel.WorksheetFormulaChangedEventArgs#worksheetId:member + package: excel! + fullName: worksheetId + summary: Gets the ID of the worksheet in which the formula changed. + remarks: >- + \[ [API set: ExcelApi + 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheetId: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetfreezepanes.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetfreezepanes.yml new file mode 100644 index 0000000000..7fa7a81d51 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetfreezepanes.yml @@ -0,0 +1,291 @@ +### YamlMime:TSType +name: Excel.WorksheetFreezePanes +uid: excel!Excel.WorksheetFreezePanes:class +package: excel! +fullName: Excel.WorksheetFreezePanes +summary: '' +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.WorksheetFreezePanes#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: +methods: + - name: freezeAt(frozenRange) + uid: excel!Excel.WorksheetFreezePanes#freezeAt:member(1) + package: excel! + fullName: freezeAt(frozenRange) + summary: >- + Sets the frozen cells in the active worksheet view. The range provided + corresponds to cells that will be frozen in the top- and left-most pane. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-freeze-panes.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + + // Freeze the specified range in top-and-left-most pane of the worksheet. + sheet.freezePanes.freezeAt(sheet.getRange("H2:K5")); + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'freezeAt(frozenRange: Range | string): void;' + parameters: + - id: frozenRange + description: >- + A range that represents the cells to be frozen, or `null` to remove + all frozen panes. + type: | string + return: + type: void + description: '' + - name: freezeColumns(count) + uid: excel!Excel.WorksheetFreezePanes#freezeColumns:member(1) + package: excel! + fullName: freezeColumns(count) + summary: Freeze the first column or columns of the worksheet in place. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-freeze-panes.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + + // Freeze the first two columns in the worksheet. + sheet.freezePanes.freezeColumns(2); + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'freezeColumns(count?: number): void;' + parameters: + - id: count + description: >- + Optional number of columns to freeze, or zero to unfreeze all + columns + type: number + return: + type: void + description: '' + - name: freezeRows(count) + uid: excel!Excel.WorksheetFreezePanes#freezeRows:member(1) + package: excel! + fullName: freezeRows(count) + summary: Freeze the top row or rows of the worksheet in place. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-freeze-panes.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + + // Freeze the top two rows in the worksheet. + sheet.freezePanes.freezeRows(2); + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'freezeRows(count?: number): void;' + parameters: + - id: count + description: Optional number of rows to freeze, or zero to unfreeze all rows + type: number + return: + type: void + description: '' + - name: getLocation() + uid: excel!Excel.WorksheetFreezePanes#getLocation:member(1) + package: excel! + fullName: getLocation() + summary: >- + Gets a range that describes the frozen cells in the active worksheet view. + The frozen range corresponds to cells that are frozen in the top- and + left-most pane. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getLocation(): Excel.Range;' + return: + type: + description: '' + - name: getLocationOrNullObject() + uid: excel!Excel.WorksheetFreezePanes#getLocationOrNullObject:member(1) + package: excel! + fullName: getLocationOrNullObject() + summary: >- + Gets a range that describes the frozen cells in the active worksheet view. + The frozen range corresponds to cells that are frozen in the top- and + left-most pane. If there is no frozen pane, then this method returns an + object with its `isNullObject` property set to `true`. For further + information, see [*OrNullObject methods and + properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties). + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-freeze-panes.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + const frozenRange = sheet.freezePanes.getLocationOrNullObject(); + frozenRange.load("address"); + + await context.sync(); + + if (frozenRange.isNullObject) { + console.log(`The worksheet does not contain a frozen pane.`); + } else { + console.log(`The address of the frozen range (cells that are frozen in the top-and-left-most pane) is "${frozenRange.address}"`); + } + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getLocationOrNullObject(): Excel.Range;' + return: + type: + description: '' + - name: toJSON() + uid: excel!Excel.WorksheetFreezePanes#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.WorksheetFreezePanes` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.WorksheetFreezePanesData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + toJSON(): { + [key: string]: string; + }; + return: + type: |- + { + [key: string]: string; + } + description: '' + - name: unfreeze() + uid: excel!Excel.WorksheetFreezePanes#unfreeze:member(1) + package: excel! + fullName: unfreeze() + summary: Removes all frozen panes in the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-freeze-panes.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Sample"); + sheet.freezePanes.unfreeze(); + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'unfreeze(): void;' + return: + type: void + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetmovedeventargs.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetmovedeventargs.yml new file mode 100644 index 0000000000..04c21083ac --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetmovedeventargs.yml @@ -0,0 +1,103 @@ +### YamlMime:TSType +name: Excel.WorksheetMovedEventArgs +uid: excel!Excel.WorksheetMovedEventArgs:interface +package: excel! +fullName: Excel.WorksheetMovedEventArgs +summary: >- + Notifies when a worksheet is moved within a workbook. + + + If a worksheet is moved from one position within the workbook to another via + the Excel UI, then this API will trigger an event. Note that if the position + of a worksheet changes as a result of moving a different worksheet, then this + event won't trigger for both position changes. This event only triggers for + the primary worksheet move, and not any worksheet position changes that occur + as a result of that primary move. +remarks: >- + \[ [API set: ExcelApi + 1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: positionAfter + uid: excel!Excel.WorksheetMovedEventArgs#positionAfter:member + package: excel! + fullName: positionAfter + summary: Gets the new position of the worksheet, after the move. + remarks: >- + \[ [API set: ExcelApi + 1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'positionAfter: number;' + return: + type: number + - name: positionBefore + uid: excel!Excel.WorksheetMovedEventArgs#positionBefore:member + package: excel! + fullName: positionBefore + summary: Gets the previous position of the worksheet, prior to the move. + remarks: >- + \[ [API set: ExcelApi + 1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'positionBefore: number;' + return: + type: number + - name: source + uid: excel!Excel.WorksheetMovedEventArgs#source:member + package: excel! + fullName: source + summary: The source of the event. It can be local or remote (through co-authoring). + remarks: >- + \[ [API set: ExcelApi + 1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'source: Excel.EventSource | "Local" | "Remote";' + return: + type: | "Local" | "Remote" + - name: type + uid: excel!Excel.WorksheetMovedEventArgs#type:member + package: excel! + fullName: type + summary: Gets the type of the event. + remarks: >- + \[ [API set: ExcelApi + 1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: string;' + return: + type: string + - name: worksheetId + uid: excel!Excel.WorksheetMovedEventArgs#worksheetId:member + package: excel! + fullName: worksheetId + summary: Gets the ID of the worksheet that was moved. + remarks: >- + \[ [API set: ExcelApi + 1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheetId: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetnamechangedeventargs.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetnamechangedeventargs.yml new file mode 100644 index 0000000000..3a04f37b3a --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetnamechangedeventargs.yml @@ -0,0 +1,94 @@ +### YamlMime:TSType +name: Excel.WorksheetNameChangedEventArgs +uid: excel!Excel.WorksheetNameChangedEventArgs:interface +package: excel! +fullName: Excel.WorksheetNameChangedEventArgs +summary: Provides information about the worksheet whose name has changed. +remarks: >- + \[ [API set: ExcelApi + 1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: nameAfter + uid: excel!Excel.WorksheetNameChangedEventArgs#nameAfter:member + package: excel! + fullName: nameAfter + summary: Gets the new name of the worksheet, after the name change. + remarks: >- + \[ [API set: ExcelApi + 1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'nameAfter: string;' + return: + type: string + - name: nameBefore + uid: excel!Excel.WorksheetNameChangedEventArgs#nameBefore:member + package: excel! + fullName: nameBefore + summary: Gets the previous name of the worksheet, before the name changed. + remarks: >- + \[ [API set: ExcelApi + 1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'nameBefore: string;' + return: + type: string + - name: source + uid: excel!Excel.WorksheetNameChangedEventArgs#source:member + package: excel! + fullName: source + summary: The source of the event. It can be local or remote (through co-authoring). + remarks: >- + \[ [API set: ExcelApi + 1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'source: Excel.EventSource | "Local" | "Remote";' + return: + type: | "Local" | "Remote" + - name: type + uid: excel!Excel.WorksheetNameChangedEventArgs#type:member + package: excel! + fullName: type + summary: Gets the type of the event. + remarks: >- + \[ [API set: ExcelApi + 1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: string;' + return: + type: string + - name: worksheetId + uid: excel!Excel.WorksheetNameChangedEventArgs#worksheetId:member + package: excel! + fullName: worksheetId + summary: Gets the ID of the worksheet with the new name. + remarks: >- + \[ [API set: ExcelApi + 1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheetId: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetpositiontype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetpositiontype.yml new file mode 100644 index 0000000000..d422f6469b --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetpositiontype.yml @@ -0,0 +1,78 @@ +### YamlMime:TSEnum +name: Excel.WorksheetPositionType +uid: excel!Excel.WorksheetPositionType:enum +package: excel! +fullName: Excel.WorksheetPositionType +summary: >- + The position of a worksheet relative to another worksheet or the entire + worksheet collection. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-insert-external-worksheets.yaml + + + await Excel.run(async (context) => { + // Retrieve the source workbook. + const workbook = context.workbook; + + // Set up the insert options. + const options = { + sheetNamesToInsert: [], // Insert all the worksheets from the source workbook. + positionType: Excel.WorksheetPositionType.after, // Insert after the `relativeTo` sheet. + relativeTo: "Sheet1" // The sheet relative to which the other worksheets will be inserted. Used with `positionType`. + }; + + // Insert the new worksheets. + workbook.insertWorksheetsFromBase64(externalWorkbook, options); + await context.sync(); + }); + + ``` + +isPreview: false +isDeprecated: false +fields: + - name: after + uid: excel!Excel.WorksheetPositionType.after:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"After"' + - name: before + uid: excel!Excel.WorksheetPositionType.before:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Before"' + - name: beginning + uid: excel!Excel.WorksheetPositionType.beginning:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"Beginning"' + - name: end + uid: excel!Excel.WorksheetPositionType.end:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"End"' + - name: none + uid: excel!Excel.WorksheetPositionType.none:member + package: excel! + summary: >- + * \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + value: '"None"' diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetprotection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetprotection.yml new file mode 100644 index 0000000000..8a64d8ab10 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetprotection.yml @@ -0,0 +1,259 @@ +### YamlMime:TSType +name: Excel.WorksheetProtection +uid: excel!Excel.WorksheetProtection:class +package: excel! +fullName: Excel.WorksheetProtection +summary: Represents the protection of a worksheet object. +remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.WorksheetProtection#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: options + uid: excel!Excel.WorksheetProtection#options:member + package: excel! + fullName: options + summary: Specifies the protection options for the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly options: Excel.WorksheetProtectionOptions;' + return: + type: + - name: protected + uid: excel!Excel.WorksheetProtection#protected:member + package: excel! + fullName: protected + summary: Specifies if the worksheet is protected. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly protected: boolean;' + return: + type: boolean +methods: + - name: load(options) + uid: excel!Excel.WorksheetProtection#load:member(1) + package: excel! + fullName: load(options) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: >- + load(options?: Excel.Interfaces.WorksheetProtectionLoadOptions): + Excel.WorksheetProtection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: excel!Excel.WorksheetProtection#load:member(2) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.WorksheetProtection;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.WorksheetProtection#load:member(3) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.WorksheetProtection; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: protect(options, password) + uid: excel!Excel.WorksheetProtection#protect:member(1) + package: excel! + fullName: protect(options, password) + summary: Protects a worksheet. Fails if the worksheet has already been protected. + remarks: >- + \[ [API set: ExcelApi 1.2 for options; 1.7 for + password](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/data-protection.yaml + + + let password = await passwordHandler(); + + passwordHelper(password); + + await Excel.run(async (context) => { + let activeSheet = context.workbook.worksheets.getActiveWorksheet(); + activeSheet.load("protection/protected"); + + await context.sync(); + + if (!activeSheet.protection.protected) { + activeSheet.protection.protect(null, password); + } + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + protect(options?: Excel.WorksheetProtectionOptions, password?: string): + void; + parameters: + - id: options + description: Optional. Sheet protection options. + type: + - id: password + description: Optional. Sheet protection password. + type: string + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.WorksheetProtection#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.WorksheetProtection` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.WorksheetProtectionData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.WorksheetProtectionData;' + return: + type: >- + + description: '' + - name: unprotect(password) + uid: excel!Excel.WorksheetProtection#unprotect:member(1) + package: excel! + fullName: unprotect(password) + summary: Unprotects a worksheet. + remarks: >- + \[ [API set: ExcelApi 1.7 for + password](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/data-protection.yaml + + + let password = await passwordHandler(); + + passwordHelper(password); + + await Excel.run(async (context) => { + let activeSheet = context.workbook.worksheets.getActiveWorksheet(); + activeSheet.protection.unprotect(password); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'unprotect(password?: string): void;' + parameters: + - id: password + description: Sheet protection password. + type: string + return: + type: void + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetprotectionchangedeventargs.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetprotectionchangedeventargs.yml new file mode 100644 index 0000000000..1d408aca44 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetprotectionchangedeventargs.yml @@ -0,0 +1,159 @@ +### YamlMime:TSType +name: Excel.WorksheetProtectionChangedEventArgs +uid: excel!Excel.WorksheetProtectionChangedEventArgs:interface +package: excel! +fullName: Excel.WorksheetProtectionChangedEventArgs +summary: >- + Provides information about the worksheet that raised the protection status + changed event, which fires when the protection status is updated in a + worksheet. +remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: isProtected + uid: excel!Excel.WorksheetProtectionChangedEventArgs#isProtected:member + package: excel! + fullName: isProtected + summary: Gets the current protection status of the worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-worksheet-protection.yaml + + + async function checkProtection(event: + Excel.WorksheetProtectionChangedEventArgs) { + // This function is an event handler that returns the protection status of a worksheet + // and information about the changed worksheet. + await Excel.run(async (context) => { + const protectionStatus = event.isProtected; + const worksheetId = event.worksheetId; + const source = event.source; + console.log("Protection status changed. Protection status is now: " + protectionStatus + "."); + console.log(" ID of changed worksheet: " + worksheetId + "."); + console.log(" Source of change event: " + source + "."); + }); + } + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'isProtected: boolean;' + return: + type: boolean + - name: source + uid: excel!Excel.WorksheetProtectionChangedEventArgs#source:member + package: excel! + fullName: source + summary: The source of the event. It can be local or remote (through co-authoring). + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-worksheet-protection.yaml + + + async function checkProtection(event: + Excel.WorksheetProtectionChangedEventArgs) { + // This function is an event handler that returns the protection status of a worksheet + // and information about the changed worksheet. + await Excel.run(async (context) => { + const protectionStatus = event.isProtected; + const worksheetId = event.worksheetId; + const source = event.source; + console.log("Protection status changed. Protection status is now: " + protectionStatus + "."); + console.log(" ID of changed worksheet: " + worksheetId + "."); + console.log(" Source of change event: " + source + "."); + }); + } + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'source: Excel.EventSource | "Local" | "Remote";' + return: + type: | "Local" | "Remote" + - name: type + uid: excel!Excel.WorksheetProtectionChangedEventArgs#type:member + package: excel! + fullName: type + summary: Gets the type of the event. See `Excel.EventType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: "WorksheetProtectionChanged";' + return: + type: '"WorksheetProtectionChanged"' + - name: worksheetId + uid: excel!Excel.WorksheetProtectionChangedEventArgs#worksheetId:member + package: excel! + fullName: worksheetId + summary: Gets the ID of the worksheet in which the protection status is changed. + remarks: >- + \[ [API set: ExcelApi + 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-worksheet-protection.yaml + + + async function checkProtection(event: + Excel.WorksheetProtectionChangedEventArgs) { + // This function is an event handler that returns the protection status of a worksheet + // and information about the changed worksheet. + await Excel.run(async (context) => { + const protectionStatus = event.isProtected; + const worksheetId = event.worksheetId; + const source = event.source; + console.log("Protection status changed. Protection status is now: " + protectionStatus + "."); + console.log(" ID of changed worksheet: " + worksheetId + "."); + console.log(" Source of change event: " + source + "."); + }); + } + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheetId: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetprotectionoptions.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetprotectionoptions.yml new file mode 100644 index 0000000000..a962462e5f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetprotectionoptions.yml @@ -0,0 +1,236 @@ +### YamlMime:TSType +name: Excel.WorksheetProtectionOptions +uid: excel!Excel.WorksheetProtectionOptions:interface +package: excel! +fullName: Excel.WorksheetProtectionOptions +summary: Represents the options in sheet protection. +remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: allowAutoFilter + uid: excel!Excel.WorksheetProtectionOptions#allowAutoFilter:member + package: excel! + fullName: allowAutoFilter + summary: >- + Represents the worksheet protection option allowing use of the AutoFilter + feature. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'allowAutoFilter?: boolean;' + return: + type: boolean + - name: allowDeleteColumns + uid: excel!Excel.WorksheetProtectionOptions#allowDeleteColumns:member + package: excel! + fullName: allowDeleteColumns + summary: Represents the worksheet protection option allowing deleting of columns. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'allowDeleteColumns?: boolean;' + return: + type: boolean + - name: allowDeleteRows + uid: excel!Excel.WorksheetProtectionOptions#allowDeleteRows:member + package: excel! + fullName: allowDeleteRows + summary: Represents the worksheet protection option allowing deleting of rows. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'allowDeleteRows?: boolean;' + return: + type: boolean + - name: allowEditObjects + uid: excel!Excel.WorksheetProtectionOptions#allowEditObjects:member + package: excel! + fullName: allowEditObjects + summary: Represents the worksheet protection option allowing editing of objects. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'allowEditObjects?: boolean;' + return: + type: boolean + - name: allowEditScenarios + uid: excel!Excel.WorksheetProtectionOptions#allowEditScenarios:member + package: excel! + fullName: allowEditScenarios + summary: Represents the worksheet protection option allowing editing of scenarios. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'allowEditScenarios?: boolean;' + return: + type: boolean + - name: allowFormatCells + uid: excel!Excel.WorksheetProtectionOptions#allowFormatCells:member + package: excel! + fullName: allowFormatCells + summary: Represents the worksheet protection option allowing formatting of cells. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'allowFormatCells?: boolean;' + return: + type: boolean + - name: allowFormatColumns + uid: excel!Excel.WorksheetProtectionOptions#allowFormatColumns:member + package: excel! + fullName: allowFormatColumns + summary: Represents the worksheet protection option allowing formatting of columns. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'allowFormatColumns?: boolean;' + return: + type: boolean + - name: allowFormatRows + uid: excel!Excel.WorksheetProtectionOptions#allowFormatRows:member + package: excel! + fullName: allowFormatRows + summary: Represents the worksheet protection option allowing formatting of rows. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'allowFormatRows?: boolean;' + return: + type: boolean + - name: allowInsertColumns + uid: excel!Excel.WorksheetProtectionOptions#allowInsertColumns:member + package: excel! + fullName: allowInsertColumns + summary: Represents the worksheet protection option allowing inserting of columns. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'allowInsertColumns?: boolean;' + return: + type: boolean + - name: allowInsertHyperlinks + uid: excel!Excel.WorksheetProtectionOptions#allowInsertHyperlinks:member + package: excel! + fullName: allowInsertHyperlinks + summary: >- + Represents the worksheet protection option allowing inserting of + hyperlinks. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'allowInsertHyperlinks?: boolean;' + return: + type: boolean + - name: allowInsertRows + uid: excel!Excel.WorksheetProtectionOptions#allowInsertRows:member + package: excel! + fullName: allowInsertRows + summary: Represents the worksheet protection option allowing inserting of rows. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'allowInsertRows?: boolean;' + return: + type: boolean + - name: allowPivotTables + uid: excel!Excel.WorksheetProtectionOptions#allowPivotTables:member + package: excel! + fullName: allowPivotTables + summary: >- + Represents the worksheet protection option allowing use of the PivotTable + feature. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'allowPivotTables?: boolean;' + return: + type: boolean + - name: allowSort + uid: excel!Excel.WorksheetProtectionOptions#allowSort:member + package: excel! + fullName: allowSort + summary: >- + Represents the worksheet protection option allowing use of the sort + feature. + remarks: >- + \[ [API set: ExcelApi + 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'allowSort?: boolean;' + return: + type: boolean + - name: selectionMode + uid: excel!Excel.WorksheetProtectionOptions#selectionMode:member + package: excel! + fullName: selectionMode + summary: Represents the worksheet protection option of selection mode. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + selectionMode?: Excel.ProtectionSelectionMode | "Normal" | "Unlocked" | + "None"; + return: + type: >- + | "Normal" | + "Unlocked" | "None" diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetrowhiddenchangedeventargs.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetrowhiddenchangedeventargs.yml new file mode 100644 index 0000000000..735825b0ce --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetrowhiddenchangedeventargs.yml @@ -0,0 +1,100 @@ +### YamlMime:TSType +name: Excel.WorksheetRowHiddenChangedEventArgs +uid: excel!Excel.WorksheetRowHiddenChangedEventArgs:interface +package: excel! +fullName: Excel.WorksheetRowHiddenChangedEventArgs +summary: Provides information about the worksheet's row hidden change event. +remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: address + uid: excel!Excel.WorksheetRowHiddenChangedEventArgs#address:member + package: excel! + fullName: address + summary: >- + Gets the range address that represents the changed area of a specific + worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'address: string;' + return: + type: string + - name: changeType + uid: excel!Excel.WorksheetRowHiddenChangedEventArgs#changeType:member + package: excel! + fullName: changeType + summary: >- + Gets the type of change that represents how the event was triggered. See + `Excel.RowHiddenChangeType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'changeType: Excel.RowHiddenChangeType | "Unhidden" | "Hidden";' + return: + type: >- + | "Unhidden" | + "Hidden" + - name: source + uid: excel!Excel.WorksheetRowHiddenChangedEventArgs#source:member + package: excel! + fullName: source + summary: Gets the source of the event. See `Excel.EventSource` for details. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'source: Excel.EventSource | "Local" | "Remote";' + return: + type: | "Local" | "Remote" + - name: type + uid: excel!Excel.WorksheetRowHiddenChangedEventArgs#type:member + package: excel! + fullName: type + summary: Gets the type of the event. See `Excel.EventType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: "WorksheetRowHiddenChanged";' + return: + type: '"WorksheetRowHiddenChanged"' + - name: worksheetId + uid: excel!Excel.WorksheetRowHiddenChangedEventArgs#worksheetId:member + package: excel! + fullName: worksheetId + summary: Gets the ID of the worksheet in which the data changed. + remarks: >- + \[ [API set: ExcelApi + 1.11](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheetId: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetrowsortedeventargs.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetrowsortedeventargs.yml new file mode 100644 index 0000000000..23c554f1de --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetrowsortedeventargs.yml @@ -0,0 +1,81 @@ +### YamlMime:TSType +name: Excel.WorksheetRowSortedEventArgs +uid: excel!Excel.WorksheetRowSortedEventArgs:interface +package: excel! +fullName: Excel.WorksheetRowSortedEventArgs +summary: Provides information about the row-sorted event and its related worksheet. +remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: address + uid: excel!Excel.WorksheetRowSortedEventArgs#address:member + package: excel! + fullName: address + summary: >- + Gets the range address that represents the sorted areas of a specific + worksheet. Only rows changed as a result of the sort operation are + returned. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'address: string;' + return: + type: string + - name: source + uid: excel!Excel.WorksheetRowSortedEventArgs#source:member + package: excel! + fullName: source + summary: Gets the source of the event. See `Excel.EventSource` for details. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'source: Excel.EventSource | "Local" | "Remote";' + return: + type: | "Local" | "Remote" + - name: type + uid: excel!Excel.WorksheetRowSortedEventArgs#type:member + package: excel! + fullName: type + summary: Gets the type of the event. See `Excel.EventType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: "WorksheetRowSorted";' + return: + type: '"WorksheetRowSorted"' + - name: worksheetId + uid: excel!Excel.WorksheetRowSortedEventArgs#worksheetId:member + package: excel! + fullName: worksheetId + summary: Gets the ID of the worksheet where the sorting happened. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheetId: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetsearchcriteria.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetsearchcriteria.yml new file mode 100644 index 0000000000..b2f65dbb3b --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetsearchcriteria.yml @@ -0,0 +1,50 @@ +### YamlMime:TSType +name: Excel.WorksheetSearchCriteria +uid: excel!Excel.WorksheetSearchCriteria:interface +package: excel! +fullName: Excel.WorksheetSearchCriteria +summary: Represents the worksheet search criteria to be used. +remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: completeMatch + uid: excel!Excel.WorksheetSearchCriteria#completeMatch:member + package: excel! + fullName: completeMatch + summary: >- + Specifies if the match needs to be complete or partial. A complete match + matches the entire contents of the cell. A partial match matches a + substring within the content of the cell (e.g., `cat` partially matches + `caterpillar` and `scatter`). Default is `false` (partial). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'completeMatch?: boolean;' + return: + type: boolean + - name: matchCase + uid: excel!Excel.WorksheetSearchCriteria#matchCase:member + package: excel! + fullName: matchCase + summary: >- + Specifies if the match is case-sensitive. Default is `false` + (case-insensitive). + remarks: >- + \[ [API set: ExcelApi + 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'matchCase?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetselectionchangedeventargs.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetselectionchangedeventargs.yml new file mode 100644 index 0000000000..a81a6ec517 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetselectionchangedeventargs.yml @@ -0,0 +1,63 @@ +### YamlMime:TSType +name: Excel.WorksheetSelectionChangedEventArgs +uid: excel!Excel.WorksheetSelectionChangedEventArgs:interface +package: excel! +fullName: Excel.WorksheetSelectionChangedEventArgs +summary: >- + Provides information about the worksheet that raised the selection changed + event. +remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: address + uid: excel!Excel.WorksheetSelectionChangedEventArgs#address:member + package: excel! + fullName: address + summary: >- + Gets the range address that represents the selected area of a specific + worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'address: string;' + return: + type: string + - name: type + uid: excel!Excel.WorksheetSelectionChangedEventArgs#type:member + package: excel! + fullName: type + summary: Gets the type of the event. See `Excel.EventType` for details. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: "WorksheetSelectionChanged";' + return: + type: '"WorksheetSelectionChanged"' + - name: worksheetId + uid: excel!Excel.WorksheetSelectionChangedEventArgs#worksheetId:member + package: excel! + fullName: worksheetId + summary: Gets the ID of the worksheet in which the selection changed. + remarks: >- + \[ [API set: ExcelApi + 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheetId: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetsingleclickedeventargs.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetsingleclickedeventargs.yml new file mode 100644 index 0000000000..348af649d9 --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetsingleclickedeventargs.yml @@ -0,0 +1,129 @@ +### YamlMime:TSType +name: Excel.WorksheetSingleClickedEventArgs +uid: excel!Excel.WorksheetSingleClickedEventArgs:interface +package: excel! +fullName: Excel.WorksheetSingleClickedEventArgs +summary: >- + Provides information about the left-clicked/tapped event and its related + worksheet. +remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: address + uid: excel!Excel.WorksheetSingleClickedEventArgs#address:member + package: excel! + fullName: address + summary: >- + Gets the address that represents the cell which was left-clicked/tapped + for a specific worksheet. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/event-worksheet-single-click.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + sheet.onSingleClicked.add((event) => { + return Excel.run((context) => { + console.log(`Click detected at ${event.address} (pixel offset from upper-left cell corner: ${event.offsetX}, ${event.offsetY})`); + return context.sync(); + }); + }); + + console.log("The worksheet click handler is registered."); + + await context.sync(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'address: string;' + return: + type: string + - name: offsetX + uid: excel!Excel.WorksheetSingleClickedEventArgs#offsetX:member + package: excel! + fullName: offsetX + summary: >- + The distance, in points, from the left-clicked/tapped point to the left + (or right for right-to-left languages) gridline edge of the + left-clicked/tapped cell. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'offsetX: number;' + return: + type: number + - name: offsetY + uid: excel!Excel.WorksheetSingleClickedEventArgs#offsetY:member + package: excel! + fullName: offsetY + summary: >- + The distance, in points, from the left-clicked/tapped point to the top + gridline edge of the left-clicked/tapped cell. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'offsetY: number;' + return: + type: number + - name: type + uid: excel!Excel.WorksheetSingleClickedEventArgs#type:member + package: excel! + fullName: type + summary: Gets the type of the event. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: "WorksheetSingleClicked";' + return: + type: '"WorksheetSingleClicked"' + - name: worksheetId + uid: excel!Excel.WorksheetSingleClickedEventArgs#worksheetId:member + package: excel! + fullName: worksheetId + summary: Gets the ID of the worksheet in which the cell was left-clicked/tapped. + remarks: >- + \[ [API set: ExcelApi + 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheetId: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetvisibilitychangedeventargs.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetvisibilitychangedeventargs.yml new file mode 100644 index 0000000000..5b2edb484f --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.worksheetvisibilitychangedeventargs.yml @@ -0,0 +1,106 @@ +### YamlMime:TSType +name: Excel.WorksheetVisibilityChangedEventArgs +uid: excel!Excel.WorksheetVisibilityChangedEventArgs:interface +package: excel! +fullName: Excel.WorksheetVisibilityChangedEventArgs +summary: Provides information about the worksheet whose visibility has changed. +remarks: >- + \[ [API set: ExcelApi + 1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: source + uid: excel!Excel.WorksheetVisibilityChangedEventArgs#source:member + package: excel! + fullName: source + summary: The source of the event. It can be local or remote (through co-authoring). + remarks: >- + \[ [API set: ExcelApi + 1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'source: Excel.EventSource | "Local" | "Remote";' + return: + type: | "Local" | "Remote" + - name: type + uid: excel!Excel.WorksheetVisibilityChangedEventArgs#type:member + package: excel! + fullName: type + summary: Gets the type of the event. + remarks: >- + \[ [API set: ExcelApi + 1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'type: string;' + return: + type: string + - name: visibilityAfter + uid: excel!Excel.WorksheetVisibilityChangedEventArgs#visibilityAfter:member + package: excel! + fullName: visibilityAfter + summary: >- + Gets the new visibility setting of the worksheet, after the visibility + change. + remarks: >- + \[ [API set: ExcelApi + 1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + visibilityAfter: Excel.SheetVisibility | "Visible" | "Hidden" | + "VeryHidden"; + return: + type: >- + | "Visible" | "Hidden" + | "VeryHidden" + - name: visibilityBefore + uid: excel!Excel.WorksheetVisibilityChangedEventArgs#visibilityBefore:member + package: excel! + fullName: visibilityBefore + summary: >- + Gets the previous visibility setting of the worksheet, before the + visibility change. + remarks: >- + \[ [API set: ExcelApi + 1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + visibilityBefore: Excel.SheetVisibility | "Visible" | "Hidden" | + "VeryHidden"; + return: + type: >- + | "Visible" | "Hidden" + | "VeryHidden" + - name: worksheetId + uid: excel!Excel.WorksheetVisibilityChangedEventArgs#worksheetId:member + package: excel! + fullName: worksheetId + summary: Gets the ID of the worksheet whose visibility has changed. + remarks: >- + \[ [API set: ExcelApi + 1.17](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'worksheetId: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/excel_1_20/toc.yml b/docs/docs-ref-autogen/excel_1_20/toc.yml new file mode 100644 index 0000000000..8be6f87b7d --- /dev/null +++ b/docs/docs-ref-autogen/excel_1_20/toc.yml @@ -0,0 +1,2068 @@ +items: + - name: API reference + items: + - name: API reference overview + href: ../overview/overview.md + - name: Excel + uid: excel! + items: + - name: Custom Functions + uid: '' + items: + - name: Custom functions runtime + uid: custom-functions-runtime! + items: + - name: CancelableInvocation + uid: >- + custom-functions-runtime!CustomFunctions.CancelableInvocation:interface + - name: Error + uid: custom-functions-runtime!CustomFunctions.Error:class + - name: ErrorCode + uid: custom-functions-runtime!CustomFunctions.ErrorCode:enum + - name: Invocation + uid: >- + custom-functions-runtime!CustomFunctions.Invocation:interface + - name: StreamingInvocation + uid: >- + custom-functions-runtime!CustomFunctions.StreamingInvocation:interface + - name: Enums + uid: '' + items: + - name: AggregationFunction + uid: excel!Excel.AggregationFunction:enum + - name: ArrowheadLength + uid: excel!Excel.ArrowheadLength:enum + - name: ArrowheadStyle + uid: excel!Excel.ArrowheadStyle:enum + - name: ArrowheadWidth + uid: excel!Excel.ArrowheadWidth:enum + - name: AutoFillType + uid: excel!Excel.AutoFillType:enum + - name: BindingType + uid: excel!Excel.BindingType:enum + - name: BlockedErrorCellValueSubType + uid: excel!Excel.BlockedErrorCellValueSubType:enum + - name: BorderIndex + uid: excel!Excel.BorderIndex:enum + - name: BorderLineStyle + uid: excel!Excel.BorderLineStyle:enum + - name: BorderWeight + uid: excel!Excel.BorderWeight:enum + - name: BuiltInStyle + uid: excel!Excel.BuiltInStyle:enum + - name: BusyErrorCellValueSubType + uid: excel!Excel.BusyErrorCellValueSubType:enum + - name: CalcErrorCellValueSubType + uid: excel!Excel.CalcErrorCellValueSubType:enum + - name: CalculationMode + uid: excel!Excel.CalculationMode:enum + - name: CalculationState + uid: excel!Excel.CalculationState:enum + - name: CalculationType + uid: excel!Excel.CalculationType:enum + - name: CellControlType + uid: excel!Excel.CellControlType:enum + - name: CellValueType + uid: excel!Excel.CellValueType:enum + - name: ChartAxisCategoryType + uid: excel!Excel.ChartAxisCategoryType:enum + - name: ChartAxisDisplayUnit + uid: excel!Excel.ChartAxisDisplayUnit:enum + - name: ChartAxisGroup + uid: excel!Excel.ChartAxisGroup:enum + - name: ChartAxisPosition + uid: excel!Excel.ChartAxisPosition:enum + - name: ChartAxisScaleType + uid: excel!Excel.ChartAxisScaleType:enum + - name: ChartAxisTickLabelPosition + uid: excel!Excel.ChartAxisTickLabelPosition:enum + - name: ChartAxisTickMark + uid: excel!Excel.ChartAxisTickMark:enum + - name: ChartAxisTimeUnit + uid: excel!Excel.ChartAxisTimeUnit:enum + - name: ChartAxisType + uid: excel!Excel.ChartAxisType:enum + - name: ChartBinType + uid: excel!Excel.ChartBinType:enum + - name: ChartBoxQuartileCalculation + uid: excel!Excel.ChartBoxQuartileCalculation:enum + - name: ChartColorScheme + uid: excel!Excel.ChartColorScheme:enum + - name: ChartDataLabelPosition + uid: excel!Excel.ChartDataLabelPosition:enum + - name: ChartDataSourceType + uid: excel!Excel.ChartDataSourceType:enum + - name: ChartDisplayBlanksAs + uid: excel!Excel.ChartDisplayBlanksAs:enum + - name: ChartErrorBarsInclude + uid: excel!Excel.ChartErrorBarsInclude:enum + - name: ChartErrorBarsType + uid: excel!Excel.ChartErrorBarsType:enum + - name: ChartGradientStyle + uid: excel!Excel.ChartGradientStyle:enum + - name: ChartGradientStyleType + uid: excel!Excel.ChartGradientStyleType:enum + - name: ChartLegendPosition + uid: excel!Excel.ChartLegendPosition:enum + - name: ChartLineStyle + uid: excel!Excel.ChartLineStyle:enum + - name: ChartMapAreaLevel + uid: excel!Excel.ChartMapAreaLevel:enum + - name: ChartMapLabelStrategy + uid: excel!Excel.ChartMapLabelStrategy:enum + - name: ChartMapProjectionType + uid: excel!Excel.ChartMapProjectionType:enum + - name: ChartMarkerStyle + uid: excel!Excel.ChartMarkerStyle:enum + - name: ChartParentLabelStrategy + uid: excel!Excel.ChartParentLabelStrategy:enum + - name: ChartPlotAreaPosition + uid: excel!Excel.ChartPlotAreaPosition:enum + - name: ChartPlotBy + uid: excel!Excel.ChartPlotBy:enum + - name: ChartSeriesBy + uid: excel!Excel.ChartSeriesBy:enum + - name: ChartSeriesDimension + uid: excel!Excel.ChartSeriesDimension:enum + - name: ChartSplitType + uid: excel!Excel.ChartSplitType:enum + - name: ChartTextHorizontalAlignment + uid: excel!Excel.ChartTextHorizontalAlignment:enum + - name: ChartTextVerticalAlignment + uid: excel!Excel.ChartTextVerticalAlignment:enum + - name: ChartTickLabelAlignment + uid: excel!Excel.ChartTickLabelAlignment:enum + - name: ChartTitlePosition + uid: excel!Excel.ChartTitlePosition:enum + - name: ChartTrendlineType + uid: excel!Excel.ChartTrendlineType:enum + - name: ChartType + uid: excel!Excel.ChartType:enum + - name: ChartUnderlineStyle + uid: excel!Excel.ChartUnderlineStyle:enum + - name: ClearApplyTo + uid: excel!Excel.ClearApplyTo:enum + - name: CloseBehavior + uid: excel!Excel.CloseBehavior:enum + - name: CommentChangeType + uid: excel!Excel.CommentChangeType:enum + - name: ConditionalCellValueOperator + uid: excel!Excel.ConditionalCellValueOperator:enum + - name: ConditionalDataBarAxisFormat + uid: excel!Excel.ConditionalDataBarAxisFormat:enum + - name: ConditionalDataBarDirection + uid: excel!Excel.ConditionalDataBarDirection:enum + - name: ConditionalFormatColorCriterionType + uid: excel!Excel.ConditionalFormatColorCriterionType:enum + - name: ConditionalFormatDirection + uid: excel!Excel.ConditionalFormatDirection:enum + - name: ConditionalFormatIconRuleType + uid: excel!Excel.ConditionalFormatIconRuleType:enum + - name: ConditionalFormatPresetCriterion + uid: excel!Excel.ConditionalFormatPresetCriterion:enum + - name: ConditionalFormatRuleType + uid: excel!Excel.ConditionalFormatRuleType:enum + - name: ConditionalFormatType + uid: excel!Excel.ConditionalFormatType:enum + - name: ConditionalIconCriterionOperator + uid: excel!Excel.ConditionalIconCriterionOperator:enum + - name: ConditionalRangeBorderIndex + uid: excel!Excel.ConditionalRangeBorderIndex:enum + - name: ConditionalRangeBorderLineStyle + uid: excel!Excel.ConditionalRangeBorderLineStyle:enum + - name: ConditionalRangeFontUnderlineStyle + uid: excel!Excel.ConditionalRangeFontUnderlineStyle:enum + - name: ConditionalTextOperator + uid: excel!Excel.ConditionalTextOperator:enum + - name: ConditionalTopBottomCriterionType + uid: excel!Excel.ConditionalTopBottomCriterionType:enum + - name: ConnectErrorCellValueSubType + uid: excel!Excel.ConnectErrorCellValueSubType:enum + - name: ConnectorType + uid: excel!Excel.ConnectorType:enum + - name: ContentType + uid: excel!Excel.ContentType:enum + - name: DataChangeType + uid: excel!Excel.DataChangeType:enum + - name: DataSourceType + uid: excel!Excel.DataSourceType:enum + - name: DataValidationAlertStyle + uid: excel!Excel.DataValidationAlertStyle:enum + - name: DataValidationOperator + uid: excel!Excel.DataValidationOperator:enum + - name: DataValidationType + uid: excel!Excel.DataValidationType:enum + - name: DateFilterCondition + uid: excel!Excel.DateFilterCondition:enum + - name: DeleteShiftDirection + uid: excel!Excel.DeleteShiftDirection:enum + - name: DocumentPropertyItem + uid: excel!Excel.DocumentPropertyItem:enum + - name: DocumentPropertyType + uid: excel!Excel.DocumentPropertyType:enum + - name: DynamicFilterCriteria + uid: excel!Excel.DynamicFilterCriteria:enum + - name: EntityCardLayoutType + uid: excel!Excel.EntityCardLayoutType:enum + - name: EntityCompactLayoutIcons + uid: excel!Excel.EntityCompactLayoutIcons:enum + - name: ErrorCellValueType + uid: excel!Excel.ErrorCellValueType:enum + - name: ErrorCodes + uid: excel!Excel.ErrorCodes:enum + - name: EventSource + uid: excel!Excel.EventSource:enum + - name: EventTriggerSource + uid: excel!Excel.EventTriggerSource:enum + - name: EventType + uid: excel!Excel.EventType:enum + - name: ExternalErrorCellValueSubType + uid: excel!Excel.ExternalErrorCellValueSubType:enum + - name: FieldErrorCellValueSubType + uid: excel!Excel.FieldErrorCellValueSubType:enum + - name: FillPattern + uid: excel!Excel.FillPattern:enum + - name: FilterDatetimeSpecificity + uid: excel!Excel.FilterDatetimeSpecificity:enum + - name: FilterOn + uid: excel!Excel.FilterOn:enum + - name: FilterOperator + uid: excel!Excel.FilterOperator:enum + - name: FunctionCellValueType + uid: excel!Excel.FunctionCellValueType:enum + - name: GeometricShapeType + uid: excel!Excel.GeometricShapeType:enum + - name: GroupOption + uid: excel!Excel.GroupOption:enum + - name: HeaderFooterState + uid: excel!Excel.HeaderFooterState:enum + - name: HorizontalAlignment + uid: excel!Excel.HorizontalAlignment:enum + - name: IconSet + uid: excel!Excel.IconSet:enum + - name: ImageFittingMode + uid: excel!Excel.ImageFittingMode:enum + - name: InsertShiftDirection + uid: excel!Excel.InsertShiftDirection:enum + - name: KeyboardDirection + uid: excel!Excel.KeyboardDirection:enum + - name: LabelFilterCondition + uid: excel!Excel.LabelFilterCondition:enum + - name: LinkedDataTypeState + uid: excel!Excel.LinkedDataTypeState:enum + - name: LinkedEntityDataDomainRefreshMode + uid: excel!Excel.LinkedEntityDataDomainRefreshMode:enum + - name: LoadToType + uid: excel!Excel.LoadToType:enum + - name: NamedItemScope + uid: excel!Excel.NamedItemScope:enum + - name: NamedItemType + uid: excel!Excel.NamedItemType:enum + - name: NumberFormatCategory + uid: excel!Excel.NumberFormatCategory:enum + - name: NumErrorCellValueSubType + uid: excel!Excel.NumErrorCellValueSubType:enum + - name: PageOrientation + uid: excel!Excel.PageOrientation:enum + - name: PaperType + uid: excel!Excel.PaperType:enum + - name: PictureFormat + uid: excel!Excel.PictureFormat:enum + - name: PivotAxis + uid: excel!Excel.PivotAxis:enum + - name: PivotFilterTopBottomCriterion + uid: excel!Excel.PivotFilterTopBottomCriterion:enum + - name: PivotFilterType + uid: excel!Excel.PivotFilterType:enum + - name: PivotLayoutType + uid: excel!Excel.PivotLayoutType:enum + - name: Placement + uid: excel!Excel.Placement:enum + - name: PrintComments + uid: excel!Excel.PrintComments:enum + - name: PrintErrorType + uid: excel!Excel.PrintErrorType:enum + - name: PrintMarginUnit + uid: excel!Excel.PrintMarginUnit:enum + - name: PrintOrder + uid: excel!Excel.PrintOrder:enum + - name: ProtectionSelectionMode + uid: excel!Excel.ProtectionSelectionMode:enum + - name: QueryError + uid: excel!Excel.QueryError:enum + - name: RangeCopyType + uid: excel!Excel.RangeCopyType:enum + - name: RangeUnderlineStyle + uid: excel!Excel.RangeUnderlineStyle:enum + - name: RangeValueType + uid: excel!Excel.RangeValueType:enum + - name: ReadingOrder + uid: excel!Excel.ReadingOrder:enum + - name: ReferenceValueType + uid: excel!Excel.ReferenceValueType:enum + - name: RefErrorCellValueSubType + uid: excel!Excel.RefErrorCellValueSubType:enum + - name: RibbonTab + uid: excel!Excel.RibbonTab:enum + - name: RowHiddenChangeType + uid: excel!Excel.RowHiddenChangeType:enum + - name: SaveBehavior + uid: excel!Excel.SaveBehavior:enum + - name: SearchDirection + uid: excel!Excel.SearchDirection:enum + - name: ShapeAutoSize + uid: excel!Excel.ShapeAutoSize:enum + - name: ShapeFillType + uid: excel!Excel.ShapeFillType:enum + - name: ShapeFontUnderlineStyle + uid: excel!Excel.ShapeFontUnderlineStyle:enum + - name: ShapeLineDashStyle + uid: excel!Excel.ShapeLineDashStyle:enum + - name: ShapeLineStyle + uid: excel!Excel.ShapeLineStyle:enum + - name: ShapeScaleFrom + uid: excel!Excel.ShapeScaleFrom:enum + - name: ShapeScaleType + uid: excel!Excel.ShapeScaleType:enum + - name: ShapeTextHorizontalAlignment + uid: excel!Excel.ShapeTextHorizontalAlignment:enum + - name: ShapeTextHorizontalOverflow + uid: excel!Excel.ShapeTextHorizontalOverflow:enum + - name: ShapeTextOrientation + uid: excel!Excel.ShapeTextOrientation:enum + - name: ShapeTextReadingOrder + uid: excel!Excel.ShapeTextReadingOrder:enum + - name: ShapeTextVerticalAlignment + uid: excel!Excel.ShapeTextVerticalAlignment:enum + - name: ShapeTextVerticalOverflow + uid: excel!Excel.ShapeTextVerticalOverflow:enum + - name: ShapeType + uid: excel!Excel.ShapeType:enum + - name: ShapeZOrder + uid: excel!Excel.ShapeZOrder:enum + - name: SheetVisibility + uid: excel!Excel.SheetVisibility:enum + - name: ShowAsCalculation + uid: excel!Excel.ShowAsCalculation:enum + - name: SlicerSortType + uid: excel!Excel.SlicerSortType:enum + - name: SortBy + uid: excel!Excel.SortBy:enum + - name: SortDataOption + uid: excel!Excel.SortDataOption:enum + - name: SortMethod + uid: excel!Excel.SortMethod:enum + - name: SortOn + uid: excel!Excel.SortOn:enum + - name: SortOrientation + uid: excel!Excel.SortOrientation:enum + - name: SpecialCellType + uid: excel!Excel.SpecialCellType:enum + - name: SpecialCellValueType + uid: excel!Excel.SpecialCellValueType:enum + - name: SpillErrorCellValueSubType + uid: excel!Excel.SpillErrorCellValueSubType:enum + - name: SubtotalLocationType + uid: excel!Excel.SubtotalLocationType:enum + - name: TopBottomSelectionType + uid: excel!Excel.TopBottomSelectionType:enum + - name: ValueErrorCellValueSubType + uid: excel!Excel.ValueErrorCellValueSubType:enum + - name: ValueFilterCondition + uid: excel!Excel.ValueFilterCondition:enum + - name: VerticalAlignment + uid: excel!Excel.VerticalAlignment:enum + - name: WorksheetPositionType + uid: excel!Excel.WorksheetPositionType:enum + - name: Icon Sets + uid: '' + items: + - name: FiveArrowsGraySet + uid: excel!Excel.FiveArrowsGraySet:interface + - name: FiveArrowsSet + uid: excel!Excel.FiveArrowsSet:interface + - name: FiveBoxesSet + uid: excel!Excel.FiveBoxesSet:interface + - name: FiveQuartersSet + uid: excel!Excel.FiveQuartersSet:interface + - name: FiveRatingSet + uid: excel!Excel.FiveRatingSet:interface + - name: FourArrowsGraySet + uid: excel!Excel.FourArrowsGraySet:interface + - name: FourArrowsSet + uid: excel!Excel.FourArrowsSet:interface + - name: FourRatingSet + uid: excel!Excel.FourRatingSet:interface + - name: FourRedToBlackSet + uid: excel!Excel.FourRedToBlackSet:interface + - name: FourTrafficLightsSet + uid: excel!Excel.FourTrafficLightsSet:interface + - name: IconCollections + uid: excel!Excel.IconCollections:interface + - name: ThreeArrowsGraySet + uid: excel!Excel.ThreeArrowsGraySet:interface + - name: ThreeArrowsSet + uid: excel!Excel.ThreeArrowsSet:interface + - name: ThreeFlagsSet + uid: excel!Excel.ThreeFlagsSet:interface + - name: ThreeSignsSet + uid: excel!Excel.ThreeSignsSet:interface + - name: ThreeStarsSet + uid: excel!Excel.ThreeStarsSet:interface + - name: ThreeSymbols2Set + uid: excel!Excel.ThreeSymbols2Set:interface + - name: ThreeSymbolsSet + uid: excel!Excel.ThreeSymbolsSet:interface + - name: ThreeTrafficLights1Set + uid: excel!Excel.ThreeTrafficLights1Set:interface + - name: ThreeTrafficLights2Set + uid: excel!Excel.ThreeTrafficLights2Set:interface + - name: ThreeTrianglesSet + uid: excel!Excel.ThreeTrianglesSet:interface + - name: Application + uid: excel!Excel.Application:class + - name: ArrayCellValue + uid: excel!Excel.ArrayCellValue:interface + - name: AutoFilter + uid: excel!Excel.AutoFilter:class + - name: BasicCardLayout + uid: excel!Excel.BasicCardLayout:interface + - name: BasicCompactLayout + uid: excel!Excel.BasicCompactLayout:interface + - name: BasicDataValidation + uid: excel!Excel.BasicDataValidation:interface + - name: BasicViewLayouts + uid: excel!Excel.BasicViewLayouts:interface + - name: Binding + uid: excel!Excel.Binding:class + - name: BindingCollection + uid: excel!Excel.BindingCollection:class + - name: BindingDataChangedEventArgs + uid: excel!Excel.BindingDataChangedEventArgs:interface + - name: BindingSelectionChangedEventArgs + uid: excel!Excel.BindingSelectionChangedEventArgs:interface + - name: BlockedErrorCellValue + uid: excel!Excel.BlockedErrorCellValue:interface + - name: BooleanCellValue + uid: excel!Excel.BooleanCellValue:interface + - name: BusyErrorCellValue + uid: excel!Excel.BusyErrorCellValue:interface + - name: CalcErrorCellValue + uid: excel!Excel.CalcErrorCellValue:interface + - name: CardLayout + uid: excel!Excel.CardLayout:type + - name: CardLayoutListSection + uid: excel!Excel.CardLayoutListSection:interface + - name: CardLayoutPropertyReference + uid: excel!Excel.CardLayoutPropertyReference:interface + - name: CardLayoutSection + uid: excel!Excel.CardLayoutSection:type + - name: CardLayoutSectionStandardProperties + uid: excel!Excel.CardLayoutSectionStandardProperties:interface + - name: CardLayoutStandardProperties + uid: excel!Excel.CardLayoutStandardProperties:interface + - name: CardLayoutTableSection + uid: excel!Excel.CardLayoutTableSection:interface + - name: CardLayoutTwoColumnSection + uid: excel!Excel.CardLayoutTwoColumnSection:interface + - name: CellBorder + uid: excel!Excel.CellBorder:interface + - name: CellBorderCollection + uid: excel!Excel.CellBorderCollection:interface + - name: CellControl + uid: excel!Excel.CellControl:type + - name: CellProperties + uid: excel!Excel.CellProperties:interface + - name: CellPropertiesBorderLoadOptions + uid: excel!Excel.CellPropertiesBorderLoadOptions:interface + - name: CellPropertiesFill + uid: excel!Excel.CellPropertiesFill:interface + - name: CellPropertiesFillLoadOptions + uid: excel!Excel.CellPropertiesFillLoadOptions:interface + - name: CellPropertiesFont + uid: excel!Excel.CellPropertiesFont:interface + - name: CellPropertiesFontLoadOptions + uid: excel!Excel.CellPropertiesFontLoadOptions:interface + - name: CellPropertiesFormat + uid: excel!Excel.CellPropertiesFormat:interface + - name: CellPropertiesFormatLoadOptions + uid: excel!Excel.CellPropertiesFormatLoadOptions:interface + - name: CellPropertiesLoadOptions + uid: excel!Excel.CellPropertiesLoadOptions:interface + - name: CellPropertiesProtection + uid: excel!Excel.CellPropertiesProtection:interface + - name: CellValue + uid: excel!Excel.CellValue:type + - name: CellValueAndPropertyMetadata + uid: excel!Excel.CellValueAndPropertyMetadata:type + - name: CellValueAttributionAttributes + uid: excel!Excel.CellValueAttributionAttributes:interface + - name: CellValueConditionalFormat + uid: excel!Excel.CellValueConditionalFormat:class + - name: CellValueExtraProperties + uid: excel!Excel.CellValueExtraProperties:interface + - name: CellValuePropertyMetadata + uid: excel!Excel.CellValuePropertyMetadata:interface + - name: CellValuePropertyMetadataExclusions + uid: excel!Excel.CellValuePropertyMetadataExclusions:interface + - name: CellValueProviderAttributes + uid: excel!Excel.CellValueProviderAttributes:interface + - name: ChangedEventDetail + uid: excel!Excel.ChangedEventDetail:interface + - name: ChangeDirectionState + uid: excel!Excel.ChangeDirectionState:interface + - name: Chart + uid: excel!Excel.Chart:class + - name: ChartActivatedEventArgs + uid: excel!Excel.ChartActivatedEventArgs:interface + - name: ChartAddedEventArgs + uid: excel!Excel.ChartAddedEventArgs:interface + - name: ChartAreaFormat + uid: excel!Excel.ChartAreaFormat:class + - name: ChartAxes + uid: excel!Excel.ChartAxes:class + - name: ChartAxis + uid: excel!Excel.ChartAxis:class + - name: ChartAxisFormat + uid: excel!Excel.ChartAxisFormat:class + - name: ChartAxisTitle + uid: excel!Excel.ChartAxisTitle:class + - name: ChartAxisTitleFormat + uid: excel!Excel.ChartAxisTitleFormat:class + - name: ChartBinOptions + uid: excel!Excel.ChartBinOptions:class + - name: ChartBorder + uid: excel!Excel.ChartBorder:class + - name: ChartBoxwhiskerOptions + uid: excel!Excel.ChartBoxwhiskerOptions:class + - name: ChartCollection + uid: excel!Excel.ChartCollection:class + - name: ChartDataLabel + uid: excel!Excel.ChartDataLabel:class + - name: ChartDataLabelAnchor + uid: excel!Excel.ChartDataLabelAnchor:class + - name: ChartDataLabelFormat + uid: excel!Excel.ChartDataLabelFormat:class + - name: ChartDataLabels + uid: excel!Excel.ChartDataLabels:class + - name: ChartDataTable + uid: excel!Excel.ChartDataTable:class + - name: ChartDataTableFormat + uid: excel!Excel.ChartDataTableFormat:class + - name: ChartDeactivatedEventArgs + uid: excel!Excel.ChartDeactivatedEventArgs:interface + - name: ChartDeletedEventArgs + uid: excel!Excel.ChartDeletedEventArgs:interface + - name: ChartErrorBars + uid: excel!Excel.ChartErrorBars:class + - name: ChartErrorBarsFormat + uid: excel!Excel.ChartErrorBarsFormat:class + - name: ChartFill + uid: excel!Excel.ChartFill:class + - name: ChartFont + uid: excel!Excel.ChartFont:class + - name: ChartFormatString + uid: excel!Excel.ChartFormatString:class + - name: ChartGridlines + uid: excel!Excel.ChartGridlines:class + - name: ChartGridlinesFormat + uid: excel!Excel.ChartGridlinesFormat:class + - name: ChartLeaderLines + uid: excel!Excel.ChartLeaderLines:class + - name: ChartLeaderLinesFormat + uid: excel!Excel.ChartLeaderLinesFormat:class + - name: ChartLegend + uid: excel!Excel.ChartLegend:class + - name: ChartLegendEntry + uid: excel!Excel.ChartLegendEntry:class + - name: ChartLegendEntryCollection + uid: excel!Excel.ChartLegendEntryCollection:class + - name: ChartLegendFormat + uid: excel!Excel.ChartLegendFormat:class + - name: ChartLineFormat + uid: excel!Excel.ChartLineFormat:class + - name: ChartMapOptions + uid: excel!Excel.ChartMapOptions:class + - name: ChartPivotOptions + uid: excel!Excel.ChartPivotOptions:class + - name: ChartPlotArea + uid: excel!Excel.ChartPlotArea:class + - name: ChartPlotAreaFormat + uid: excel!Excel.ChartPlotAreaFormat:class + - name: ChartPoint + uid: excel!Excel.ChartPoint:class + - name: ChartPointFormat + uid: excel!Excel.ChartPointFormat:class + - name: ChartPointsCollection + uid: excel!Excel.ChartPointsCollection:class + - name: ChartSeries + uid: excel!Excel.ChartSeries:class + - name: ChartSeriesCollection + uid: excel!Excel.ChartSeriesCollection:class + - name: ChartSeriesFormat + uid: excel!Excel.ChartSeriesFormat:class + - name: ChartTitle + uid: excel!Excel.ChartTitle:class + - name: ChartTitleFormat + uid: excel!Excel.ChartTitleFormat:class + - name: ChartTrendline + uid: excel!Excel.ChartTrendline:class + - name: ChartTrendlineCollection + uid: excel!Excel.ChartTrendlineCollection:class + - name: ChartTrendlineFormat + uid: excel!Excel.ChartTrendlineFormat:class + - name: ChartTrendlineLabel + uid: excel!Excel.ChartTrendlineLabel:class + - name: ChartTrendlineLabelFormat + uid: excel!Excel.ChartTrendlineLabelFormat:class + - name: CheckboxCellControl + uid: excel!Excel.CheckboxCellControl:interface + - name: ColorScaleConditionalFormat + uid: excel!Excel.ColorScaleConditionalFormat:class + - name: ColumnProperties + uid: excel!Excel.ColumnProperties:interface + - name: ColumnPropertiesLoadOptions + uid: excel!Excel.ColumnPropertiesLoadOptions:interface + - name: Comment + uid: excel!Excel.Comment:class + - name: CommentAddedEventArgs + uid: excel!Excel.CommentAddedEventArgs:interface + - name: CommentChangedEventArgs + uid: excel!Excel.CommentChangedEventArgs:interface + - name: CommentCollection + uid: excel!Excel.CommentCollection:class + - name: CommentDeletedEventArgs + uid: excel!Excel.CommentDeletedEventArgs:interface + - name: CommentDetail + uid: excel!Excel.CommentDetail:interface + - name: CommentMention + uid: excel!Excel.CommentMention:interface + - name: CommentReply + uid: excel!Excel.CommentReply:class + - name: CommentReplyCollection + uid: excel!Excel.CommentReplyCollection:class + - name: CommentRichContent + uid: excel!Excel.CommentRichContent:interface + - name: CompactLayout + uid: excel!Excel.CompactLayout:type + - name: ConditionalCellValueRule + uid: excel!Excel.ConditionalCellValueRule:interface + - name: ConditionalColorScaleCriteria + uid: excel!Excel.ConditionalColorScaleCriteria:interface + - name: ConditionalColorScaleCriterion + uid: excel!Excel.ConditionalColorScaleCriterion:interface + - name: ConditionalDataBarNegativeFormat + uid: excel!Excel.ConditionalDataBarNegativeFormat:class + - name: ConditionalDataBarPositiveFormat + uid: excel!Excel.ConditionalDataBarPositiveFormat:class + - name: ConditionalDataBarRule + uid: excel!Excel.ConditionalDataBarRule:interface + - name: ConditionalFormat + uid: excel!Excel.ConditionalFormat:class + - name: ConditionalFormatCollection + uid: excel!Excel.ConditionalFormatCollection:class + - name: ConditionalFormatRule + uid: excel!Excel.ConditionalFormatRule:class + - name: ConditionalIconCriterion + uid: excel!Excel.ConditionalIconCriterion:interface + - name: ConditionalPresetCriteriaRule + uid: excel!Excel.ConditionalPresetCriteriaRule:interface + - name: ConditionalRangeBorder + uid: excel!Excel.ConditionalRangeBorder:class + - name: ConditionalRangeBorderCollection + uid: excel!Excel.ConditionalRangeBorderCollection:class + - name: ConditionalRangeFill + uid: excel!Excel.ConditionalRangeFill:class + - name: ConditionalRangeFont + uid: excel!Excel.ConditionalRangeFont:class + - name: ConditionalRangeFormat + uid: excel!Excel.ConditionalRangeFormat:class + - name: ConditionalTextComparisonRule + uid: excel!Excel.ConditionalTextComparisonRule:interface + - name: ConditionalTopBottomRule + uid: excel!Excel.ConditionalTopBottomRule:interface + - name: ConnectErrorCellValue + uid: excel!Excel.ConnectErrorCellValue:interface + - name: CultureInfo + uid: excel!Excel.CultureInfo:class + - name: CustomConditionalFormat + uid: excel!Excel.CustomConditionalFormat:class + - name: CustomDataValidation + uid: excel!Excel.CustomDataValidation:interface + - name: CustomFunctionManager + uid: excel!Excel.CustomFunctionManager:class + - name: CustomFunctionVisibilityOptions + uid: excel!Excel.CustomFunctionVisibilityOptions:interface + - name: CustomProperty + uid: excel!Excel.CustomProperty:class + - name: CustomPropertyCollection + uid: excel!Excel.CustomPropertyCollection:class + - name: CustomXmlPart + uid: excel!Excel.CustomXmlPart:class + - name: CustomXmlPartCollection + uid: excel!Excel.CustomXmlPartCollection:class + - name: CustomXmlPartScopedCollection + uid: excel!Excel.CustomXmlPartScopedCollection:class + - name: DataBarConditionalFormat + uid: excel!Excel.DataBarConditionalFormat:class + - name: DataConnectionCollection + uid: excel!Excel.DataConnectionCollection:class + - name: DataPivotHierarchy + uid: excel!Excel.DataPivotHierarchy:class + - name: DataPivotHierarchyCollection + uid: excel!Excel.DataPivotHierarchyCollection:class + - name: DataValidation + uid: excel!Excel.DataValidation:class + - name: DataValidationErrorAlert + uid: excel!Excel.DataValidationErrorAlert:interface + - name: DataValidationPrompt + uid: excel!Excel.DataValidationPrompt:interface + - name: DataValidationRule + uid: excel!Excel.DataValidationRule:interface + - name: DateTimeDataValidation + uid: excel!Excel.DateTimeDataValidation:interface + - name: DatetimeFormatInfo + uid: excel!Excel.DatetimeFormatInfo:class + - name: Div0ErrorCellValue + uid: excel!Excel.Div0ErrorCellValue:interface + - name: DocumentProperties + uid: excel!Excel.DocumentProperties:class + - name: DoubleCellValue + uid: excel!Excel.DoubleCellValue:interface + - name: EmptyCellControl + uid: excel!Excel.EmptyCellControl:interface + - name: EmptyCellValue + uid: excel!Excel.EmptyCellValue:interface + - name: EntityCardLayout + uid: excel!Excel.EntityCardLayout:interface + - name: EntityCellValue + uid: excel!Excel.EntityCellValue:interface + - name: EntityCompactLayout + uid: excel!Excel.EntityCompactLayout:interface + - name: EntityPropertyExtraProperties + uid: excel!Excel.EntityPropertyExtraProperties:interface + - name: EntityPropertyType + uid: excel!Excel.EntityPropertyType:type + - name: EntityViewLayouts + uid: excel!Excel.EntityViewLayouts:interface + - name: ErrorCellValue + uid: excel!Excel.ErrorCellValue:type + - name: ExternalErrorCellValue + uid: excel!Excel.ExternalErrorCellValue:interface + - name: FieldErrorCellValue + uid: excel!Excel.FieldErrorCellValue:interface + - name: Filter + uid: excel!Excel.Filter:class + - name: FilterCriteria + uid: excel!Excel.FilterCriteria:interface + - name: FilterDatetime + uid: excel!Excel.FilterDatetime:interface + - name: FilterPivotHierarchy + uid: excel!Excel.FilterPivotHierarchy:class + - name: FilterPivotHierarchyCollection + uid: excel!Excel.FilterPivotHierarchyCollection:class + - name: FormatProtection + uid: excel!Excel.FormatProtection:class + - name: FormattedNumberCellValue + uid: excel!Excel.FormattedNumberCellValue:interface + - name: FormulaChangedEventDetail + uid: excel!Excel.FormulaChangedEventDetail:interface + - name: FunctionCellValue + uid: excel!Excel.FunctionCellValue:type + - name: FunctionResult + uid: excel!Excel.FunctionResult:class + - name: Functions + uid: excel!Excel.Functions:class + - name: GeometricShape + uid: excel!Excel.GeometricShape:class + - name: GettingDataErrorCellValue + uid: excel!Excel.GettingDataErrorCellValue:interface + - name: GroupShapeCollection + uid: excel!Excel.GroupShapeCollection:class + - name: HeaderFooter + uid: excel!Excel.HeaderFooter:class + - name: HeaderFooterGroup + uid: excel!Excel.HeaderFooterGroup:class + - name: Icon + uid: excel!Excel.Icon:interface + - name: IconSetConditionalFormat + uid: excel!Excel.IconSetConditionalFormat:class + - name: Image + uid: excel!Excel.Image:class + - name: InsertWorksheetOptions + uid: excel!Excel.InsertWorksheetOptions:interface + - name: IterativeCalculation + uid: excel!Excel.IterativeCalculation:class + - name: JavaScriptCustomFunctionReferenceCellValue + uid: excel!Excel.JavaScriptCustomFunctionReferenceCellValue:interface + - name: Line + uid: excel!Excel.Line:class + - name: LinkedEntityCellValue + uid: excel!Excel.LinkedEntityCellValue:interface + - name: LinkedEntityDataDomain + uid: excel!Excel.LinkedEntityDataDomain:class + - name: LinkedEntityDataDomainAddedEventArgs + uid: excel!Excel.LinkedEntityDataDomainAddedEventArgs:interface + - name: LinkedEntityDataDomainCollection + uid: excel!Excel.LinkedEntityDataDomainCollection:class + - name: LinkedEntityDataDomainCreateOptions + uid: excel!Excel.LinkedEntityDataDomainCreateOptions:interface + - name: LinkedEntityDataDomainRefreshCompletedEventArgs + uid: >- + excel!Excel.LinkedEntityDataDomainRefreshCompletedEventArgs:interface + - name: LinkedEntityDataDomainRefreshModeChangedEventArgs + uid: >- + excel!Excel.LinkedEntityDataDomainRefreshModeChangedEventArgs:interface + - name: LinkedEntityId + uid: excel!Excel.LinkedEntityId:interface + - name: LinkedEntityIdCulture + uid: excel!Excel.LinkedEntityIdCulture:interface + - name: LinkedEntityLoadServiceRequest + uid: excel!Excel.LinkedEntityLoadServiceRequest:interface + - name: LinkedEntityLoadServiceResult + uid: excel!Excel.LinkedEntityLoadServiceResult:interface + - name: ListDataValidation + uid: excel!Excel.ListDataValidation:interface + - name: MixedCellControl + uid: excel!Excel.MixedCellControl:interface + - name: NamedItem + uid: excel!Excel.NamedItem:class + - name: NamedItemArrayValues + uid: excel!Excel.NamedItemArrayValues:class + - name: NamedItemCollection + uid: excel!Excel.NamedItemCollection:class + - name: NameErrorCellValue + uid: excel!Excel.NameErrorCellValue:interface + - name: NotAvailableErrorCellValue + uid: excel!Excel.NotAvailableErrorCellValue:interface + - name: Note + uid: excel!Excel.Note:class + - name: NoteCollection + uid: excel!Excel.NoteCollection:class + - name: NullErrorCellValue + uid: excel!Excel.NullErrorCellValue:interface + - name: NumberFormatInfo + uid: excel!Excel.NumberFormatInfo:class + - name: NumErrorCellValue + uid: excel!Excel.NumErrorCellValue:interface + - name: PageBreak + uid: excel!Excel.PageBreak:class + - name: PageBreakCollection + uid: excel!Excel.PageBreakCollection:class + - name: PageLayout + uid: excel!Excel.PageLayout:class + - name: PageLayoutMarginOptions + uid: excel!Excel.PageLayoutMarginOptions:interface + - name: PageLayoutZoomOptions + uid: excel!Excel.PageLayoutZoomOptions:interface + - name: PivotDateFilter + uid: excel!Excel.PivotDateFilter:interface + - name: PivotField + uid: excel!Excel.PivotField:class + - name: PivotFieldCollection + uid: excel!Excel.PivotFieldCollection:class + - name: PivotFilters + uid: excel!Excel.PivotFilters:interface + - name: PivotHierarchy + uid: excel!Excel.PivotHierarchy:class + - name: PivotHierarchyCollection + uid: excel!Excel.PivotHierarchyCollection:class + - name: PivotItem + uid: excel!Excel.PivotItem:class + - name: PivotItemCollection + uid: excel!Excel.PivotItemCollection:class + - name: PivotLabelFilter + uid: excel!Excel.PivotLabelFilter:interface + - name: PivotLayout + uid: excel!Excel.PivotLayout:class + - name: PivotManualFilter + uid: excel!Excel.PivotManualFilter:interface + - name: PivotTable + uid: excel!Excel.PivotTable:class + - name: PivotTableCollection + uid: excel!Excel.PivotTableCollection:class + - name: PivotTableScopedCollection + uid: excel!Excel.PivotTableScopedCollection:class + - name: PivotTableStyle + uid: excel!Excel.PivotTableStyle:class + - name: PivotTableStyleCollection + uid: excel!Excel.PivotTableStyleCollection:class + - name: PivotValueFilter + uid: excel!Excel.PivotValueFilter:interface + - name: PlaceholderErrorCellValue + uid: excel!Excel.PlaceholderErrorCellValue:interface + - name: PresetCriteriaConditionalFormat + uid: excel!Excel.PresetCriteriaConditionalFormat:class + - name: Query + uid: excel!Excel.Query:class + - name: QueryCollection + uid: excel!Excel.QueryCollection:class + - name: Range + uid: excel!Excel.Range:class + - name: RangeAreas + uid: excel!Excel.RangeAreas:class + - name: RangeAreasCollection + uid: excel!Excel.RangeAreasCollection:class + - name: RangeBorder + uid: excel!Excel.RangeBorder:class + - name: RangeBorderCollection + uid: excel!Excel.RangeBorderCollection:class + - name: RangeCollection + uid: excel!Excel.RangeCollection:class + - name: RangeFill + uid: excel!Excel.RangeFill:class + - name: RangeFont + uid: excel!Excel.RangeFont:class + - name: RangeFormat + uid: excel!Excel.RangeFormat:class + - name: RangeHyperlink + uid: excel!Excel.RangeHyperlink:interface + - name: RangeReference + uid: excel!Excel.RangeReference:interface + - name: RangeSort + uid: excel!Excel.RangeSort:class + - name: RangeTextRun + uid: excel!Excel.RangeTextRun:interface + - name: RangeView + uid: excel!Excel.RangeView:class + - name: RangeViewCollection + uid: excel!Excel.RangeViewCollection:class + - name: ReferenceCellValue + uid: excel!Excel.ReferenceCellValue:interface + - name: ReferencedValue + uid: excel!Excel.ReferencedValue:type + - name: RefErrorCellValue + uid: excel!Excel.RefErrorCellValue:interface + - name: RemoveDuplicatesResult + uid: excel!Excel.RemoveDuplicatesResult:class + - name: ReplaceCriteria + uid: excel!Excel.ReplaceCriteria:interface + - name: RequestContext + uid: excel!Excel.RequestContext:class + - name: RootReferenceCellValue + uid: excel!Excel.RootReferenceCellValue:interface + - name: RowColumnPivotHierarchy + uid: excel!Excel.RowColumnPivotHierarchy:class + - name: RowColumnPivotHierarchyCollection + uid: excel!Excel.RowColumnPivotHierarchyCollection:class + - name: RowProperties + uid: excel!Excel.RowProperties:interface + - name: RowPropertiesLoadOptions + uid: excel!Excel.RowPropertiesLoadOptions:interface + - name: RunOptions + uid: excel!Excel.RunOptions:interface + - name: Runtime + uid: excel!Excel.Runtime:class + - name: SearchCriteria + uid: excel!Excel.SearchCriteria:interface + - name: SelectionChangedEventArgs + uid: excel!Excel.SelectionChangedEventArgs:interface + - name: Session + uid: excel!Excel.Session:interface + - name: SettableCellProperties + uid: excel!Excel.SettableCellProperties:interface + - name: SettableColumnProperties + uid: excel!Excel.SettableColumnProperties:interface + - name: SettableRowProperties + uid: excel!Excel.SettableRowProperties:interface + - name: Setting + uid: excel!Excel.Setting:class + - name: SettingCollection + uid: excel!Excel.SettingCollection:class + - name: SettingsChangedEventArgs + uid: excel!Excel.SettingsChangedEventArgs:interface + - name: Shape + uid: excel!Excel.Shape:class + - name: ShapeActivatedEventArgs + uid: excel!Excel.ShapeActivatedEventArgs:interface + - name: ShapeCollection + uid: excel!Excel.ShapeCollection:class + - name: ShapeDeactivatedEventArgs + uid: excel!Excel.ShapeDeactivatedEventArgs:interface + - name: ShapeFill + uid: excel!Excel.ShapeFill:class + - name: ShapeFont + uid: excel!Excel.ShapeFont:class + - name: ShapeGroup + uid: excel!Excel.ShapeGroup:class + - name: ShapeLineFormat + uid: excel!Excel.ShapeLineFormat:class + - name: ShowAsRule + uid: excel!Excel.ShowAsRule:interface + - name: Slicer + uid: excel!Excel.Slicer:class + - name: SlicerCollection + uid: excel!Excel.SlicerCollection:class + - name: SlicerItem + uid: excel!Excel.SlicerItem:class + - name: SlicerItemCollection + uid: excel!Excel.SlicerItemCollection:class + - name: SlicerStyle + uid: excel!Excel.SlicerStyle:class + - name: SlicerStyleCollection + uid: excel!Excel.SlicerStyleCollection:class + - name: SortField + uid: excel!Excel.SortField:interface + - name: SpillErrorCellValue + uid: excel!Excel.SpillErrorCellValue:interface + - name: StringCellValue + uid: excel!Excel.StringCellValue:interface + - name: Style + uid: excel!Excel.Style:class + - name: StyleCollection + uid: excel!Excel.StyleCollection:class + - name: Subtotals + uid: excel!Excel.Subtotals:interface + - name: Table + uid: excel!Excel.Table:class + - name: TableAddedEventArgs + uid: excel!Excel.TableAddedEventArgs:interface + - name: TableChangedEventArgs + uid: excel!Excel.TableChangedEventArgs:interface + - name: TableCollection + uid: excel!Excel.TableCollection:class + - name: TableColumn + uid: excel!Excel.TableColumn:class + - name: TableColumnCollection + uid: excel!Excel.TableColumnCollection:class + - name: TableDeletedEventArgs + uid: excel!Excel.TableDeletedEventArgs:interface + - name: TableRow + uid: excel!Excel.TableRow:class + - name: TableRowCollection + uid: excel!Excel.TableRowCollection:class + - name: TableScopedCollection + uid: excel!Excel.TableScopedCollection:class + - name: TableSelectionChangedEventArgs + uid: excel!Excel.TableSelectionChangedEventArgs:interface + - name: TableSort + uid: excel!Excel.TableSort:class + - name: TableStyle + uid: excel!Excel.TableStyle:class + - name: TableStyleCollection + uid: excel!Excel.TableStyleCollection:class + - name: TextConditionalFormat + uid: excel!Excel.TextConditionalFormat:class + - name: TextFrame + uid: excel!Excel.TextFrame:class + - name: TextRange + uid: excel!Excel.TextRange:class + - name: TimelineStyle + uid: excel!Excel.TimelineStyle:class + - name: TimelineStyleCollection + uid: excel!Excel.TimelineStyleCollection:class + - name: TopBottomConditionalFormat + uid: excel!Excel.TopBottomConditionalFormat:class + - name: UnknownCellControl + uid: excel!Excel.UnknownCellControl:interface + - name: ValueErrorCellValue + uid: excel!Excel.ValueErrorCellValue:interface + - name: ValueTypeNotAvailableCellValue + uid: excel!Excel.ValueTypeNotAvailableCellValue:interface + - name: WebImageCellValue + uid: excel!Excel.WebImageCellValue:interface + - name: Workbook + uid: excel!Excel.Workbook:class + - name: WorkbookActivatedEventArgs + uid: excel!Excel.WorkbookActivatedEventArgs:interface + - name: WorkbookAutoSaveSettingChangedEventArgs + uid: excel!Excel.WorkbookAutoSaveSettingChangedEventArgs:interface + - name: WorkbookCreated + uid: excel!Excel.WorkbookCreated:class + - name: WorkbookProtection + uid: excel!Excel.WorkbookProtection:class + - name: WorkbookRangeAreas + uid: excel!Excel.WorkbookRangeAreas:class + - name: Worksheet + uid: excel!Excel.Worksheet:class + - name: WorksheetActivatedEventArgs + uid: excel!Excel.WorksheetActivatedEventArgs:interface + - name: WorksheetAddedEventArgs + uid: excel!Excel.WorksheetAddedEventArgs:interface + - name: WorksheetCalculatedEventArgs + uid: excel!Excel.WorksheetCalculatedEventArgs:interface + - name: WorksheetChangedEventArgs + uid: excel!Excel.WorksheetChangedEventArgs:interface + - name: WorksheetCollection + uid: excel!Excel.WorksheetCollection:class + - name: WorksheetColumnSortedEventArgs + uid: excel!Excel.WorksheetColumnSortedEventArgs:interface + - name: WorksheetCustomProperty + uid: excel!Excel.WorksheetCustomProperty:class + - name: WorksheetCustomPropertyCollection + uid: excel!Excel.WorksheetCustomPropertyCollection:class + - name: WorksheetDeactivatedEventArgs + uid: excel!Excel.WorksheetDeactivatedEventArgs:interface + - name: WorksheetDeletedEventArgs + uid: excel!Excel.WorksheetDeletedEventArgs:interface + - name: WorksheetFormatChangedEventArgs + uid: excel!Excel.WorksheetFormatChangedEventArgs:interface + - name: WorksheetFormulaChangedEventArgs + uid: excel!Excel.WorksheetFormulaChangedEventArgs:interface + - name: WorksheetFreezePanes + uid: excel!Excel.WorksheetFreezePanes:class + - name: WorksheetMovedEventArgs + uid: excel!Excel.WorksheetMovedEventArgs:interface + - name: WorksheetNameChangedEventArgs + uid: excel!Excel.WorksheetNameChangedEventArgs:interface + - name: WorksheetProtection + uid: excel!Excel.WorksheetProtection:class + - name: WorksheetProtectionChangedEventArgs + uid: excel!Excel.WorksheetProtectionChangedEventArgs:interface + - name: WorksheetProtectionOptions + uid: excel!Excel.WorksheetProtectionOptions:interface + - name: WorksheetRowHiddenChangedEventArgs + uid: excel!Excel.WorksheetRowHiddenChangedEventArgs:interface + - name: WorksheetRowSortedEventArgs + uid: excel!Excel.WorksheetRowSortedEventArgs:interface + - name: WorksheetSearchCriteria + uid: excel!Excel.WorksheetSearchCriteria:interface + - name: WorksheetSelectionChangedEventArgs + uid: excel!Excel.WorksheetSelectionChangedEventArgs:interface + - name: WorksheetSingleClickedEventArgs + uid: excel!Excel.WorksheetSingleClickedEventArgs:interface + - name: WorksheetVisibilityChangedEventArgs + uid: excel!Excel.WorksheetVisibilityChangedEventArgs:interface + - name: OneNote + href: /javascript/api/onenote + - name: Outlook + href: /javascript/api/outlook + - name: PowerPoint + href: /javascript/api/powerpoint + - name: Visio + href: /javascript/api/visio + - name: Word + href: /javascript/api/word + - name: Common APIs + uid: office! + items: + - name: Office + uid: office! + items: + - name: Enums + uid: '' + items: + - name: ActiveView + uid: office!Office.ActiveView:enum + - name: AsyncResultStatus + uid: office!Office.AsyncResultStatus:enum + - name: BindingType + uid: office!Office.BindingType:enum + - name: CoercionType + uid: office!Office.CoercionType:enum + - name: CustomXMLNodeType + uid: office!Office.CustomXMLNodeType:enum + - name: DevicePermissionType + uid: office!Office.DevicePermissionType:enum + - name: DocumentMode + uid: office!Office.DocumentMode:enum + - name: EventType + uid: office!Office.EventType:enum + - name: FileType + uid: office!Office.FileType:enum + - name: FilterType + uid: office!Office.FilterType:enum + - name: GoToType + uid: office!Office.GoToType:enum + - name: HostType + uid: office!Office.HostType:enum + - name: Index + uid: office!Office.Index:enum + - name: InitializationReason + uid: office!Office.InitializationReason:enum + - name: PlatformType + uid: office!Office.PlatformType:enum + - name: ProjectProjectFields + uid: office!Office.ProjectProjectFields:enum + - name: ProjectResourceFields + uid: office!Office.ProjectResourceFields:enum + - name: ProjectTaskFields + uid: office!Office.ProjectTaskFields:enum + - name: ProjectViewTypes + uid: office!Office.ProjectViewTypes:enum + - name: SelectionMode + uid: office!Office.SelectionMode:enum + - name: StartupBehavior + uid: office!Office.StartupBehavior:enum + - name: Table + uid: office!Office.Table:enum + - name: ThemeId + uid: office!Office.ThemeId:enum + - name: ValueFormat + uid: office!Office.ValueFormat:enum + - name: VisibilityMode + uid: office!Office.VisibilityMode:enum + - name: Actions + uid: office!Office.Actions:interface + - name: AddBindingFromNamedItemOptions + uid: office!Office.AddBindingFromNamedItemOptions:interface + - name: AddBindingFromPromptOptions + uid: office!Office.AddBindingFromPromptOptions:interface + - name: AddBindingFromSelectionOptions + uid: office!Office.AddBindingFromSelectionOptions:interface + - name: Addin + uid: office!Office.Addin:interface + - name: AddinCommands.Event + uid: office!Office.AddinCommands.Event:interface + - name: AddinCommands.EventCompletedOptions + uid: office!Office.AddinCommands.EventCompletedOptions:interface + - name: AddinCommands.Source + uid: office!Office.AddinCommands.Source:interface + - name: AsyncContextOptions + uid: office!Office.AsyncContextOptions:interface + - name: AsyncResult + uid: office!Office.AsyncResult:interface + - name: Auth + uid: office!Office.Auth:interface + - name: AuthContext + uid: office!Office.AuthContext:interface + - name: AuthOptions + uid: office!Office.AuthOptions:interface + - name: BeforeDocumentCloseNotification + uid: office!Office.BeforeDocumentCloseNotification:interface + - name: Binding + uid: office!Office.Binding:interface + - name: BindingDataChangedEventArgs + uid: office!Office.BindingDataChangedEventArgs:interface + - name: Bindings + uid: office!Office.Bindings:interface + - name: BindingSelectionChangedEventArgs + uid: office!Office.BindingSelectionChangedEventArgs:interface + - name: Context + uid: office!Office.Context:interface + - name: ContextInformation + uid: office!Office.ContextInformation:interface + - name: ContextMenu + uid: office!Office.ContextMenu:interface + - name: ContextMenuControl + uid: office!Office.ContextMenuControl:interface + - name: ContextMenuUpdaterData + uid: office!Office.ContextMenuUpdaterData:interface + - name: Control + uid: office!Office.Control:interface + - name: CustomXmlNode + uid: office!Office.CustomXmlNode:interface + - name: CustomXmlPart + uid: office!Office.CustomXmlPart:interface + - name: CustomXmlParts + uid: office!Office.CustomXmlParts:interface + - name: CustomXmlPrefixMappings + uid: office!Office.CustomXmlPrefixMappings:interface + - name: DevicePermission + uid: office!Office.DevicePermission:interface + - name: Dialog + uid: office!Office.Dialog:interface + - name: DialogMessageOptions + uid: office!Office.DialogMessageOptions:interface + - name: DialogOptions + uid: office!Office.DialogOptions:interface + - name: DialogParentMessageReceivedEventArgs + uid: office!Office.DialogParentMessageReceivedEventArgs:interface + - name: Document + uid: office!Office.Document:interface + - name: DocumentSelectionChangedEventArgs + uid: office!Office.DocumentSelectionChangedEventArgs:interface + - name: Error + uid: office!Office.Error:interface + - name: File + uid: office!Office.File:interface + - name: FileProperties + uid: office!Office.FileProperties:interface + - name: GetBindingDataOptions + uid: office!Office.GetBindingDataOptions:interface + - name: GetFileOptions + uid: office!Office.GetFileOptions:interface + - name: GetSelectedDataOptions + uid: office!Office.GetSelectedDataOptions:interface + - name: GoToByIdOptions + uid: office!Office.GoToByIdOptions:interface + - name: Group + uid: office!Office.Group:interface + - name: IPromiseConstructor + uid: office!Office.IPromiseConstructor:interface + - name: MatrixBinding + uid: office!Office.MatrixBinding:interface + - name: NodeDeletedEventArgs + uid: office!Office.NodeDeletedEventArgs:interface + - name: NodeInsertedEventArgs + uid: office!Office.NodeInsertedEventArgs:interface + - name: NodeReplacedEventArgs + uid: office!Office.NodeReplacedEventArgs:interface + - name: OfficeTheme + uid: office!Office.OfficeTheme:interface + - name: RangeCoordinates + uid: office!Office.RangeCoordinates:interface + - name: RangeFormatConfiguration + uid: office!Office.RangeFormatConfiguration:interface + - name: RemoveHandlerOptions + uid: office!Office.RemoveHandlerOptions:interface + - name: RequirementSetSupport + uid: office!Office.RequirementSetSupport:interface + - name: Ribbon + uid: office!Office.Ribbon:interface + - name: RibbonUpdaterData + uid: office!Office.RibbonUpdaterData:interface + - name: SaveSettingsOptions + uid: office!Office.SaveSettingsOptions:interface + - name: SetBindingDataOptions + uid: office!Office.SetBindingDataOptions:interface + - name: SetSelectedDataOptions + uid: office!Office.SetSelectedDataOptions:interface + - name: Settings + uid: office!Office.Settings:interface + - name: SettingsChangedEventArgs + uid: office!Office.SettingsChangedEventArgs:interface + - name: Slice + uid: office!Office.Slice:interface + - name: Tab + uid: office!Office.Tab:interface + - name: TableBinding + uid: office!Office.TableBinding:interface + - name: TableData + uid: office!Office.TableData:class + - name: TextBinding + uid: office!Office.TextBinding:interface + - name: UI + uid: office!Office.UI:interface + - name: Urls + uid: office!Office.Urls:interface + - name: VisibilityModeChangedMessage + uid: office!Office.VisibilityModeChangedMessage:interface + - name: OfficeExtension + items: + - name: ClientObject + uid: office!OfficeExtension.ClientObject:class + - name: ClientRequestContext + uid: office!OfficeExtension.ClientRequestContext:class + - name: ClientResult + uid: office!OfficeExtension.ClientResult:class + - name: DebugInfo + uid: office!OfficeExtension.DebugInfo:interface + - name: EmbeddedOptions + uid: office!OfficeExtension.EmbeddedOptions:interface + - name: EmbeddedSession + uid: office!OfficeExtension.EmbeddedSession:class + - name: Error + uid: office!OfficeExtension.Error:class + - name: ErrorCodes + uid: office!OfficeExtension.ErrorCodes:class + - name: EventHandlerResult + uid: office!OfficeExtension.EventHandlerResult:class + - name: EventHandlers + uid: office!OfficeExtension.EventHandlers:class + - name: EventInfo + uid: office!OfficeExtension.EventInfo:interface + - name: IPromise + uid: office!OfficeExtension.IPromise:type + - name: LoadOption + uid: office!OfficeExtension.LoadOption:interface + - name: RequestContextDebugInfo + uid: office!OfficeExtension.RequestContextDebugInfo:interface + - name: RequestUrlAndHeaderInfo + uid: office!OfficeExtension.RequestUrlAndHeaderInfo:interface + - name: RunOptions + uid: office!OfficeExtension.RunOptions:interface + - name: TrackedObjects + uid: office!OfficeExtension.TrackedObjects:class + - name: UpdateOptions + uid: office!OfficeExtension.UpdateOptions:interface + - name: OfficeRuntime + uid: office-runtime! + items: + - name: ApiInformation + uid: office-runtime!OfficeRuntime.ApiInformation:interface + - name: Auth + uid: office-runtime!OfficeRuntime.Auth:interface + - name: AuthOptions + uid: office-runtime!OfficeRuntime.AuthOptions:interface + - name: Dialog + uid: office-runtime!OfficeRuntime.Dialog:interface + - name: DisplayWebDialogOptions + uid: office-runtime!OfficeRuntime.DisplayWebDialogOptions:interface + - name: Storage + uid: office-runtime!OfficeRuntime.Storage:interface + - name: Add-in only manifest reference + items: + - name: Add-in only manifest overview + href: ../../manifest/manifest.md + - name: AllowSnapshot + href: ../../manifest/allowsnapshot.md + - name: AlternateId + href: ../../manifest/alternateid.md + - name: AppDomain + href: ../../manifest/appdomain.md + - name: AppDomains + href: ../../manifest/appdomains.md + - name: CitationText + href: ../../manifest/citationtext.md + - name: DefaultLocale + href: ../../manifest/defaultlocale.md + - name: DefaultSettings + href: ../../manifest/defaultsettings.md + - name: Description + href: ../../manifest/description.md + - name: DesktopSettings + href: ../../manifest/desktopsettings.md + - name: Dictionary + href: ../../manifest/dictionary.md + - name: DictionaryHomePage + href: ../../manifest/dictionaryhomepage.md + - name: DisableEntityHighlighting + href: ../../manifest/disableentityhighlighting.md + - name: DisplayName + href: ../../manifest/displayname.md + - name: ExtendedOverrides + href: ../../manifest/extendedoverrides.md + - name: FileName + href: ../../manifest/filename.md + - name: Form + href: ../../manifest/form.md + - name: FormSettings + href: ../../manifest/formsettings.md + - name: HighResolutionIconUrl + href: ../../manifest/highresolutioniconurl.md + - name: Host + href: ../../manifest/host.md + - name: Hosts + href: ../../manifest/hosts.md + - name: IconUrl + href: ../../manifest/iconurl.md + - name: Id + href: ../../manifest/id.md + - name: Metadata + href: ../../manifest/metadata.md + - name: Method + href: ../../manifest/method.md + - name: Methods + href: ../../manifest/methods.md + - name: Namespace + href: ../../manifest/namespace.md + - name: OfficeApp + href: ../../manifest/officeapp.md + - name: Override + href: ../../manifest/override.md + - name: Permissions + href: ../../manifest/permissions.md + - name: PhoneSettings + href: ../../manifest/phonesettings.md + - name: ProgId + href: ../../manifest/progid.md + - name: ProviderName + href: ../../manifest/providername.md + - name: QueryUri + href: ../../manifest/queryuri.md + - name: RequestedHeight + href: ../../manifest/requestedheight.md + - name: RequestedWidth + href: ../../manifest/requestedwidth.md + - name: Requirements + href: ../../manifest/requirements.md + - name: Rule + href: ../../manifest/rule.md + - name: Set + href: ../../manifest/set.md + - name: Sets + href: ../../manifest/sets.md + - name: SourceLocation + href: ../../manifest/sourcelocation.md + - name: SupportUrl + href: ../../manifest/supporturl.md + - name: TabletSettings + href: ../../manifest/tabletsettings.md + - name: TargetDialect + href: ../../manifest/targetdialect.md + - name: TargetDialects + href: ../../manifest/targetdialects.md + - name: Tokens + href: ../../manifest/tokens.md + - name: Token + href: ../../manifest/token.md + - name: Type + href: ../../manifest/type.md + - name: Version + href: ../../manifest/version.md + - name: VersionOverrides + items: + - name: VersionOverrides Overview + href: ../../manifest/versionoverrides.md + - name: VersionOverrides 1.0 TaskPane + href: ../../manifest/versionoverrides-1-0-taskpane.md + - name: VersionOverrides 1.0 Content + href: ../../manifest/versionoverrides-1-0-content.md + - name: VersionOverrides 1.0 Mail + href: ../../manifest/versionoverrides-1-0-mail.md + - name: VersionOverrides 1.1 Mail + href: ../../manifest/versionoverrides-1-1-mail.md + - name: Action + href: ../../manifest/action.md + - name: AllFormFactors + href: ../../manifest/allformfactors.md + - name: CommandSurface + href: ../../manifest/commandsurface.md + - name: Control + href: ../../manifest/control.md + - name: Control (Button) + href: ../../manifest/control-button.md + - name: Control (Menu) + href: ../../manifest/control-menu.md + - name: Control (MobileButton) + href: ../../manifest/control-mobilebutton.md + - name: CustomTab + href: ../../manifest/customtab.md + - name: DesktopFormFactor + href: ../../manifest/desktopformfactor.md + - name: Enabled + href: ../../manifest/enabled.md + - name: EquivalentAddin + href: ../../manifest/equivalentaddin.md + - name: EquivalentAddins + href: ../../manifest/equivalentaddins.md + - name: Event + href: ../../manifest/event.md + - name: ExtendedPermission + href: ../../manifest/extendedpermission.md + - name: ExtendedPermissions + href: ../../manifest/extendedpermissions.md + - name: ExtensionPoint + href: ../../manifest/extensionpoint.md + - name: FunctionFile + href: ../../manifest/functionfile.md + - name: GetStarted + href: ../../manifest/getstarted.md + - name: Group + href: ../../manifest/group.md + - name: Host + href: ../../manifest/host.md + - name: Hosts + href: ../../manifest/hosts.md + - name: Icon + href: ../../manifest/icon.md + - name: Image + href: ../../manifest/image.md + - name: Images + href: ../../manifest/images.md + - name: Item + href: ../../manifest/item.md + - name: Items + href: ../../manifest/items.md + - name: LaunchEvent + href: ../../manifest/launchevent.md + - name: LaunchEvents + href: ../../manifest/launchevents.md + - name: LongStrings + href: ../../manifest/longstrings.md + - name: MessageAttachment + href: ../../manifest/messageattachment.md + - name: MessageAttachments + href: ../../manifest/messageattachments.md + - name: MobileFormFactor + href: ../../manifest/mobileformfactor.md + - name: MoreInfo + href: ../../manifest/moreinfo.md + - name: OfficeMenu + href: ../../manifest/officemenu.md + - name: OfficeTab + href: ../../manifest/officetab.md + - name: Override + href: ../../manifest/override.md + - name: OverriddenByRibbonApi + href: ../../manifest/overriddenbyribbonapi.md + - name: Page + href: ../../manifest/page.md + - name: PreProcessingDialog + href: ../../manifest/preprocessingdialog.md + - name: ReportPhishingCustomization + href: ../../manifest/reportphishingcustomization.md + - name: ReportingOptions + href: ../../manifest/reportingoptions.md + - name: Resources + href: ../../manifest/resources.md + - name: Runtime + href: ../../manifest/runtime.md + - name: Runtimes + href: ../../manifest/runtimes.md + - name: Scopes + href: ../../manifest/scopes.md + - name: Script + href: ../../manifest/script.md + - name: ShortStrings + href: ../../manifest/shortstrings.md + - name: SourceLocation (version overrides) + href: ../../manifest/customfunctionssourcelocation.md + - name: String + href: ../../manifest/string.md + - name: Supertip + href: ../../manifest/supertip.md + - name: SupportsSharedFolders + href: ../../manifest/supportssharedfolders.md + - name: Url + href: ../../manifest/url.md + - name: Urls + href: ../../manifest/urls.md + - name: WebApplicationInfo + href: ../../manifest/webapplicationinfo.md + - name: Requirement sets + items: + - name: Application and platform availability + href: ../../requirement-sets/requirement-sets.md + - name: Excel requirement sets + items: + - name: Overview + href: ../../requirement-sets/excel/excel-api-requirement-sets.md + displayName: Excel + - name: CustomFunctionsRuntime API requirement sets + href: ../../requirement-sets/excel/custom-functions-requirement-sets.md + displayName: Excel, Custom Functions + - name: Excel preview APIs + href: ../../requirement-sets/excel/excel-preview-apis.md + displayName: Excel + - name: ExcelApi online-only requirement set + href: ../../requirement-sets/excel/excel-api-online-requirement-set.md + displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel + - name: ExcelApi 1.19 requirement set + href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md + displayName: Excel + - name: ExcelApi 1.18 requirement set + href: ../../requirement-sets/excel/excel-api-1-18-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 + - name: ExcelApi 1.15 requirement set + href: ../../requirement-sets/excel/excel-api-1-15-requirement-set.md + displayName: Excel + - name: ExcelApi 1.14 requirement set + href: ../../requirement-sets/excel/excel-api-1-14-requirement-set.md + displayName: Excel + - name: ExcelApi 1.13 requirement set + href: ../../requirement-sets/excel/excel-api-1-13-requirement-set.md + displayName: Excel + - name: ExcelApi 1.12 requirement set + href: ../../requirement-sets/excel/excel-api-1-12-requirement-set.md + displayName: Excel + - name: ExcelApi 1.11 requirement set + href: ../../requirement-sets/excel/excel-api-1-11-requirement-set.md + displayName: Excel + - name: ExcelApi 1.10 requirement set + href: ../../requirement-sets/excel/excel-api-1-10-requirement-set.md + displayName: Excel + - name: ExcelApi 1.9 requirement set + href: ../../requirement-sets/excel/excel-api-1-9-requirement-set.md + displayName: Excel + - name: ExcelApi 1.8 requirement set + href: ../../requirement-sets/excel/excel-api-1-8-requirement-set.md + displayName: Excel + - name: ExcelApi 1.7 requirement set + href: ../../requirement-sets/excel/excel-api-1-7-requirement-set.md + displayName: Excel + - name: ExcelApi 1.6 requirement set + href: ../../requirement-sets/excel/excel-api-1-6-requirement-set.md + displayName: Excel + - name: ExcelApi 1.5 requirement set + href: ../../requirement-sets/excel/excel-api-1-5-requirement-set.md + displayName: Excel + - name: ExcelApi 1.4 requirement set + href: ../../requirement-sets/excel/excel-api-1-4-requirement-set.md + displayName: Excel + - name: ExcelApi 1.3 requirement set + href: ../../requirement-sets/excel/excel-api-1-3-requirement-set.md + displayName: Excel + - name: ExcelApi 1.2 requirement set + href: ../../requirement-sets/excel/excel-api-1-2-requirement-set.md + displayName: Excel + - name: ExcelApi 1.1 requirement set + href: ../../requirement-sets/excel/excel-api-1-1-requirement-set.md + displayName: Excel + - name: OneNote requirement sets + items: + - name: API requirement sets + href: ../../requirement-sets/onenote/onenote-api-requirement-sets.md + displayName: OneNote + - name: Outlook requirement sets + items: + - name: Overview + href: ../../requirement-sets/outlook/outlook-api-requirement-sets.md + displayName: Outlook + - name: Mailbox preview requirement set + items: + - name: Overview + href: >- + ../../requirement-sets/outlook/preview-requirement-set/outlook-requirement-set-preview.md + - name: Office + href: >- + ../../requirement-sets/outlook/preview-requirement-set/office.md + - name: Office.context + href: >- + ../../requirement-sets/outlook/preview-requirement-set/Office.context.md + - name: Office.context.mailbox + href: >- + ../../requirement-sets/outlook/preview-requirement-set/Office.context.mailbox.md + - name: Office.context.mailbox.item + href: >- + ../../requirement-sets/outlook/preview-requirement-set/Office.context.mailbox.item.md + - name: Mailbox requirement set 1.15 + items: + - name: Overview + href: >- + ../../requirement-sets/outlook/requirement-set-1.15/outlook-requirement-set-1.15.md + - name: Office + href: ../../requirement-sets/outlook/requirement-set-1.15/office.md + - name: Office.context + href: >- + ../../requirement-sets/outlook/requirement-set-1.15/Office.context.md + - name: Office.context.mailbox + href: >- + ../../requirement-sets/outlook/requirement-set-1.15/Office.context.mailbox.md + - name: Office.context.mailbox.item + href: >- + ../../requirement-sets/outlook/requirement-set-1.15/Office.context.mailbox.item.md + - name: Mailbox requirement set 1.14 + items: + - name: Overview + href: >- + ../../requirement-sets/outlook/requirement-set-1.14/outlook-requirement-set-1.14.md + - name: Office + href: ../../requirement-sets/outlook/requirement-set-1.14/office.md + - name: Office.context + href: >- + ../../requirement-sets/outlook/requirement-set-1.14/Office.context.md + - name: Office.context.mailbox + href: >- + ../../requirement-sets/outlook/requirement-set-1.14/Office.context.mailbox.md + - name: Office.context.mailbox.item + href: >- + ../../requirement-sets/outlook/requirement-set-1.14/Office.context.mailbox.item.md + - name: Mailbox requirement set 1.13 + items: + - name: Overview + href: >- + ../../requirement-sets/outlook/requirement-set-1.13/outlook-requirement-set-1.13.md + - name: Office + href: ../../requirement-sets/outlook/requirement-set-1.13/office.md + - name: Office.context + href: >- + ../../requirement-sets/outlook/requirement-set-1.13/Office.context.md + - name: Office.context.mailbox + href: >- + ../../requirement-sets/outlook/requirement-set-1.13/Office.context.mailbox.md + - name: Office.context.mailbox.item + href: >- + ../../requirement-sets/outlook/requirement-set-1.13/Office.context.mailbox.item.md + - name: Mailbox requirement set 1.12 + items: + - name: Overview + href: >- + ../../requirement-sets/outlook/requirement-set-1.12/outlook-requirement-set-1.12.md + - name: Office + href: ../../requirement-sets/outlook/requirement-set-1.12/office.md + - name: Office.context + href: >- + ../../requirement-sets/outlook/requirement-set-1.12/Office.context.md + - name: Office.context.mailbox + href: >- + ../../requirement-sets/outlook/requirement-set-1.12/Office.context.mailbox.md + - name: Office.context.mailbox.item + href: >- + ../../requirement-sets/outlook/requirement-set-1.12/Office.context.mailbox.item.md + - name: Mailbox requirement set 1.11 + items: + - name: Overview + href: >- + ../../requirement-sets/outlook/requirement-set-1.11/outlook-requirement-set-1.11.md + - name: Office + href: ../../requirement-sets/outlook/requirement-set-1.11/office.md + - name: Office.context + href: >- + ../../requirement-sets/outlook/requirement-set-1.11/Office.context.md + - name: Office.context.mailbox + href: >- + ../../requirement-sets/outlook/requirement-set-1.11/Office.context.mailbox.md + - name: Office.context.mailbox.item + href: >- + ../../requirement-sets/outlook/requirement-set-1.11/Office.context.mailbox.item.md + - name: Mailbox requirement set 1.10 + items: + - name: Overview + href: >- + ../../requirement-sets/outlook/requirement-set-1.10/outlook-requirement-set-1.10.md + - name: Office + href: ../../requirement-sets/outlook/requirement-set-1.10/office.md + - name: Office.context + href: >- + ../../requirement-sets/outlook/requirement-set-1.10/Office.context.md + - name: Office.context.mailbox + href: >- + ../../requirement-sets/outlook/requirement-set-1.10/Office.context.mailbox.md + - name: Office.context.mailbox.item + href: >- + ../../requirement-sets/outlook/requirement-set-1.10/Office.context.mailbox.item.md + - name: Mailbox requirement set 1.9 + items: + - name: Overview + href: >- + ../../requirement-sets/outlook/requirement-set-1.9/outlook-requirement-set-1.9.md + - name: Office + href: ../../requirement-sets/outlook/requirement-set-1.9/office.md + - name: Office.context + href: >- + ../../requirement-sets/outlook/requirement-set-1.9/Office.context.md + - name: Office.context.mailbox + href: >- + ../../requirement-sets/outlook/requirement-set-1.9/Office.context.mailbox.md + - name: Office.context.mailbox.item + href: >- + ../../requirement-sets/outlook/requirement-set-1.9/Office.context.mailbox.item.md + - name: Mailbox requirement set 1.8 + items: + - name: Overview + href: >- + ../../requirement-sets/outlook/requirement-set-1.8/outlook-requirement-set-1.8.md + - name: Office + href: ../../requirement-sets/outlook/requirement-set-1.8/office.md + - name: Office.context + href: >- + ../../requirement-sets/outlook/requirement-set-1.8/Office.context.md + - name: Office.context.mailbox + href: >- + ../../requirement-sets/outlook/requirement-set-1.8/Office.context.mailbox.md + - name: Office.context.mailbox.item + href: >- + ../../requirement-sets/outlook/requirement-set-1.8/Office.context.mailbox.item.md + - name: Mailbox requirement set 1.7 + items: + - name: Overview + href: >- + ../../requirement-sets/outlook/requirement-set-1.7/outlook-requirement-set-1.7.md + - name: Office + href: ../../requirement-sets/outlook/requirement-set-1.7/office.md + - name: Office.context + href: >- + ../../requirement-sets/outlook/requirement-set-1.7/Office.context.md + - name: Office.context.mailbox + href: >- + ../../requirement-sets/outlook/requirement-set-1.7/Office.context.mailbox.md + - name: Office.context.mailbox.item + href: >- + ../../requirement-sets/outlook/requirement-set-1.7/Office.context.mailbox.item.md + - name: Mailbox requirement set 1.6 + items: + - name: Overview + href: >- + ../../requirement-sets/outlook/requirement-set-1.6/outlook-requirement-set-1.6.md + - name: Office + href: ../../requirement-sets/outlook/requirement-set-1.6/office.md + - name: Office.context + href: >- + ../../requirement-sets/outlook/requirement-set-1.6/Office.context.md + - name: Office.context.mailbox + href: >- + ../../requirement-sets/outlook/requirement-set-1.6/Office.context.mailbox.md + - name: Office.context.mailbox.item + href: >- + ../../requirement-sets/outlook/requirement-set-1.6/Office.context.mailbox.item.md + - name: Mailbox requirement set 1.5 + items: + - name: Overview + href: >- + ../../requirement-sets/outlook/requirement-set-1.5/outlook-requirement-set-1.5.md + - name: Office + href: ../../requirement-sets/outlook/requirement-set-1.5/office.md + - name: Office.context + href: >- + ../../requirement-sets/outlook/requirement-set-1.5/Office.context.md + - name: Office.context.mailbox + href: >- + ../../requirement-sets/outlook/requirement-set-1.5/Office.context.mailbox.md + - name: Office.context.mailbox.item + href: >- + ../../requirement-sets/outlook/requirement-set-1.5/Office.context.mailbox.item.md + - name: Mailbox requirement set 1.4 + items: + - name: Overview + href: >- + ../../requirement-sets/outlook/requirement-set-1.4/outlook-requirement-set-1.4.md + - name: Office + href: ../../requirement-sets/outlook/requirement-set-1.4/office.md + - name: Office.context + href: >- + ../../requirement-sets/outlook/requirement-set-1.4/Office.context.md + - name: Office.context.mailbox + href: >- + ../../requirement-sets/outlook/requirement-set-1.4/Office.context.mailbox.md + - name: Office.context.mailbox.item + href: >- + ../../requirement-sets/outlook/requirement-set-1.4/Office.context.mailbox.item.md + - name: Mailbox requirement set 1.3 + items: + - name: Overview + href: >- + ../../requirement-sets/outlook/requirement-set-1.3/outlook-requirement-set-1.3.md + - name: Office + href: ../../requirement-sets/outlook/requirement-set-1.3/office.md + - name: Office.context + href: >- + ../../requirement-sets/outlook/requirement-set-1.3/Office.context.md + - name: Office.context.mailbox + href: >- + ../../requirement-sets/outlook/requirement-set-1.3/Office.context.mailbox.md + - name: Office.context.mailbox.item + href: >- + ../../requirement-sets/outlook/requirement-set-1.3/Office.context.mailbox.item.md + - name: Mailbox requirement set 1.2 + items: + - name: Overview + href: >- + ../../requirement-sets/outlook/requirement-set-1.2/outlook-requirement-set-1.2.md + - name: Office + href: ../../requirement-sets/outlook/requirement-set-1.2/office.md + - name: Office.context + href: >- + ../../requirement-sets/outlook/requirement-set-1.2/Office.context.md + - name: Office.context.mailbox + href: >- + ../../requirement-sets/outlook/requirement-set-1.2/Office.context.mailbox.md + - name: Office.context.mailbox.item + href: >- + ../../requirement-sets/outlook/requirement-set-1.2/Office.context.mailbox.item.md + - name: Mailbox requirement set 1.1 + items: + - name: Overview + href: >- + ../../requirement-sets/outlook/requirement-set-1.1/outlook-requirement-set-1.1.md + - name: Office + href: ../../requirement-sets/outlook/requirement-set-1.1/office.md + - name: Office.context + href: >- + ../../requirement-sets/outlook/requirement-set-1.1/Office.context.md + - name: Office.context.mailbox + href: >- + ../../requirement-sets/outlook/requirement-set-1.1/Office.context.mailbox.md + - name: Office.context.mailbox.item + href: >- + ../../requirement-sets/outlook/requirement-set-1.1/Office.context.mailbox.item.md + - name: PowerPoint requirement sets + items: + - name: Overview + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-requirement-sets.md + displayName: PowerPoint + - name: PowerPoint preview APIs + href: ../../requirement-sets/powerpoint/powerpoint-preview-apis.md + displayName: PowerPoint + - name: PowerPointApi 1.9 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-9-requirement-set.md + displayName: PowerPoint + - name: PowerPointApi 1.8 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-8-requirement-set.md + displayName: PowerPoint + - name: PowerPointApi 1.7 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-7-requirement-set.md + displayName: PowerPoint + - name: PowerPointApi 1.6 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-6-requirement-set.md + displayName: PowerPoint + - name: PowerPointApi 1.5 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-5-requirement-set.md + displayName: PowerPoint + - name: PowerPointApi 1.4 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-4-requirement-set.md + displayName: PowerPoint + - name: PowerPointApi 1.3 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-3-requirement-set.md + displayName: PowerPoint + - name: PowerPointApi 1.2 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-2-requirement-set.md + displayName: PowerPoint + - name: PowerPointApi 1.1 requirement set + href: >- + ../../requirement-sets/powerpoint/powerpoint-api-1-1-requirement-set.md + displayName: PowerPoint + - name: Word requirement sets + items: + - name: Overview + href: ../../requirement-sets/word/word-api-requirement-sets.md + displayName: Word + - name: Word preview APIs + href: ../../requirement-sets/word/word-preview-apis.md + displayName: Word + - name: WordApi online-only requirement set + href: ../../requirement-sets/word/word-api-online-requirement-set.md + displayName: Word + - name: WordApiDesktop 1.2 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.2-requirement-set.md + displayName: Word + - name: WordApiDesktop 1.1 requirement set + href: >- + ../../requirement-sets/word/word-api-desktop-1.1-requirement-set.md + displayName: Word + - name: WordApi 1.9 requirement set + href: ../../requirement-sets/word/word-api-1-9-requirement-set.md + displayName: Word + - name: WordApi 1.8 requirement set + href: ../../requirement-sets/word/word-api-1-8-requirement-set.md + displayName: Word + - name: WordApi 1.7 requirement set + href: ../../requirement-sets/word/word-api-1-7-requirement-set.md + displayName: Word + - name: WordApi 1.6 requirement set + href: ../../requirement-sets/word/word-api-1-6-requirement-set.md + displayName: Word + - name: WordApi 1.5 requirement set + href: ../../requirement-sets/word/word-api-1-5-requirement-set.md + displayName: Word + - name: WordApi 1.4 requirement set + href: ../../requirement-sets/word/word-api-1-4-requirement-set.md + displayName: Word + - name: WordApi 1.3 requirement set + href: ../../requirement-sets/word/word-api-1-3-requirement-set.md + displayName: Word + - name: WordApi 1.2 requirement set + href: ../../requirement-sets/word/word-api-1-2-requirement-set.md + displayName: Word + - name: WordApi 1.1 requirement set + href: ../../requirement-sets/word/word-api-1-1-requirement-set.md + displayName: Word + - name: Common API requirement sets + items: + - name: Overview + href: ../../requirement-sets/common/office-add-in-requirement-sets.md + - name: Add-in commands requirement sets + href: ../../requirement-sets/common/add-in-commands-requirement-sets.md + - name: Device Permission Service requirement sets + href: >- + ../../requirement-sets/common/device-permission-service-requirement-sets.md + - name: Dialog API requirement sets + href: ../../requirement-sets/common/dialog-api-requirement-sets.md + - name: Dialog Origin requirement sets + href: ../../requirement-sets/common/dialog-origin-requirement-sets.md + - name: Identity API requirement sets + href: ../../requirement-sets/common/identity-api-requirement-sets.md + - name: Image Coercion requirement sets + href: ../../requirement-sets/common/image-coercion-requirement-sets.md + - name: Keyboard Shortcuts requirement sets + href: >- + ../../requirement-sets/common/keyboard-shortcuts-requirement-sets.md + - name: Nested App Auth requirement sets + href: ../../requirement-sets/common/nested-app-auth-requirement-sets.md + - name: Open Browser Window requirement sets + href: >- + ../../requirement-sets/common/open-browser-window-api-requirement-sets.md + - name: Ribbon API requirement sets + href: ../../requirement-sets/common/ribbon-api-requirement-sets.md + - name: Shared Runtime requirement sets + href: ../../requirement-sets/common/shared-runtime-requirement-sets.md diff --git a/docs/docs-ref-autogen/excel_1_3/toc.yml b/docs/docs-ref-autogen/excel_1_3/toc.yml index 6c1fd42423..eb4b39e82a 100644 --- a/docs/docs-ref-autogen/excel_1_3/toc.yml +++ b/docs/docs-ref-autogen/excel_1_3/toc.yml @@ -748,6 +748,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/excel_1_4/toc.yml b/docs/docs-ref-autogen/excel_1_4/toc.yml index e13706598a..5ada83f0e9 100644 --- a/docs/docs-ref-autogen/excel_1_4/toc.yml +++ b/docs/docs-ref-autogen/excel_1_4/toc.yml @@ -756,6 +756,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/excel_1_5/toc.yml b/docs/docs-ref-autogen/excel_1_5/toc.yml index a9fbe40786..3ceeeb07df 100644 --- a/docs/docs-ref-autogen/excel_1_5/toc.yml +++ b/docs/docs-ref-autogen/excel_1_5/toc.yml @@ -764,6 +764,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/excel_1_6/toc.yml b/docs/docs-ref-autogen/excel_1_6/toc.yml index d1e4cc9542..5fe6872d80 100644 --- a/docs/docs-ref-autogen/excel_1_6/toc.yml +++ b/docs/docs-ref-autogen/excel_1_6/toc.yml @@ -846,6 +846,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/excel_1_7/toc.yml b/docs/docs-ref-autogen/excel_1_7/toc.yml index f7c21a3415..fc2c8f2af2 100644 --- a/docs/docs-ref-autogen/excel_1_7/toc.yml +++ b/docs/docs-ref-autogen/excel_1_7/toc.yml @@ -948,6 +948,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/excel_1_8/toc.yml b/docs/docs-ref-autogen/excel_1_8/toc.yml index 734270f8f4..594737bd14 100644 --- a/docs/docs-ref-autogen/excel_1_8/toc.yml +++ b/docs/docs-ref-autogen/excel_1_8/toc.yml @@ -1042,6 +1042,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/excel_1_9/toc.yml b/docs/docs-ref-autogen/excel_1_9/toc.yml index bbd5d5e8d6..cebcd1a129 100644 --- a/docs/docs-ref-autogen/excel_1_9/toc.yml +++ b/docs/docs-ref-autogen/excel_1_9/toc.yml @@ -1283,6 +1283,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/excel_online/excel.yml b/docs/docs-ref-autogen/excel_online/excel.yml index e4bce20e9e..fc3cd23bdf 100644 --- a/docs/docs-ref-autogen/excel_online/excel.yml +++ b/docs/docs-ref-autogen/excel_online/excel.yml @@ -251,6 +251,7 @@ classes: - excel!Excel.ConditionalRangeFormat:class - excel!Excel.CultureInfo:class - excel!Excel.CustomConditionalFormat:class + - excel!Excel.CustomFunctionManager:class - excel!Excel.CustomProperty:class - excel!Excel.CustomPropertyCollection:class - excel!Excel.CustomXmlPart:class @@ -427,6 +428,7 @@ interfaces: - excel!Excel.ConditionalTopBottomRule:interface - excel!Excel.ConnectErrorCellValue:interface - excel!Excel.CustomDataValidation:interface + - excel!Excel.CustomFunctionVisibilityOptions:interface - excel!Excel.DataValidationErrorAlert:interface - excel!Excel.DataValidationPrompt:interface - excel!Excel.DataValidationRule:interface diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.cardlayout.yml b/docs/docs-ref-autogen/excel_online/excel/excel.cardlayout.yml index 4de2b1d604..07ebbc46e3 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.cardlayout.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.cardlayout.yml @@ -4,7 +4,15 @@ uid: excel!Excel.CardLayout:type package: excel! fullName: Excel.CardLayout summary: Represents the layout of a card in card view. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.cardlayoutsection.yml b/docs/docs-ref-autogen/excel_online/excel/excel.cardlayoutsection.yml index 5491f6727f..cca1b0c56e 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.cardlayoutsection.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.cardlayoutsection.yml @@ -4,7 +4,17 @@ uid: excel!Excel.CardLayoutSection:type package: excel! fullName: Excel.CardLayoutSection summary: Represents the layout of a section of a card in card view. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection), [Excel.CardLayoutTwoColumnSection](/javascript/api/excel/excel.cardlayouttwocolumnsection)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), + [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection), + [Excel.CardLayoutTwoColumnSection](/javascript/api/excel/excel.cardlayouttwocolumnsection) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.cellcontrol.yml b/docs/docs-ref-autogen/excel_online/excel/excel.cellcontrol.yml index ecd03dccf2..5e5954d3df 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.cellcontrol.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.cellcontrol.yml @@ -4,7 +4,47 @@ uid: excel!Excel.CellControl:type package: excel! fullName: Excel.CellControl summary: Represents an interactable control inside of a cell. -remarks: "\\[ [API set: ExcelApi 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\n\n\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.UnknownCellControl](/javascript/api/excel/excel.unknowncellcontrol), [Excel.EmptyCellControl](/javascript/api/excel/excel.emptycellcontrol), [Excel.MixedCellControl](/javascript/api/excel/excel.mixedcellcontrol), [Excel.CheckboxCellControl](/javascript/api/excel/excel.checkboxcellcontrol)\r\n\r\n#### Examples\n\n```TypeScript\n// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml\n\n// Add checkboxes to the table.\nawait Excel.run(async (context) => {\n const sheet = context.workbook.worksheets.getActiveWorksheet();\n\n // Get the second column in the table, without the header.\n const range = sheet.tables.getItem(\"FruitTable\").columns.getItem(\"Analysis\").getDataBodyRange();\n\n // Change the boolean values to checkboxes.\n range.control = {\n type: Excel.CellControlType.checkbox\n };\n await context.sync();\n});\n```" +remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + + + Learn more about the types in this type alias through the following links. + + + [Excel.UnknownCellControl](/javascript/api/excel/excel.unknowncellcontrol), + [Excel.EmptyCellControl](/javascript/api/excel/excel.emptycellcontrol), + [Excel.MixedCellControl](/javascript/api/excel/excel.mixedcellcontrol), + [Excel.CheckboxCellControl](/javascript/api/excel/excel.checkboxcellcontrol) + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml + + + // Add checkboxes to the table. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Get the second column in the table, without the header. + const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange(); + + // Change the boolean values to checkboxes. + range.control = { + type: Excel.CellControlType.checkbox + }; + await context.sync(); + }); + + ``` isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.cellvalue.yml b/docs/docs-ref-autogen/excel_online/excel/excel.cellvalue.yml index ef4aaccfd2..4722937ebb 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.cellvalue.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.cellvalue.yml @@ -4,7 +4,28 @@ uid: excel!Excel.CellValue:type package: excel! fullName: Excel.CellValue summary: Represents the value in a cell. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), [Excel.FormattedNumberCellValue](/javascript/api/excel/excel.formattednumbercellvalue), [Excel.FunctionCellValue](/javascript/api/excel/excel.functioncellvalue), [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), + [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), + [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), + [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), + [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), + [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), + [Excel.FormattedNumberCellValue](/javascript/api/excel/excel.formattednumbercellvalue), + [Excel.FunctionCellValue](/javascript/api/excel/excel.functioncellvalue), + [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), + [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), + [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), + [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), + [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), + [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.cellvalueandpropertymetadata.yml b/docs/docs-ref-autogen/excel_online/excel/excel.cellvalueandpropertymetadata.yml index 566432a914..5f661bb32f 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.cellvalueandpropertymetadata.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.cellvalueandpropertymetadata.yml @@ -6,7 +6,16 @@ fullName: Excel.CellValueAndPropertyMetadata summary: >- Represents the value and metadata of a property. The metadata applies to the property (and not the value), but it is combined with the value in this type. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValue](/javascript/api/excel/excel.cellvalue), [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CellValue](/javascript/api/excel/excel.cellvalue), + [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.compactlayout.yml b/docs/docs-ref-autogen/excel_online/excel/excel.compactlayout.yml index 3f25496779..5bb689c662 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.compactlayout.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.compactlayout.yml @@ -6,7 +6,15 @@ fullName: Excel.CompactLayout summary: >- Represents the layout used when there is limited space to represent the entity. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.customfunctionmanager.yml b/docs/docs-ref-autogen/excel_online/excel/excel.customfunctionmanager.yml new file mode 100644 index 0000000000..085d0f6fbc --- /dev/null +++ b/docs/docs-ref-autogen/excel_online/excel/excel.customfunctionmanager.yml @@ -0,0 +1,158 @@ +### YamlMime:TSType +name: Excel.CustomFunctionManager +uid: excel!Excel.CustomFunctionManager:class +package: excel! +fullName: Excel.CustomFunctionManager +summary: Manages settings on custom functions. +remarks: >- + \[ [API set: ExcelApi + 1.20](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: excel!Excel.CustomFunctionManager#context:member + package: excel! + fullName: context + summary: >- + The request context associated with the object. This connects the add-in's + process to the Office host application's process. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: +methods: + - name: load(propertyNames) + uid: excel!Excel.CustomFunctionManager#load:member(1) + package: excel! + fullName: load(propertyNames) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Excel.CustomFunctionManager;' + parameters: + - id: propertyNames + description: >- + A comma-delimited string or an array of strings that specify the + properties to load. + type: string | string[] + return: + type: + description: '' + - name: load(propertyNamesAndPaths) + uid: excel!Excel.CustomFunctionManager#load:member(2) + package: excel! + fullName: load(propertyNamesAndPaths) + summary: >- + Queues up a command to load the specified properties of the object. You + must call `context.sync()` before reading the properties. + remarks: >- + \[ [API set: ExcelApi + 1.20](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.CustomFunctionManager; + parameters: + - id: propertyNamesAndPaths + description: >- + `propertyNamesAndPaths.select` is a comma-delimited string that + specifies the properties to load, and `propertyNamesAndPaths.expand` + is a comma-delimited string that specifies the navigation properties + to load. + type: |- + { + select?: string; + expand?: string; + } + return: + type: + description: '' + - name: newObject(context) + uid: excel!Excel.CustomFunctionManager.newObject:member(1) + package: excel! + fullName: newObject(context) + summary: Create a new instance of the `Excel.CustomFunctionManager` object. + remarks: >- + \[ [API set: ExcelApi + 1.20](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + static newObject(context: OfficeExtension.ClientRequestContext): + Excel.CustomFunctionManager; + parameters: + - id: context + description: '' + type: + return: + type: + description: '' + - name: setVisibility(customFunctionVisibilityOptions) + uid: excel!Excel.CustomFunctionManager.setVisibility:member(1) + package: excel! + fullName: setVisibility(customFunctionVisibilityOptions) + summary: Show or hide custom functions in Excel AutoComplete. + remarks: >- + \[ [API set: ExcelApi + 1.20](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + static setVisibility(customFunctionVisibilityOptions: + Excel.CustomFunctionVisibilityOptions): void; + parameters: + - id: customFunctionVisibilityOptions + description: Specifies which custom functions to show or hide. + type: + return: + type: void + description: '' + - name: toJSON() + uid: excel!Excel.CustomFunctionManager#toJSON:member(1) + package: excel! + fullName: toJSON() + summary: >- + Overrides the JavaScript `toJSON()` method in order to provide more useful + output when an API object is passed to `JSON.stringify()`. + (`JSON.stringify`, in turn, calls the `toJSON` method of the + object that's passed to it.) Whereas the original + `Excel.CustomFunctionManager` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Excel.Interfaces.CustomFunctionManagerData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Excel.Interfaces.CustomFunctionManagerData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.customfunctionvisibilityoptions.yml b/docs/docs-ref-autogen/excel_online/excel/excel.customfunctionvisibilityoptions.yml new file mode 100644 index 0000000000..69a2c25bc7 --- /dev/null +++ b/docs/docs-ref-autogen/excel_online/excel/excel.customfunctionvisibilityoptions.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: Excel.CustomFunctionVisibilityOptions +uid: excel!Excel.CustomFunctionVisibilityOptions:interface +package: excel! +fullName: Excel.CustomFunctionVisibilityOptions +summary: Represents which custom functions to show or hide in Excel AutoComplete. +remarks: >- + \[ [API set: ExcelApi + 1.20](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: hide + uid: excel!Excel.CustomFunctionVisibilityOptions#hide:member + package: excel! + fullName: hide + summary: A list of custom functions to hide from Excel AutoComplete. + remarks: >- + \[ [API set: ExcelApi + 1.20](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'hide?: string[];' + return: + type: string[] + - name: show + uid: excel!Excel.CustomFunctionVisibilityOptions#show:member + package: excel! + fullName: show + summary: A list of custom functions to show in Excel AutoComplete. + remarks: >- + \[ [API set: ExcelApi + 1.20](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'show?: string[];' + return: + type: string[] diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.entitypropertytype.yml b/docs/docs-ref-autogen/excel_online/excel/excel.entitypropertytype.yml index 41a8cc7fcf..bc54a6eff6 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.entitypropertytype.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.entitypropertytype.yml @@ -4,7 +4,16 @@ uid: excel!Excel.EntityPropertyType:type package: excel! fullName: Excel.EntityPropertyType summary: Represents the value of a property. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), [Excel.CellValue](/javascript/api/excel/excel.cellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), + [Excel.CellValue](/javascript/api/excel/excel.cellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.errorcellvalue.yml b/docs/docs-ref-autogen/excel_online/excel/excel.errorcellvalue.yml index e5addcc22f..b88b1959c2 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.errorcellvalue.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.errorcellvalue.yml @@ -4,7 +4,62 @@ uid: excel!Excel.ErrorCellValue:type package: excel! fullName: Excel.ErrorCellValue summary: Represents a cell value which contains an error. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\n\n\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue), [Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue), [Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue), [Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue), [Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue), [Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue), [Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue), [Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue), [Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue), [Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue), [Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue), [Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue), [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue), [Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue), [Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue), [Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue)\r\n\r\n#### Examples\n\n```TypeScript\n// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml\n\n// This function sets the value of cell A1 to a #BUSY! error using data types.\nawait Excel.run(async (context) => {\n // Retrieve the Sample worksheet and cell A1 on that sheet.\n const sheet = context.workbook.worksheets.getItemOrNullObject(\"Sample\");\n const range = sheet.getRange(\"A1\");\n\n // Get the error data type and set its type to `busy`.\n const error: Excel.ErrorCellValue = {\n type: Excel.CellValueType.error,\n errorType: Excel.ErrorCellValueType.busy\n };\n\n // Set cell A1 as the busy error.\n range.valuesAsJson = [[error]];\n await context.sync();\n});\n```" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + + + Learn more about the types in this type alias through the following links. + + + [Excel.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue), + [Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue), + [Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue), + [Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue), + [Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue), + [Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue), + [Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue), + [Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue), + [Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue), + [Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue), + [Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue), + [Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue), + [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue), + [Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue), + [Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue), + [Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue) + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml + + + // This function sets the value of cell A1 to a #BUSY! error using data types. + + await Excel.run(async (context) => { + // Retrieve the Sample worksheet and cell A1 on that sheet. + const sheet = context.workbook.worksheets.getItemOrNullObject("Sample"); + const range = sheet.getRange("A1"); + + // Get the error data type and set its type to `busy`. + const error: Excel.ErrorCellValue = { + type: Excel.CellValueType.error, + errorType: Excel.ErrorCellValueType.busy + }; + + // Set cell A1 as the busy error. + range.valuesAsJson = [[error]]; + await context.sync(); + }); + + ``` isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.functioncellvalue.yml b/docs/docs-ref-autogen/excel_online/excel/excel.functioncellvalue.yml index 50b7239609..b1f83d2ff4 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.functioncellvalue.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.functioncellvalue.yml @@ -4,7 +4,15 @@ uid: excel!Excel.FunctionCellValue:type package: excel! fullName: Excel.FunctionCellValue summary: Represents a cell value which can be evaluated as a function. -remarks: "\\[ [API set: ExcelApi 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.JavaScriptCustomFunctionReferenceCellValue](/javascript/api/excel/excel.javascriptcustomfunctionreferencecellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.JavaScriptCustomFunctionReferenceCellValue](/javascript/api/excel/excel.javascriptcustomfunctionreferencecellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.referencedvalue.yml b/docs/docs-ref-autogen/excel_online/excel/excel.referencedvalue.yml index 57044e8ebe..168b4928ba 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.referencedvalue.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.referencedvalue.yml @@ -4,7 +4,20 @@ uid: excel!Excel.ReferencedValue:type package: excel! fullName: Excel.ReferencedValue summary: Represents the value in a cell. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), + [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), + [Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue), + [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), + [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), + [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.runoptions.yml b/docs/docs-ref-autogen/excel_online/excel/excel.runoptions.yml index c650e6bd70..300015ddf7 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.runoptions.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.runoptions.yml @@ -34,6 +34,28 @@ properties: content: 'delayForCellEdit?: boolean;' return: type: boolean + - name: mergeUndoGroup + uid: excel!Excel.RunOptions#mergeUndoGroup:member + package: excel! + fullName: mergeUndoGroup + summary: >- + Determines whether the batch requests should be merged to one undo group. + + + When false, each `context.sync()` call creates an undo record. When true, + all `context.sync()` calls in a single `Excel.run` are merged into one + `undo` group. + remarks: >- + \[ [API set: ExcelApi + 1.20](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: false + isDeprecated: false + syntax: + content: 'mergeUndoGroup?: boolean;' + return: + type: boolean extends: >- <> diff --git a/docs/docs-ref-autogen/excel_online/toc.yml b/docs/docs-ref-autogen/excel_online/toc.yml index 792a37d19b..b3111a0fe4 100644 --- a/docs/docs-ref-autogen/excel_online/toc.yml +++ b/docs/docs-ref-autogen/excel_online/toc.yml @@ -697,6 +697,10 @@ items: uid: excel!Excel.CustomConditionalFormat:class - name: CustomDataValidation uid: excel!Excel.CustomDataValidation:interface + - name: CustomFunctionManager + uid: excel!Excel.CustomFunctionManager:class + - name: CustomFunctionVisibilityOptions + uid: excel!Excel.CustomFunctionVisibilityOptions:interface - name: CustomProperty uid: excel!Excel.CustomProperty:class - name: CustomPropertyCollection @@ -1631,6 +1635,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/onenote/toc.yml b/docs/docs-ref-autogen/onenote/toc.yml index c270a773ae..48f13dbcf5 100644 --- a/docs/docs-ref-autogen/onenote/toc.yml +++ b/docs/docs-ref-autogen/onenote/toc.yml @@ -605,6 +605,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/outlook/toc.yml b/docs/docs-ref-autogen/outlook/toc.yml index 69107399f8..e9365e97b3 100644 --- a/docs/docs-ref-autogen/outlook/toc.yml +++ b/docs/docs-ref-autogen/outlook/toc.yml @@ -721,6 +721,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/outlook_1_1/toc.yml b/docs/docs-ref-autogen/outlook_1_1/toc.yml index 67abc57533..0904ede9d2 100644 --- a/docs/docs-ref-autogen/outlook_1_1/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_1/toc.yml @@ -577,6 +577,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/outlook_1_10/toc.yml b/docs/docs-ref-autogen/outlook_1_10/toc.yml index c615d6f1a9..3f9cfdab1e 100644 --- a/docs/docs-ref-autogen/outlook_1_10/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_10/toc.yml @@ -677,6 +677,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/outlook_1_11/toc.yml b/docs/docs-ref-autogen/outlook_1_11/toc.yml index 579801a8d6..3a9668dc0f 100644 --- a/docs/docs-ref-autogen/outlook_1_11/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_11/toc.yml @@ -679,6 +679,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/outlook_1_12/toc.yml b/docs/docs-ref-autogen/outlook_1_12/toc.yml index b96367ad16..df5ca0beff 100644 --- a/docs/docs-ref-autogen/outlook_1_12/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_12/toc.yml @@ -681,6 +681,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/outlook_1_13/toc.yml b/docs/docs-ref-autogen/outlook_1_13/toc.yml index cf161f1bf1..8912df693e 100644 --- a/docs/docs-ref-autogen/outlook_1_13/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_13/toc.yml @@ -693,6 +693,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/outlook_1_14/toc.yml b/docs/docs-ref-autogen/outlook_1_14/toc.yml index 958d10d997..b2e315c8f7 100644 --- a/docs/docs-ref-autogen/outlook_1_14/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_14/toc.yml @@ -707,6 +707,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/outlook_1_15/toc.yml b/docs/docs-ref-autogen/outlook_1_15/toc.yml index 55621d15ab..8bb0fbc135 100644 --- a/docs/docs-ref-autogen/outlook_1_15/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_15/toc.yml @@ -713,6 +713,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/outlook_1_2/toc.yml b/docs/docs-ref-autogen/outlook_1_2/toc.yml index df61343841..3c567cd78f 100644 --- a/docs/docs-ref-autogen/outlook_1_2/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_2/toc.yml @@ -579,6 +579,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/outlook_1_3/toc.yml b/docs/docs-ref-autogen/outlook_1_3/toc.yml index 422e8ba85b..666d04bc01 100644 --- a/docs/docs-ref-autogen/outlook_1_3/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_3/toc.yml @@ -587,6 +587,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/outlook_1_4/toc.yml b/docs/docs-ref-autogen/outlook_1_4/toc.yml index 422e8ba85b..666d04bc01 100644 --- a/docs/docs-ref-autogen/outlook_1_4/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_4/toc.yml @@ -587,6 +587,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/outlook_1_5/toc.yml b/docs/docs-ref-autogen/outlook_1_5/toc.yml index b59d900e10..1fdd91f572 100644 --- a/docs/docs-ref-autogen/outlook_1_5/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_5/toc.yml @@ -597,6 +597,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/outlook_1_6/toc.yml b/docs/docs-ref-autogen/outlook_1_6/toc.yml index b59d900e10..1fdd91f572 100644 --- a/docs/docs-ref-autogen/outlook_1_6/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_6/toc.yml @@ -597,6 +597,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/outlook_1_7/toc.yml b/docs/docs-ref-autogen/outlook_1_7/toc.yml index 665cc3a157..e0ae3ca8f0 100644 --- a/docs/docs-ref-autogen/outlook_1_7/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_7/toc.yml @@ -627,6 +627,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/outlook_1_8/toc.yml b/docs/docs-ref-autogen/outlook_1_8/toc.yml index 84610babdf..0e0a444aef 100644 --- a/docs/docs-ref-autogen/outlook_1_8/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_8/toc.yml @@ -661,6 +661,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/outlook_1_9/toc.yml b/docs/docs-ref-autogen/outlook_1_9/toc.yml index 84610babdf..0e0a444aef 100644 --- a/docs/docs-ref-autogen/outlook_1_9/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_9/toc.yml @@ -661,6 +661,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/powerpoint/toc.yml b/docs/docs-ref-autogen/powerpoint/toc.yml index cc79a8ea04..7f2539607b 100644 --- a/docs/docs-ref-autogen/powerpoint/toc.yml +++ b/docs/docs-ref-autogen/powerpoint/toc.yml @@ -708,6 +708,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/powerpoint_1_1/toc.yml b/docs/docs-ref-autogen/powerpoint_1_1/toc.yml index bdea7fc991..dc5ed106cd 100644 --- a/docs/docs-ref-autogen/powerpoint_1_1/toc.yml +++ b/docs/docs-ref-autogen/powerpoint_1_1/toc.yml @@ -513,6 +513,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/powerpoint_1_2/toc.yml b/docs/docs-ref-autogen/powerpoint_1_2/toc.yml index a7d6cf7bfc..69c04f952d 100644 --- a/docs/docs-ref-autogen/powerpoint_1_2/toc.yml +++ b/docs/docs-ref-autogen/powerpoint_1_2/toc.yml @@ -521,6 +521,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/powerpoint_1_3/toc.yml b/docs/docs-ref-autogen/powerpoint_1_3/toc.yml index 02fa571fd5..26123de495 100644 --- a/docs/docs-ref-autogen/powerpoint_1_3/toc.yml +++ b/docs/docs-ref-autogen/powerpoint_1_3/toc.yml @@ -539,6 +539,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/powerpoint_1_4/toc.yml b/docs/docs-ref-autogen/powerpoint_1_4/toc.yml index b3a35aaa7b..8e86e35c7e 100644 --- a/docs/docs-ref-autogen/powerpoint_1_4/toc.yml +++ b/docs/docs-ref-autogen/powerpoint_1_4/toc.yml @@ -575,6 +575,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/powerpoint_1_5/toc.yml b/docs/docs-ref-autogen/powerpoint_1_5/toc.yml index 8b726d38d2..96926c24eb 100644 --- a/docs/docs-ref-autogen/powerpoint_1_5/toc.yml +++ b/docs/docs-ref-autogen/powerpoint_1_5/toc.yml @@ -579,6 +579,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/powerpoint_1_6/toc.yml b/docs/docs-ref-autogen/powerpoint_1_6/toc.yml index af34330654..e0b586e322 100644 --- a/docs/docs-ref-autogen/powerpoint_1_6/toc.yml +++ b/docs/docs-ref-autogen/powerpoint_1_6/toc.yml @@ -583,6 +583,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/powerpoint_1_7/toc.yml b/docs/docs-ref-autogen/powerpoint_1_7/toc.yml index 5bdad31c86..a3af5bf0b2 100644 --- a/docs/docs-ref-autogen/powerpoint_1_7/toc.yml +++ b/docs/docs-ref-autogen/powerpoint_1_7/toc.yml @@ -597,6 +597,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/powerpoint_1_8/toc.yml b/docs/docs-ref-autogen/powerpoint_1_8/toc.yml index 94bc824179..826b42d7f7 100644 --- a/docs/docs-ref-autogen/powerpoint_1_8/toc.yml +++ b/docs/docs-ref-autogen/powerpoint_1_8/toc.yml @@ -643,6 +643,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/powerpoint_1_9/toc.yml b/docs/docs-ref-autogen/powerpoint_1_9/toc.yml index e65312514b..a857bcc624 100644 --- a/docs/docs-ref-autogen/powerpoint_1_9/toc.yml +++ b/docs/docs-ref-autogen/powerpoint_1_9/toc.yml @@ -661,6 +661,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/visio/toc.yml b/docs/docs-ref-autogen/visio/toc.yml index 188c98ddad..b1f6e3fa1f 100644 --- a/docs/docs-ref-autogen/visio/toc.yml +++ b/docs/docs-ref-autogen/visio/toc.yml @@ -351,6 +351,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/word/toc.yml b/docs/docs-ref-autogen/word/toc.yml index 641c128235..5563e4799d 100644 --- a/docs/docs-ref-autogen/word/toc.yml +++ b/docs/docs-ref-autogen/word/toc.yml @@ -1209,6 +1209,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/word_1_1/toc.yml b/docs/docs-ref-autogen/word_1_1/toc.yml index a886eb7355..e2759820bb 100644 --- a/docs/docs-ref-autogen/word_1_1/toc.yml +++ b/docs/docs-ref-autogen/word_1_1/toc.yml @@ -555,6 +555,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/word_1_2/toc.yml b/docs/docs-ref-autogen/word_1_2/toc.yml index a886eb7355..e2759820bb 100644 --- a/docs/docs-ref-autogen/word_1_2/toc.yml +++ b/docs/docs-ref-autogen/word_1_2/toc.yml @@ -555,6 +555,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/word_1_3/toc.yml b/docs/docs-ref-autogen/word_1_3/toc.yml index 960e6a20ae..cc69b6707f 100644 --- a/docs/docs-ref-autogen/word_1_3/toc.yml +++ b/docs/docs-ref-autogen/word_1_3/toc.yml @@ -611,6 +611,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/word_1_3_hidden_document/toc.yml b/docs/docs-ref-autogen/word_1_3_hidden_document/toc.yml index 960e6a20ae..cc69b6707f 100644 --- a/docs/docs-ref-autogen/word_1_3_hidden_document/toc.yml +++ b/docs/docs-ref-autogen/word_1_3_hidden_document/toc.yml @@ -611,6 +611,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/word_1_4/toc.yml b/docs/docs-ref-autogen/word_1_4/toc.yml index 7e195b7c7b..1343219953 100644 --- a/docs/docs-ref-autogen/word_1_4/toc.yml +++ b/docs/docs-ref-autogen/word_1_4/toc.yml @@ -639,6 +639,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/word_1_4_hidden_document/toc.yml b/docs/docs-ref-autogen/word_1_4_hidden_document/toc.yml index 7e195b7c7b..1343219953 100644 --- a/docs/docs-ref-autogen/word_1_4_hidden_document/toc.yml +++ b/docs/docs-ref-autogen/word_1_4_hidden_document/toc.yml @@ -639,6 +639,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/word_1_5/toc.yml b/docs/docs-ref-autogen/word_1_5/toc.yml index 74b03b672c..b85676d900 100644 --- a/docs/docs-ref-autogen/word_1_5/toc.yml +++ b/docs/docs-ref-autogen/word_1_5/toc.yml @@ -681,6 +681,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/word_1_5_hidden_document/toc.yml b/docs/docs-ref-autogen/word_1_5_hidden_document/toc.yml index 74b03b672c..b85676d900 100644 --- a/docs/docs-ref-autogen/word_1_5_hidden_document/toc.yml +++ b/docs/docs-ref-autogen/word_1_5_hidden_document/toc.yml @@ -681,6 +681,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/word_1_6/toc.yml b/docs/docs-ref-autogen/word_1_6/toc.yml index d50374f3cc..d828a29749 100644 --- a/docs/docs-ref-autogen/word_1_6/toc.yml +++ b/docs/docs-ref-autogen/word_1_6/toc.yml @@ -697,6 +697,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/word_1_7/toc.yml b/docs/docs-ref-autogen/word_1_7/toc.yml index b9054d7656..b1f04274b8 100644 --- a/docs/docs-ref-autogen/word_1_7/toc.yml +++ b/docs/docs-ref-autogen/word_1_7/toc.yml @@ -723,6 +723,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/word_1_8/toc.yml b/docs/docs-ref-autogen/word_1_8/toc.yml index 471f9b7649..1e75b6eb26 100644 --- a/docs/docs-ref-autogen/word_1_8/toc.yml +++ b/docs/docs-ref-autogen/word_1_8/toc.yml @@ -727,6 +727,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/word_1_9/toc.yml b/docs/docs-ref-autogen/word_1_9/toc.yml index bea952f6f9..15e8ed8aa0 100644 --- a/docs/docs-ref-autogen/word_1_9/toc.yml +++ b/docs/docs-ref-autogen/word_1_9/toc.yml @@ -735,6 +735,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/word_desktop_1_1/toc.yml b/docs/docs-ref-autogen/word_desktop_1_1/toc.yml index 5d309946f5..1132c1b1cb 100644 --- a/docs/docs-ref-autogen/word_desktop_1_1/toc.yml +++ b/docs/docs-ref-autogen/word_desktop_1_1/toc.yml @@ -753,6 +753,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/word_desktop_1_2/toc.yml b/docs/docs-ref-autogen/word_desktop_1_2/toc.yml index b59a70635d..5ef460fbb0 100644 --- a/docs/docs-ref-autogen/word_desktop_1_2/toc.yml +++ b/docs/docs-ref-autogen/word_desktop_1_2/toc.yml @@ -807,6 +807,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/docs-ref-autogen/word_online/toc.yml b/docs/docs-ref-autogen/word_online/toc.yml index bea952f6f9..15e8ed8aa0 100644 --- a/docs/docs-ref-autogen/word_online/toc.yml +++ b/docs/docs-ref-autogen/word_online/toc.yml @@ -735,6 +735,9 @@ items: - name: ExcelApi online-only requirement set href: ../../requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/docs/includes/excel-1_20.md b/docs/includes/excel-1_20.md new file mode 100644 index 0000000000..739f05f521 --- /dev/null +++ b/docs/includes/excel-1_20.md @@ -0,0 +1,6 @@ +| Class | Fields | Description | +|:---|:---|:---| +|[CustomFunctionManager](/javascript/api/excel/excel.customfunctionmanager)||| +|[CustomFunctionVisibilityOptions](/javascript/api/excel/excel.customfunctionvisibilityoptions)|[hide](/javascript/api/excel/excel.customfunctionvisibilityoptions#excel-excel-customfunctionvisibilityoptions-hide-member)|A list of custom functions to hide from Excel AutoComplete.| +||[show](/javascript/api/excel/excel.customfunctionvisibilityoptions#excel-excel-customfunctionvisibilityoptions-show-member)|A list of custom functions to show in Excel AutoComplete.| +|[RunOptions](/javascript/api/excel/excel.runoptions)|[mergeUndoGroup](/javascript/api/excel/excel.runoptions#excel-excel-runoptions-mergeundogroup-member)|Determines whether the batch requests should be merged to one undo group.| diff --git a/docs/includes/excel-preview.md b/docs/includes/excel-preview.md index 095ed195aa..91a9538bee 100644 --- a/docs/includes/excel-preview.md +++ b/docs/includes/excel-preview.md @@ -16,9 +16,6 @@ ||[getTask()](/javascript/api/excel/excel.commentreply#excel-excel-commentreply-gettask-member(1))|Gets the task associated with this comment reply's thread.| ||[getTaskOrNullObject()](/javascript/api/excel/excel.commentreply#excel-excel-commentreply-gettaskornullobject-member(1))|Gets the task associated with this comment reply's thread.| |[ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue)|[errorSubType](/javascript/api/excel/excel.connecterrorcellvalue#excel-excel-connecterrorcellvalue-errorsubtype-member)|Represents the type of `ConnectErrorCellValue`.| -|[CustomFunctionManager](/javascript/api/excel/excel.customfunctionmanager)||| -|[CustomFunctionVisibilityOptions](/javascript/api/excel/excel.customfunctionvisibilityoptions)|[hide](/javascript/api/excel/excel.customfunctionvisibilityoptions#excel-excel-customfunctionvisibilityoptions-hide-member)|A list of custom functions to hide from Excel AutoComplete.| -||[show](/javascript/api/excel/excel.customfunctionvisibilityoptions#excel-excel-customfunctionvisibilityoptions-show-member)|A list of custom functions to show in Excel AutoComplete.| |[DatetimeFormatInfo](/javascript/api/excel/excel.datetimeformatinfo)|[shortDateTimePattern](/javascript/api/excel/excel.datetimeformatinfo#excel-excel-datetimeformatinfo-shortdatetimepattern-member)|Gets the format string for a short date and time value.| |[DocumentTask](/javascript/api/excel/excel.documenttask)|[assign(assignee: Excel.EmailIdentity)](/javascript/api/excel/excel.documenttask#excel-excel-documenttask-assign-member(1))|Adds the given user to the list of assignees attached to the task.| ||[assignees](/javascript/api/excel/excel.documenttask#excel-excel-documenttask-assignees-member)|Returns a collection of assignees of the task.| diff --git a/docs/requirement-sets/excel/excel-api-1-20-requirement-set.md b/docs/requirement-sets/excel/excel-api-1-20-requirement-set.md new file mode 100644 index 0000000000..6e93ce7ffe --- /dev/null +++ b/docs/requirement-sets/excel/excel-api-1-20-requirement-set.md @@ -0,0 +1,22 @@ +--- +title: Excel JavaScript API requirement set 1.20 +description: Details about the ExcelApi 1.20 requirement set. +ms.date: 09/09/2025 +ms.topic: whats-new +ms.localizationpriority: medium +--- + +# What's new in Excel JavaScript API 1.20 + +The ExcelApi 1.20 adds [undo support for Excel JavaScript APIs](/office/dev/add-ins/excel/excel-add-ins-undo-capabilities) and controls for showing and hiding custom functions in Excel AutoComplete. + +## API list + +The following table lists the APIs in Excel JavaScript API requirement set 1.20. To view API reference documentation for all APIs supported by Excel JavaScript API requirement set 1.20 or earlier, see [Excel APIs in requirement set 1.20 or earlier](/javascript/api/excel?view=excel-js-1.20&preserve-view=true). + +[!INCLUDE[API table](../../includes/excel-1_20.md)] + +## See also + +- [Excel JavaScript API Reference Documentation](/javascript/api/excel?view=excel-js-1.20&preserve-view=true) +- [Excel JavaScript API requirement sets](excel-api-requirement-sets.md) diff --git a/docs/requirement-sets/requirement-sets.md b/docs/requirement-sets/requirement-sets.md index 1cbd13ae05..c3772cacf4 100644 --- a/docs/requirement-sets/requirement-sets.md +++ b/docs/requirement-sets/requirement-sets.md @@ -1,7 +1,7 @@ --- title: Office client application and platform availability for Office Add-ins description: Supported requirement sets for Excel, OneNote, Outlook, PowerPoint, Project, and Word. -ms.date: 08/28/2025 +ms.date: 09/09/2025 ms.topic: overview ms.localizationpriority: high --- @@ -20,15 +20,15 @@ To work as expected, your Office Add-in might depend on a specific Office applic |Platform|Extension points|Application-specific API requirement sets|[Common API requirement sets](common/office-add-in-requirement-sets.md)| |---|---|---|---| -|Office on the web|
  • TaskPane
  • Content
  • [CustomFunctions](excel/custom-functions-requirement-sets.md)
  • [Add-in Commands](common/add-in-commands-requirement-sets.md)
|
  • [ExcelApi 1.1](excel/excel-api-1-1-requirement-set.md)
  • [ExcelApi 1.2](excel/excel-api-1-2-requirement-set.md)
  • [ExcelApi 1.3](excel/excel-api-1-3-requirement-set.md)
  • [ExcelApi 1.4](excel/excel-api-1-4-requirement-set.md)
  • [ExcelApi 1.5](excel/excel-api-1-5-requirement-set.md)
  • [ExcelApi 1.6](excel/excel-api-1-6-requirement-set.md)
  • [ExcelApi 1.7](excel/excel-api-1-7-requirement-set.md)
  • [ExcelApi 1.8](excel/excel-api-1-8-requirement-set.md)
  • [ExcelApi 1.9](excel/excel-api-1-9-requirement-set.md)
  • [ExcelApi 1.10](excel/excel-api-1-10-requirement-set.md)
  • [ExcelApi 1.11](excel/excel-api-1-11-requirement-set.md)
  • [ExcelApi 1.12](excel/excel-api-1-12-requirement-set.md)
  • [ExcelApi 1.13](excel/excel-api-1-13-requirement-set.md)
  • [ExcelApi 1.14](excel/excel-api-1-14-requirement-set.md)
  • [ExcelApi 1.15](excel/excel-api-1-15-requirement-set.md)
  • [ExcelApi 1.16](excel/excel-api-1-16-requirement-set.md)
  • [ExcelApi 1.17](excel/excel-api-1-17-requirement-set.md)
  • [ExcelApi 1.18](excel/excel-api-1-18-requirement-set.md)
  • [ExcelApi 1.19](excel/excel-api-1-19-requirement-set.md)
  • [ExcelApiOnline](excel/excel-api-online-requirement-set.md)
|
  • [BindingEvents](common/office-add-in-requirement-sets.md#bindingevents)
  • [CompressedFile](common/office-add-in-requirement-sets.md#compressedfile)
  • [ContextMenuApi 1.1](common/context-menu-api-requirement-sets.md)
  • [DevicePermissionService 1.1](common/device-permission-service-requirement-sets.md)
  • [DialogApi 1.1](common/dialog-api-requirement-sets.md)
  • [DialogApi 1.2](common/dialog-api-requirement-sets.md)
  • [DialogOrigin 1.1](common/dialog-origin-requirement-sets.md)
  • [DocumentEvents](common/office-add-in-requirement-sets.md#documentevents)
  • [File](common/office-add-in-requirement-sets.md#file)
  • [IdentityAPI 1.3](common/identity-api-requirement-sets.md)
  • [KeyboardShortcuts 1.1](common/keyboard-shortcuts-requirement-sets.md)
  • [MatrixBindings](common/office-add-in-requirement-sets.md#matrixbindings)
  • [MatrixCoercion](common/office-add-in-requirement-sets.md#matrixcoercion)
  • [NestedAppAuth 1.1](common/nested-app-auth-requirement-sets.md) (preview)
  • [RibbonApi 1.1](common/ribbon-api-requirement-sets.md)
  • [RibbonApi 1.2](common/ribbon-api-requirement-sets.md)
  • [Selection](common/office-add-in-requirement-sets.md#selection)
  • [Settings](common/office-add-in-requirement-sets.md#settings)
  • [SharedRuntime 1.1](common/shared-runtime-requirement-sets.md)
  • [SharedRuntime 1.2](common/shared-runtime-requirement-sets.md)
  • [TableBindings](common/office-add-in-requirement-sets.md#tablebindings)
  • [TableCoercion](common/office-add-in-requirement-sets.md#tablecoercion)
  • [TextBindings](common/office-add-in-requirement-sets.md#textbindings)
  • [TextCoercion](common/office-add-in-requirement-sets.md#textcoercion)
| -|Office on Windows (Microsoft 365 subscription)|
  • TaskPane
  • Content
  • [CustomFunctions](excel/custom-functions-requirement-sets.md)
  • [Add-in Commands](common/add-in-commands-requirement-sets.md)
|
  • [ExcelApi 1.1](excel/excel-api-1-1-requirement-set.md)
  • [ExcelApi 1.2](excel/excel-api-1-2-requirement-set.md)
  • [ExcelApi 1.3](excel/excel-api-1-3-requirement-set.md)
  • [ExcelApi 1.4](excel/excel-api-1-4-requirement-set.md)
  • [ExcelApi 1.5](excel/excel-api-1-5-requirement-set.md)
  • [ExcelApi 1.6](excel/excel-api-1-6-requirement-set.md)
  • [ExcelApi 1.7](excel/excel-api-1-7-requirement-set.md)
  • [ExcelApi 1.8](excel/excel-api-1-8-requirement-set.md)
  • [ExcelApi 1.9](excel/excel-api-1-9-requirement-set.md)
  • [ExcelApi 1.10](excel/excel-api-1-10-requirement-set.md)
  • [ExcelApi 1.11](excel/excel-api-1-11-requirement-set.md)
  • [ExcelApi 1.12](excel/excel-api-1-12-requirement-set.md)
  • [ExcelApi 1.13](excel/excel-api-1-13-requirement-set.md)
  • [ExcelApi 1.14](excel/excel-api-1-14-requirement-set.md)
  • [ExcelApi 1.15](excel/excel-api-1-15-requirement-set.md)
  • [ExcelApi 1.16](excel/excel-api-1-16-requirement-set.md)
  • [ExcelApi 1.17](excel/excel-api-1-17-requirement-set.md)
  • [ExcelApi 1.18](excel/excel-api-1-18-requirement-set.md)
  • [ExcelApi 1.19](excel/excel-api-1-19-requirement-set.md)
|
  • [BindingEvents](common/office-add-in-requirement-sets.md#bindingevents)
  • [CompressedFile](common/office-add-in-requirement-sets.md#compressedfile)
  • [ContextMenuApi 1.1](common/context-menu-api-requirement-sets.md)
  • [DialogApi 1.1](common/dialog-api-requirement-sets.md)
  • [DialogApi 1.2](common/dialog-api-requirement-sets.md)
  • [DialogOrigin 1.1](common/dialog-origin-requirement-sets.md)
  • [DocumentEvents](common/office-add-in-requirement-sets.md#documentevents)
  • [File](common/office-add-in-requirement-sets.md#file)
  • [IdentityAPI 1.3](common/identity-api-requirement-sets.md)
  • [ImageCoercion 1.1](common/image-coercion-requirement-sets.md#imagecoercion-11)
  • [ImageCoercion 1.2](common/image-coercion-requirement-sets.md#imagecoercion-12)
  • [KeyboardShortcuts 1.1](common/keyboard-shortcuts-requirement-sets.md)
  • [MatrixBindings](common/office-add-in-requirement-sets.md#matrixbindings)
  • [MatrixCoercion](common/office-add-in-requirement-sets.md#matrixcoercion)
  • [NestedAppAuth 1.1](common/nested-app-auth-requirement-sets.md) (preview)
  • [OpenBrowserWindowApi 1.1](common/open-browser-window-api-requirement-sets.md)
  • [RibbonApi 1.1](common/ribbon-api-requirement-sets.md)
  • [RibbonApi 1.2](common/ribbon-api-requirement-sets.md)
  • [Selection](common/office-add-in-requirement-sets.md#selection)
  • [Settings](common/office-add-in-requirement-sets.md#settings)
  • [SharedRuntime 1.1](common/shared-runtime-requirement-sets.md)
  • [SharedRuntime 1.2](common/shared-runtime-requirement-sets.md)
  • [TableBindings](common/office-add-in-requirement-sets.md#tablebindings)
  • [TableCoercion](common/office-add-in-requirement-sets.md#tablecoercion)
  • [TextBindings](common/office-add-in-requirement-sets.md#textbindings)
  • [TextCoercion](common/office-add-in-requirement-sets.md#textcoercion)
| -|Office on Windows
(retail perpetual Office 2016 and later)|
  • TaskPane
  • Content
  • [CustomFunctions](excel/custom-functions-requirement-sets.md)
  • [Add-in Commands](common/add-in-commands-requirement-sets.md)
|
  • [ExcelApi 1.1](excel/excel-api-1-1-requirement-set.md)
  • [ExcelApi 1.2](excel/excel-api-1-2-requirement-set.md)
  • [ExcelApi 1.3](excel/excel-api-1-3-requirement-set.md)
  • [ExcelApi 1.4](excel/excel-api-1-4-requirement-set.md)
  • [ExcelApi 1.5](excel/excel-api-1-5-requirement-set.md)
  • [ExcelApi 1.6](excel/excel-api-1-6-requirement-set.md)
  • [ExcelApi 1.7](excel/excel-api-1-7-requirement-set.md)
  • [ExcelApi 1.8](excel/excel-api-1-8-requirement-set.md)
  • [ExcelApi 1.9](excel/excel-api-1-9-requirement-set.md)
  • [ExcelApi 1.10](excel/excel-api-1-10-requirement-set.md)
  • [ExcelApi 1.11](excel/excel-api-1-11-requirement-set.md)
  • [ExcelApi 1.12](excel/excel-api-1-12-requirement-set.md)
  • [ExcelApi 1.13](excel/excel-api-1-13-requirement-set.md)
  • [ExcelApi 1.14](excel/excel-api-1-14-requirement-set.md)
  • [ExcelApi 1.15](excel/excel-api-1-15-requirement-set.md)
  • [ExcelApi 1.16](excel/excel-api-1-16-requirement-set.md)
  • [ExcelApi 1.17](excel/excel-api-1-17-requirement-set.md)
  • [ExcelApi 1.18](excel/excel-api-1-18-requirement-set.md)
  • [ExcelApi 1.19](excel/excel-api-1-19-requirement-set.md)
|
  • [BindingEvents](common/office-add-in-requirement-sets.md#bindingevents)
  • [CompressedFile](common/office-add-in-requirement-sets.md#compressedfile)
  • [ContextMenuApi 1.1](common/context-menu-api-requirement-sets.md)
  • [DialogApi 1.1](common/dialog-api-requirement-sets.md)
  • [DialogApi 1.2](common/dialog-api-requirement-sets.md)
  • [DialogOrigin 1.1](common/dialog-origin-requirement-sets.md)
  • [DocumentEvents](common/office-add-in-requirement-sets.md#documentevents)
  • [File](common/office-add-in-requirement-sets.md#file)
  • [IdentityAPI 1.3](common/identity-api-requirement-sets.md)
  • [ImageCoercion 1.1](common/image-coercion-requirement-sets.md#imagecoercion-11)
  • [ImageCoercion 1.2](common/image-coercion-requirement-sets.md#imagecoercion-12)
  • [KeyboardShortcuts 1.1](common/keyboard-shortcuts-requirement-sets.md)
  • [MatrixBindings](common/office-add-in-requirement-sets.md#matrixbindings)
  • [MatrixCoercion](common/office-add-in-requirement-sets.md#matrixcoercion)
  • [OpenBrowserWindowApi 1.1](common/open-browser-window-api-requirement-sets.md)
  • [RibbonApi 1.1](common/ribbon-api-requirement-sets.md)
  • [RibbonApi 1.2](common/ribbon-api-requirement-sets.md)
  • [Selection](common/office-add-in-requirement-sets.md#selection)
  • [Settings](common/office-add-in-requirement-sets.md#settings)
  • [SharedRuntime 1.1](common/shared-runtime-requirement-sets.md)
  • [SharedRuntime 1.2](common/shared-runtime-requirement-sets.md)
  • [TableBindings](common/office-add-in-requirement-sets.md#tablebindings)
  • [TableCoercion](common/office-add-in-requirement-sets.md#tablecoercion)
  • [TextBindings](common/office-add-in-requirement-sets.md#textbindings)
  • [TextCoercion](common/office-add-in-requirement-sets.md#textcoercion)
| +|Office on the web|
  • TaskPane
  • Content
  • [CustomFunctions](excel/custom-functions-requirement-sets.md)
  • [Add-in Commands](common/add-in-commands-requirement-sets.md)
|
  • [ExcelApi 1.1](excel/excel-api-1-1-requirement-set.md)
  • [ExcelApi 1.2](excel/excel-api-1-2-requirement-set.md)
  • [ExcelApi 1.3](excel/excel-api-1-3-requirement-set.md)
  • [ExcelApi 1.4](excel/excel-api-1-4-requirement-set.md)
  • [ExcelApi 1.5](excel/excel-api-1-5-requirement-set.md)
  • [ExcelApi 1.6](excel/excel-api-1-6-requirement-set.md)
  • [ExcelApi 1.7](excel/excel-api-1-7-requirement-set.md)
  • [ExcelApi 1.8](excel/excel-api-1-8-requirement-set.md)
  • [ExcelApi 1.9](excel/excel-api-1-9-requirement-set.md)
  • [ExcelApi 1.10](excel/excel-api-1-10-requirement-set.md)
  • [ExcelApi 1.11](excel/excel-api-1-11-requirement-set.md)
  • [ExcelApi 1.12](excel/excel-api-1-12-requirement-set.md)
  • [ExcelApi 1.13](excel/excel-api-1-13-requirement-set.md)
  • [ExcelApi 1.14](excel/excel-api-1-14-requirement-set.md)
  • [ExcelApi 1.15](excel/excel-api-1-15-requirement-set.md)
  • [ExcelApi 1.16](excel/excel-api-1-16-requirement-set.md)
  • [ExcelApi 1.17](excel/excel-api-1-17-requirement-set.md)
  • [ExcelApi 1.18](excel/excel-api-1-18-requirement-set.md)
  • [ExcelApi 1.19](excel/excel-api-1-19-requirement-set.md)
  • [ExcelApi 1.20](excel/excel-api-1-20-requirement-set.md)
  • [ExcelApiOnline](excel/excel-api-online-requirement-set.md)
|
  • [BindingEvents](common/office-add-in-requirement-sets.md#bindingevents)
  • [CompressedFile](common/office-add-in-requirement-sets.md#compressedfile)
  • [ContextMenuApi 1.1](common/context-menu-api-requirement-sets.md)
  • [DevicePermissionService 1.1](common/device-permission-service-requirement-sets.md)
  • [DialogApi 1.1](common/dialog-api-requirement-sets.md)
  • [DialogApi 1.2](common/dialog-api-requirement-sets.md)
  • [DialogOrigin 1.1](common/dialog-origin-requirement-sets.md)
  • [DocumentEvents](common/office-add-in-requirement-sets.md#documentevents)
  • [File](common/office-add-in-requirement-sets.md#file)
  • [IdentityAPI 1.3](common/identity-api-requirement-sets.md)
  • [KeyboardShortcuts 1.1](common/keyboard-shortcuts-requirement-sets.md)
  • [MatrixBindings](common/office-add-in-requirement-sets.md#matrixbindings)
  • [MatrixCoercion](common/office-add-in-requirement-sets.md#matrixcoercion)
  • [NestedAppAuth 1.1](common/nested-app-auth-requirement-sets.md) (preview)
  • [RibbonApi 1.1](common/ribbon-api-requirement-sets.md)
  • [RibbonApi 1.2](common/ribbon-api-requirement-sets.md)
  • [Selection](common/office-add-in-requirement-sets.md#selection)
  • [Settings](common/office-add-in-requirement-sets.md#settings)
  • [SharedRuntime 1.1](common/shared-runtime-requirement-sets.md)
  • [SharedRuntime 1.2](common/shared-runtime-requirement-sets.md)
  • [TableBindings](common/office-add-in-requirement-sets.md#tablebindings)
  • [TableCoercion](common/office-add-in-requirement-sets.md#tablecoercion)
  • [TextBindings](common/office-add-in-requirement-sets.md#textbindings)
  • [TextCoercion](common/office-add-in-requirement-sets.md#textcoercion)
| +|Office on Windows (Microsoft 365 subscription)|
  • TaskPane
  • Content
  • [CustomFunctions](excel/custom-functions-requirement-sets.md)
  • [Add-in Commands](common/add-in-commands-requirement-sets.md)
|
  • [ExcelApi 1.1](excel/excel-api-1-1-requirement-set.md)
  • [ExcelApi 1.2](excel/excel-api-1-2-requirement-set.md)
  • [ExcelApi 1.3](excel/excel-api-1-3-requirement-set.md)
  • [ExcelApi 1.4](excel/excel-api-1-4-requirement-set.md)
  • [ExcelApi 1.5](excel/excel-api-1-5-requirement-set.md)
  • [ExcelApi 1.6](excel/excel-api-1-6-requirement-set.md)
  • [ExcelApi 1.7](excel/excel-api-1-7-requirement-set.md)
  • [ExcelApi 1.8](excel/excel-api-1-8-requirement-set.md)
  • [ExcelApi 1.9](excel/excel-api-1-9-requirement-set.md)
  • [ExcelApi 1.10](excel/excel-api-1-10-requirement-set.md)
  • [ExcelApi 1.11](excel/excel-api-1-11-requirement-set.md)
  • [ExcelApi 1.12](excel/excel-api-1-12-requirement-set.md)
  • [ExcelApi 1.13](excel/excel-api-1-13-requirement-set.md)
  • [ExcelApi 1.14](excel/excel-api-1-14-requirement-set.md)
  • [ExcelApi 1.15](excel/excel-api-1-15-requirement-set.md)
  • [ExcelApi 1.16](excel/excel-api-1-16-requirement-set.md)
  • [ExcelApi 1.17](excel/excel-api-1-17-requirement-set.md)
  • [ExcelApi 1.18](excel/excel-api-1-18-requirement-set.md)
  • [ExcelApi 1.19](excel/excel-api-1-19-requirement-set.md)
  • [ExcelApi 1.20](excel/excel-api-1-20-requirement-set.md)
|
  • [BindingEvents](common/office-add-in-requirement-sets.md#bindingevents)
  • [CompressedFile](common/office-add-in-requirement-sets.md#compressedfile)
  • [ContextMenuApi 1.1](common/context-menu-api-requirement-sets.md)
  • [DialogApi 1.1](common/dialog-api-requirement-sets.md)
  • [DialogApi 1.2](common/dialog-api-requirement-sets.md)
  • [DialogOrigin 1.1](common/dialog-origin-requirement-sets.md)
  • [DocumentEvents](common/office-add-in-requirement-sets.md#documentevents)
  • [File](common/office-add-in-requirement-sets.md#file)
  • [IdentityAPI 1.3](common/identity-api-requirement-sets.md)
  • [ImageCoercion 1.1](common/image-coercion-requirement-sets.md#imagecoercion-11)
  • [ImageCoercion 1.2](common/image-coercion-requirement-sets.md#imagecoercion-12)
  • [KeyboardShortcuts 1.1](common/keyboard-shortcuts-requirement-sets.md)
  • [MatrixBindings](common/office-add-in-requirement-sets.md#matrixbindings)
  • [MatrixCoercion](common/office-add-in-requirement-sets.md#matrixcoercion)
  • [NestedAppAuth 1.1](common/nested-app-auth-requirement-sets.md) (preview)
  • [OpenBrowserWindowApi 1.1](common/open-browser-window-api-requirement-sets.md)
  • [RibbonApi 1.1](common/ribbon-api-requirement-sets.md)
  • [RibbonApi 1.2](common/ribbon-api-requirement-sets.md)
  • [Selection](common/office-add-in-requirement-sets.md#selection)
  • [Settings](common/office-add-in-requirement-sets.md#settings)
  • [SharedRuntime 1.1](common/shared-runtime-requirement-sets.md)
  • [SharedRuntime 1.2](common/shared-runtime-requirement-sets.md)
  • [TableBindings](common/office-add-in-requirement-sets.md#tablebindings)
  • [TableCoercion](common/office-add-in-requirement-sets.md#tablecoercion)
  • [TextBindings](common/office-add-in-requirement-sets.md#textbindings)
  • [TextCoercion](common/office-add-in-requirement-sets.md#textcoercion)
| +|Office on Windows
(retail perpetual Office 2016 and later)|
  • TaskPane
  • Content
  • [CustomFunctions](excel/custom-functions-requirement-sets.md)
  • [Add-in Commands](common/add-in-commands-requirement-sets.md)
|
  • [ExcelApi 1.1](excel/excel-api-1-1-requirement-set.md)
  • [ExcelApi 1.2](excel/excel-api-1-2-requirement-set.md)
  • [ExcelApi 1.3](excel/excel-api-1-3-requirement-set.md)
  • [ExcelApi 1.4](excel/excel-api-1-4-requirement-set.md)
  • [ExcelApi 1.5](excel/excel-api-1-5-requirement-set.md)
  • [ExcelApi 1.6](excel/excel-api-1-6-requirement-set.md)
  • [ExcelApi 1.7](excel/excel-api-1-7-requirement-set.md)
  • [ExcelApi 1.8](excel/excel-api-1-8-requirement-set.md)
  • [ExcelApi 1.9](excel/excel-api-1-9-requirement-set.md)
  • [ExcelApi 1.10](excel/excel-api-1-10-requirement-set.md)
  • [ExcelApi 1.11](excel/excel-api-1-11-requirement-set.md)
  • [ExcelApi 1.12](excel/excel-api-1-12-requirement-set.md)
  • [ExcelApi 1.13](excel/excel-api-1-13-requirement-set.md)
  • [ExcelApi 1.14](excel/excel-api-1-14-requirement-set.md)
  • [ExcelApi 1.15](excel/excel-api-1-15-requirement-set.md)
  • [ExcelApi 1.16](excel/excel-api-1-16-requirement-set.md)
  • [ExcelApi 1.17](excel/excel-api-1-17-requirement-set.md)
  • [ExcelApi 1.18](excel/excel-api-1-18-requirement-set.md)
  • [ExcelApi 1.19](excel/excel-api-1-19-requirement-set.md)
  • [ExcelApi 1.20](excel/excel-api-1-20-requirement-set.md)
|
  • [BindingEvents](common/office-add-in-requirement-sets.md#bindingevents)
  • [CompressedFile](common/office-add-in-requirement-sets.md#compressedfile)
  • [ContextMenuApi 1.1](common/context-menu-api-requirement-sets.md)
  • [DialogApi 1.1](common/dialog-api-requirement-sets.md)
  • [DialogApi 1.2](common/dialog-api-requirement-sets.md)
  • [DialogOrigin 1.1](common/dialog-origin-requirement-sets.md)
  • [DocumentEvents](common/office-add-in-requirement-sets.md#documentevents)
  • [File](common/office-add-in-requirement-sets.md#file)
  • [IdentityAPI 1.3](common/identity-api-requirement-sets.md)
  • [ImageCoercion 1.1](common/image-coercion-requirement-sets.md#imagecoercion-11)
  • [ImageCoercion 1.2](common/image-coercion-requirement-sets.md#imagecoercion-12)
  • [KeyboardShortcuts 1.1](common/keyboard-shortcuts-requirement-sets.md)
  • [MatrixBindings](common/office-add-in-requirement-sets.md#matrixbindings)
  • [MatrixCoercion](common/office-add-in-requirement-sets.md#matrixcoercion)
  • [OpenBrowserWindowApi 1.1](common/open-browser-window-api-requirement-sets.md)
  • [RibbonApi 1.1](common/ribbon-api-requirement-sets.md)
  • [RibbonApi 1.2](common/ribbon-api-requirement-sets.md)
  • [Selection](common/office-add-in-requirement-sets.md#selection)
  • [Settings](common/office-add-in-requirement-sets.md#settings)
  • [SharedRuntime 1.1](common/shared-runtime-requirement-sets.md)
  • [SharedRuntime 1.2](common/shared-runtime-requirement-sets.md)
  • [TableBindings](common/office-add-in-requirement-sets.md#tablebindings)
  • [TableCoercion](common/office-add-in-requirement-sets.md#tablecoercion)
  • [TextBindings](common/office-add-in-requirement-sets.md#textbindings)
  • [TextCoercion](common/office-add-in-requirement-sets.md#textcoercion)
| |Office 2024 on Windows
(volume-licensed perpetual)|
  • TaskPane
  • Content
  • [CustomFunctions](excel/custom-functions-requirement-sets.md)
  • [Add-in Commands](common/add-in-commands-requirement-sets.md)
|
  • [ExcelApi 1.1](excel/excel-api-1-1-requirement-set.md)
  • [ExcelApi 1.2](excel/excel-api-1-2-requirement-set.md)
  • [ExcelApi 1.3](excel/excel-api-1-3-requirement-set.md)
  • [ExcelApi 1.4](excel/excel-api-1-4-requirement-set.md)
  • [ExcelApi 1.5](excel/excel-api-1-5-requirement-set.md)
  • [ExcelApi 1.6](excel/excel-api-1-6-requirement-set.md)
  • [ExcelApi 1.7](excel/excel-api-1-7-requirement-set.md)
  • [ExcelApi 1.8](excel/excel-api-1-8-requirement-set.md)
  • [ExcelApi 1.9](excel/excel-api-1-9-requirement-set.md)
  • [ExcelApi 1.10](excel/excel-api-1-10-requirement-set.md)
  • [ExcelApi 1.11](excel/excel-api-1-11-requirement-set.md)
  • [ExcelApi 1.12](excel/excel-api-1-12-requirement-set.md)
  • [ExcelApi 1.13](excel/excel-api-1-13-requirement-set.md)
  • [ExcelApi 1.14](excel/excel-api-1-14-requirement-set.md)
  • [ExcelApi 1.15](excel/excel-api-1-15-requirement-set.md)
  • [ExcelApi 1.16](excel/excel-api-1-16-requirement-set.md)
  • [ExcelApi 1.17](excel/excel-api-1-17-requirement-set.md)
|
  • [BindingEvents](common/office-add-in-requirement-sets.md#bindingevents)
  • [CompressedFile](common/office-add-in-requirement-sets.md#compressedfile)
  • [DialogApi 1.1](common/dialog-api-requirement-sets.md)
  • [DialogApi 1.2](common/dialog-api-requirement-sets.md)
  • [DialogOrigin 1.1](common/dialog-origin-requirement-sets.md)
  • [DocumentEvents](common/office-add-in-requirement-sets.md#documentevents)
  • [File](common/office-add-in-requirement-sets.md#file)
  • [IdentityAPI 1.3](common/identity-api-requirement-sets.md)
  • [ImageCoercion 1.1](common/image-coercion-requirement-sets.md#imagecoercion-11)
  • [ImageCoercion 1.2](common/image-coercion-requirement-sets.md#imagecoercion-12)
  • [MatrixBindings](common/office-add-in-requirement-sets.md#matrixbindings)
  • [MatrixCoercion](common/office-add-in-requirement-sets.md#matrixcoercion)
  • [OpenBrowserWindowApi 1.1](common/open-browser-window-api-requirement-sets.md)
  • [RibbonApi 1.1](common/ribbon-api-requirement-sets.md)
  • [RibbonApi 1.2](common/ribbon-api-requirement-sets.md)
  • [Selection](common/office-add-in-requirement-sets.md#selection)
  • [Settings](common/office-add-in-requirement-sets.md#settings)
  • [SharedRuntime 1.1](common/shared-runtime-requirement-sets.md)
  • [TableBindings](common/office-add-in-requirement-sets.md#tablebindings)
  • [TableCoercion](common/office-add-in-requirement-sets.md#tablecoercion)
  • [TextBindings](common/office-add-in-requirement-sets.md#textbindings)
  • [TextCoercion](common/office-add-in-requirement-sets.md#textcoercion)
| |Office 2021 on Windows
(volume-licensed perpetual)|
  • TaskPane
  • Content
  • [CustomFunctions](excel/custom-functions-requirement-sets.md)
  • [Add-in Commands](common/add-in-commands-requirement-sets.md)
|
  • [ExcelApi 1.1](excel/excel-api-1-1-requirement-set.md)
  • [ExcelApi 1.2](excel/excel-api-1-2-requirement-set.md)
  • [ExcelApi 1.3](excel/excel-api-1-3-requirement-set.md)
  • [ExcelApi 1.4](excel/excel-api-1-4-requirement-set.md)
  • [ExcelApi 1.5](excel/excel-api-1-5-requirement-set.md)
  • [ExcelApi 1.6](excel/excel-api-1-6-requirement-set.md)
  • [ExcelApi 1.7](excel/excel-api-1-7-requirement-set.md)
  • [ExcelApi 1.8](excel/excel-api-1-8-requirement-set.md)
  • [ExcelApi 1.9](excel/excel-api-1-9-requirement-set.md)
  • [ExcelApi 1.10](excel/excel-api-1-10-requirement-set.md)
  • [ExcelApi 1.11](excel/excel-api-1-11-requirement-set.md)
  • [ExcelApi 1.12](excel/excel-api-1-12-requirement-set.md)
  • [ExcelApi 1.13](excel/excel-api-1-13-requirement-set.md)
  • [ExcelApi 1.14](excel/excel-api-1-14-requirement-set.md)
|
  • [BindingEvents](common/office-add-in-requirement-sets.md#bindingevents)
  • [CompressedFile](common/office-add-in-requirement-sets.md#compressedfile)
  • [DialogApi 1.1](common/dialog-api-requirement-sets.md)
  • [DialogApi 1.2](common/dialog-api-requirement-sets.md)
  • [DialogOrigin 1.1](common/dialog-origin-requirement-sets.md)
  • [DocumentEvents](common/office-add-in-requirement-sets.md#documentevents)
  • [File](common/office-add-in-requirement-sets.md#file)
  • [IdentityAPI 1.3](common/identity-api-requirement-sets.md)
  • [ImageCoercion 1.1](common/image-coercion-requirement-sets.md#imagecoercion-11)
  • [ImageCoercion 1.2](common/image-coercion-requirement-sets.md#imagecoercion-12)
  • [MatrixBindings](common/office-add-in-requirement-sets.md#matrixbindings)
  • [MatrixCoercion](common/office-add-in-requirement-sets.md#matrixcoercion)
  • [OpenBrowserWindowApi 1.1](common/open-browser-window-api-requirement-sets.md)
  • [RibbonApi 1.1](common/ribbon-api-requirement-sets.md)
  • [RibbonApi 1.2](common/ribbon-api-requirement-sets.md)
  • [Selection](common/office-add-in-requirement-sets.md#selection)
  • [Settings](common/office-add-in-requirement-sets.md#settings)
  • [SharedRuntime 1.1](common/shared-runtime-requirement-sets.md)
  • [TableBindings](common/office-add-in-requirement-sets.md#tablebindings)
  • [TableCoercion](common/office-add-in-requirement-sets.md#tablecoercion)
  • [TextBindings](common/office-add-in-requirement-sets.md#textbindings)
  • [TextCoercion](common/office-add-in-requirement-sets.md#textcoercion)
| |Office 2019 on Windows
(volume-licensed perpetual)|
  • TaskPane
  • Content
  • [Add-in Commands](common/add-in-commands-requirement-sets.md)
|
  • [ExcelApi 1.1](excel/excel-api-1-1-requirement-set.md)
  • [ExcelApi 1.2](excel/excel-api-1-2-requirement-set.md)
  • [ExcelApi 1.3](excel/excel-api-1-3-requirement-set.md)
  • [ExcelApi 1.4](excel/excel-api-1-4-requirement-set.md)
  • [ExcelApi 1.5](excel/excel-api-1-5-requirement-set.md)
  • [ExcelApi 1.6](excel/excel-api-1-6-requirement-set.md)
  • [ExcelApi 1.7](excel/excel-api-1-7-requirement-set.md)
  • [ExcelApi 1.8](excel/excel-api-1-8-requirement-set.md)
|
  • [BindingEvents](common/office-add-in-requirement-sets.md#bindingevents)
  • [CompressedFile](common/office-add-in-requirement-sets.md#compressedfile)
  • [DialogApi 1.1](common/dialog-api-requirement-sets.md)
  • [DialogOrigin 1.1](common/dialog-origin-requirement-sets.md)
  • [DocumentEvents](common/office-add-in-requirement-sets.md#documentevents)
  • [File](common/office-add-in-requirement-sets.md#file)
  • [ImageCoercion 1.1](common/image-coercion-requirement-sets.md#imagecoercion-11)
  • [MatrixBindings](common/office-add-in-requirement-sets.md#matrixbindings)
  • [MatrixCoercion](common/office-add-in-requirement-sets.md#matrixcoercion)
  • [Selection](common/office-add-in-requirement-sets.md#selection)
  • [Settings](common/office-add-in-requirement-sets.md#settings)
  • [TableBindings](common/office-add-in-requirement-sets.md#tablebindings)
  • [TableCoercion](common/office-add-in-requirement-sets.md#tablecoercion)
  • [TextBindings](common/office-add-in-requirement-sets.md#textbindings)
  • [TextCoercion](common/office-add-in-requirement-sets.md#textcoercion)
| |Office 2016 on Windows
(volume-licensed perpetual)|
  • TaskPane
  • Content
|
  • [ExcelApi 1.1](excel/excel-api-1-1-requirement-set.md)
|
  • [BindingEvents](common/office-add-in-requirement-sets.md#bindingevents)
  • [CompressedFile](common/office-add-in-requirement-sets.md#compressedfile)
  • [DialogApi 1.1](common/dialog-api-requirement-sets.md)\*
  • [DialogOrigin 1.1](common/dialog-origin-requirement-sets.md)
  • [DocumentEvents](common/office-add-in-requirement-sets.md#documentevents)
  • [File](common/office-add-in-requirement-sets.md#file)
  • [ImageCoercion 1.1](common/image-coercion-requirement-sets.md#imagecoercion-11)
  • [MatrixBindings](common/office-add-in-requirement-sets.md#matrixbindings)
  • [MatrixCoercion](common/office-add-in-requirement-sets.md#matrixcoercion)
  • [Selection](common/office-add-in-requirement-sets.md#selection)
  • [Settings](common/office-add-in-requirement-sets.md#settings)
  • [TableBindings](common/office-add-in-requirement-sets.md#tablebindings)
  • [TableCoercion](common/office-add-in-requirement-sets.md#tablecoercion)
  • [TextBindings](common/office-add-in-requirement-sets.md#textbindings)
  • [TextCoercion](common/office-add-in-requirement-sets.md#textcoercion)
| -|Office on Mac|
  • TaskPane
  • Content
  • [CustomFunctions](excel/custom-functions-requirement-sets.md)
  • [Add-in Commands](common/add-in-commands-requirement-sets.md)
|
  • [ExcelApi 1.1](excel/excel-api-1-1-requirement-set.md)
  • [ExcelApi 1.2](excel/excel-api-1-2-requirement-set.md)
  • [ExcelApi 1.3](excel/excel-api-1-3-requirement-set.md)
  • [ExcelApi 1.4](excel/excel-api-1-4-requirement-set.md)
  • [ExcelApi 1.5](excel/excel-api-1-5-requirement-set.md)
  • [ExcelApi 1.6](excel/excel-api-1-6-requirement-set.md)
  • [ExcelApi 1.7](excel/excel-api-1-7-requirement-set.md)
  • [ExcelApi 1.8](excel/excel-api-1-8-requirement-set.md)
  • [ExcelApi 1.9](excel/excel-api-1-9-requirement-set.md)
  • [ExcelApi 1.10](excel/excel-api-1-10-requirement-set.md)
  • [ExcelApi 1.11](excel/excel-api-1-11-requirement-set.md)
  • [ExcelApi 1.12](excel/excel-api-1-12-requirement-set.md)
  • [ExcelApi 1.13](excel/excel-api-1-13-requirement-set.md)
  • [ExcelApi 1.14](excel/excel-api-1-14-requirement-set.md)
  • [ExcelApi 1.15](excel/excel-api-1-15-requirement-set.md)
  • [ExcelApi 1.16](excel/excel-api-1-16-requirement-set.md)
  • [ExcelApi 1.17](excel/excel-api-1-17-requirement-set.md)
  • [ExcelApi 1.18](excel/excel-api-1-18-requirement-set.md)
    • li>[ExcelApi 1.19](excel/excel-api-1-19-requirement-set.md)
|
  • [BindingEvents](common/office-add-in-requirement-sets.md#bindingevents)
  • [CompressedFile](common/office-add-in-requirement-sets.md#compressedfile)
  • [ContextMenuApi 1.1](common/context-menu-api-requirement-sets.md)
  • [DialogApi 1.1](common/dialog-api-requirement-sets.md)
  • [DialogApi 1.2](common/dialog-api-requirement-sets.md)
  • [DialogOrigin 1.1](common/dialog-origin-requirement-sets.md)
  • [DocumentEvents](common/office-add-in-requirement-sets.md#documentevents)
  • [File](common/office-add-in-requirement-sets.md#file)
  • [IdentityAPI 1.3](common/identity-api-requirement-sets.md)
  • [ImageCoercion 1.1](common/image-coercion-requirement-sets.md#imagecoercion-11)
  • [ImageCoercion 1.2](common/image-coercion-requirement-sets.md#imagecoercion-12)
  • [KeyboardShortcuts 1.1](common/keyboard-shortcuts-requirement-sets.md)
  • [MatrixBindings](common/office-add-in-requirement-sets.md#matrixbindings)
  • [MatrixCoercion](common/office-add-in-requirement-sets.md#matrixcoercion)
  • [NestedAppAuth 1.1](common/nested-app-auth-requirement-sets.md) (preview)
  • [OpenBrowserWindowApi 1.1](common/open-browser-window-api-requirement-sets.md)
  • [PdfFile](common/office-add-in-requirement-sets.md#pdffile)
  • [RibbonApi 1.1](common/ribbon-api-requirement-sets.md)
  • [RibbonApi 1.2](common/ribbon-api-requirement-sets.md)
  • [Selection](common/office-add-in-requirement-sets.md#selection)
  • [Settings](common/office-add-in-requirement-sets.md#settings)
  • [SharedRuntime 1.1](common/shared-runtime-requirement-sets.md)
  • [SharedRuntime 1.2](common/shared-runtime-requirement-sets.md)
  • [TableBindings](common/office-add-in-requirement-sets.md#tablebindings)
  • [TableCoercion](common/office-add-in-requirement-sets.md#tablecoercion)
  • [TextBindings](common/office-add-in-requirement-sets.md#textbindings)
  • [TextCoercion](common/office-add-in-requirement-sets.md#textcoercion)
| -|Office on iPad
(Microsoft 365 subscription)|
  • TaskPane
  • Content
|
  • [ExcelApi 1.1](excel/excel-api-1-1-requirement-set.md)
  • [ExcelApi 1.2](excel/excel-api-1-2-requirement-set.md)
  • [ExcelApi 1.3](excel/excel-api-1-3-requirement-set.md)
  • [ExcelApi 1.4](excel/excel-api-1-4-requirement-set.md)
  • [ExcelApi 1.5](excel/excel-api-1-5-requirement-set.md)
  • [ExcelApi 1.6](excel/excel-api-1-6-requirement-set.md)
  • [ExcelApi 1.7](excel/excel-api-1-7-requirement-set.md)
  • [ExcelApi 1.8](excel/excel-api-1-8-requirement-set.md)
  • [ExcelApi 1.9](excel/excel-api-1-9-requirement-set.md)
  • [ExcelApi 1.10](excel/excel-api-1-10-requirement-set.md)
  • [ExcelApi 1.11](excel/excel-api-1-11-requirement-set.md)
  • [ExcelApi 1.12](excel/excel-api-1-12-requirement-set.md)
  • [ExcelApi 1.13](excel/excel-api-1-13-requirement-set.md)
  • [ExcelApi 1.14](excel/excel-api-1-14-requirement-set.md)
  • [ExcelApi 1.15](excel/excel-api-1-15-requirement-set.md)
  • [ExcelApi 1.16](excel/excel-api-1-16-requirement-set.md)
  • [ExcelApi 1.17](excel/excel-api-1-17-requirement-set.md)
  • [ExcelApi 1.18](excel/excel-api-1-18-requirement-set.md)
  • [ExcelApi 1.19](excel/excel-api-1-19-requirement-set.md)
|
  • [BindingEvents](common/office-add-in-requirement-sets.md#bindingevents)
  • [DialogApi 1.1](common/dialog-api-requirement-sets.md)
  • [DialogApi 1.2](common/dialog-api-requirement-sets.md)
  • [DialogOrigin 1.1](common/dialog-origin-requirement-sets.md)
  • [DocumentEvents](common/office-add-in-requirement-sets.md#documentevents)
  • [File](common/office-add-in-requirement-sets.md#file)
  • [ImageCoercion 1.1](common/image-coercion-requirement-sets.md#imagecoercion-11)
  • [MatrixBindings](common/office-add-in-requirement-sets.md#matrixbindings)
  • [MatrixCoercion](common/office-add-in-requirement-sets.md#matrixcoercion)
  • [NestedAppAuth 1.1](common/nested-app-auth-requirement-sets.md) (preview)
  • [OpenBrowserWindowApi 1.1](common/open-browser-window-api-requirement-sets.md)
  • [Selection](common/office-add-in-requirement-sets.md#selection)
  • [Settings](common/office-add-in-requirement-sets.md#settings)
  • [TableBindings](common/office-add-in-requirement-sets.md#tablebindings)
  • [TableCoercion](common/office-add-in-requirement-sets.md#tablecoercion)
  • [TextBindings](common/office-add-in-requirement-sets.md#textbindings)
  • [TextCoercion](common/office-add-in-requirement-sets.md#textcoercion)
| +|Office on Mac|
  • TaskPane
  • Content
  • [CustomFunctions](excel/custom-functions-requirement-sets.md)
  • [Add-in Commands](common/add-in-commands-requirement-sets.md)
|
  • [ExcelApi 1.1](excel/excel-api-1-1-requirement-set.md)
  • [ExcelApi 1.2](excel/excel-api-1-2-requirement-set.md)
  • [ExcelApi 1.3](excel/excel-api-1-3-requirement-set.md)
  • [ExcelApi 1.4](excel/excel-api-1-4-requirement-set.md)
  • [ExcelApi 1.5](excel/excel-api-1-5-requirement-set.md)
  • [ExcelApi 1.6](excel/excel-api-1-6-requirement-set.md)
  • [ExcelApi 1.7](excel/excel-api-1-7-requirement-set.md)
  • [ExcelApi 1.8](excel/excel-api-1-8-requirement-set.md)
  • [ExcelApi 1.9](excel/excel-api-1-9-requirement-set.md)
  • [ExcelApi 1.10](excel/excel-api-1-10-requirement-set.md)
  • [ExcelApi 1.11](excel/excel-api-1-11-requirement-set.md)
  • [ExcelApi 1.12](excel/excel-api-1-12-requirement-set.md)
  • [ExcelApi 1.13](excel/excel-api-1-13-requirement-set.md)
  • [ExcelApi 1.14](excel/excel-api-1-14-requirement-set.md)
  • [ExcelApi 1.15](excel/excel-api-1-15-requirement-set.md)
  • [ExcelApi 1.16](excel/excel-api-1-16-requirement-set.md)
  • [ExcelApi 1.17](excel/excel-api-1-17-requirement-set.md)
  • [ExcelApi 1.18](excel/excel-api-1-18-requirement-set.md)
  • [ExcelApi 1.19](excel/excel-api-1-19-requirement-set.md)
  • [ExcelApi 1.20](excel/excel-api-1-20-requirement-set.md)
|
  • [BindingEvents](common/office-add-in-requirement-sets.md#bindingevents)
  • [CompressedFile](common/office-add-in-requirement-sets.md#compressedfile)
  • [ContextMenuApi 1.1](common/context-menu-api-requirement-sets.md)
  • [DialogApi 1.1](common/dialog-api-requirement-sets.md)
  • [DialogApi 1.2](common/dialog-api-requirement-sets.md)
  • [DialogOrigin 1.1](common/dialog-origin-requirement-sets.md)
  • [DocumentEvents](common/office-add-in-requirement-sets.md#documentevents)
  • [File](common/office-add-in-requirement-sets.md#file)
  • [IdentityAPI 1.3](common/identity-api-requirement-sets.md)
  • [ImageCoercion 1.1](common/image-coercion-requirement-sets.md#imagecoercion-11)
  • [ImageCoercion 1.2](common/image-coercion-requirement-sets.md#imagecoercion-12)
  • [KeyboardShortcuts 1.1](common/keyboard-shortcuts-requirement-sets.md)
  • [MatrixBindings](common/office-add-in-requirement-sets.md#matrixbindings)
  • [MatrixCoercion](common/office-add-in-requirement-sets.md#matrixcoercion)
  • [NestedAppAuth 1.1](common/nested-app-auth-requirement-sets.md) (preview)
  • [OpenBrowserWindowApi 1.1](common/open-browser-window-api-requirement-sets.md)
  • [PdfFile](common/office-add-in-requirement-sets.md#pdffile)
  • [RibbonApi 1.1](common/ribbon-api-requirement-sets.md)
  • [RibbonApi 1.2](common/ribbon-api-requirement-sets.md)
  • [Selection](common/office-add-in-requirement-sets.md#selection)
  • [Settings](common/office-add-in-requirement-sets.md#settings)
  • [SharedRuntime 1.1](common/shared-runtime-requirement-sets.md)
  • [SharedRuntime 1.2](common/shared-runtime-requirement-sets.md)
  • [TableBindings](common/office-add-in-requirement-sets.md#tablebindings)
  • [TableCoercion](common/office-add-in-requirement-sets.md#tablecoercion)
  • [TextBindings](common/office-add-in-requirement-sets.md#textbindings)
  • [TextCoercion](common/office-add-in-requirement-sets.md#textcoercion)
| +|Office on iPad
(Microsoft 365 subscription)|
  • TaskPane
  • Content
|
  • [ExcelApi 1.1](excel/excel-api-1-1-requirement-set.md)
  • [ExcelApi 1.2](excel/excel-api-1-2-requirement-set.md)
  • [ExcelApi 1.3](excel/excel-api-1-3-requirement-set.md)
  • [ExcelApi 1.4](excel/excel-api-1-4-requirement-set.md)
  • [ExcelApi 1.5](excel/excel-api-1-5-requirement-set.md)
  • [ExcelApi 1.6](excel/excel-api-1-6-requirement-set.md)
  • [ExcelApi 1.7](excel/excel-api-1-7-requirement-set.md)
  • [ExcelApi 1.8](excel/excel-api-1-8-requirement-set.md)
  • [ExcelApi 1.9](excel/excel-api-1-9-requirement-set.md)
  • [ExcelApi 1.10](excel/excel-api-1-10-requirement-set.md)
  • [ExcelApi 1.11](excel/excel-api-1-11-requirement-set.md)
  • [ExcelApi 1.12](excel/excel-api-1-12-requirement-set.md)
  • [ExcelApi 1.13](excel/excel-api-1-13-requirement-set.md)
  • [ExcelApi 1.14](excel/excel-api-1-14-requirement-set.md)
  • [ExcelApi 1.15](excel/excel-api-1-15-requirement-set.md)
  • [ExcelApi 1.16](excel/excel-api-1-16-requirement-set.md)
  • [ExcelApi 1.17](excel/excel-api-1-17-requirement-set.md)
  • [ExcelApi 1.18](excel/excel-api-1-18-requirement-set.md)
  • [ExcelApi 1.19](excel/excel-api-1-19-requirement-set.md)
  • [ExcelApi 1.20](excel/excel-api-1-20-requirement-set.md)
|
  • [BindingEvents](common/office-add-in-requirement-sets.md#bindingevents)
  • [DialogApi 1.1](common/dialog-api-requirement-sets.md)
  • [DialogApi 1.2](common/dialog-api-requirement-sets.md)
  • [DialogOrigin 1.1](common/dialog-origin-requirement-sets.md)
  • [DocumentEvents](common/office-add-in-requirement-sets.md#documentevents)
  • [File](common/office-add-in-requirement-sets.md#file)
  • [ImageCoercion 1.1](common/image-coercion-requirement-sets.md#imagecoercion-11)
  • [MatrixBindings](common/office-add-in-requirement-sets.md#matrixbindings)
  • [MatrixCoercion](common/office-add-in-requirement-sets.md#matrixcoercion)
  • [NestedAppAuth 1.1](common/nested-app-auth-requirement-sets.md) (preview)
  • [OpenBrowserWindowApi 1.1](common/open-browser-window-api-requirement-sets.md)
  • [Selection](common/office-add-in-requirement-sets.md#selection)
  • [Settings](common/office-add-in-requirement-sets.md#settings)
  • [TableBindings](common/office-add-in-requirement-sets.md#tablebindings)
  • [TableCoercion](common/office-add-in-requirement-sets.md#tablecoercion)
  • [TextBindings](common/office-add-in-requirement-sets.md#textbindings)
  • [TextCoercion](common/office-add-in-requirement-sets.md#textcoercion)
| ** Added with post-release updates.* diff --git a/docs/toc.yml b/docs/toc.yml index 2ddbb6e9a1..e9f35f2059 100644 --- a/docs/toc.yml +++ b/docs/toc.yml @@ -255,6 +255,9 @@ items: - name: ExcelApi online-only requirement set href: requirement-sets/excel/excel-api-online-requirement-set.md displayName: Excel + - name: ExcelApi 1.20 requirement set + href: requirement-sets/excel/excel-api-1-20-requirement-set.md + displayName: Excel - name: ExcelApi 1.19 requirement set href: requirement-sets/excel/excel-api-1-19-requirement-set.md displayName: Excel diff --git a/generate-docs/API Coverage Report.csv b/generate-docs/API Coverage Report.csv index d7b7e75010..485f8e4bb4 100644 --- a/generate-docs/API Coverage Report.csv +++ b/generate-docs/API Coverage Report.csv @@ -5615,6 +5615,7 @@ Excel.RowPropertiesLoadOptions,"rowHidden",Property,Excellent,false Excel.RowPropertiesLoadOptions,"rowIndex",Property,Excellent,false Excel.RunOptions,N/A,Interface,Excellent,false Excel.RunOptions,"delayForCellEdit",Property,Excellent,false +Excel.RunOptions,"mergeUndoGroup",Property,Excellent,false Excel.Runtime,N/A,Class,Unknown,false Excel.Runtime,"context",Property,Excellent,false Excel.Runtime,"enableEvents",Property,Fine,true diff --git a/generate-docs/GenerateDocs.sh b/generate-docs/GenerateDocs.sh index b19ce3f432..55737a84f2 100644 --- a/generate-docs/GenerateDocs.sh +++ b/generate-docs/GenerateDocs.sh @@ -45,7 +45,8 @@ if [ ! -d "tool-inputs" ]; then mkdir tool-inputs fi -npx version-remover api-extractor-inputs-excel-release/Excel_online/excel.d.ts api-extractor-inputs-excel-release/Excel_1_19/excel.d.ts "Api set: ExcelApiOnline 1.1" +npx version-remover api-extractor-inputs-excel-release/Excel_online/excel.d.ts api-extractor-inputs-excel-release/Excel_1_20/excel.d.ts "Api set: ExcelApiOnline 1.1" +npx version-remover api-extractor-inputs-excel-release/Excel_1_20/excel.d.ts api-extractor-inputs-excel-release/Excel_1_19/excel.d.ts "Api set: ExcelApi 1.20" configs/excel-1_20-config.json npx version-remover api-extractor-inputs-excel-release/Excel_1_19/excel.d.ts api-extractor-inputs-excel-release/Excel_1_18/excel.d.ts "Api set: ExcelApi 1.19" configs/excel-1_19-config.json npx version-remover api-extractor-inputs-excel-release/Excel_1_18/excel.d.ts api-extractor-inputs-excel-release/Excel_1_17/excel.d.ts "Api set: ExcelApi 1.18" npx version-remover api-extractor-inputs-excel-release/Excel_1_17/excel.d.ts api-extractor-inputs-excel-release/Excel_1_16/excel.d.ts "Api set: ExcelApi 1.17" @@ -128,7 +129,8 @@ npx version-remover api-extractor-inputs-word-release/word_1_1/word.d.ts ./tool- npx whats-new api-extractor-inputs-excel/excel.d.ts api-extractor-inputs-excel-release/Excel_online/excel.d.ts ../docs/includes/excel-preview javascript/api/excel/ configs/excel-link-config.json -npx whats-new api-extractor-inputs-excel-release/Excel_online/excel.d.ts api-extractor-inputs-excel-release/Excel_1_19/excel.d.ts ../docs/includes/excel-online javascript/api/excel/ configs/excel-link-config.json +npx whats-new api-extractor-inputs-excel-release/Excel_online/excel.d.ts api-extractor-inputs-excel-release/Excel_1_20/excel.d.ts ../docs/includes/excel-online javascript/api/excel/ configs/excel-link-config.json +npx whats-new api-extractor-inputs-excel-release/Excel_1_20/excel.d.ts api-extractor-inputs-excel-release/Excel_1_19/excel.d.ts ../docs/includes/excel-1_20 javascript/api/excel/ configs/excel-link-config.json npx whats-new api-extractor-inputs-excel-release/Excel_1_19/excel.d.ts api-extractor-inputs-excel-release/Excel_1_18/excel.d.ts ../docs/includes/excel-1_19 javascript/api/excel/ configs/excel-link-config.json npx whats-new api-extractor-inputs-excel-release/Excel_1_18/excel.d.ts api-extractor-inputs-excel-release/Excel_1_17/excel.d.ts ../docs/includes/excel-1_18 javascript/api/excel/ configs/excel-link-config.json npx whats-new api-extractor-inputs-excel-release/Excel_1_17/excel.d.ts api-extractor-inputs-excel-release/Excel_1_16/excel.d.ts ../docs/includes/excel-1_17 javascript/api/excel/ configs/excel-link-config.json @@ -221,6 +223,12 @@ if [ ! -d "json/excel_online" ]; then ../../node_modules/.bin/api-extractor run popd fi +if [ ! -d "json/excel_1_20" ]; then + echo Running API Extractor for Excel 1.20. + pushd api-extractor-inputs-excel-release/excel_1_20 + ../../node_modules/.bin/api-extractor run + popd +fi if [ ! -d "json/excel_1_19" ]; then echo Running API Extractor for Excel 1.19. pushd api-extractor-inputs-excel-release/excel_1_19 @@ -691,6 +699,9 @@ fi if [ ! -d "yaml/excel_1_19" ]; then ./node_modules/.bin/api-documenter yaml --input-folder ./json/excel_1_19 --output-folder ./yaml/excel_1_19 --office 2>/dev/null fi +if [ ! -d "yaml/excel_1_20" ]; then + ./node_modules/.bin/api-documenter yaml --input-folder ./json/excel_1_20 --output-folder ./yaml/excel_1_20 --office 2>/dev/null +fi if [ ! -d "yaml/excel_online" ]; then ./node_modules/.bin/api-documenter yaml --input-folder ./json/excel_online --output-folder ./yaml/excel_online --office 2>/dev/null fi diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_1/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_1/excel.d.ts index cf83048f57..fc3aa70228 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_1/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_1/excel.d.ts @@ -142,6 +142,7 @@ export declare namespace Excel { * The default behavior with no `delayForCellEdit` property specified is equivalent to when it is `false`. */ delayForCellEdit?: boolean; + } /** * Executes a batch script that performs actions on the Excel object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. @@ -4377,6 +4378,8 @@ export declare namespace Excel { + + diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_10/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_10/excel.d.ts index 964afc00e7..3698121d5f 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_10/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_10/excel.d.ts @@ -792,6 +792,7 @@ export declare namespace Excel { * The default behavior with no `delayForCellEdit` property specified is equivalent to when it is `false`. */ delayForCellEdit?: boolean; + } /** * Executes a batch script that performs actions on the Excel object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. @@ -16585,6 +16586,8 @@ export declare namespace Excel { */ toJSON(): Excel.Interfaces.ConditionalRangeBorderCollectionData; } + + /** * An object encapsulating a style's format and other properties. * diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_11/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_11/excel.d.ts index cbb2fdfcd8..a955c5ad04 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_11/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_11/excel.d.ts @@ -792,6 +792,7 @@ export declare namespace Excel { * The default behavior with no `delayForCellEdit` property specified is equivalent to when it is `false`. */ delayForCellEdit?: boolean; + } /** * Executes a batch script that performs actions on the Excel object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. @@ -16826,6 +16827,8 @@ export declare namespace Excel { */ toJSON(): Excel.Interfaces.ConditionalRangeBorderCollectionData; } + + /** * An object encapsulating a style's format and other properties. * diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_12/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_12/excel.d.ts index fd15f26769..25c4e06e97 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_12/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_12/excel.d.ts @@ -792,6 +792,7 @@ export declare namespace Excel { * The default behavior with no `delayForCellEdit` property specified is equivalent to when it is `false`. */ delayForCellEdit?: boolean; + } /** * Executes a batch script that performs actions on the Excel object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. @@ -18231,6 +18232,8 @@ export declare namespace Excel { */ toJSON(): Excel.Interfaces.ConditionalRangeBorderCollectionData; } + + /** * An object encapsulating a style's format and other properties. * diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_13/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_13/excel.d.ts index 0ef0959ace..c90843f447 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_13/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_13/excel.d.ts @@ -792,6 +792,7 @@ export declare namespace Excel { * The default behavior with no `delayForCellEdit` property specified is equivalent to when it is `false`. */ delayForCellEdit?: boolean; + } /** * Executes a batch script that performs actions on the Excel object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. @@ -18489,6 +18490,8 @@ export declare namespace Excel { */ toJSON(): Excel.Interfaces.ConditionalRangeBorderCollectionData; } + + /** * An object encapsulating a style's format and other properties. * diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_14/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_14/excel.d.ts index 189d99e7e8..cfdc3f8bda 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_14/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_14/excel.d.ts @@ -792,6 +792,7 @@ export declare namespace Excel { * The default behavior with no `delayForCellEdit` property specified is equivalent to when it is `false`. */ delayForCellEdit?: boolean; + } /** * Executes a batch script that performs actions on the Excel object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. @@ -18996,6 +18997,8 @@ export declare namespace Excel { */ toJSON(): Excel.Interfaces.ConditionalRangeBorderCollectionData; } + + /** * An object encapsulating a style's format and other properties. * diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_15/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_15/excel.d.ts index 481cf89fdd..ea06735d7f 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_15/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_15/excel.d.ts @@ -792,6 +792,7 @@ export declare namespace Excel { * The default behavior with no `delayForCellEdit` property specified is equivalent to when it is `false`. */ delayForCellEdit?: boolean; + } /** * Executes a batch script that performs actions on the Excel object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. @@ -19083,6 +19084,8 @@ export declare namespace Excel { */ toJSON(): Excel.Interfaces.ConditionalRangeBorderCollectionData; } + + /** * An object encapsulating a style's format and other properties. * diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_16/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_16/excel.d.ts index a3db684dec..99d8a2f294 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_16/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_16/excel.d.ts @@ -7065,6 +7065,7 @@ export declare namespace Excel { * The default behavior with no `delayForCellEdit` property specified is equivalent to when it is `false`. */ delayForCellEdit?: boolean; + } /** * Executes a batch script that performs actions on the Excel object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. @@ -25507,6 +25508,8 @@ export declare namespace Excel { */ toJSON(): Excel.Interfaces.ConditionalRangeBorderCollectionData; } + + /** * An object encapsulating a style's format and other properties. * diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_17/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_17/excel.d.ts index 7b390b6ee1..f61f12c97c 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_17/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_17/excel.d.ts @@ -7065,6 +7065,7 @@ export declare namespace Excel { * The default behavior with no `delayForCellEdit` property specified is equivalent to when it is `false`. */ delayForCellEdit?: boolean; + } /** * Executes a batch script that performs actions on the Excel object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. @@ -25758,6 +25759,8 @@ export declare namespace Excel { */ toJSON(): Excel.Interfaces.ConditionalRangeBorderCollectionData; } + + /** * An object encapsulating a style's format and other properties. * diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_18/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_18/excel.d.ts index d3e120a2d3..580dedb3ff 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_18/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_18/excel.d.ts @@ -7118,6 +7118,7 @@ export declare namespace Excel { * The default behavior with no `delayForCellEdit` property specified is equivalent to when it is `false`. */ delayForCellEdit?: boolean; + } /** * Executes a batch script that performs actions on the Excel object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. @@ -25905,6 +25906,8 @@ export declare namespace Excel { */ toJSON(): Excel.Interfaces.ConditionalRangeBorderCollectionData; } + + /** * An object encapsulating a style's format and other properties. * diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_19/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_19/excel.d.ts index 39ed95bbff..9ea11a8add 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_19/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_19/excel.d.ts @@ -7505,6 +7505,7 @@ export declare namespace Excel { * The default behavior with no `delayForCellEdit` property specified is equivalent to when it is `false`. */ delayForCellEdit?: boolean; + } /** * Executes a batch script that performs actions on the Excel object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. @@ -26561,6 +26562,8 @@ export declare namespace Excel { */ toJSON(): Excel.Interfaces.ConditionalRangeBorderCollectionData; } + + /** * An object encapsulating a style's format and other properties. * diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_2/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_2/excel.d.ts index d6406c733e..826cd095ba 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_2/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_2/excel.d.ts @@ -300,6 +300,7 @@ export declare namespace Excel { * The default behavior with no `delayForCellEdit` property specified is equivalent to when it is `false`. */ delayForCellEdit?: boolean; + } /** * Executes a batch script that performs actions on the Excel object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. @@ -5531,6 +5532,8 @@ export declare namespace Excel { + + diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_20/api-extractor.json b/generate-docs/api-extractor-inputs-excel-release/Excel_1_20/api-extractor.json new file mode 100644 index 0000000000..362d6a7896 --- /dev/null +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_20/api-extractor.json @@ -0,0 +1,38 @@ +{ + "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", + "mainEntryPointFilePath": "excel.d.ts", + "apiReport": { + "enabled": false + }, + "docModel": { + "enabled": true, + "apiJsonFilePath": "../../json/excel_1_20/.api.json" + }, + "dtsRollup": { + "enabled": false + }, + "messages": { + "extractorMessageReporting": { + "ae-missing-release-tag": { + "logLevel": "none" + }, + "ae-forgotten-export": { + "logLevel": "none" + } + }, + "tsdocMessageReporting": { + "tsdoc-escape-right-brace": { + "logLevel": "none" + }, + "tsdoc-escape-greater-than": { + "logLevel": "none" + }, + "tsdoc-malformed-inline-tag": { + "logLevel": "none" + }, + "tsdoc-unnecessary-backslash": { + "logLevel": "none" + } + } + } +} \ No newline at end of file diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_20/dist/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-excel-release/Excel_1_20/dist/tsdoc-metadata.json new file mode 100644 index 0000000000..ae2e4ace9e --- /dev/null +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_20/dist/tsdoc-metadata.json @@ -0,0 +1,11 @@ +// This file is read by tools that parse documentation comments conforming to the TSDoc standard. +// It should be published with your NPM package. It should not be tracked by Git. +{ + "tsdocVersion": "0.12", + "toolPackages": [ + { + "packageName": "@microsoft/api-extractor", + "packageVersion": "7.0.13" + } + ] +} diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_20/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_20/excel.d.ts new file mode 100644 index 0000000000..f73c72373c --- /dev/null +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_20/excel.d.ts @@ -0,0 +1,65537 @@ +import { OfficeExtension } from "../../api-extractor-inputs-office/office" +import { Office as Outlook} from "../../api-extractor-inputs-outlook/outlook" +//////////////////////////////////////////////////////////////// +/////////////////////// Begin Excel APIs /////////////////////// +//////////////////////////////////////////////////////////////// + + + +export declare namespace Excel { + /** + * Represents an unknown cell control. + * This represents a control that was added in a future version of Excel, and the current version of Excel doesn't know how to display this control. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + export interface UnknownCellControl { + type: CellControlType.unknown; + } + /** + * Represents an empty cell control. + * This represents the state where a cell does not have a control. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + export interface EmptyCellControl { + type: CellControlType.empty; + } + /** + * Represents the result of a query that resulted in multiple cell controls. + * If the result has multiple controls, then they can't be represented as a single result. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + export interface MixedCellControl { + type: CellControlType.mixed; + } + /** + * Represents a checkbox. This is a cell control that allows a user to toggle the boolean value in a cell. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + export interface CheckboxCellControl { + type: CellControlType.checkbox; + } + /** + * Represents an interactable control inside of a cell. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + export type CellControl = UnknownCellControl | EmptyCellControl | MixedCellControl | CheckboxCellControl; + /** + * Represents a 2D array of cell values. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface ArrayCellValue { + /** + * Represents the type of this cell value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + type: CellValueType.array | ReferenceValueType.array | "Array"; + /** + * Represents the value that would be returned by `Range.values` for a cell with this value. + * When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale. + * When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicValue?: "#VALUE!" | string; + /** + * Represents the value that would be returned by `Range.valueTypes` for a cell with this value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicType?: RangeValueType.error | "Error"; + /** + * Represents the elements of the array. May not directly contain an `ArrayCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + elements: CellValue[][]; + /** + * Represents the cell values which are referenced within `ArrayCellValue.elements`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + referencedValues?: ReferencedValue[]; + } + /** + * The basic compact layout properties. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + export interface BasicCompactLayout { + /** + * Specifies the name of the icon which is used to open the card. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + icon?: string | EntityCompactLayoutIcons; + } + /** + * Represents a card layout used for the Boolean, double, and string basic types. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + export interface BasicCardLayout extends CardLayoutStandardProperties { + /** + * Represents the type of this layout. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + layout?: EntityCardLayoutType.entity | "Entity"; + } + /** + * Represents layout information for various views of the value and its properties. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + export interface BasicViewLayouts { + /** + * Represents the layout of this value and its properties in card view. + * If the `BasicCardLayout` object does not have a layout property, it is assumed to be "Entity". + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + card?: BasicCardLayout; + /** + * Represents the layout used when there is limited space to represent the value. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + compact?: BasicCompactLayout; + } + /** + * Represents types of #BLOCKED! errors. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + enum BlockedErrorCellValueSubType { + /** + * An unknown type of error. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + unknown = "Unknown", + /** + * An error caused by a service not supporting a linked data type. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + dataTypeRestrictedDomain = "DataTypeRestrictedDomain", + /** + * An error caused by privacy settings. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + dataTypePrivacySetting = "DataTypePrivacySetting", + /** + * An error caused by an unsupported data type. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + dataTypeUnsupportedApp = "DataTypeUnsupportedApp", + /** + * An error caused by external links. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + externalLinksGeneric = "ExternalLinksGeneric", + /** + * An error caused by disabled rich data links. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + richDataLinkDisabled = "RichDataLinkDisabled", + /** + * An error caused by sign in failure. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + signInError = "SignInError", + /** + * An error caused by a license verification failure. Displays as error type #BLOCKED! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + noLicense = "NoLicense" + } + /** + * Represents the value of a cell containing a #BLOCKED! error. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface BlockedErrorCellValue { + /** + * Represents the type of this cell value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + type: CellValueType.error | "Error"; + /** + * Represents the value that would be returned by `Range.values` for a cell with this value. + * When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale. + * When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicValue?: "#BLOCKED!" | string; + /** + * Represents the value that would be returned by `Range.valueTypes` for a cell with this value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicType?: RangeValueType.error | "Error"; + /** + * Represents the type of `ErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + errorType?: ErrorCellValueType.blocked | "Blocked"; + /** + * Represents the type of `BlockedErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + errorSubType?: BlockedErrorCellValueSubType | "Unknown" | "DataTypeRestrictedDomain" | "DataTypePrivacySetting" | "DataTypeUnsupportedApp" | "ExternalLinksGeneric" | "RichDataLinkDisabled" | "SignInError" | "NoLicense"; + } + /** + * Represents the value of a cell containing a Boolean. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface BooleanCellValue { + /** + * Represents the type of this cell value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + type: CellValueType.boolean | "Boolean"; + /** + * Represents the value that would be returned by `Range.values` for a cell with this value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicValue: boolean; + /** + * Represents the value that would be returned by `Range.valueTypes` for a cell with this value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicType?: RangeValueType.boolean | "Boolean"; + /** + * Represents additional properties of this Boolean value. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + properties?: { + [key: string]: EntityPropertyType; + }; + /** + * Represents layout information for views of this Boolean value. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + layouts?: BasicViewLayouts; + /** + * Represents information that describes the service that provided the data in this `BooleanCellValue`. + * This information can be used for branding in card view. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + provider?: CellValueProviderAttributes; + /** + * Represents the cell values which are referenced within `BooleanCellValue.properties`. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + referencedValues?: ReferencedValue[]; + } + /** + * Represents types of #BUSY! errors. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + enum BusyErrorCellValueSubType { + /** + * An unknown type of error. Displays as error type #BUSY! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + unknown = "Unknown", + /** + * An error caused by external links. Displays as error type #BUSY! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + externalLinksGeneric = "ExternalLinksGeneric", + /** + * An error that displays while an image is loading. Displays as error type #BUSY! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + loadingImage = "LoadingImage" + } + /** + * Represents the value of a cell containing a #BUSY! error. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface BusyErrorCellValue { + /** + * Represents the type of this cell value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + type: CellValueType.error | "Error"; + /** + * Represents the value that would be returned by `Range.values` for a cell with this value. + * When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale. + * When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicValue?: "#BUSY!" | string; + /** + * Represents the value that would be returned by `Range.valueTypes` for a cell with this value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicType?: RangeValueType.error | "Error"; + /** + * Represents the type of `ErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + errorType?: ErrorCellValueType.busy | "Busy"; + /** + * Represents the type of `BusyErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + errorSubType?: BusyErrorCellValueSubType | "Unknown" | "ExternalLinksGeneric" | "LoadingImage"; + } + /** + * Represents types of #CALC! errors. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + enum CalcErrorCellValueSubType { + /** + * An unknown type of error. Displays as error type #CALC! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + unknown = "Unknown", + /** + * An error caused by including an array in an array. Displays as error type #CALC! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + arrayOfArrays = "ArrayOfArrays", + /** + * An error caused by including a range in an array. Displays as error type #CALC! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + arrayOfRanges = "ArrayOfRanges", + /** + * An error caused by an empty array. Displays as error type #CALC! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + emptyArray = "EmptyArray", + /** + * An error caused by attempting to lift an unsupported formula (such as a Dynamic UDF) over an array. Displays as error type #CALC! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + unsupportedLifting = "UnsupportedLifting", + /** + * An error caused by a data table referencing a pending formula. The pending formula is likely asynchronous. Displays as error type #CALC! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + dataTableReferencedPendingFormula = "DataTableReferencedPendingFormula", + /** + * An error caused by a function referencing too many cells. Displays as error type #CALC! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + tooManyCells = "TooManyCells", + /** + * An error caused by a cell's formula evaluating to a lambda value. Displays as error type #CALC! in Excel. + * + * Warning: `lambdaInCell` was deprecated in ExcelApi 1.19. + * + * @deprecated Deprecated since ExcelApi 1.19. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + lambdaInCell = "LambdaInCell", + /** + * An error caused by a `CellValue` object that is too deeply nested within another `CellValue`. Displays as error type #CALC! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + tooDeeplyNested = "TooDeeplyNested", + /** + * An error caused by a cell's formula returning a string that exceeds the maximum of 32767 characters. Displays as error type #CALC! in Excel. + * Some characters, like emoji, may appear to be one character in the Excel UI but are actually processed as surrogate characters. A surrogate character counts as multiple characters toward the maximum character limit. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + textOverflow = "TextOverflow" + } + /** + * Represents the value of a cell containing a #CALC! error. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface CalcErrorCellValue { + /** + * Represents the type of this cell value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + type: CellValueType.error | "Error"; + /** + * Represents the value that would be returned by `Range.values` for a cell with this value. + * When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale. + * When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicValue?: "#CALC!" | string; + /** + * Represents the value that would be returned by `Range.valueTypes` for a cell with this value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicType?: RangeValueType.error | "Error"; + /** + * Represents the type of `ErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + errorType?: ErrorCellValueType.calc | "Calc"; + /** + * Represents the type of `CalcErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + errorSubType?: CalcErrorCellValueSubType | "Unknown" | "ArrayOfArrays" | "ArrayOfRanges" | "EmptyArray" | "UnsupportedLifting" | "DataTableReferencedPendingFormula" | "TooManyCells" | "LambdaInCell" | "TooDeeplyNested" | "TextOverflow"; + /** + * Represents the name of the function causing the error. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + functionName?: string; + } + /** + * Represents a reference to a property used by the card layout. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface CardLayoutPropertyReference { + /** + * Represents the name of the property referenced by the card layout. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + property: string; + } + /** + * Properties of a card layout relevant to most card layouts. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface CardLayoutSectionStandardProperties { + /** + * Represents the title of this section of the card. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + title?: string; + /** + * Represents whether this section of the card is collapsible. + * If the card section has a title, the default value is `true`. + * If the card section doesn't have a title, the default value is `false`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + collapsible?: boolean; + /** + * Represents whether this section of the card is initially collapsed. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + collapsed?: boolean; + /** + * Represents the names of the properties in this section. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + properties: string[]; + } + /** + * Represents a section of a card that is arranged as a list in card view. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface CardLayoutListSection extends CardLayoutSectionStandardProperties { + /** + * Represents the type of layout for this section. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + layout: "List"; + } + /** + * Represents a section of a card that is arranged as a table in card view. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface CardLayoutTableSection extends CardLayoutSectionStandardProperties { + /** + * Represents the type of layout for this section. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + layout: "Table"; + } + /** + * Represents a section of a card that is arranged as two columns in card view. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + export interface CardLayoutTwoColumnSection extends CardLayoutSectionStandardProperties { + /** + * Represents the type of layout for this section. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + layout: "TwoColumn"; + } + /** + * Represents the layout of a section of a card in card view. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export type CardLayoutSection = CardLayoutListSection | CardLayoutTableSection | CardLayoutTwoColumnSection; + /** + * Properties of a card layout relevant to most card layouts. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface CardLayoutStandardProperties { + /** + * Specifies a property which will be used as the main image of the card. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + mainImage?: CardLayoutPropertyReference; + /** + * Represents the title of the card or the specification of which property contains the title of the card. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + title?: string | CardLayoutPropertyReference; + /** + * Represents a specification of which property contains the subtitle of the card. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + subTitle?: CardLayoutPropertyReference; + /** + * Represents the sections of the card. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + sections?: CardLayoutSection[]; + } + /** + * Represents the layout of a card in card view. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export type CardLayout = EntityCardLayout; + /** + * Types of entity card layouts. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + enum EntityCardLayoutType { + /** + * Entity layout of the entity card. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + entity = "Entity" + } + /** + * The compact layout properties for an entity. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface EntityCompactLayout { + /** + * Specifies the name of the icon which is used to open the card. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + icon?: string | EntityCompactLayoutIcons; + } + /** + * Represents the types of the `FunctionCellValue` object. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + enum FunctionCellValueType { + /** + * Reference to a JavaScript custom function. For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/excel/custom-functions-overview | Create custom functions in Excel}. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + javaScriptReference = "JavaScriptReference" + } + /** + * Represents a reference to a JavaScript custom function. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + export interface JavaScriptCustomFunctionReferenceCellValue { + /** + * Represents the type of this cell value. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + type: CellValueType.function | "Function"; + /** + * Represents the value that would be returned by `Range.values` for a cell with this value. + * When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale. + * When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + basicValue?: "#VALUE!" | string; + /** + * Represents the value that would be returned by `Range.valueTypes` for a cell with this value. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + basicType?: RangeValueType.error | "Error"; + /** + * Represents the type of `FunctionCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + functionType: FunctionCellValueType.javaScriptReference | "JavaScriptReference"; + /** + * Represents the namespace used by the custom function. For more information, see {@link https://learn.microsoft.com/javascript/api/manifest/namespace | Manifest reference: Namespace}. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + namespace: string; + /** + * Represents the ID of the custom function. For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/excel/custom-functions-json-autogeneration#id | Autogenerate JSON metadata for custom functions: ID}. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + id: string; + } + /** + * Represents a cell value which can be evaluated as a function. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + export type FunctionCellValue = JavaScriptCustomFunctionReferenceCellValue; + /** + * Represents the layout used when there is limited space to represent the entity. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export type CompactLayout = EntityCompactLayout; + /** + * The list of icons available for `EntityCompactLayout`. An icon displays in the Excel UI, either to the left of the title in a cell that contains an entity card, or to the left of the title of a referenced entity inside an entity card. Selecting the icon opens the entity card. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + enum EntityCompactLayoutIcons { + /** + * The default icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + generic = "Generic", + /** + * Accessibility icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + accessibility = "Accessibility", + /** + * Airplane icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + airplane = "Airplane", + /** + * Airplane taking off icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + airplaneTakeOff = "AirplaneTakeOff", + /** + * Album icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + album = "Album", + /** + * Alert icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + alert = "Alert", + /** + * Alert urgent icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + alertUrgent = "AlertUrgent", + /** + * Animal icon. Displays as a pawprint. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + animal = "Animal", + /** + * Animal cat icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + animalCat = "AnimalCat", + /** + * Animal dog icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + animalDog = "AnimalDog", + /** + * Animal rabbit icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + animalRabbit = "AnimalRabbit", + /** + * Animal turtle icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + animalTurtle = "AnimalTurtle", + /** + * App folder icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + appFolder = "AppFolder", + /** + * App generic icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + appGeneric = "AppGeneric", + /** + * Apple icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + apple = "Apple", + /** + * Approvals app icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + approvalsApp = "ApprovalsApp", + /** + * Archive icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + archive = "Archive", + /** + * Archive multiple icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + archiveMultiple = "ArchiveMultiple", + /** + * Arrow trending lines icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + arrowTrendingLines = "ArrowTrendingLines", + /** + * Art icon. Displays as a paint palette. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + art = "Art", + /** + * Atom icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + atom = "Atom", + /** + * Attach icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + attach = "Attach", + /** + * Automobile icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + automobile = "Automobile", + /** + * Autosum icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + autosum = "Autosum", + /** + * Backpack icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + backpack = "Backpack", + /** + * Badge icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + badge = "Badge", + /** + * Balloon icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + balloon = "Balloon", + /** + * Bank icon. Displays as a building with pillars and a triangular roof. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + bank = "Bank", + /** + * Barcode scanner icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + barcodeScanner = "BarcodeScanner", + /** + * Basketball icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basketball = "Basketball", + /** + * Battery empty icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + battery0 = "Battery0", + /** + * Battery full icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + battery10 = "Battery10", + /** + * Beach icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + beach = "Beach", + /** + * Beaker icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + beaker = "Beaker", + /** + * Bed icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + bed = "Bed", + /** + * Bin full icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + binFull = "BinFull", + /** + * Bird icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + bird = "Bird", + /** + * Bluetooth icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + bluetooth = "Bluetooth", + /** + * Board icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + board = "Board", + /** + * Board games icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + boardGames = "BoardGames", + /** + * Book icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + book = "Book", + /** + * Bookmark icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + bookmark = "Bookmark", + /** + * Bookmark multiple icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + bookmarkMultiple = "BookmarkMultiple", + /** + * Bot icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + bot = "Bot", + /** + * Bowl chopsticks icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + bowlChopsticks = "BowlChopsticks", + /** + * Box icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + box = "Box", + /** + * Box multiple icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + boxMultiple = "BoxMultiple", + /** + * Brain circuit icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + brainCircuit = "BrainCircuit", + /** + * Branch icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + branch = "Branch", + /** + * Branch fork icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + branchFork = "BranchFork", + /** + * Branch request icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + branchRequest = "BranchRequest", + /** + * Bridge icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + bridge = "Bridge", + /** + * Briefcase icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + briefcase = "Briefcase", + /** + * Briefcase medical icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + briefcaseMedical = "BriefcaseMedical", + /** + * Broad activity feed icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + broadActivityFeed = "BroadActivityFeed", + /** + * Broom icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + broom = "Broom", + /** + * Bug icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + bug = "Bug", + /** + * Building icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + building = "Building", + /** + * Building bank icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + buildingBank = "BuildingBank", + /** + * Building factory icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + buildingFactory = "BuildingFactory", + /** + * Building government icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + buildingGovernment = "BuildingGovernment", + /** + * Building home icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + buildingHome = "BuildingHome", + /** + * Building lighthouse icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + buildingLighthouse = "BuildingLighthouse", + /** + * Building multiple icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + buildingMultiple = "BuildingMultiple", + /** + * Building retail icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + buildingRetail = "BuildingRetail", + /** + * Building retail more icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + buildingRetailMore = "BuildingRetailMore", + /** + * Building retail toolbox icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + buildingRetailToolbox = "BuildingRetailToolbox", + /** + * Building shop icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + buildingShop = "BuildingShop", + /** + * Building skyscraper icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + buildingSkyscraper = "BuildingSkyscraper", + /** + * Calculator icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + calculator = "Calculator", + /** + * Calendar left to right icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + calendarLtr = "CalendarLtr", + /** + * Calendar right to left icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + calendarRtl = "CalendarRtl", + /** + * Call icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + call = "Call", + /** + * Calligraphy pen icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + calligraphyPen = "CalligraphyPen", + /** + * Camera icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + camera = "Camera", + /** + * Camera dome icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + cameraDome = "CameraDome", + /** + * Car icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + car = "Car", + /** + * Cart icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + cart = "Cart", + /** + * Cat icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + cat = "Cat", + /** + * Certificate icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + certificate = "Certificate", + /** + * Chart multiple icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + chartMultiple = "ChartMultiple", + /** + * Chat icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + chat = "Chat", + /** + * Chat multiple icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + chatMultiple = "ChatMultiple", + /** + * Chat video icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + chatVideo = "ChatVideo", + /** + * Check icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + check = "Check", + /** + * Checkbox checked icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + checkboxChecked = "CheckboxChecked", + /** + * Checkbox unchecked icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + checkboxUnchecked = "CheckboxUnchecked", + /** + * Checkmark icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + checkmark = "Checkmark", + /** + * Chess icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + chess = "Chess", + /** + * City icon. Displays as multiple tall buildings. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + city = "City", + /** + * Class icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + class = "Class", + /** + * Classification icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + classification = "Classification", + /** + * Clipboard icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + clipboard = "Clipboard", + /** + * Clipboard data bar icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + clipboardDataBar = "ClipboardDataBar", + /** + * Clipboard pulse icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + clipboardPulse = "ClipboardPulse", + /** + * Clipboard task icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + clipboardTask = "ClipboardTask", + /** + * Clock icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + clock = "Clock", + /** + * Clock alarm icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + clockAlarm = "ClockAlarm", + /** + * Cloud icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + cloud = "Cloud", + /** + * Cloud words icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + cloudWords = "CloudWords", + /** + * Code icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + code = "Code", + /** + * Collections icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + collections = "Collections", + /** + * Comment icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + comment = "Comment", + /** + * Comment multiple icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + commentMultiple = "CommentMultiple", + /** + * Communication icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + communication = "Communication", + /** + * Compass northwest icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + compassNorthwest = "CompassNorthwest", + /** + * Conference room icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + conferenceRoom = "ConferenceRoom", + /** + * Connector icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + connector = "Connector", + /** + * Constellation icon. Displays dots in the shape of Ursa Major. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + constellation = "Constellation", + /** + * Contact card icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + contactCard = "ContactCard", + /** + * Cookies icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + cookies = "Cookies", + /** + * Couch icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + couch = "Couch", + /** + * Credit card person icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + creditCardPerson = "CreditCardPerson", + /** + * Credit card toolbox icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + creditCardToolbox = "CreditCardToolbox", + /** + * Cube icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + cube = "Cube", + /** + * Cube multiple icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + cubeMultiple = "CubeMultiple", + /** + * Cube tree icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + cubeTree = "CubeTree", + /** + * Currency dollar euro icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + currencyDollarEuro = "CurrencyDollarEuro", + /** + * Currency dollar rupee icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + currencyDollarRupee = "CurrencyDollarRupee", + /** + * Data area icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + dataArea = "DataArea", + /** + * Database icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + database = "Database", + /** + * Database multiple icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + databaseMultiple = "DatabaseMultiple", + /** + * Data funnel icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + dataFunnel = "DataFunnel", + /** + * Data histogram icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + dataHistogram = "DataHistogram", + /** + * Data line icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + dataLine = "DataLine", + /** + * Data pie icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + dataPie = "DataPie", + /** + * Data scatter icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + dataScatter = "DataScatter", + /** + * Data sunburst icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + dataSunburst = "DataSunburst", + /** + * Data treemap icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + dataTreemap = "DataTreemap", + /** + * Data waterfall icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + dataWaterfall = "DataWaterfall", + /** + * Data whisker icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + dataWhisker = "DataWhisker", + /** + * Dentist icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + dentist = "Dentist", + /** + * Design ideas icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + designIdeas = "DesignIdeas", + /** + * Desktop icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + desktop = "Desktop", + /** + * Desktop Mac icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + desktopMac = "DesktopMac", + /** + * Developer board icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + developerBoard = "DeveloperBoard", + /** + * Device meeting room icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + deviceMeetingRoom = "DeviceMeetingRoom", + /** + * Diagram icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + diagram = "Diagram", + /** + * Dialpad icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + dialpad = "Dialpad", + /** + * Diamond icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + diamond = "Diamond", + /** + * Dinosaur icon. Displays as a long-necked dinosaur, similar to a Brachiosaurus. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + dinosaur = "Dinosaur", + /** + * Directions icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + directions = "Directions", + /** + * Disaster icon. Displays as a house sinking in a flood. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + disaster = "Disaster", + /** + * Diversity icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + diversity = "Diversity", + /** + * DNA icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + dNA = "DNA", + /** + * Doctor icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + doctor = "Doctor", + /** + * Document icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + document = "Document", + /** + * Document data icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + documentData = "DocumentData", + /** + * Document landscape icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + documentLandscape = "DocumentLandscape", + /** + * Document multiple icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + documentMultiple = "DocumentMultiple", + /** + * Document PDF icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + documentPdf = "DocumentPdf", + /** + * Document queue icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + documentQueue = "DocumentQueue", + /** + * Document text icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + documentText = "DocumentText", + /** + * Dog icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + dog = "Dog", + /** + * Door icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + door = "Door", + /** + * Door tag icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + doorTag = "DoorTag", + /** + * Drafts icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + drafts = "Drafts", + /** + * Drama icon. Displays as a pair of theatre masks. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + drama = "Drama", + /** + * Drink beer icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + drinkBeer = "DrinkBeer", + /** + * Drink coffee icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + drinkCoffee = "DrinkCoffee", + /** + * Drink margarita icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + drinkMargarita = "DrinkMargarita", + /** + * Drink to go icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + drinkToGo = "DrinkToGo", + /** + * Drink wine icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + drinkWine = "DrinkWine", + /** + * Drive train icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + driveTrain = "DriveTrain", + /** + * Drop icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + drop = "Drop", + /** + * Dual screen icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + dualScreen = "DualScreen", + /** + * Dumbbell icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + dumbbell = "Dumbbell", + /** + * Earth icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + earth = "Earth", + /** + * Emoji icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + emoji = "Emoji", + /** + * Emoji angry icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + emojiAngry = "EmojiAngry", + /** + * Emoji hand icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + emojiHand = "EmojiHand", + /** + * Emoji laugh icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + emojiLaugh = "EmojiLaugh", + /** + * Emoji meh icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + emojiMeh = "EmojiMeh", + /** + * Emoji multiple icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + emojiMultiple = "EmojiMultiple", + /** + * Emoji sad icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + emojiSad = "EmojiSad", + /** + * Emoji sad slight icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + emojiSadSlight = "EmojiSadSlight", + /** + * Emoji smile slight icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + emojiSmileSlight = "EmojiSmileSlight", + /** + * Emoji sparkle icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + emojiSparkle = "EmojiSparkle", + /** + * Emoji surprise icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + emojiSurprise = "EmojiSurprise", + /** + * Engine icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + engine = "Engine", + /** + * Eraser icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + eraser = "Eraser", + /** + * Eye icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + eye = "Eye", + /** + * Eyedropper icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + eyedropper = "Eyedropper", + /** + * Fax icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + fax = "Fax", + /** + * Fingerprint icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + fingerprint = "Fingerprint", + /** + * First aid icon. Displays as a briefcase with a medical cross symbol. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + firstAid = "FirstAid", + /** + * Flag icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + flag = "Flag", + /** + * Flash icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + flash = "Flash", + /** + * Flashlight icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + flashlight = "Flashlight", + /** + * Flow icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + flow = "Flow", + /** + * Flowchart icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + flowchart = "Flowchart", + /** + * Folder icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + folder = "Folder", + /** + * Folder open icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + folderOpen = "FolderOpen", + /** + * Folder open vertical icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + folderOpenVertical = "FolderOpenVertical", + /** + * Folder person icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + folderPerson = "FolderPerson", + /** + * Folder zip icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + folderZip = "FolderZip", + /** + * Food icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + food = "Food", + /** + * Food apple icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + foodApple = "FoodApple", + /** + * Food cake icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + foodCake = "FoodCake", + /** + * Food egg icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + foodEgg = "FoodEgg", + /** + * Food grains icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + foodGrains = "FoodGrains", + /** + * Food pizza icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + foodPizza = "FoodPizza", + /** + * Food toast icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + foodToast = "FoodToast", + /** + * Galaxy icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + galaxy = "Galaxy", + /** + * Games icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + games = "Games", + /** + * Gantt chart icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + ganttChart = "GanttChart", + /** + * Gas icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + gas = "Gas", + /** + * Gas pump icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + gasPump = "GasPump", + /** + * Gauge icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + gauge = "Gauge", + /** + * Gavel icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + gavel = "Gavel", + /** + * Gift icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + gift = "Gift", + /** + * Gift card icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + giftCard = "GiftCard", + /** + * Glasses icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + glasses = "Glasses", + /** + * Globe icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + globe = "Globe", + /** + * Globe surface icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + globeSurface = "GlobeSurface", + /** + * Grid icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + grid = "Grid", + /** + * Grid dots icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + gridDots = "GridDots", + /** + * Grid Kanban icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + gridKanban = "GridKanban", + /** + * Guardian icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + guardian = "Guardian", + /** + * Guest icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + guest = "Guest", + /** + * Guitar icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + guitar = "Guitar", + /** + * Hand left icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + handLeft = "HandLeft", + /** + * Hand right icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + handRight = "HandRight", + /** + * Handshake icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + handshake = "Handshake", + /** + * Hard drive icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + hardDrive = "HardDrive", + /** + * Graduation hat icon. Displays as a hat with a tassel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + hatGraduation = "HatGraduation", + /** + * Headphones icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + headphones = "Headphones", + /** + * Headphones sound wave icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + headphonesSoundWave = "HeadphonesSoundWave", + /** + * Headset icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + headset = "Headset", + /** + * Headset VR icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + headsetVr = "HeadsetVr", + /** + * Heart icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + heart = "Heart", + /** + * Heart broken icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + heartBroken = "HeartBroken", + /** + * Heart circle icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + heartCircle = "HeartCircle", + /** + * Human heart icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + heartHuman = "HeartHuman", + /** + * Heart pulse icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + heartPulse = "HeartPulse", + /** + * History icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + history = "History", + /** + * Home icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + home = "Home", + /** + * Home more icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + homeMore = "HomeMore", + /** + * Home person icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + homePerson = "HomePerson", + /** + * Icons icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + icons = "Icons", + /** + * Image icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + image = "Image", + /** + * Image globe icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + imageGlobe = "ImageGlobe", + /** + * Image multiple icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + imageMultiple = "ImageMultiple", + /** + * IoT icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + iot = "Iot", + /** + * Joystick icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + joystick = "Joystick", + /** + * Justice icon. Displays as the scales of justice. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + justice = "Justice", + /** + * Key icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + key = "Key", + /** + * Keyboard icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + keyboard = "Keyboard", + /** + * Keyboard layout split icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + keyboardLayoutSplit = "KeyboardLayoutSplit", + /** + * Key multiple icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + keyMultiple = "KeyMultiple", + /** + * Languages icon. Displays as a document and a globe. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + languages = "Languages", + /** + * Laptop icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + laptop = "Laptop", + /** + * Lasso icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + lasso = "Lasso", + /** + * Launcher settings icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + launcherSettings = "LauncherSettings", + /** + * Layer icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + layer = "Layer", + /** + * Leaf icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + leaf = "Leaf", + /** + * Leaf one icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + leafOne = "LeafOne", + /** + * Leaf three icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + leafThree = "LeafThree", + /** + * Leaf two icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + leafTwo = "LeafTwo", + /** + * Library icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + library = "Library", + /** + * Lightbulb icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + lightbulb = "Lightbulb", + /** + * Lightbulb filament icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + lightbulbFilament = "LightbulbFilament", + /** + * Likert icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + likert = "Likert", + /** + * Link icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + link = "Link", + /** + * Local language icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + localLanguage = "LocalLanguage", + /** + * Location icon. Displays as a map marker. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + location = "Location", + /** + * Lock closed icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + lockClosed = "LockClosed", + /** + * Lock multiple icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + lockMultiple = "LockMultiple", + /** + * Lock open icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + lockOpen = "LockOpen", + /** + * Lottery icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + lottery = "Lottery", + /** + * Luggage icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + luggage = "Luggage", + /** + * Mail icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + mail = "Mail", + /** + * Mail inbox icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + mailInbox = "MailInbox", + /** + * Mail multiple icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + mailMultiple = "MailMultiple", + /** + * Map icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + map = "Map", + /** + * Map pin icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + mapPin = "MapPin", + /** + * Markdown icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + markdown = "Markdown", + /** + * Math formula icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + mathFormula = "MathFormula", + /** + * Math symbols icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + mathSymbols = "MathSymbols", + /** + * Max icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + max = "Max", + /** + * Megaphone icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + megaphone = "Megaphone", + /** + * Megaphone loud icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + megaphoneLoud = "MegaphoneLoud", + /** + * Mention icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + mention = "Mention", + /** + * Mic icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + mic = "Mic", + /** + * Microscope icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + microscope = "Microscope", + /** + * Midi icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + midi = "Midi", + /** + * Molecule icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + molecule = "Molecule", + /** + * Money icon. Displays as paper money and coins. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + money = "Money", + /** + * Money hand icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + moneyHand = "MoneyHand", + /** + * Mountain icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + mountain = "Mountain", + /** + * Movie camera icon. Displays as a video camera. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + movieCamera = "MovieCamera", + /** + * Movies and TV icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + moviesAndTv = "MoviesAndTv", + /** + * Music note icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + musicNote = "MusicNote", + /** + * Music note icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + musicNote1 = "MusicNote1", + /** + * Music double note icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + musicNote2 = "MusicNote2", + /** + * My location icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + myLocation = "MyLocation", + /** + * N by N icon. Displays as a three by three grid. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + nByN = "NByN", + /** + * N by one icon. Displays as a three by one grid. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + nByOne = "NByOne", + /** + * News icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + news = "News", + /** + * Notable people icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + notablePeople = "NotablePeople", + /** + * Note icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + note = "Note", + /** + * Notebook icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + notebook = "Notebook", + /** + * Notepad icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + notepad = "Notepad", + /** + * Notepad person icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + notepadPerson = "NotepadPerson", + /** + * One by N icon. Displays as a one by three grid. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + oneByN = "OneByN", + /** + * One by one icon. Displays as a one by one grid. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + oneByOne = "OneByOne", + /** + * Options icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + options = "Options", + /** + * Organization icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + organization = "Organization", + /** + * Organization horizontal icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + organizationHorizontal = "OrganizationHorizontal", + /** + * Oval icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + oval = "Oval", + /** + * Paint brush icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + paintBrush = "PaintBrush", + /** + * Paint bucket icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + paintBucket = "PaintBucket", + /** + * Partly sunny weather icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + partlySunnyWeather = "PartlySunnyWeather", + /** + * Password icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + password = "Password", + /** + * Patch icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + patch = "Patch", + /** + * Patient icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + patient = "Patient", + /** + * Payment icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + payment = "Payment", + /** + * Pen icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + pen = "Pen", + /** + * Pentagon icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + pentagon = "Pentagon", + /** + * People icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + people = "People", + /** + * People audience icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + peopleAudience = "PeopleAudience", + /** + * People call icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + peopleCall = "PeopleCall", + /** + * People community icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + peopleCommunity = "PeopleCommunity", + /** + * People money icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + peopleMoney = "PeopleMoney", + /** + * People queue icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + peopleQueue = "PeopleQueue", + /** + * People team icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + peopleTeam = "PeopleTeam", + /** + * People toolbox icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + peopleToolbox = "PeopleToolbox", + /** + * Person icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + person = "Person", + /** + * Person board icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + personBoard = "PersonBoard", + /** + * Person call icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + personCall = "PersonCall", + /** + * Person chat icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + personChat = "PersonChat", + /** + * Person feedback icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + personFeedback = "PersonFeedback", + /** + * Person support icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + personSupport = "PersonSupport", + /** + * Person voice icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + personVoice = "PersonVoice", + /** + * Phone icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + phone = "Phone", + /** + * Phone desktop icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + phoneDesktop = "PhoneDesktop", + /** + * Phone laptop icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + phoneLaptop = "PhoneLaptop", + /** + * Phone shake icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + phoneShake = "PhoneShake", + /** + * Phone tablet icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + phoneTablet = "PhoneTablet", + /** + * Phone vibrate icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + phoneVibrate = "PhoneVibrate", + /** + * Photo filter icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + photoFilter = "PhotoFilter", + /** + * Pi icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + pi = "Pi", + /** + * Picture in picture icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + pictureInPicture = "PictureInPicture", + /** + * Pilates icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + pilates = "Pilates", + /** + * Pill icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + pill = "Pill", + /** + * Pin icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + pin = "Pin", + /** + * Pipeline icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + pipeline = "Pipeline", + /** + * Planet icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + planet = "Planet", + /** + * Playing cards icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + playingCards = "PlayingCards", + /** + * Plug connected icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + plugConnected = "PlugConnected", + /** + * Plug disconnected icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + plugDisconnected = "PlugDisconnected", + /** + * Point scan icon. Displays as a target focus symbol. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + pointScan = "PointScan", + /** + * Poll icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + poll = "Poll", + /** + * Power icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + power = "Power", + /** + * Predictions icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + predictions = "Predictions", + /** + * Premium icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + premium = "Premium", + /** + * Presenter icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + presenter = "Presenter", + /** + * Preview link icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + previewLink = "PreviewLink", + /** + * Print icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + print = "Print", + /** + * Production icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + production = "Production", + /** + * Prohibited icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + prohibited = "Prohibited", + /** + * Projection screen icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + projectionScreen = "ProjectionScreen", + /** + * Protocol handler icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + protocolHandler = "ProtocolHandler", + /** + * Pulse icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + pulse = "Pulse", + /** + * Pulse square icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + pulseSquare = "PulseSquare", + /** + * Puzzle piece icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + puzzlePiece = "PuzzlePiece", + /** + * QR code icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + qrCode = "QrCode", + /** + * Radar icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + radar = "Radar", + /** + * Ram icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + ram = "Ram", + /** + * Reading list icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + readingList = "ReadingList", + /** + * Real estate icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + realEstate = "RealEstate", + /** + * Receipt icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + receipt = "Receipt", + /** + * Reward icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + reward = "Reward", + /** + * Rhombus icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + rhombus = "Rhombus", + /** + * Ribbon icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + ribbon = "Ribbon", + /** + * Ribbon star icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + ribbonStar = "RibbonStar", + /** + * Road cone icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + roadCone = "RoadCone", + /** + * Rocket icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + rocket = "Rocket", + /** + * Router icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + router = "Router", + /** + * RSS icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + rss = "Rss", + /** + * Ruler icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + ruler = "Ruler", + /** + * Run icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + run = "Run", + /** + * Running icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + running = "Running", + /** + * Satellite icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + satellite = "Satellite", + /** + * Save icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + save = "Save", + /** + * Savings icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + savings = "Savings", + /** + * Scales icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + scales = "Scales", + /** + * Scan icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + scan = "Scan", + /** + * Scratchpad icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + scratchpad = "Scratchpad", + /** + * Screen person icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + screenPerson = "ScreenPerson", + /** + * Screenshot icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + screenshot = "Screenshot", + /** + * Search icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + search = "Search", + /** + * Serial port icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + serialPort = "SerialPort", + /** + * Server icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + server = "Server", + /** + * Server multiple icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + serverMultiple = "ServerMultiple", + /** + * Service bell icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + serviceBell = "ServiceBell", + /** + * Settings icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + settings = "Settings", + /** + * Shapes icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + shapes = "Shapes", + /** + * Shield icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + shield = "Shield", + /** + * Shield task icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + shieldTask = "ShieldTask", + /** + * Shopping bag icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + shoppingBag = "ShoppingBag", + /** + * Signature icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + signature = "Signature", + /** + * Sim icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + sim = "Sim", + /** + * Sleep icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + sleep = "Sleep", + /** + * Smartwatch icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + smartwatch = "Smartwatch", + /** + * Sound source icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + soundSource = "SoundSource", + /** + * Sound wave circle icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + soundWaveCircle = "SoundWaveCircle", + /** + * Sparkle icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + sparkle = "Sparkle", + /** + * Speaker icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + speaker0 = "Speaker0", + /** + * Speaker with sound wave icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + speaker2 = "Speaker2", + /** + * Sport icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + sport = "Sport", + /** + * Sport american football icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + sportAmericanFootball = "SportAmericanFootball", + /** + * Sport baseball icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + sportBaseball = "SportBaseball", + /** + * Sport basketball icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + sportBasketball = "SportBasketball", + /** + * Sport hockey icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + sportHockey = "SportHockey", + /** + * Sport soccer icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + sportSoccer = "SportSoccer", + /** + * Square multiple icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + squareMultiple = "SquareMultiple", + /** + * Square shadow icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + squareShadow = "SquareShadow", + /** + * Squares nested icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + squaresNested = "SquaresNested", + /** + * Stack icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + stack = "Stack", + /** + * Stack star icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + stackStar = "StackStar", + /** + * Star icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + star = "Star", + /** + * Star filled icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + starFilled = "StarFilled", + /** + * Star half icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + starHalf = "StarHalf", + /** + * Star with 3 horizontal lines icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + starLineHorizontal3 = "StarLineHorizontal3", + /** + * Star one quarter icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + starOneQuarter = "StarOneQuarter", + /** + * Star three quarter icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + starThreeQuarter = "StarThreeQuarter", + /** + * Status icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + status = "Status", + /** + * Steps icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + steps = "Steps", + /** + * Stethoscope icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + stethoscope = "Stethoscope", + /** + * Sticker icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + sticker = "Sticker", + /** + * Storage icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + storage = "Storage", + /** + * Stream icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + stream = "Stream", + /** + * Stream input icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + streamInput = "StreamInput", + /** + * Stream input output icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + streamInputOutput = "StreamInputOutput", + /** + * Stream output icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + streamOutput = "StreamOutput", + /** + * Style guide icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + styleGuide = "StyleGuide", + /** + * Sub grid icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + subGrid = "SubGrid", + /** + * Subtitles icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + subtitles = "Subtitles", + /** + * Surface earbuds icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + surfaceEarbuds = "SurfaceEarbuds", + /** + * Surface hub icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + surfaceHub = "SurfaceHub", + /** + * Symbols icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + symbols = "Symbols", + /** + * Syringe icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + syringe = "Syringe", + /** + * System icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + system = "System", + /** + * Tab desktop icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + tabDesktop = "TabDesktop", + /** + * Tab InPrivate account icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + tabInprivateAccount = "TabInprivateAccount", + /** + * Table icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + table = "Table", + /** + * Table image icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + tableImage = "TableImage", + /** + * Table multiple icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + tableMultiple = "TableMultiple", + /** + * Tablet icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + tablet = "Tablet", + /** + * Tabs icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + tabs = "Tabs", + /** + * Tag icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + tag = "Tag", + /** + * Tag circle icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + tagCircle = "TagCircle", + /** + * Tag multiple icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + tagMultiple = "TagMultiple", + /** + * Target icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + target = "Target", + /** + * Target arrow icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + targetArrow = "TargetArrow", + /** + * Teddy icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + teddy = "Teddy", + /** + * Temperature icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + temperature = "Temperature", + /** + * Tent icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + tent = "Tent", + /** + * Tetris app icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + tetrisApp = "TetrisApp", + /** + * Textbox icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + textbox = "Textbox", + /** + * Text quote icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + textQuote = "TextQuote", + /** + * Thinking icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + thinking = "Thinking", + /** + * Thumb dislike icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + thumbDislike = "ThumbDislike", + /** + * Thumb like icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + thumbLike = "ThumbLike", + /** + * Ticket diagonal icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + ticketDiagonal = "TicketDiagonal", + /** + * Ticket horizontal icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + ticketHorizontal = "TicketHorizontal", + /** + * Time and weather icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + timeAndWeather = "TimeAndWeather", + /** + * Timeline icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + timeline = "Timeline", + /** + * Timer icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + timer = "Timer", + /** + * Toolbox icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + toolbox = "Toolbox", + /** + * Top speed icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + topSpeed = "TopSpeed", + /** + * Translate icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + translate = "Translate", + /** + * Transmission icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + transmission = "Transmission", + /** + * Tree deciduous icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + treeDeciduous = "TreeDeciduous", + /** + * Tree evergreen icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + treeEvergreen = "TreeEvergreen", + /** + * Trophy icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + trophy = "Trophy", + /** + * TV icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + tv = "Tv", + /** + * TV USB icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + tvUsb = "TvUsb", + /** + * Umbrella icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + umbrella = "Umbrella", + /** + * USB plug icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + usbPlug = "UsbPlug", + /** + * USB stick icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + usbStick = "UsbStick", + /** + * Vault icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + vault = "Vault", + /** + * Vehicle bicycle icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + vehicleBicycle = "VehicleBicycle", + /** + * Vehicle bus icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + vehicleBus = "VehicleBus", + /** + * Vehicle cab icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + vehicleCab = "VehicleCab", + /** + * Vehicle car icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + vehicleCar = "VehicleCar", + /** + * Vehicle car collision icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + vehicleCarCollision = "VehicleCarCollision", + /** + * Vehicle car profile left-to-right icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + vehicleCarProfileLtr = "VehicleCarProfileLtr", + /** + * Vehicle car profile right-to-left icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + vehicleCarProfileRtl = "VehicleCarProfileRtl", + /** + * Vehicle ship icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + vehicleShip = "VehicleShip", + /** + * Vehicle subway icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + vehicleSubway = "VehicleSubway", + /** + * Vehicle truck icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + vehicleTruck = "VehicleTruck", + /** + * Vehicle truck bag icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + vehicleTruckBag = "VehicleTruckBag", + /** + * Vehicle truck cube icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + vehicleTruckCube = "VehicleTruckCube", + /** + * Vehicle truck profile icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + vehicleTruckProfile = "VehicleTruckProfile", + /** + * Video icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + video = "Video", + /** + * Video 360 icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + video360 = "Video360", + /** + * Video chat icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + videoChat = "VideoChat", + /** + * Video clip icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + videoClip = "VideoClip", + /** + * Video clip multiple icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + videoClipMultiple = "VideoClipMultiple", + /** + * Video person icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + videoPerson = "VideoPerson", + /** + * Video recording icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + videoRecording = "VideoRecording", + /** + * Video security icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + videoSecurity = "VideoSecurity", + /** + * View desktop icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + viewDesktop = "ViewDesktop", + /** + * View desktop mobile icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + viewDesktopMobile = "ViewDesktopMobile", + /** + * Violin icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + violin = "Violin", + /** + * Virtual network icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + virtualNetwork = "VirtualNetwork", + /** + * Voicemail icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + voicemail = "Voicemail", + /** + * Vote icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + vote = "Vote", + /** + * Walkie talkie icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + walkieTalkie = "WalkieTalkie", + /** + * Wallet icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + wallet = "Wallet", + /** + * Wallet credit card icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + walletCreditCard = "WalletCreditCard", + /** + * Wallpaper icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + wallpaper = "Wallpaper", + /** + * Wand icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + wand = "Wand", + /** + * Warning icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + warning = "Warning", + /** + * Weather blowing snow icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + weatherBlowingSnow = "WeatherBlowingSnow", + /** + * Weather cloudy icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + weatherCloudy = "WeatherCloudy", + /** + * Weather drizzle icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + weatherDrizzle = "WeatherDrizzle", + /** + * Weather duststorm icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + weatherDuststorm = "WeatherDuststorm", + /** + * Weather fog icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + weatherFog = "WeatherFog", + /** + * Weather hail day icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + weatherHailDay = "WeatherHailDay", + /** + * Weather hail night icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + weatherHailNight = "WeatherHailNight", + /** + * Weather haze icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + weatherHaze = "WeatherHaze", + /** + * Weather moon icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + weatherMoon = "WeatherMoon", + /** + * Weather partly cloudy day icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + weatherPartlyCloudyDay = "WeatherPartlyCloudyDay", + /** + * Weather partly cloudy night icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + weatherPartlyCloudyNight = "WeatherPartlyCloudyNight", + /** + * Weather rain icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + weatherRain = "WeatherRain", + /** + * Weather rain showers day icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + weatherRainShowersDay = "WeatherRainShowersDay", + /** + * Weather rain showers night icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + weatherRainShowersNight = "WeatherRainShowersNight", + /** + * Weather rain snow icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + weatherRainSnow = "WeatherRainSnow", + /** + * Weather snow icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + weatherSnow = "WeatherSnow", + /** + * Weather snowflake icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + weatherSnowflake = "WeatherSnowflake", + /** + * Weather snow shower day icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + weatherSnowShowerDay = "WeatherSnowShowerDay", + /** + * Weather snow shower night icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + weatherSnowShowerNight = "WeatherSnowShowerNight", + /** + * Weather squalls icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + weatherSqualls = "WeatherSqualls", + /** + * Weather sunny high icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + weatherSunnyHigh = "WeatherSunnyHigh", + /** + * Weather sunny low icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + weatherSunnyLow = "WeatherSunnyLow", + /** + * Weather thunderstorm icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + weatherThunderstorm = "WeatherThunderstorm", + /** + * Web asset icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + webAsset = "WebAsset", + /** + * Whiteboard icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + whiteboard = "Whiteboard", + /** + * Wifi signal with 3 bars icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + wifi1 = "Wifi1", + /** + * Wifi signal with 2 bars icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + wifi2 = "Wifi2", + /** + * Window icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + window = "Window", + /** + * Window multiple icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + windowMultiple = "WindowMultiple", + /** + * Window wrench icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + windowWrench = "WindowWrench", + /** + * Wrench icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + wrench = "Wrench", + /** + * Wrench screwdriver icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + wrenchScrewdriver = "WrenchScrewdriver", + /** + * X-ray icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + xray = "Xray", + /** + * Yoga icon. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + yoga = "Yoga" + } + /** + * Represents a reference into `referencedValues`. One scenario for using this reference is to avoid duplicating cell value objects (such as an `EntityCellValue`). Define a cell value object once in `referencedValues`, and then refer to that cell value from many places by using a `ReferenceCellValue` where the duplicated value would have appeared. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface ReferenceCellValue { + /** + * Represents the type of this cell value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + type: CellValueType.reference | "Reference"; + /** + * Represents the value that would be returned by `Range.values` for a cell with this value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicValue?: boolean | number | string; + /** + * Represents the value that would be returned by `Range.valueTypes` for a cell with this value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicType?: RangeValueType | "Boolean" | "Double" | "Error" | "Empty" | "String"; + /** + * Represents the index into the `referencedValues` properties of cell values such as `EntityCellValue` and `ArrayCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + reference: number; + } + /** + * Represents a reference to the value which contains `referencedValues`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface RootReferenceCellValue { + /** + * Represents the type of this cell value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + type: ReferenceValueType.root | "Root"; + /** + * Represents the value that would be returned by `Range.values` for a cell with this value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicValue?: boolean | number | string; + /** + * Represents the value that would be returned by `Range.valueTypes` for a cell with this value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicType?: RangeValueType | "Boolean" | "Double" | "Error" | "Empty" | "String"; + } + /** + * Represents the types of the `ReferenceValue` object. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + enum ReferenceValueType { + /** + * Represents an `ArrayCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + array = "Array", + /** + * Represents an `EntityCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + entity = "Entity", + /** + * Represents a `RootReferenceCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + root = "Root", + /** + * Represents a `DoubleCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + double = "Double", + /** + * Represents a `StringCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + string = "String", + /** + * Represents a `BooleanCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + boolean = "Boolean" + } + /** + * Represents the value in a cell. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export type ReferencedValue = ArrayCellValue | EntityCellValue | RootReferenceCellValue | DoubleCellValue | StringCellValue | BooleanCellValue; + /** + * Represents the types of the `CellValue` object. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + enum CellValueType { + /** + * Represents an `ArrayCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + array = "Array", + /** + * Represents a `BooleanCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + boolean = "Boolean", + /** + * Represents a `DoubleCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + double = "Double", + /** + * Represents an `EntityCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + entity = "Entity", + /** + * Represents an `EmptyCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + empty = "Empty", + /** + * Represents an `ErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + error = "Error", + /** + * Represents a `FormattedNumberCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + formattedNumber = "FormattedNumber", + /** + * Represents a `FunctionCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + function = "Function", + /** + * Represents a `LinkedEntityCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + linkedEntity = "LinkedEntity", + /** + * Represents a `ReferenceCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + reference = "Reference", + /** + * Represents a `StringCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + string = "String", + /** + * Represents a `ValueTypeNotAvailableCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + notAvailable = "NotAvailable", + /** + * Represents a `WebImageCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + webImage = "WebImage" + } + /** + * Represents the value in a cell. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export type CellValue = (ArrayCellValue | BooleanCellValue | DoubleCellValue | EntityCellValue | EmptyCellValue | ErrorCellValue | FormattedNumberCellValue | FunctionCellValue | LinkedEntityCellValue | ReferenceCellValue | StringCellValue | ValueTypeNotAvailableCellValue | WebImageCellValue) & CellValueExtraProperties; + /** + * These extra properties may appear on a `CellValue` and provide information about that `CellValue`, but the extra properties are not part of the value in the cell. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface CellValueExtraProperties { + /** + * Represents whether this `CellValue` will be used to overwrite a cell. + * When false, APIs which would use this `CellValue` to overwrite a cell will instead ignore this value without throwing an error. + * The default value is true. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + writable?: boolean; + /** + * Represents an explanation about why `CellValue.writable` is specified as false. + * Note: This string is only available if `writable` is specified as false. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + writableNote?: string; + } + /** + * Represents the value and metadata of a property. The metadata applies to the property (and not the value), but it is combined with the value in this type. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export type CellValueAndPropertyMetadata = (CellValue) & EntityPropertyExtraProperties; + /** + * The attribution attributes object represents the set of details that can be used to describe where information came from, if the information comes from a public source. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface CellValueAttributionAttributes { + /** + * Represents a URL to the source of the `CellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + sourceAddress?: string; + /** + * Represents a name for the source of the `CellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + sourceText?: string; + /** + * Represents a URL to a license or source that describes how this property can be used. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + licenseAddress?: string; + /** + * Represents a name for the license that governs this property. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + licenseText?: string; + } + /** + * Represents the value of a cell containing a #BUSY! error. + * This type of error is used as a placeholder while the value of a cell is downloaded. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface PlaceholderErrorCellValue { + /** + * Represents the type of this cell value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + type: CellValueType.error | "Error"; + /** + * Represents the value that would be returned by `Range.values` for a cell with this value. + * When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale. + * When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicValue?: "#BUSY!" | string; + /** + * Represents the value that would be returned by `Range.valueTypes` for a cell with this value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicType?: RangeValueType.error | "Error"; + /** + * Represents the type of `ErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + errorType?: ErrorCellValueType.placeholder | "Placeholder"; + /** + * `PlaceholderErrorCellValue` is used during processing, while data is downloaded. The `target` property represents the data that is downloading, the data for which the `PlaceholderErrorCellValue` object is a placeholder. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + target: LinkedEntityCellValue | WebImageCellValue; + } + /** + * The provider attributes object represents the set of details used in card view to provide specified branding information for a `CellValue` type that supports provider attributes. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface CellValueProviderAttributes { + /** + * Represents the provider description property that is used in card view if no logo is specified. + * If a logo is specified, this will be used as tooltip text. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + description?: string; + /** + * Represents a URL used to download an image that will be used as a logo in card view. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + logoSourceAddress?: string; + /** + * Represents a URL that is the navigation target if the user clicks on the logo element in card view. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + logoTargetAddress?: string; + } + /** + * Metadata about a property in `EntityCellValue.properties`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface CellValuePropertyMetadata { + /** + * Represents which features this property is excluded from. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + excludeFrom?: CellValuePropertyMetadataExclusions; + /** + * Represents the sublabel for this property shown in card view. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + sublabel?: string; + /** + * Represents attribution information to describe the source and license requirements for using this property. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + attribution?: CellValueAttributionAttributes[]; + } + /** + * Represents the exclusion of a property in `EntityCellValue.properties` from features of Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface CellValuePropertyMetadataExclusions { + /** + * True represents that the property is excluded from the properties shown by card view. False and undefined represent the default behavior of including the property. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + cardView?: boolean; + /** + * True represents that the property is excluded from the properties shown by auto complete. False and undefined represent the default behavior of including the property. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + autoComplete?: boolean; + /** + * True represents that the property is excluded from the properties used to compare cell values during recalc. False and undefined represent the default behavior of including the property. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + calcCompare?: boolean; + /** + * True represents that the property is excluded from the properties which can be accessed via the FIELDVALUE function. False and undefined represent the default behavior of including the property. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + dotNotation?: boolean; + } + /** + * Represents types of #CONNECT! errors. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + enum ConnectErrorCellValueSubType { + /** + * An unknown type of error. Displays as error type #CONNECT! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + unknown = "Unknown", + /** + * An error caused by a problem with the service. Displays as error type #CONNECT! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + serviceError = "ServiceError", + /** + * An error caused by an issue with the external links. Displays as error type #CONNECT! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + externalLinks = "ExternalLinks", + /** + * An error caused by an external link to a non-cloud location, such as a link to an Excel file that is saved to a local computer instead of to a cloud location. Displays as error type #CONNECT! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + externalLinksNonCloudLocation = "ExternalLinksNonCloudLocation", + /** + * An error caused by no service connection for linked data types. Displays as error type #CONNECT! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + dataTypeNoConnection = "DataTypeNoConnection", + /** + * An error caused by an issue in the service for linked data types. Displays as error type #CONNECT! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + dataTypeServiceError = "DataTypeServiceError", + /** + * An error caused by missing content. Displays as error type #CONNECT! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + missingContent = "MissingContent", + /** + * An error caused by request throttling. Displays as error type #CONNECT! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + requestThrottle = "RequestThrottle", + /** + * An error caused by external links failing to refresh. Displays as error type #CONNECT! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + externalLinksFailedToRefresh = "ExternalLinksFailedToRefresh", + /** + * An error caused by a failure to access external links. Displays as error type #CONNECT! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + externalLinksAccessFailed = "ExternalLinksAccessFailed", + /** + * An error caused by a server error while resolving an external link. Displays as error type #CONNECT! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + externalLinksServerError = "ExternalLinksServerError", + /** + * An error caused by an invalid request while resolving an external link. Displays as error type #CONNECT! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + externalLinksInvalidRequest = "ExternalLinksInvalidRequest", + /** + * An error caused by a lack of authentication for external links. Displays as error type #CONNECT! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + externalLinksUnAuthenticated = "ExternalLinksUnAuthenticated", + /** + * An error caused by throttling from an external link host. Displays as error type #CONNECT! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + externalLinksThrottledByHost = "ExternalLinksThrottledByHost", + /** + * An error caused by an external link to a file which exceeds file size capacity. Displays as error type #CONNECT! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + externalLinksFileTooLarge = "ExternalLinksFileTooLarge", + /** + * An error caused by an outdated linked entity. Displays as error type #CONNECT! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + outdatedLinkedEntity = "OutdatedLinkedEntity", + /** + * An error caused by an error returned from the server. Displays as error type #CONNECT! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + genericServerError = "GenericServerError" + } + /** + * Represents the value of a cell containing a #CONNECT! error. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface ConnectErrorCellValue { + /** + * Represents the type of this cell value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + type: CellValueType.error | "Error"; + /** + * Represents the value that would be returned by `Range.values` for a cell with this value. + * When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale. + * When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicValue?: "#CONNECT!" | string; + /** + * Represents the value that would be returned by `Range.valueTypes` for a cell with this value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicType?: RangeValueType.error | "Error"; + /** + * Represents the type of `ErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + errorType?: ErrorCellValueType.connect | "Connect"; + /** + * Represents the type of `ConnectErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + errorSubType?: ConnectErrorCellValueSubType | "Unknown" | "ServiceError" | "ExternalLinks" | "ExternalLinksNonCloudLocation" | "DataTypeNoConnection" | "DataTypeServiceError" | "MissingContent" | "RequestThrottle" | "ExternalLinksFailedToRefresh" | "ExternalLinksAccessFailed" | "ExternalLinksServerError" | "ExternalLinksInvalidRequest" | "ExternalLinksUnAuthenticated" | "ExternalLinksThrottledByHost" | "ExternalLinksFileTooLarge" | "OutdatedLinkedEntity" | "GenericServerError"; + } + /** + * Represents the value of a cell containing a #DIV/0! error. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface Div0ErrorCellValue { + /** + * Represents the type of this cell value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + type: CellValueType.error | "Error"; + /** + * Represents the value that would be returned by `Range.values` for a cell with this value. + * When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale. + * When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicValue?: "#DIV/0!" | string; + /** + * Represents the value that would be returned by `Range.valueTypes` for a cell with this value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicType?: RangeValueType.error | "Error"; + /** + * Represents the type of `ErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + errorType?: ErrorCellValueType.div0 | "Div0"; + } + /** + * Represents the value of a cell containing a double. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface DoubleCellValue { + /** + * Represents the type of this cell value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + type: CellValueType.double | "Double"; + /** + * Represents the value that would be returned by `Range.values` for a cell with this value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicValue: number; + /** + * Represents the value that would be returned by `Range.valueTypes` for a cell with this value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicType?: RangeValueType.double | "Double"; + /** + * Returns the number format string that is used to display this value. + * When accessed through a `valuesAsJson` property, this number format string is in the en-US locale. When accessed through a `valuesAsJsonLocal` property, this number format is in the user's display locale. + * Number format strings must conform to Excel guidelines. + * To learn more, see {@link https://support.microsoft.com/office/c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5 | Review guidelines for customizing a number format}. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + numberFormat?: string; + /** + * Represents additional properties of this double value. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + properties?: { + [key: string]: EntityPropertyType; + }; + /** + * Represents layout information for views of this double value. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + layouts?: BasicViewLayouts; + /** + * Represents information that describes the service that provided the data in this `DoubleCellValue`. + * This information can be used for branding in card view. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + provider?: CellValueProviderAttributes; + /** + * Represents the cell values which are referenced within `DoubleCellValue.properties`. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + referencedValues?: ReferencedValue[]; + } + /** + * Represents the value of a cell that's empty and has no formulas or data. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface EmptyCellValue { + /** + * Represents the type of this cell value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + type: CellValueType.empty | "Empty"; + /** + * Represents the value that would be returned by `Range.values` for a cell with this value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicValue?: ""; + /** + * Represents the value that would be returned by `Range.valueTypes` for a cell with this value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicType?: RangeValueType.empty | "Empty"; + } + /** + * Represents the value of a property. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export type EntityPropertyType = CellValueAndPropertyMetadata | CellValue; + /** + * Properties used by `CellValueAndPropertyMetadata`. These properties refer to the metadata and not to a `CellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface EntityPropertyExtraProperties { + /** + * Represents metadata about the property. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + propertyMetadata?: CellValuePropertyMetadata; + } + /** + * Represents a set of properties without a schema or defined structure. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface EntityCellValue { + /** + * Represents the type of this cell value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + type: CellValueType.entity | ReferenceValueType.entity | "Entity"; + /** + * Represents the value that would be returned by `Range.values` for a cell with this value. + * When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale. + * When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicValue?: "#VALUE!" | string; + /** + * Represents the value that would be returned by `Range.valueTypes` for a cell with this value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicType?: RangeValueType.error | "Error"; + /** + * Represents the text shown when a cell with this value is rendered. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + text?: string; + /** + * Represents the properties of this entity and their metadata. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + properties?: { + [key: string]: EntityPropertyType; + }; + /** + * Represents layout information for views of this entity. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + layouts?: EntityViewLayouts; + /** + * Represents information that describes the service that provided the data in this `EntityCellValue`. + * This information can be used for branding in entity cards. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + provider?: CellValueProviderAttributes; + /** + * Represents the cell values which are referenced within `EntityCellValue.properties`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + referencedValues?: ReferencedValue[]; + } + /** + * Represents layout information for various views of the entity. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface EntityViewLayouts { + /** + * Represents the layout of this entity in card view. + * If the `CardLayout` object does not have a layout property, it is assumed to be "Entity". + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + card?: CardLayout; + /** + * Represents the layout used when there is limited space to represent the entity. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + compact?: CompactLayout; + } + /** + * Represents a card layout that is best used for an entity. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface EntityCardLayout extends CardLayoutStandardProperties { + /** + * Represents the type of this layout. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + layout?: "Entity"; + } + /** + * Represents the types of the `ErrorCellValue` object. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + enum ErrorCellValueType { + /** + * Represents a `BlockedErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + blocked = "Blocked", + /** + * Represents a `BusyErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + busy = "Busy", + /** + * Represents a `CalcErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + calc = "Calc", + /** + * Represents a `ConnectErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + connect = "Connect", + /** + * Represents a `Div0ErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + div0 = "Div0", + /** + * Represents an `ExternalErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + external = "External", + /** + * Represents a `FieldErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + field = "Field", + /** + * Represents a `GettingDataErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + gettingData = "GettingData", + /** + * Represents a `NotAvailableErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + notAvailable = "NotAvailable", + /** + * Represents a `NameErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + name = "Name", + /** + * Represents a `NullErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + null = "Null", + /** + * Represents a `NumErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + num = "Num", + /** + * Represents a `PlaceholderErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + placeholder = "Placeholder", + /** + * Represents a `RefErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + ref = "Ref", + /** + * Represents a `SpillErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + spill = "Spill", + /** + * Represents a `ValueErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + value = "Value" + } + /** + * Represents a cell value which contains an error. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export type ErrorCellValue = BlockedErrorCellValue | BusyErrorCellValue | CalcErrorCellValue | ConnectErrorCellValue | Div0ErrorCellValue | ExternalErrorCellValue | FieldErrorCellValue | GettingDataErrorCellValue | NotAvailableErrorCellValue | NameErrorCellValue | NullErrorCellValue | NumErrorCellValue | PlaceholderErrorCellValue | RefErrorCellValue | SpillErrorCellValue | ValueErrorCellValue; + /** + * Represents types of #EXTERNAL! errors. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + enum ExternalErrorCellValueSubType { + /** + * An unknown type of error. Displays as error type #EXTERNAL! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + unknown = "Unknown" + } + /** + * Represents the value of a cell containing an #EXTERNAL! error. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface ExternalErrorCellValue { + /** + * Represents the type of this cell value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + type: CellValueType.error | "Error"; + /** + * Represents the value that would be returned by `Range.values` for a cell with this value. + * When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale. + * When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicValue?: "#EXTERNAL!" | string; + /** + * Represents the value that would be returned by `Range.valueTypes` for a cell with this value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicType?: RangeValueType.error | "Error"; + /** + * Represents the type of `ErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + errorType?: ErrorCellValueType.external | "External"; + /** + * Represents the type of `ExternalErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + errorSubType?: ExternalErrorCellValueSubType | "Unknown"; + } + /** + * Represents types of #FIELD! errors. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + enum FieldErrorCellValueSubType { + /** + * An unknown type of error. Displays as error type #FIELD! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + unknown = "Unknown", + /** + * An error caused by a missing file. In this case, the RichValueWebImageValue.xml file is missing from the metro package. Displays as error type #FIELD! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + webImageMissingFilePart = "WebImageMissingFilePart", + /** + * An error caused by an error from a data provider. Displays as error type #FIELD! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + dataProviderError = "DataProviderError", + /** + * 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. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + richValueRelMissingFilePart = "RichValueRelMissingFilePart" + } + /** + * Represents the value of a cell containing a #FIELD! error. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface FieldErrorCellValue { + /** + * Represents the type of this cell value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + type: CellValueType.error | "Error"; + /** + * Represents the value that would be returned by `Range.values` for a cell with this value. + * When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale. + * When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicValue?: "#FIELD!" | string; + /** + * Represents the value that would be returned by `Range.valueTypes` for a cell with this value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicType?: RangeValueType.error | "Error"; + /** + * Represents the type of `ErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + errorType?: ErrorCellValueType.field | "Field"; + /** + * Represents the type of `FieldErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + errorSubType?: FieldErrorCellValueSubType | "Unknown" | "WebImageMissingFilePart" | "DataProviderError" | "RichValueRelMissingFilePart"; + /** + * Represents the field which was not found by FIELDVALUE. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + fieldName?: string; + } + /** + * Represents the value of a cell containing a number with a format string. Number format strings must conform to Excel guidelines. To learn more, see {@link https://support.microsoft.com/office/c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5 | Review guidelines for customizing a number format}. + * In this scenario, the format is applied to the value and not to the cell, so the value retains its format string throughout calculation. + * + * @deprecated As of [Api set: ExcelApi 1.19], use {@link https://learn.microsoft.com/javascript/api/excel/excel.doublecellvalue | DoubleCellValue} instead. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface FormattedNumberCellValue { + /** + * Represents the type of this cell value. + * + * @deprecated Deprecated since [Api set: ExcelApi 1.19]. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + type: CellValueType.formattedNumber | "FormattedNumber"; + /** + * Represents the value that would be returned by `Range.values` for a cell with this value. + * + * @deprecated Deprecated since [Api set: ExcelApi 1.19]. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicValue: number; + /** + * Represents the value that would be returned by `Range.valueTypes` for a cell with this value. + * + * @deprecated Deprecated since [Api set: ExcelApi 1.19]. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicType?: RangeValueType.double | "Double"; + /** + * Returns the number format string that is used to display this value. + * When accessed through a `valuesAsJson` property, this number format string is in the en-US locale. When accessed through a `valuesAsJsonLocal` property, this number format is in the user's display locale. + * Number format strings must conform to Excel guidelines. + * To learn more, see {@link https://support.microsoft.com/office/c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5 | Review guidelines for customizing a number format}. + * + * @deprecated Deprecated since [Api set: ExcelApi 1.19]. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + numberFormat: string; + } + /** + * Represents the value of a cell containing a #GETTING_DATA error. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface GettingDataErrorCellValue { + /** + * Represents the type of this cell value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + type: CellValueType.error | "Error"; + /** + * Represents the value that would be returned by `Range.values` for a cell with this value. + * When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale. + * When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicValue?: "#GETTING_DATA" | string; + /** + * Represents the value that would be returned by `Range.valueTypes` for a cell with this value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicType?: RangeValueType.error | "Error"; + /** + * Represents the type of `ErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + errorType?: ErrorCellValueType.gettingData | "GettingData"; + } + /** + * Represents a request to `@linkedEntityLoadService` custom function to load `LinkedEntityCellValue` objects. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This interface isn't supported in Excel on the web. + */ + export interface LinkedEntityLoadServiceRequest { + /** + * Represents the domain specific to the service used to create the `LinkedEntityCellValue` objects. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + domainId: string; + /** + * Represents the entity IDs and cultures of the `LinkedEntityCellValue` objects to load. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + entities: LinkedEntityIdCulture[]; + } + /** + * Represents the result of a request to `@linkedEntityLoadService` custom function to load `LinkedEntityCellValue` objects. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + export interface LinkedEntityLoadServiceResult { + /** + * Represents the loaded `LinkedEntityCellValue` objects. The loaded objects must be returned in the same order as the `entities` property of `LinkedEntityLoadServiceRequest`. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + entities: LinkedEntityCellValue[]; + } + /** + * The linked entity ID object represents a set of properties that describes a service and culture for locating this service defined value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface LinkedEntityId { + /** + * Represents which service was used to create the `CellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + serviceId: number; + /** + * Represents a domain specific to a service used to create the `CellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + domainId?: string; + /** + * Represents an identifier specific to a service used to create the `CellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + entityId: string; + /** + * Represents which language culture was used to create this `CellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + culture: string; + } + /** + * Represents the entity ID and culture for a `LinkedEntityCellValue` object. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This interface isn't supported in Excel on the web. + */ + export interface LinkedEntityIdCulture { + /** + * Represents the identifier specific to a service used to create the `LinkedEntityCellValue` object. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + entityId: string; + /** + * Represents the language culture used to create the `LinkedEntityCellValue` object. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + culture: string; + } + /** + * Represents a value whose properties derive from a service. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface LinkedEntityCellValue { + /** + * Represents the type of this cell value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + type: CellValueType.linkedEntity | "LinkedEntity"; + /** + * Represents the value that would be returned by `Range.values` for a cell with this value. + * When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale. + * When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicValue?: "#VALUE!" | string; + /** + * Represents the value that would be returned by `Range.valueTypes` for a cell with this value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicType?: RangeValueType.error | "Error"; + /** + * Represents the service source that provided the information in this value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + id: LinkedEntityId; + /** + * Represents the text shown when a cell with this value is rendered. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + text?: string; + /** + * Represents the properties of this linked entity and their metadata. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + properties?: { + [key: string]: EntityPropertyType; + }; + /** + * Represents layout information for views of this linked entity. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + layouts?: EntityViewLayouts; + /** + * Represents information that describes the service that provided data in this `LinkedEntityCellValue`. + * This information can be used for branding in entity cards. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + provider?: CellValueProviderAttributes; + } + /** + * Represents the value of a cell containing a #N/A error. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface NotAvailableErrorCellValue { + /** + * Represents the type of this cell value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + type: CellValueType.error | "Error"; + /** + * Represents the value that would be returned by `Range.values` for a cell with this value. + * When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale. + * When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicValue?: "#N/A" | string; + /** + * Represents the value that would be returned by `Range.valueTypes` for a cell with this value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicType?: RangeValueType.error | "Error"; + /** + * Represents the type of `ErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + errorType?: ErrorCellValueType.notAvailable | "NotAvailable"; + } + /** + * Represents the value of a cell containing a #NAME? error. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface NameErrorCellValue { + /** + * Represents the type of this cell value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + type: CellValueType.error | "Error"; + /** + * Represents the value that would be returned by `Range.values` for a cell with this value. + * When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale. + * When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicValue?: "#NAME?" | string; + /** + * Represents the value that would be returned by `Range.valueTypes` for a cell with this value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicType?: RangeValueType.error | "Error"; + /** + * Represents the type of `ErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + errorType?: ErrorCellValueType.name | "Name"; + } + /** + * Represents the value of a cell containing a #NULL! error. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface NullErrorCellValue { + /** + * Represents the type of this cell value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + type: CellValueType.error | "Error"; + /** + * Represents the value that would be returned by `Range.values` for a cell with this value. + * When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale. + * When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicValue?: "#NULL!" | string; + /** + * Represents the value that would be returned by `Range.valueTypes` for a cell with this value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicType?: RangeValueType.error | "Error"; + /** + * Represents the type of `ErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + errorType?: ErrorCellValueType.null | "Null"; + } + /** + * Represents types of #NUM! errors. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + enum NumErrorCellValueSubType { + /** + * An unknown type of error. Displays as error type #NUM! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + unknown = "Unknown", + /** + * An error caused by a cell's formula having an array parameter with too many rows or columns. The maximum number of rows and columns in an array parameter is 1048576. Displays as error type #NUM! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + arrayTooLarge = "ArrayTooLarge" + } + /** + * Represents the value of a cell containing a #NUM! error. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface NumErrorCellValue { + /** + * Represents the type of this cell value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + type: CellValueType.error | "Error"; + /** + * Represents the value that would be returned by `Range.values` for a cell with this value. + * When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale. + * When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicValue?: "#NUM!" | string; + /** + * Represents the value that would be returned by `Range.valueTypes` for a cell with this value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicType?: RangeValueType.error | "Error"; + /** + * Represents the type of `ErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + errorType?: ErrorCellValueType.num | "Num"; + /** + * Represents the type of `NumErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + errorSubType?: NumErrorCellValueSubType | "Unknown" | "ArrayTooLarge"; + /** + * Represents the name of the function causing the error. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + functionName?: string; + } + /** + * Represents types of #REF! errors. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + enum RefErrorCellValueSubType { + /** + * An unknown type of error. Displays as error type #REF! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + unknown = "Unknown", + /** + * An error caused by structured references from the linked workbook. Displays as error type #REF! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + externalLinksStructuredRef = "ExternalLinksStructuredRef", + /** + * An error caused by dynamic array references from the linked workbook. Displays as error type #REF! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + externalLinksCalculatedRef = "ExternalLinksCalculatedRef" + } + /** + * Represents the value of a cell containing a #REF! error. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface RefErrorCellValue { + /** + * Represents the type of this cell value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + type: CellValueType.error | "Error"; + /** + * Represents the value that would be returned by `Range.values` for a cell with this value. + * When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale. + * When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicValue?: "#REF!" | string; + /** + * Represents the value that would be returned by `Range.valueTypes` for a cell with this value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicType?: RangeValueType.error | "Error"; + /** + * Represents the type of `ErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + errorType?: ErrorCellValueType.ref | "Ref"; + /** + * Represents the type of `RefErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + errorSubType?: RefErrorCellValueSubType | "Unknown" | "ExternalLinksStructuredRef" | "ExternalLinksCalculatedRef"; + } + /** + * Represents types of #SPILL! errors. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + enum SpillErrorCellValueSubType { + /** + * An unknown type of error. Displays as error type #SPILL! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + unknown = "Unknown", + /** + * An error caused by a dynamic array attempting to spill data into a cell that isn't empty. Displays as error type #SPILL! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + collision = "Collision", + /** + * An error caused by a dynamic array formula that can't be evaluated in a single calculation. Displays as error type #SPILL! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + indeterminateSize = "IndeterminateSize", + /** + * An error caused by a dynamic array attempting to spill over the edge of the worksheet. Displays as error type #SPILL! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + worksheetEdge = "WorksheetEdge", + /** + * An error caused by insufficient memory when attempting to calculate a dynamic array formula. Displays as error type #SPILL! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + outOfMemoryWhileCalc = "OutOfMemoryWhileCalc", + /** + * An error caused by entering a dynamic array formula in a table. Displays as error type #SPILL! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + table = "Table", + /** + * An error caused by a merged cell blocking a dynamic array. Displays as error type #SPILL! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + mergedCell = "MergedCell" + } + /** + * Represents the value of a cell containing a #SPILL! error. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface SpillErrorCellValue { + /** + * Represents the type of this cell value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + type: CellValueType.error | "Error"; + /** + * Represents the value that would be returned by `Range.values` for a cell with this value. + * When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale. + * When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicValue?: "#SPILL!" | string; + /** + * Represents the value that would be returned by `Range.valueTypes` for a cell with this value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicType?: RangeValueType.error | "Error"; + /** + * Represents the type of `ErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + errorType?: ErrorCellValueType.spill | "Spill"; + /** + * Represents the type of `SpillErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + errorSubType?: SpillErrorCellValueSubType | "Unknown" | "Collision" | "IndeterminateSize" | "WorksheetEdge" | "OutOfMemoryWhileCalc" | "Table" | "MergedCell"; + /** + * Represents the number of rows that would spill if there were no #SPILL! error. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + rowCount?: number; + /** + * Represents the number of columns that would spill if there were no #SPILL! error. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + columnCount?: number; + } + /** + * Represents the value of a cell containing a string. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface StringCellValue { + /** + * Represents the type of this cell value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + type: CellValueType.string | "String"; + /** + * Represents the value that would be returned by `Range.values` for a cell with this value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicValue: string; + /** + * Represents the value that would be returned by `Range.valueTypes` for a cell with this value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicType?: RangeValueType.string | "String"; + /** + * Represents additional properties of this string value. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + properties?: { + [key: string]: EntityPropertyType; + }; + /** + * Represents layout information for views of this string value. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + layouts?: BasicViewLayouts; + /** + * Represents information that describes the service that provided the data in this `StringCellValue`. + * This information can be used for branding in card view. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + provider?: CellValueProviderAttributes; + /** + * Represents the cell values which are referenced within `StringCellValue.properties`. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + referencedValues?: ReferencedValue[]; + } + /** + * Represents types of #VALUE! errors. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + enum ValueErrorCellValueSubType { + /** + * An unknown type of error. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + unknown = "Unknown", + /** + * An error caused by a column_index_num parameter of VLOOKUP of less than 1. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + vlookupColumnIndexLessThanOne = "VlookupColumnIndexLessThanOne", + /** + * An error caused by VLOOKUP not finding its lookup_value parameter. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + vlookupResultNotFound = "VlookupResultNotFound", + /** + * An error caused by a row_index_num parameter of HLOOKUP of less than 1. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + hlookupRowIndexLessThanOne = "HlookupRowIndexLessThanOne", + /** + * An error caused by HLOOKUP not finding its lookup_value parameter. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + hlookupResultNotFound = "HlookupResultNotFound", + /** + * An error caused by encountering a string where a number was expected, and that string not being coercible to a number. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + coerceStringToNumberInvalid = "CoerceStringToNumberInvalid", + /** + * An error caused by encountering a string where a boolean was expected, and that string not being coercible to a boolean. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + coerceStringToBoolInvalid = "CoerceStringToBoolInvalid", + /** + * An error caused by conversion of a string to a type other than a boolean or number. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + coerceStringToInvalidType = "CoerceStringToInvalidType", + /** + * An error caused by SUBARRAY missing a start row. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + subArrayStartRowMissingEndRowNot = "SubArrayStartRowMissingEndRowNot", + /** + * An error caused by SUBARRAY missing a start column. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + subArrayStartColumnMissingEndColumnNot = "SubArrayStartColumnMissingEndColumnNot", + /** + * An error caused by a `WebImageValue` with an invalid URL. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + invalidImageUrl = "InvalidImageUrl", + /** + * An error caused by STOCKHISTORY having a date range which only contains days that don't have stock trading. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + stockHistoryNonTradingDays = "StockHistoryNonTradingDays", + /** + * An error caused by passing a stock parameter which is not a stock to STOCKHISTORY. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + stockHistoryNotAStock = "StockHistoryNotAStock", + /** + * An error caused by passing an invalid date to STOCKHISTORY. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + stockHistoryInvalidDate = "StockHistoryInvalidDate", + /** + * An error caused by passing an end_date parameter that precedes the start_date parameter to STOCKHISTORY. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + stockHistoryEndBeforeStart = "StockHistoryEndBeforeStart", + /** + * An error caused by passing a future start_date parameter to STOCKHISTORY. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + stockHistoryStartInFuture = "StockHistoryStartInFuture", + /** + * An error caused by invalid interval or header parameters for STOCKHISTORY. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + stockHistoryInvalidEnum = "StockHistoryInvalidEnum", + /** + * An error caused by STOCKHISTORY parameters that request only the date and no other fields. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + stockHistoryOnlyDateRequested = "StockHistoryOnlyDateRequested", + /** + * An error caused by STOCKHISTORY not finding the history of the specified stock. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + stockHistoryNotFound = "StockHistoryNotFound", + /** + * An error caused by passing the incorrect number of parameters to a lambda value. Displays as error type #VALUE! in Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + lambdaWrongParamCount = "LambdaWrongParamCount" + } + /** + * Represents the value of a cell containing a #VALUE! error. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface ValueErrorCellValue { + /** + * Represents the type of this cell value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + type: CellValueType.error | "Error"; + /** + * Represents the value that would be returned by `Range.values` for a cell with this value. + * When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale. + * When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicValue?: "#VALUE!" | string; + /** + * Represents the value that would be returned by `Range.valueTypes` for a cell with this value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicType?: RangeValueType.error | "Error"; + /** + * Represents the type of `ErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + errorType?: ErrorCellValueType.value | "Value"; + /** + * Represents the type of `ValueErrorCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + errorSubType?: ValueErrorCellValueSubType | "Unknown" | "VlookupColumnIndexLessThanOne" | "VlookupResultNotFound" | "HlookupRowIndexLessThanOne" | "HlookupResultNotFound" | "CoerceStringToNumberInvalid" | "CoerceStringToBoolInvalid" | "CoerceStringToInvalidType" | "SubArrayStartRowMissingEndRowNot" | "SubArrayStartColumnMissingEndColumnNot" | "InvalidImageUrl" | "StockHistoryNonTradingDays" | "StockHistoryNotAStock" | "StockHistoryInvalidDate" | "StockHistoryEndBeforeStart" | "StockHistoryStartInFuture" | "StockHistoryInvalidEnum" | "StockHistoryOnlyDateRequested" | "StockHistoryNotFound" | "LambdaWrongParamCount"; + } + /** + * Represents the value of a cell containing a type of value which cannot be serialized. + * For example, an #UNKNOWN! error which represents a type of rich value not known to this version of Excel. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface ValueTypeNotAvailableCellValue { + /** + * Represents the type of this cell value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + type: CellValueType.notAvailable | "NotAvailable"; + /** + * Represents the value that would be returned by `Range.values` for a cell with this value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicValue: boolean | number | string; + /** + * Represents the value that would be returned by `Range.valueTypes` for a cell with this value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicType: RangeValueType | "Boolean" | "Double" | "Error" | "Empty" | "String"; + } + /** + * Represents the value of a cell containing an image downloaded from the internet. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + export interface WebImageCellValue { + /** + * Represents the type of this cell value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + type: CellValueType.webImage | "WebImage"; + /** + * Represents the value that would be returned by `Range.values` for a cell with this value. + * When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale. + * When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicValue?: "#VALUE!" | string; + /** + * Represents the value that would be returned by `Range.valueTypes` for a cell with this value. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + basicType?: RangeValueType.error | "Error"; + /** + * Represents the URL from which the image will be downloaded. + * This image must be hosted on a server that supports HTTPS. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + address: string; + /** + * Represents the alternate text that can be used in accessibility scenarios to describe what the image represents. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + altText?: string; + /** + * Represents the URL of a webpage with images that are considered related to this `WebImageCellValue`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + relatedImagesAddress?: string; + /** + * Represents attribution information to describe the source and license requirements for using this image. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + attribution?: CellValueAttributionAttributes[]; + /** + * Represents information that describes the entity or individual who provided the image. + * This information can be used for branding in image cards. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + provider?: CellValueProviderAttributes; + } + /** + * + * Represents which cell properties to load, when used as part of a "range.getCellProperties" method. + * + * [Api set: ExcelApi 1.9] + */ + export interface CellPropertiesLoadOptions { + /** + * + * Specifies whether to load on the `address` property. + * + * [Api set: ExcelApi 1.9] + */ + address?: boolean; + /** + * + * Specifies whether to load on the `addressLocal` property. + * + * [Api set: ExcelApi 1.9] + */ + addressLocal?: boolean; + /** + * + * Specifies whether to load on the `format` property. + * + * [Api set: ExcelApi 1.9] + */ + format?: Excel.CellPropertiesFormatLoadOptions; + /** + * + * Specifies whether to load on the `hidden` property. + * + * [Api set: ExcelApi 1.9] + */ + hidden?: boolean; + /** + * + * Specifies whether to load on the `hyperlink` property. + * + * [Api set: ExcelApi 1.9] + */ + hyperlink?: boolean; + /** + * + * Specifies whether to load on the `style` property. + * + * [Api set: ExcelApi 1.9] + */ + style?: boolean; + /** + * Specifies whether to load on the `textRuns` property. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + textRuns?: boolean; + } + /** + * + * Represents which row properties to load, when used as part of a "range.getRowProperties" method. + * + * [Api set: ExcelApi 1.9] + */ + export interface RowPropertiesLoadOptions extends CellPropertiesLoadOptions { + /** + * + * Specifies whether to load on the `rowHidden` property. + * + * [Api set: ExcelApi 1.9] + */ + rowHidden?: boolean; + /** + * + * Specifies whether to load on the `rowIndex` property. + * + * [Api set: ExcelApi 1.9] + */ + rowIndex?: boolean; + /** + * + * Specifies whether to load on the `format` property. + * + * [Api set: ExcelApi 1.9] + */ + format?: Excel.CellPropertiesFormatLoadOptions & { + rowHeight?: boolean; + }; + } + /** + * + * Represents which column properties to load, when used as part of a "range.getColumnProperties" method. + * + * [Api set: ExcelApi 1.9] + */ + export interface ColumnPropertiesLoadOptions extends CellPropertiesLoadOptions { + /** + * + * Specifies whether to load on the `columnIndex` property. + * + * [Api set: ExcelApi 1.9] + */ + columnIndex?: boolean; + /** + * + * Specifies whether to load on the `columnHidden` property. + * + * [Api set: ExcelApi 1.9] + */ + columnHidden?: boolean; + /** + * + * Specifies whether to load on the `format` property. + * + * [Api set: ExcelApi 1.9] + */ + format?: Excel.CellPropertiesFormatLoadOptions & { + columnWidth?: boolean; + }; + } + /** + * + * Represents which properties to load on the format object. + * + * [Api set: ExcelApi 1.9] + */ + export interface CellPropertiesFormatLoadOptions { + /** + * + * Specifies whether to load on the `autoIndent` property. + * + * [Api set: ExcelApi 1.9] + */ + autoIndent?: boolean; + /** + * + * Specifies whether to load on the `borders` property. + * + * [Api set: ExcelApi 1.9] + */ + borders?: Excel.CellPropertiesBorderLoadOptions; + /** + * + * Specifies whether to load on the `fill` property. + * + * [Api set: ExcelApi 1.9] + */ + fill?: Excel.CellPropertiesFillLoadOptions; + /** + * + * Specifies whether to load on the `font` property. + * + * [Api set: ExcelApi 1.9] + */ + font?: Excel.CellPropertiesFontLoadOptions; + /** + * + * Specifies whether to load on the `horizontalAlignment` property. + * + * [Api set: ExcelApi 1.9] + */ + horizontalAlignment?: boolean; + /** + * + * Specifies whether to load on the `indentLevel` property. + * + * [Api set: ExcelApi 1.9] + */ + indentLevel?: boolean; + /** + * + * Specifies whether to load on the `protection` property. + * + * [Api set: ExcelApi 1.9] + */ + protection?: boolean; + /** + * + * Specifies whether to load on the `readingOrder` property. + * + * [Api set: ExcelApi 1.9] + */ + readingOrder?: boolean; + /** + * + * Specifies whether to load on the `shrinkToFit` property. + * + * [Api set: ExcelApi 1.9] + */ + shrinkToFit?: boolean; + /** + * + * Specifies whether to load on the `textOrientation` property. + * + * [Api set: ExcelApi 1.9] + */ + textOrientation?: boolean; + /** + * + * Specifies whether to load on the `useStandardHeight` property. + * + * [Api set: ExcelApi 1.9] + */ + useStandardHeight?: boolean; + /** + * + * Specifies whether to load on the `useStandardWidth` property. + * + * [Api set: ExcelApi 1.9] + */ + useStandardWidth?: boolean; + /** + * + * Specifies whether to load on the `verticalAlignment` property. + * + * [Api set: ExcelApi 1.9] + */ + verticalAlignment?: boolean; + /** + * + * Specifies whether to load on the `wrapText` property. + * + * [Api set: ExcelApi 1.9] + */ + wrapText?: boolean; + } + /** + * + * Represents the input parameter of setCellProperties. + * + * [Api set: ExcelApi 1.9] + */ + export interface SettableCellProperties { + /** + * + * Represents the `format` property. + * + * [Api set: ExcelApi 1.9] + */ + format?: Excel.CellPropertiesFormat; + /** + * + * Represents the `hyperlink` property. + * + * [Api set: ExcelApi 1.9] + */ + hyperlink?: Excel.RangeHyperlink; + /** + * + * Represents the `style` property. + * + * [Api set: ExcelApi 1.9] + */ + style?: string; + /** + * Represents the `textRuns` property. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + textRuns?: RangeTextRun[]; + } + /** + * + * Represents the returned properties of getCellProperties. + * + * [Api set: ExcelApi 1.9] + */ + export interface CellProperties extends SettableCellProperties { + /** + * + * Represents the `address` property. + * + * [Api set: ExcelApi 1.9] + */ + address?: string; + /** + * + * Represents the `addressLocal` property. + * + * [Api set: ExcelApi 1.9] + */ + addressLocal?: string; + /** + * + * Represents the `hidden` property. + * + * [Api set: ExcelApi 1.9] + */ + hidden?: boolean; + } + /** + * + * Represents the input parameter of setRowProperties. + * + * [Api set: ExcelApi 1.9] + */ + export interface SettableRowProperties extends SettableCellProperties { + /** + * + * Represents the `rowHidden` property. + * + * [Api set: ExcelApi 1.9] + */ + rowHidden?: boolean; + /** + * + * Represents the `format` property. + * + * [Api set: ExcelApi 1.9] + */ + format?: Excel.CellPropertiesFormat & { + rowHeight?: number; + }; + } + /** + * + * Represents the returned properties of getRowProperties. + * + * [Api set: ExcelApi 1.9] + */ + export interface RowProperties extends SettableRowProperties { + /** + * + * Represents the `rowIndex` property. + * + * [Api set: ExcelApi 1.9] + */ + rowIndex?: number; + /** + * + * Represents the `address` property. + * + * [Api set: ExcelApi 1.9] + */ + address?: string; + /** + * + * Represents the `addressLocal` property. + * + * [Api set: ExcelApi 1.9] + */ + addressLocal?: string; + } + /** + * + * Represents the input parameter of setColumnProperties. + * + * [Api set: ExcelApi 1.9] + */ + export interface SettableColumnProperties extends SettableCellProperties { + /** + * + * Represents the `columnHidden` property. + * + * [Api set: ExcelApi 1.9] + */ + columnHidden?: boolean; + /** + * + * Represents the `format` property. + * + * [Api set: ExcelApi 1.9] + */ + format?: Excel.CellPropertiesFormat & { + columnWidth?: number; + }; + } + /** + * + * Represents the returned properties of getColumnProperties. + * + * [Api set: ExcelApi 1.9] + */ + export interface ColumnProperties extends SettableColumnProperties { + /** + * + * Represents the `columnIndex` property. + * + * [Api set: ExcelApi 1.9] + */ + columnIndex?: number; + /** + * + * Represents the `address` property. + * + * [Api set: ExcelApi 1.9] + */ + address?: string; + /** + * + * Represents the `addressLocal` property. + * + * [Api set: ExcelApi 1.9] + */ + addressLocal?: string; + } + /** + * + * Represents the returned format properties of getCellProperties or format input parameter of setCellProperties. + * + * [Api set: ExcelApi 1.9] + */ + export interface CellPropertiesFormat { + /** + * + * Represents the `autoIndent` property. + * + * [Api set: ExcelApi 1.9] + */ + autoIndent?: boolean; + /** + * + * Represents the `borders` property. + * + * [Api set: ExcelApi 1.9] + */ + borders?: Excel.CellBorderCollection; + /** + * + * Represents the `fill` property. + * + * [Api set: ExcelApi 1.9] + */ + fill?: Excel.CellPropertiesFill; + /** + * + * Represents the `font` property. + * + * [Api set: ExcelApi 1.9] + */ + font?: Excel.CellPropertiesFont; + /** + * + * Represents the `horizontalAlignment` property. + * + * [Api set: ExcelApi 1.9] + */ + horizontalAlignment?: Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed"; + /** + * + * Represents the `indentLevel` property. + * + * [Api set: ExcelApi 1.9] + */ + indentLevel?: number; + /** + * + * Represents the `protection` property. + * + * [Api set: ExcelApi 1.9] + */ + protection?: Excel.CellPropertiesProtection; + /** + * + * Represents the `readingOrder` property. + * + * [Api set: ExcelApi 1.9] + */ + readingOrder?: Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft"; + /** + * + * Represents the `shrinkToFit` property. + * + * [Api set: ExcelApi 1.9] + */ + shrinkToFit?: boolean; + /** + * + * Represents the `textOrientation` property. + * + * [Api set: ExcelApi 1.9] + */ + textOrientation?: number; + /** + * + * Represents the `useStandardHeight` property. + * + * [Api set: ExcelApi 1.9] + */ + useStandardHeight?: boolean; + /** + * + * Represents the `useStandardWidth` property. + * + * [Api set: ExcelApi 1.9] + */ + useStandardWidth?: boolean; + /** + * + * Represents the `verticalAlignment` property. + * + * [Api set: ExcelApi 1.9] + */ + verticalAlignment?: Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed"; + /** + * + * Represents the `wrapText` property. + * + * [Api set: ExcelApi 1.9] + */ + wrapText?: boolean; + } + /** + * + * Creates and opens a new workbook. Optionally, the workbook can be pre-populated with a Base64-encoded .xlsx file. + * The `extensionHardening` Windows registry key affects the `base64File` param. The file extension defined by the param must match the real file type of the file. If `extensionHardening` is set to deny mismatches and the file extension does not match the real file type, this API throws the following error: "This operation is not allowed due to the extension hardening policy." + * Note: Macros can be a security risk. If this API is used to create a workbook that includes a macro, the add-in user will be prompted with a "Trust this add-in?" dialog in the Excel UI. The user must select the "Trust add-in" button to proceed. + * + * [Api set: ExcelApi 1.8] + * + * @param base64File - Optional. The Base64-encoded .xlsx file. The default value is null. + */ + export function createWorkbook(base64?: string): Promise; + /** [Api set: ExcelApi 1.2] */ + export interface ThreeArrowsSet { + [index: number]: Icon; + redDownArrow: Icon; + yellowSideArrow: Icon; + greenUpArrow: Icon; + } + /** [Api set: ExcelApi 1.2] */ + export interface ThreeArrowsGraySet { + [index: number]: Icon; + grayDownArrow: Icon; + graySideArrow: Icon; + grayUpArrow: Icon; + } + /** [Api set: ExcelApi 1.2] */ + export interface ThreeFlagsSet { + [index: number]: Icon; + redFlag: Icon; + yellowFlag: Icon; + greenFlag: Icon; + } + /** [Api set: ExcelApi 1.2] */ + export interface ThreeTrafficLights1Set { + [index: number]: Icon; + redCircleWithBorder: Icon; + yellowCircle: Icon; + greenCircle: Icon; + } + /** [Api set: ExcelApi 1.2] */ + export interface ThreeTrafficLights2Set { + [index: number]: Icon; + redTrafficLight: Icon; + yellowTrafficLight: Icon; + greenTrafficLight: Icon; + } + /** [Api set: ExcelApi 1.2] */ + export interface ThreeSignsSet { + [index: number]: Icon; + redDiamond: Icon; + yellowTriangle: Icon; + greenCircle: Icon; + } + /** [Api set: ExcelApi 1.2] */ + export interface ThreeSymbolsSet { + [index: number]: Icon; + redCrossSymbol: Icon; + yellowExclamationSymbol: Icon; + greenCheckSymbol: Icon; + } + /** [Api set: ExcelApi 1.2] */ + export interface ThreeSymbols2Set { + [index: number]: Icon; + redCross: Icon; + yellowExclamation: Icon; + greenCheck: Icon; + } + /** [Api set: ExcelApi 1.2] */ + export interface FourArrowsSet { + [index: number]: Icon; + redDownArrow: Icon; + yellowDownInclineArrow: Icon; + yellowUpInclineArrow: Icon; + greenUpArrow: Icon; + } + /** [Api set: ExcelApi 1.2] */ + export interface FourArrowsGraySet { + [index: number]: Icon; + grayDownArrow: Icon; + grayDownInclineArrow: Icon; + grayUpInclineArrow: Icon; + grayUpArrow: Icon; + } + /** [Api set: ExcelApi 1.2] */ + export interface FourRedToBlackSet { + [index: number]: Icon; + blackCircle: Icon; + grayCircle: Icon; + pinkCircle: Icon; + redCircle: Icon; + } + /** [Api set: ExcelApi 1.2] */ + export interface FourRatingSet { + [index: number]: Icon; + oneBar: Icon; + twoBars: Icon; + threeBars: Icon; + fourBars: Icon; + } + /** [Api set: ExcelApi 1.2] */ + export interface FourTrafficLightsSet { + [index: number]: Icon; + blackCircleWithBorder: Icon; + redCircleWithBorder: Icon; + yellowCircle: Icon; + greenCircle: Icon; + } + /** [Api set: ExcelApi 1.2] */ + export interface FiveArrowsSet { + [index: number]: Icon; + redDownArrow: Icon; + yellowDownInclineArrow: Icon; + yellowSideArrow: Icon; + yellowUpInclineArrow: Icon; + greenUpArrow: Icon; + } + /** [Api set: ExcelApi 1.2] */ + export interface FiveArrowsGraySet { + [index: number]: Icon; + grayDownArrow: Icon; + grayDownInclineArrow: Icon; + graySideArrow: Icon; + grayUpInclineArrow: Icon; + grayUpArrow: Icon; + } + /** [Api set: ExcelApi 1.2] */ + export interface FiveRatingSet { + [index: number]: Icon; + noBars: Icon; + oneBar: Icon; + twoBars: Icon; + threeBars: Icon; + fourBars: Icon; + } + /** [Api set: ExcelApi 1.2] */ + export interface FiveQuartersSet { + [index: number]: Icon; + whiteCircleAllWhiteQuarters: Icon; + circleWithThreeWhiteQuarters: Icon; + circleWithTwoWhiteQuarters: Icon; + circleWithOneWhiteQuarter: Icon; + blackCircle: Icon; + } + /** [Api set: ExcelApi 1.2] */ + export interface ThreeStarsSet { + [index: number]: Icon; + silverStar: Icon; + halfGoldStar: Icon; + goldStar: Icon; + } + /** [Api set: ExcelApi 1.2] */ + export interface ThreeTrianglesSet { + [index: number]: Icon; + redDownTriangle: Icon; + yellowDash: Icon; + greenUpTriangle: Icon; + } + /** [Api set: ExcelApi 1.2] */ + export interface FiveBoxesSet { + [index: number]: Icon; + noFilledBoxes: Icon; + oneFilledBox: Icon; + twoFilledBoxes: Icon; + threeFilledBoxes: Icon; + fourFilledBoxes: Icon; + } + /** [Api set: ExcelApi 1.2] */ + export interface IconCollections { + threeArrows: ThreeArrowsSet; + threeArrowsGray: ThreeArrowsGraySet; + threeFlags: ThreeFlagsSet; + threeTrafficLights1: ThreeTrafficLights1Set; + threeTrafficLights2: ThreeTrafficLights2Set; + threeSigns: ThreeSignsSet; + threeSymbols: ThreeSymbolsSet; + threeSymbols2: ThreeSymbols2Set; + fourArrows: FourArrowsSet; + fourArrowsGray: FourArrowsGraySet; + fourRedToBlack: FourRedToBlackSet; + fourRating: FourRatingSet; + fourTrafficLights: FourTrafficLightsSet; + fiveArrows: FiveArrowsSet; + fiveArrowsGray: FiveArrowsGraySet; + fiveRating: FiveRatingSet; + fiveQuarters: FiveQuartersSet; + threeStars: ThreeStarsSet; + threeTriangles: ThreeTrianglesSet; + fiveBoxes: FiveBoxesSet; + } + /** [Api set: ExcelApi 1.2] */ + var icons: IconCollections; + export interface Session { + } + /** + * The RequestContext object facilitates requests to the Excel application. Since the Office add-in and the Excel application run in two different processes, the request context is required to get access to the Excel object model from the add-in. + */ + export class RequestContext extends OfficeExtension.ClientRequestContext { + constructor(url?: string | Session); + readonly workbook: Workbook; + readonly application: Application; + /** + * [Api set: ExcelApi 1.5] + */ + readonly runtime: Runtime; + } + export interface RunOptions extends OfficeExtension.RunOptions { + /** + * Determines whether Excel will delay the batch request until the user exits cell edit mode. + * + * When `false`, if the user is in cell edit when the batch request is processed by the host, the batch automatically fails. + * When `true`, the batch request is executed immediately if the user is not in cell edit mode, but if the user is in cell edit mode then the batch request is delayed until the user exits cell edit mode. + * The default behavior with no `delayForCellEdit` property specified is equivalent to when it is `false`. + */ + delayForCellEdit?: boolean; + /** + * Determines whether the batch requests should be merged to one undo group. + * + * When false, each `context.sync()` call creates an undo record. + * When true, all `context.sync()` calls in a single `Excel.run` are merged into one `undo` group. + * + * @remarks + * [Api set: ExcelApi 1.20] + */ + mergeUndoGroup?: boolean; + } + /** + * Executes a batch script that performs actions on the Excel object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. + * @param batch - A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()"). The context parameter facilitates requests to the Excel application. Since the Office add-in and the Excel application run in two different processes, the RequestContext is required to get access to the Excel object model from the add-in. + */ + export function run(batch: (context: Excel.RequestContext) => Promise): Promise; + /** + * Executes a batch script that performs actions on the Excel object model, using the RequestContext of a previously-created API object. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. + * @param object - A previously-created API object. The batch will use the same RequestContext as the passed-in object, which means that any changes applied to the object will be picked up by "context.sync()". + * @param batch - A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()"). The context parameter facilitates requests to the Excel application. Since the Office add-in and the Excel application run in two different processes, the RequestContext is required to get access to the Excel object model from the add-in. + */ + export function run(object: OfficeExtension.ClientObject, batch: (context: Excel.RequestContext) => Promise): Promise; + /** + * Executes a batch script that performs actions on the Excel object model, using the RequestContext of previously-created API objects. + * @param objects - An array of previously-created API objects. The array will be validated to make sure that all of the objects share the same context. The batch will use this shared RequestContext, which means that any changes applied to these objects will be picked up by "context.sync()". + * @param batch - A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()"). The context parameter facilitates requests to the Excel application. Since the Office add-in and the Excel application run in two different processes, the RequestContext is required to get access to the Excel object model from the add-in. + */ + export function run(objects: OfficeExtension.ClientObject[], batch: (context: Excel.RequestContext) => Promise): Promise; + /** + * Executes a batch script that performs actions on the Excel object model, using the RequestContext of a previously-created API object. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. + * @param options - The additional options for this Excel.run which specify previous objects, whether to delay the request for cell edit, session info, etc. + * @param batch - A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()"). The context parameter facilitates requests to the Excel application. Since the Office add-in and the Excel application run in two different processes, the RequestContext is required to get access to the Excel object model from the add-in. + */ + export function run(options: Excel.RunOptions, batch: (context: Excel.RequestContext) => Promise): Promise; + /** + * Executes a batch script that performs actions on the Excel object model, using the RequestContext of a previously-created object. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. + * + * @param context - A previously-created object. The batch will use the same RequestContext as the passed-in object, which means that any changes applied to the object will be picked up by "context.sync()". + * @param batch - A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()"). The context parameter facilitates requests to the Excel application. Since the Office add-in and the Excel application run in two different processes, the RequestContext is required to get access to the Excel object model from the add-in. + */ + export function run(context: OfficeExtension.ClientRequestContext, batch: (context: Excel.RequestContext) => Promise): Promise; + export function postprocessBindingDescriptor(response: any): any; + export function getDataCommonPostprocess(response: any, callArgs: any): any; + + + + /** + * Notifies when a worksheet is moved within a workbook. + + If a worksheet is moved from one position within the workbook to another + via the Excel UI, then this API will trigger an event. Note that if + the position of a worksheet changes as a result of moving a different worksheet, + then this event won't trigger for both position changes. This event only triggers + for the primary worksheet move, and not any worksheet position changes that occur + as a result of that primary move. + * + * @remarks + * [Api set: ExcelApi 1.17] + */ + export interface WorksheetMovedEventArgs { + /** + * Gets the new position of the worksheet, after the move. + * + * @remarks + * [Api set: ExcelApi 1.17] + */ + positionAfter: number; + /** + * Gets the previous position of the worksheet, prior to the move. + * + * @remarks + * [Api set: ExcelApi 1.17] + */ + positionBefore: number; + /** + * The source of the event. It can be local or remote (through co-authoring). + * + * @remarks + * [Api set: ExcelApi 1.17] + */ + source: Excel.EventSource | "Local" | "Remote"; + /** + * Gets the type of the event. + * + * @remarks + * [Api set: ExcelApi 1.17] + */ + type: string; + /** + * Gets the ID of the worksheet that was moved. + * + * @remarks + * [Api set: ExcelApi 1.17] + */ + worksheetId: string; + } + /** + * Provides information about the worksheet whose name has changed. + * + * @remarks + * [Api set: ExcelApi 1.17] + */ + export interface WorksheetNameChangedEventArgs { + /** + * Gets the new name of the worksheet, after the name change. + * + * @remarks + * [Api set: ExcelApi 1.17] + */ + nameAfter: string; + /** + * Gets the previous name of the worksheet, before the name changed. + * + * @remarks + * [Api set: ExcelApi 1.17] + */ + nameBefore: string; + /** + * The source of the event. It can be local or remote (through co-authoring). + * + * @remarks + * [Api set: ExcelApi 1.17] + */ + source: Excel.EventSource | "Local" | "Remote"; + /** + * Gets the type of the event. + * + * @remarks + * [Api set: ExcelApi 1.17] + */ + type: string; + /** + * Gets the ID of the worksheet with the new name. + * + * @remarks + * [Api set: ExcelApi 1.17] + */ + worksheetId: string; + } + /** + * Provides information about the worksheet whose visibility has changed. + * + * @remarks + * [Api set: ExcelApi 1.17] + */ + export interface WorksheetVisibilityChangedEventArgs { + /** + * The source of the event. It can be local or remote (through co-authoring). + * + * @remarks + * [Api set: ExcelApi 1.17] + */ + source: Excel.EventSource | "Local" | "Remote"; + /** + * Gets the type of the event. + * + * @remarks + * [Api set: ExcelApi 1.17] + */ + type: string; + /** + * Gets the new visibility setting of the worksheet, after the visibility change. + * + * @remarks + * [Api set: ExcelApi 1.17] + */ + visibilityAfter: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden"; + /** + * Gets the previous visibility setting of the worksheet, before the visibility change. + * + * @remarks + * [Api set: ExcelApi 1.17] + */ + visibilityBefore: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden"; + /** + * Gets the ID of the worksheet whose visibility has changed. + * + * @remarks + * [Api set: ExcelApi 1.17] + */ + worksheetId: string; + } + /** + * An enum that specifies the query load to destination. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + enum LoadToType { + /** + * Load to connection only. + * @remarks + * [Api set: ExcelApi 1.14] + */ + connectionOnly = "ConnectionOnly", + /** + * Load to a table. + * @remarks + * [Api set: ExcelApi 1.14] + */ + table = "Table", + /** + * Load to PivotTable. + * @remarks + * [Api set: ExcelApi 1.14] + */ + pivotTable = "PivotTable", + /** + * Load to PivotChart. + * @remarks + * [Api set: ExcelApi 1.14] + */ + pivotChart = "PivotChart" + } + /** + * Represents a Power Query query. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + export class Query extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Gets the query error message from when the query was last refreshed. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + readonly error: Excel.QueryError | "Unknown" | "None" | "FailedLoadToWorksheet" | "FailedLoadToDataModel" | "FailedDownload" | "FailedToCompleteDownload"; + /** + * Gets the query loaded to object type. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + readonly loadedTo: Excel.LoadToType | "ConnectionOnly" | "Table" | "PivotTable" | "PivotChart"; + /** + * Specifies if the query loaded to the data model. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + readonly loadedToDataModel: boolean; + /** + * Gets the name of the query. + Query names cannot contain periods or quotation marks. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + readonly name: string; + /** + * Gets the date and time when the query was last refreshed. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + readonly refreshDate: Date; + /** + * Gets the number of rows that were loaded when the query was last refreshed. + If last refresh has errors the value will be -1. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + readonly rowsLoadedCount: number; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.QueryLoadOptions): Excel.Query; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Query; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.Query; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.Query` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.QueryData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.QueryData; + } + /** + * Represents the collection of queries in the workbook. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + export class QueryCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.Query[]; + /** + * Gets the number of queries in the workbook. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a query from the collection based on its name. + * + * @remarks + * [Api set: ExcelApi 1.14] + * + * @param key - The name of the query case-insensitive. + * @returns The query with the given name. If there is no query by that name, then an error is thrown. + */ + getItem(key: string): Excel.Query; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.QueryCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.QueryCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.QueryCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.QueryCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.QueryCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.QueryCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.QueryCollectionData; + } + /** + * An enum that specifies the query load error message. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + enum QueryError { + /** + * Unknown error. + * @remarks + * [Api set: ExcelApi 1.14] + */ + unknown = "Unknown", + /** + * No error. + * @remarks + * [Api set: ExcelApi 1.14] + */ + none = "None", + /** + * Load to the worksheet failed. + * @remarks + * [Api set: ExcelApi 1.14] + */ + failedLoadToWorksheet = "FailedLoadToWorksheet", + /** + * Load to the data model failed. + * @remarks + * [Api set: ExcelApi 1.14] + */ + failedLoadToDataModel = "FailedLoadToDataModel", + /** + * Download failed. + * @remarks + * [Api set: ExcelApi 1.14] + */ + failedDownload = "FailedDownload", + /** + * Download did not complete. + * @remarks + * [Api set: ExcelApi 1.14] + */ + failedToCompleteDownload = "FailedToCompleteDownload" + } + + + + /** + * Represents a command type of `DataConnection`. + * + * @remarks + * [Api set: ExcelApi 1.15] + */ + enum DataSourceType { + /** + * The data source type is unknown or unsupported. + * @remarks + * [Api set: ExcelApi 1.15] + */ + unknown = "Unknown", + /** + * The data source type is a range in the current workbook. + * @remarks + * [Api set: ExcelApi 1.15] + */ + localRange = "LocalRange", + /** + * The data source type is a table in the current workbook. + * @remarks + * [Api set: ExcelApi 1.15] + */ + localTable = "LocalTable" + } + /** + * Enum representing all accepted conditions by which a date filter can be applied. + Used to configure the type of PivotFilter that is applied to the field. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + enum DateFilterCondition { + /** + * `DateFilterCondition` is unknown or unsupported. + * @remarks + * [Api set: ExcelApi 1.12] + */ + unknown = "Unknown", + /** + * Equals comparator criterion. + + Required Criteria: {`comparator`}. + Optional Criteria: {`wholeDays`, `exclusive`}. + * @remarks + * [Api set: ExcelApi 1.12] + */ + equals = "Equals", + /** + * Date is before comparator date. + + Required Criteria: {`comparator`}. + Optional Criteria: {`wholeDays`}. + * @remarks + * [Api set: ExcelApi 1.12] + */ + before = "Before", + /** + * Date is before or equal to comparator date. + + Required Criteria: {`comparator`}. + Optional Criteria: {`wholeDays`}. + * @remarks + * [Api set: ExcelApi 1.12] + */ + beforeOrEqualTo = "BeforeOrEqualTo", + /** + * Date is after comparator date. + + Required Criteria: {`comparator`}. + Optional Criteria: {`wholeDays`}. + * @remarks + * [Api set: ExcelApi 1.12] + */ + after = "After", + /** + * Date is after or equal to comparator date. + + Required Criteria: {`comparator`}. + Optional Criteria: {`wholeDays`}. + * @remarks + * [Api set: ExcelApi 1.12] + */ + afterOrEqualTo = "AfterOrEqualTo", + /** + * Between `lowerBound` and `upperBound` dates. + + Required Criteria: {`lowerBound`, `upperBound`}. + Optional Criteria: {`wholeDays`, `exclusive`}. + * @remarks + * [Api set: ExcelApi 1.12] + */ + between = "Between", + /** + * Date is tomorrow. + * @remarks + * [Api set: ExcelApi 1.12] + */ + tomorrow = "Tomorrow", + /** + * Date is today. + * @remarks + * [Api set: ExcelApi 1.12] + */ + today = "Today", + /** + * Date is yesterday. + * @remarks + * [Api set: ExcelApi 1.12] + */ + yesterday = "Yesterday", + /** + * Date is next week. + * @remarks + * [Api set: ExcelApi 1.12] + */ + nextWeek = "NextWeek", + /** + * Date is this week. + * @remarks + * [Api set: ExcelApi 1.12] + */ + thisWeek = "ThisWeek", + /** + * Date is last week. + * @remarks + * [Api set: ExcelApi 1.12] + */ + lastWeek = "LastWeek", + /** + * Date is next month. + * @remarks + * [Api set: ExcelApi 1.12] + */ + nextMonth = "NextMonth", + /** + * Date is this month. + * @remarks + * [Api set: ExcelApi 1.12] + */ + thisMonth = "ThisMonth", + /** + * Date is last month. + * @remarks + * [Api set: ExcelApi 1.12] + */ + lastMonth = "LastMonth", + /** + * Date is next quarter. + * @remarks + * [Api set: ExcelApi 1.12] + */ + nextQuarter = "NextQuarter", + /** + * Date is this quarter. + * @remarks + * [Api set: ExcelApi 1.12] + */ + thisQuarter = "ThisQuarter", + /** + * Date is last quarter. + * @remarks + * [Api set: ExcelApi 1.12] + */ + lastQuarter = "LastQuarter", + /** + * Date is next year. + * @remarks + * [Api set: ExcelApi 1.12] + */ + nextYear = "NextYear", + /** + * Date is this year. + * @remarks + * [Api set: ExcelApi 1.12] + */ + thisYear = "ThisYear", + /** + * Date is last year. + * @remarks + * [Api set: ExcelApi 1.12] + */ + lastYear = "LastYear", + /** + * Date is in the same year to date. + * @remarks + * [Api set: ExcelApi 1.12] + */ + yearToDate = "YearToDate", + /** + * Date is in Quarter 1. + * @remarks + * [Api set: ExcelApi 1.12] + */ + allDatesInPeriodQuarter1 = "AllDatesInPeriodQuarter1", + /** + * Date is in Quarter 2. + * @remarks + * [Api set: ExcelApi 1.12] + */ + allDatesInPeriodQuarter2 = "AllDatesInPeriodQuarter2", + /** + * Date is in Quarter 3. + * @remarks + * [Api set: ExcelApi 1.12] + */ + allDatesInPeriodQuarter3 = "AllDatesInPeriodQuarter3", + /** + * Date is in Quarter 4. + * @remarks + * [Api set: ExcelApi 1.12] + */ + allDatesInPeriodQuarter4 = "AllDatesInPeriodQuarter4", + /** + * Date is in January. + * @remarks + * [Api set: ExcelApi 1.12] + */ + allDatesInPeriodJanuary = "AllDatesInPeriodJanuary", + /** + * Date is in February. + * @remarks + * [Api set: ExcelApi 1.12] + */ + allDatesInPeriodFebruary = "AllDatesInPeriodFebruary", + /** + * Date is in March. + * @remarks + * [Api set: ExcelApi 1.12] + */ + allDatesInPeriodMarch = "AllDatesInPeriodMarch", + /** + * Date is in April. + * @remarks + * [Api set: ExcelApi 1.12] + */ + allDatesInPeriodApril = "AllDatesInPeriodApril", + /** + * Date is in May. + * @remarks + * [Api set: ExcelApi 1.12] + */ + allDatesInPeriodMay = "AllDatesInPeriodMay", + /** + * Date is in June. + * @remarks + * [Api set: ExcelApi 1.12] + */ + allDatesInPeriodJune = "AllDatesInPeriodJune", + /** + * Date is in July. + * @remarks + * [Api set: ExcelApi 1.12] + */ + allDatesInPeriodJuly = "AllDatesInPeriodJuly", + /** + * Date is in August. + * @remarks + * [Api set: ExcelApi 1.12] + */ + allDatesInPeriodAugust = "AllDatesInPeriodAugust", + /** + * Date is in September. + * @remarks + * [Api set: ExcelApi 1.12] + */ + allDatesInPeriodSeptember = "AllDatesInPeriodSeptember", + /** + * Date is in October. + * @remarks + * [Api set: ExcelApi 1.12] + */ + allDatesInPeriodOctober = "AllDatesInPeriodOctober", + /** + * Date is in November. + * @remarks + * [Api set: ExcelApi 1.12] + */ + allDatesInPeriodNovember = "AllDatesInPeriodNovember", + /** + * Date is in December. + * @remarks + * [Api set: ExcelApi 1.12] + */ + allDatesInPeriodDecember = "AllDatesInPeriodDecember" + } + /** + * Enum representing all accepted conditions by which a label filter can be applied. + Used to configure the type of PivotFilter that is applied to the field. + `PivotFilter.criteria.exclusive` can be set to `true` to invert many of these conditions. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + enum LabelFilterCondition { + /** + * `LabelFilterCondition` is unknown or unsupported. + * @remarks + * [Api set: ExcelApi 1.12] + */ + unknown = "Unknown", + /** + * Equals comparator criterion. + + Required Criteria: {`comparator`}. + Optional Criteria: {`exclusive`}. + * @remarks + * [Api set: ExcelApi 1.12] + */ + equals = "Equals", + /** + * Label begins with substring criterion. + + Required Criteria: {`substring`}. + Optional Criteria: {`exclusive`}. + * @remarks + * [Api set: ExcelApi 1.12] + */ + beginsWith = "BeginsWith", + /** + * Label ends with substring criterion. + + Required Criteria: {`substring`}. + Optional Criteria: {`exclusive`}. + * @remarks + * [Api set: ExcelApi 1.12] + */ + endsWith = "EndsWith", + /** + * Label contains substring criterion. + + Required Criteria: {`substring`}. + Optional Criteria: {`exclusive`}. + * @remarks + * [Api set: ExcelApi 1.12] + */ + contains = "Contains", + /** + * Greater than comparator criterion. + + Required Criteria: {`comparator`}. + * @remarks + * [Api set: ExcelApi 1.12] + */ + greaterThan = "GreaterThan", + /** + * Greater than or equal to comparator criterion. + + Required Criteria: {`comparator`}. + * @remarks + * [Api set: ExcelApi 1.12] + */ + greaterThanOrEqualTo = "GreaterThanOrEqualTo", + /** + * Less than comparator criterion. + + Required Criteria: {`comparator`}. + * @remarks + * [Api set: ExcelApi 1.12] + */ + lessThan = "LessThan", + /** + * Less than or equal to comparator criterion. + + Required Criteria: {`comparator`}. + * @remarks + * [Api set: ExcelApi 1.12] + */ + lessThanOrEqualTo = "LessThanOrEqualTo", + /** + * Between `lowerBound` and `upperBound` criteria. + + Required Criteria: {`lowerBound`, `upperBound`}. + Optional Criteria: {`exclusive`}. + * @remarks + * [Api set: ExcelApi 1.12] + */ + between = "Between" + } + /** + * Configurable template for a date filter to apply to a PivotField. + The `condition` defines what criteria need to be set in order for the filter to operate. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + export interface PivotDateFilter { + /** + * The comparator is the static value to which other values are compared. The type of comparison is defined by the condition. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + comparator?: Excel.FilterDatetime; + /** + * Specifies the condition for the filter, which defines the necessary filtering criteria. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + condition: Excel.DateFilterCondition | "Unknown" | "Equals" | "Before" | "BeforeOrEqualTo" | "After" | "AfterOrEqualTo" | "Between" | "Tomorrow" | "Today" | "Yesterday" | "NextWeek" | "ThisWeek" | "LastWeek" | "NextMonth" | "ThisMonth" | "LastMonth" | "NextQuarter" | "ThisQuarter" | "LastQuarter" | "NextYear" | "ThisYear" | "LastYear" | "YearToDate" | "AllDatesInPeriodQuarter1" | "AllDatesInPeriodQuarter2" | "AllDatesInPeriodQuarter3" | "AllDatesInPeriodQuarter4" | "AllDatesInPeriodJanuary" | "AllDatesInPeriodFebruary" | "AllDatesInPeriodMarch" | "AllDatesInPeriodApril" | "AllDatesInPeriodMay" | "AllDatesInPeriodJune" | "AllDatesInPeriodJuly" | "AllDatesInPeriodAugust" | "AllDatesInPeriodSeptember" | "AllDatesInPeriodOctober" | "AllDatesInPeriodNovember" | "AllDatesInPeriodDecember"; + /** + * If `true`, filter *excludes* items that meet criteria. The default is `false` (filter to include items that meet criteria). + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + exclusive?: boolean; + /** + * The lower-bound of the range for the `between` filter condition. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + lowerBound?: Excel.FilterDatetime; + /** + * The upper-bound of the range for the `between` filter condition. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + upperBound?: Excel.FilterDatetime; + /** + * For `equals`, `before`, `after`, and `between` filter conditions, indicates if comparisons should be made as whole days. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + wholeDays?: boolean; + } + /** + * A simple enum that represents a type of filter for a PivotField. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + enum PivotFilterType { + /** + * `PivotFilterType` is unknown or unsupported. + * @remarks + * [Api set: ExcelApi 1.12] + */ + unknown = "Unknown", + /** + * Filters based on the value of a PivotItem with respect to a `DataPivotHierarchy`. + * @remarks + * [Api set: ExcelApi 1.12] + */ + value = "Value", + /** + * Filters specific manually selected PivotItems from the PivotTable. + * @remarks + * [Api set: ExcelApi 1.12] + */ + manual = "Manual", + /** + * Filters PivotItems based on their labels. + Note: A PivotField cannot simultaneously have a label filter and a date filter applied. + * @remarks + * [Api set: ExcelApi 1.12] + */ + label = "Label", + /** + * Filters PivotItems with a date in place of a label. + Note: A PivotField cannot simultaneously have a label filter and a date filter applied. + * @remarks + * [Api set: ExcelApi 1.12] + */ + date = "Date" + } + /** + * An interface representing all PivotFilters currently applied to a given PivotField. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + export interface PivotFilters { + /** + * The PivotField's currently applied date filter. This property is `null` if no value filter is applied. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + dateFilter?: Excel.PivotDateFilter; + /** + * The PivotField's currently applied label filter. This property is `null` if no value filter is applied. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + labelFilter?: Excel.PivotLabelFilter; + /** + * The PivotField's currently applied manual filter. This property is `null` if no value filter is applied. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + manualFilter?: Excel.PivotManualFilter; + /** + * The PivotField's currently applied value filter. This property is `null` if no value filter is applied. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + valueFilter?: Excel.PivotValueFilter; + } + /** + * Configurable template for a label filter to apply to a PivotField. + The `condition` defines what criteria need to be set in order for the filter to operate. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + export interface PivotLabelFilter { + /** + * The comparator is the static value to which other values are compared. The type of comparison is defined by the condition. + Note: A numeric string is treated as a number when being compared against other numeric strings. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + comparator?: string; + /** + * Specifies the condition for the filter, which defines the necessary filtering criteria. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + condition: Excel.LabelFilterCondition | "Unknown" | "Equals" | "BeginsWith" | "EndsWith" | "Contains" | "GreaterThan" | "GreaterThanOrEqualTo" | "LessThan" | "LessThanOrEqualTo" | "Between"; + /** + * If `true`, filter *excludes* items that meet criteria. The default is `false` (filter to include items that meet criteria). + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + exclusive?: boolean; + /** + * The lower-bound of the range for the `between` filter condition. + Note: A numeric string is treated as a number when being compared against other numeric strings. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + lowerBound?: string; + /** + * The substring used for the `beginsWith`, `endsWith`, and `contains` filter conditions. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + substring?: string; + /** + * The upper-bound of the range for the `between` filter condition. + Note: A numeric string is treated as a number when being compared against other numeric strings. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + upperBound?: string; + } + /** + * Configurable template for a manual filter to apply to a PivotField. + The `condition` defines what criteria need to be set in order for the filter to operate. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + export interface PivotManualFilter { + /** + * A list of selected items to manually filter. These must be existing and valid items from the chosen field. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + selectedItems?: Array; + } + /** + * Configurable template for a value filter to apply to a PivotField. + The `condition` defines what criteria need to be set in order for the filter to operate. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + export interface PivotValueFilter { + /** + * The comparator is the static value to which other values are compared. The type of comparison is defined by the condition. + For example, if comparator is "50" and condition is "greaterThan", all item values that are not greater than 50 will be removed by the filter. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + comparator?: number; + /** + * Specifies the condition for the filter, which defines the necessary filtering criteria. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + condition: Excel.ValueFilterCondition | "Unknown" | "Equals" | "GreaterThan" | "GreaterThanOrEqualTo" | "LessThan" | "LessThanOrEqualTo" | "Between" | "TopN" | "BottomN"; + /** + * If `true`, filter *excludes* items that meet criteria. The default is `false` (filter to include items that meet criteria). + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + exclusive?: boolean; + /** + * The lower-bound of the range for the `between` filter condition. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + lowerBound?: number; + /** + * Specifies if the filter is for the top/bottom N items, top/bottom N percent, or top/bottom N sum. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + selectionType?: Excel.TopBottomSelectionType | "Items" | "Percent" | "Sum"; + /** + * The "N" threshold number of items, percent, or sum to be filtered for a top/bottom filter condition. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + threshold?: number; + /** + * The upper-bound of the range for the `between` filter condition. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + upperBound?: number; + /** + * Name of the chosen "value" in the field by which to filter. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + value: string; + } + /** + * A simple enum for top/bottom filters to select whether to filter by the top N or bottom N percent, number, or sum of values. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + enum TopBottomSelectionType { + /** + * Filter the top/bottom N number of items as measured by the chosen value. + * @remarks + * [Api set: ExcelApi 1.12] + */ + items = "Items", + /** + * Filter the top/bottom N percent of items as measured by the chosen value. + * @remarks + * [Api set: ExcelApi 1.12] + */ + percent = "Percent", + /** + * Filter the top/bottom N sum as measured by the chosen value. + * @remarks + * [Api set: ExcelApi 1.12] + */ + sum = "Sum" + } + /** + * Enum representing all accepted conditions by which a value filter can be applied. + Used to configure the type of PivotFilter that is applied to the field. + `PivotFilter.exclusive` can be set to `true` to invert many of these conditions. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + enum ValueFilterCondition { + /** + * `ValueFilterCondition` is unknown or unsupported. + * @remarks + * [Api set: ExcelApi 1.12] + */ + unknown = "Unknown", + /** + * Equals comparator criterion. + + Required Criteria: {`value`, `comparator`}. + Optional Criteria: {`exclusive`}. + * @remarks + * [Api set: ExcelApi 1.12] + */ + equals = "Equals", + /** + * Greater than comparator criterion. + + Required Criteria: {`value`, `comparator`}. + * @remarks + * [Api set: ExcelApi 1.12] + */ + greaterThan = "GreaterThan", + /** + * Greater than or equal to comparator criterion. + + Required Criteria: {`value`, `comparator`}. + * @remarks + * [Api set: ExcelApi 1.12] + */ + greaterThanOrEqualTo = "GreaterThanOrEqualTo", + /** + * Less than comparator criterion. + + Required Criteria: {`value`, `comparator`}. + * @remarks + * [Api set: ExcelApi 1.12] + */ + lessThan = "LessThan", + /** + * Less than or equal to comparator criterion. + + Required Criteria: {`value`, `comparator`}. + * @remarks + * [Api set: ExcelApi 1.12] + */ + lessThanOrEqualTo = "LessThanOrEqualTo", + /** + * Between `lowerBound` and `upperBound` criteria. + + Required Criteria: {`value`, `lowerBound`, `upperBound`}. + Optional Criteria: {`exclusive`}. + * @remarks + * [Api set: ExcelApi 1.12] + */ + between = "Between", + /** + * In top N (`threshold`) [items, percent, sum] of value category. + + Required Criteria: {`value`, `threshold`, `selectionType`}. + * @remarks + * [Api set: ExcelApi 1.12] + */ + topN = "TopN", + /** + * In bottom N (`threshold`) [items, percent, sum] of value category. + + Required Criteria: {`value`, `threshold`, `selectionType`}. + * @remarks + * [Api set: ExcelApi 1.12] + */ + bottomN = "BottomN" + } + /** + * Represents the dimensions when getting values from chart series. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + enum ChartSeriesDimension { + /** + * The chart series axis for the categories. + * @remarks + * [Api set: ExcelApi 1.12] + */ + categories = "Categories", + /** + * The chart series axis for the values. + * @remarks + * [Api set: ExcelApi 1.12] + */ + values = "Values", + /** + * The chart series axis for the x-axis values in scatter and bubble charts. + * @remarks + * [Api set: ExcelApi 1.12] + */ + xvalues = "XValues", + /** + * The chart series axis for the y-axis values in scatter and bubble charts. + * @remarks + * [Api set: ExcelApi 1.12] + */ + yvalues = "YValues", + /** + * The chart series axis for the bubble sizes in bubble charts. + * @remarks + * [Api set: ExcelApi 1.12] + */ + bubbleSizes = "BubbleSizes" + } + /** + * Provides information about the selection that raised the selection changed event. + + **Note**: If multiple, discontiguous cells are selected, `Binding.onSelectionChanged` only reports row and column information for one selection. Use `Worksheet.onSelectionChanged` for multiple selected ranges. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + export interface BindingSelectionChangedEventArgs { + /** + * Gets a temporary `Binding` object that contains the ID of the `Binding` object that raised the event. Use that ID with `BindingCollection.getItem(id)` to get the binding. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + binding: Excel.Binding; + /** + * Gets the number of columns selected. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + columnCount: number; + /** + * Gets the number of rows selected. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + rowCount: number; + /** + * Gets the index of the first column of the selection (zero-based). + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + startColumn: number; + /** + * Gets the index of the first row of the selection (zero-based). + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + startRow: number; + } + /** + * Provides information about the binding that raised the data changed event. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + export interface BindingDataChangedEventArgs { + /** + * Gets a temporary `Binding` object that contains the ID of the `Binding` object that raised the event. Use that ID with `BindingCollection.getItem(id)` to get the binding. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + binding: Excel.Binding; + } + /** + * Provides information about the document that raised the selection changed event. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + export interface SelectionChangedEventArgs { + /** + * Gets the workbook object that raised the selection changed event. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + workbook: Excel.Workbook; + } + /** + * Provides information about the setting that raised the settings changed event + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + export interface SettingsChangedEventArgs { + /** + * Gets the `Setting` object that represents the binding that raised the settings changed event + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + settings: Excel.SettingCollection; + } + /** + * Provides information about the workbook that raised the activated event. + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + export interface WorkbookActivatedEventArgs { + /** + * Gets the type of the event. See `Excel.EventType` for details. + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + type: "WorkbookActivated"; + } + /** + * Provides information about the workbook's `onAutoSaveSettingChanged` event. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface WorkbookAutoSaveSettingChangedEventArgs { + /** + * Gets the type of the event. See `Excel.EventType` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + type: "WorkbookAutoSaveSettingChanged"; + } + /** + * Represents the type of cell control. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + enum CellControlType { + /** + * Type representing an unknown control. + This represents a control that was added in a future version of Excel, and the current version of Excel doesn't know how to display this control. + * @remarks + * [Api set: ExcelApi 1.18] + */ + unknown = "Unknown", + /** + * Type representing an empty control. + * @remarks + * [Api set: ExcelApi 1.18] + */ + empty = "Empty", + /** + * Type representing a query that results in a mix of control results. + * @remarks + * [Api set: ExcelApi 1.18] + */ + mixed = "Mixed", + /** + * Type representing a checkbox control. + * @remarks + * [Api set: ExcelApi 1.18] + */ + checkbox = "Checkbox" + } + /** + * Represents the direction that existing or remaining cells in a worksheet will shift when cells are inserted into or deleted from a worksheet. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + export interface ChangeDirectionState { + /** + * Represents the direction (such as up or to the left) that the remaining cells will shift when a cell or cells are deleted. + Note: `insertShiftDirection` and `deleteShiftDirection` are exclusive and both enums can't have a value at the same time. If one has a value, then the other will return `undefined`. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + deleteShiftDirection: Excel.DeleteShiftDirection | "Up" | "Left"; + /** + * Represents the direction (such as down or to the right) that the existing cells will shift when a new cell or cells are inserted. + Note: `insertShiftDirection` and `deleteShiftDirection` are exclusive and both enums can't have a value at the same time. If one has a value, then the other will return `undefined`. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + insertShiftDirection: Excel.InsertShiftDirection | "Down" | "Right"; + } + /** + * Provides information about the details of a `WorksheetChangedEvent` or `TableChangedEvent`. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface ChangedEventDetail { + /** + * Represents the value after the change. The data returned could be a string, number, or boolean. Cells that contain an error will return the error string. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + valueAfter: any; + /** + * Represents the type of value after the change. + Unlike `valueAfter`, `valueAsJsonAfter` can represent all cell values, such as formatted number, web image, and entity data types. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valueAsJsonAfter: CellValue; + /** + * Represents the type of value before the change. + Unlike `valueBefore`, `valueAsJsonBefore` can represent all cell values, such as formatted number, web image, and entity data types. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valueAsJsonBefore: CellValue; + /** + * Represents the value before the change. The data returned could be a string, number, or boolean. Cells that contain an error will return the error string. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + valueBefore: any; + /** + * Represents the type of value after the change. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + valueTypeAfter: Excel.RangeValueType | "Unknown" | "Empty" | "String" | "Integer" | "Double" | "Boolean" | "Error" | "RichValue"; + /** + * Represents the type of value before the change. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + valueTypeBefore: Excel.RangeValueType | "Unknown" | "Empty" | "String" | "Integer" | "Double" | "Boolean" | "Error" | "RichValue"; + } + /** + * Provides information about the worksheet that raised the changed event. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + export interface WorksheetChangedEventArgs { + /** + * Gets the range address that represents the changed area of a specific worksheet. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + address: string; + /** + * Gets the change type that represents how the changed event is triggered. See `Excel.DataChangeType` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + changeType: Excel.DataChangeType | "Unknown" | "RangeEdited" | "RowInserted" | "RowDeleted" | "ColumnInserted" | "ColumnDeleted" | "CellInserted" | "CellDeleted"; + /** + * Represents the information about the change detail. This property can be retrieved when the changed event is triggered on a single cell. If the changed event is triggered on multiple cells, this property cannot be retrieved. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + details: Excel.ChangedEventDetail; + /** + * Gets the source of the event. See `Excel.EventSource` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + source: Excel.EventSource | "Local" | "Remote"; + /** + * Gets the type of the event. See `Excel.EventType` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + type: "WorksheetChanged"; + /** + * Gets the ID of the worksheet in which the data changed. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + worksheetId: string; + /** + * Represents a change to the direction that the cells in a worksheet will shift when a cell or cells are deleted or inserted. This includes the following two scenarios. + 1. The direction (such as down or to the right) that existing cells will shift when a new cell or cells are inserted into a worksheet. + 2. The direction (such as up or to the left) that the remaining cells will shift when a cell or cells are deleted from a worksheet. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + changeDirectionState: Excel.ChangeDirectionState; + /** + * Represents the trigger source of the event. For example, identifies whether this local add-in triggers the event. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + triggerSource: Excel.EventTriggerSource | "Unknown" | "ThisLocalAddin"; + /** + * + * Gets the range that represents the changed area of a specific worksheet. + * + * [Api set: ExcelApi 1.8] + */ + getRange(ctx: Excel.RequestContext): Excel.Range; + /** + * + * Gets the range that represents the changed area of a specific worksheet. It might return null object. + * + * [Api set: ExcelApi 1.8] + */ + getRangeOrNullObject(ctx: Excel.RequestContext): Excel.Range; + } + /** + * Provides information about the worksheet format change event. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface WorksheetFormatChangedEventArgs { + /** + * Gets the range address that represents the changed area of a specific worksheet. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + address: string; + /** + * Gets the source of the event. See `Excel.EventSource` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + source: Excel.EventSource | "Local" | "Remote"; + /** + * Gets the type of the event. See `Excel.EventType` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + type: "WorksheetFormatChanged"; + /** + * Gets the ID of the worksheet in which the data changed. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + worksheetId: string; + /** + * + * Gets the range that represents the changed area of a specific worksheet. + * + * [Api set: ExcelApi 1.9] + */ + getRange(ctx: Excel.RequestContext): Excel.Range; + /** + * + * Gets the range that represents the changed area of a specific worksheet. It might return null object. + * + * [Api set: ExcelApi 1.9] + */ + getRangeOrNullObject(ctx: Excel.RequestContext): Excel.Range; + } + /** + * Provides information about the worksheet's row hidden change event. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + export interface WorksheetRowHiddenChangedEventArgs { + /** + * Gets the range address that represents the changed area of a specific worksheet. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + address: string; + /** + * Gets the type of change that represents how the event was triggered. See `Excel.RowHiddenChangeType` for details. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + changeType: Excel.RowHiddenChangeType | "Unhidden" | "Hidden"; + /** + * Gets the source of the event. See `Excel.EventSource` for details. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + source: Excel.EventSource | "Local" | "Remote"; + /** + * Gets the type of the event. See `Excel.EventType` for details. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + type: "WorksheetRowHiddenChanged"; + /** + * Gets the ID of the worksheet in which the data changed. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + worksheetId: string; + } + /** + * Provides information about the table that raised the changed event. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + export interface TableChangedEventArgs { + /** + * Gets the address that represents the changed area of a table on a specific worksheet. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + address: string; + /** + * Gets the change type that represents how the changed event is triggered. See `Excel.DataChangeType` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + changeType: Excel.DataChangeType | "Unknown" | "RangeEdited" | "RowInserted" | "RowDeleted" | "ColumnInserted" | "ColumnDeleted" | "CellInserted" | "CellDeleted"; + /** + * Gets the source of the event. See `Excel.EventSource` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + source: Excel.EventSource | "Local" | "Remote"; + /** + * Gets the ID of the table in which the data changed. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + tableId: string; + /** + * Gets the type of the event. See `Excel.EventType` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + type: "TableChanged"; + /** + * Gets the ID of the worksheet in which the data changed. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + worksheetId: string; + /** + * Gets the information about the change detail. This property can be retrieved when the changed event is triggered on a single cell. If the changed event is triggered on multiple cells, this property cannot be retrieved. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + details: Excel.ChangedEventDetail; + /** + * + * Gets the range that represents the changed area of a table on a specific worksheet. + * + * [Api set: ExcelApi 1.8] + */ + getRange(ctx: Excel.RequestContext): Excel.Range; + /** + * + * Gets the range that represents the changed area of a table on a specific worksheet. It might return null object. + * + * [Api set: ExcelApi 1.8] + */ + getRangeOrNullObject(ctx: Excel.RequestContext): Excel.Range; + } + /** + * Provides information about the worksheet and formulas that raised the formula changed event. + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + export interface WorksheetFormulaChangedEventArgs { + /** + * Gets an array of `FormulaChangedEventDetail` objects, which contain the details about the all of the changed formulas. + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + formulaDetails: Excel.FormulaChangedEventDetail[]; + /** + * The source of the event. It can be local or remote (through co-authoring). + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + source: Excel.EventSource | "Local" | "Remote"; + /** + * Gets the type of the event. See `Excel.EventType` for details. + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + type: "WorksheetFormulaChanged"; + /** + * Gets the ID of the worksheet in which the formula changed. + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + worksheetId: string; + } + /** + * Provides information about a changed formula during a formula changed event. + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + export interface FormulaChangedEventDetail { + /** + * The address of the cell that contains the changed formula. + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + cellAddress: string; + /** + * Represents the previous formula, before it was changed. + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + previousFormula: string; + } + /** + * Provides information about the worksheet that raised the protection status changed event, which fires when the protection status is updated in a worksheet. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + export interface WorksheetProtectionChangedEventArgs { + + /** + * Gets the current protection status of the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + isProtected: boolean; + + + /** + * The source of the event. It can be local or remote (through co-authoring). + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + source: Excel.EventSource | "Local" | "Remote"; + /** + * Gets the type of the event. See `Excel.EventType` for details. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + type: "WorksheetProtectionChanged"; + /** + * Gets the ID of the worksheet in which the protection status is changed. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + worksheetId: string; + } + /** + * Provides information about the worksheet that raised the activated event. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + export interface WorksheetActivatedEventArgs { + /** + * Gets the type of the event. See `Excel.EventType` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + type: "WorksheetActivated"; + /** + * Gets the ID of the worksheet that is activated. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + worksheetId: string; + } + /** + * Provides information about the worksheet that raised the deactivated event. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + export interface WorksheetDeactivatedEventArgs { + /** + * Gets the type of the event. See `Excel.EventType` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + type: "WorksheetDeactivated"; + /** + * Gets the ID of the worksheet that is deactivated. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + worksheetId: string; + } + /** + * Provides information about the row-sorted event and its related worksheet. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + export interface WorksheetRowSortedEventArgs { + /** + * Gets the range address that represents the sorted areas of a specific worksheet. Only rows changed as a result of the sort operation are returned. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + address: string; + /** + * Gets the source of the event. See `Excel.EventSource` for details. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + source: Excel.EventSource | "Local" | "Remote"; + /** + * Gets the type of the event. See `Excel.EventType` for details. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + type: "WorksheetRowSorted"; + /** + * Gets the ID of the worksheet where the sorting happened. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + worksheetId: string; + } + /** + * Provides information about the column-sorted event and its related worksheet. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + export interface WorksheetColumnSortedEventArgs { + /** + * Gets the range address that represents the sorted areas of a specific worksheet. Only columns changed as a result of the sort operation are returned. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + address: string; + /** + * Gets the source of the event. See `Excel.EventSource` for details. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + source: Excel.EventSource | "Local" | "Remote"; + /** + * Gets the type of the event. See `Excel.EventType` for details. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + type: "WorksheetColumnSorted"; + /** + * Gets the ID of the worksheet where the sorting happened. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + worksheetId: string; + } + /** + * Provides information about the worksheet that raised the selection changed event. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + export interface WorksheetSelectionChangedEventArgs { + /** + * Gets the range address that represents the selected area of a specific worksheet. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + address: string; + /** + * Gets the type of the event. See `Excel.EventType` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + type: "WorksheetSelectionChanged"; + /** + * Gets the ID of the worksheet in which the selection changed. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + worksheetId: string; + } + /** + * Provides information about the left-clicked/tapped event and its related worksheet. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + export interface WorksheetSingleClickedEventArgs { + /** + * Gets the address that represents the cell which was left-clicked/tapped for a specific worksheet. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + address: string; + /** + * The distance, in points, from the left-clicked/tapped point to the left (or right for right-to-left languages) gridline edge of the left-clicked/tapped cell. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + offsetX: number; + /** + * The distance, in points, from the left-clicked/tapped point to the top gridline edge of the left-clicked/tapped cell. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + offsetY: number; + /** + * Gets the type of the event. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + type: "WorksheetSingleClicked"; + /** + * Gets the ID of the worksheet in which the cell was left-clicked/tapped. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + worksheetId: string; + } + /** + * Provides information about the table that raised the selection changed event. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + export interface TableSelectionChangedEventArgs { + /** + * Gets the range address that represents the selected area of the table on a specific worksheet. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + address: string; + /** + * Specifies if the selection is inside a table. `IsInsideTable` must be set to `true` for the address to be useful. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + isInsideTable: boolean; + /** + * Gets the ID of the table in which the selection changed. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + tableId: string; + /** + * Gets the type of the event. See `Excel.EventType` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + type: "TableSelectionChanged"; + /** + * Gets the ID of the worksheet in which the selection changed. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + worksheetId: string; + } + /** + * Provides information about the worksheet that raised the added event. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + export interface WorksheetAddedEventArgs { + /** + * Gets the source of the event. See `Excel.EventSource` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + source: Excel.EventSource | "Local" | "Remote"; + /** + * Gets the type of the event. See `Excel.EventType` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + type: "WorksheetAdded"; + /** + * Gets the ID of the worksheet that is added to the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + worksheetId: string; + } + /** + * Provides information about the worksheet that raised the deleted event. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + export interface WorksheetDeletedEventArgs { + /** + * Gets the source of the event. See `Excel.EventSource` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + source: Excel.EventSource | "Local" | "Remote"; + /** + * Gets the type of the event. See `Excel.EventType` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + type: "WorksheetDeleted"; + /** + * Gets the ID of the worksheet that is deleted from the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + worksheetId: string; + } + /** + * Provides information about the chart that raised the added event. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export interface ChartAddedEventArgs { + /** + * Gets the ID of the chart that is added to the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + chartId: string; + /** + * Gets the source of the event. See `Excel.EventSource` for details. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + source: Excel.EventSource | "Local" | "Remote"; + /** + * Gets the type of the event. See `Excel.EventType` for details. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + type: "ChartAdded"; + /** + * Gets the ID of the worksheet in which the chart is added. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + worksheetId: string; + } + /** + * Provides information about the chart that raised the activated event. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export interface ChartActivatedEventArgs { + /** + * Gets the ID of the chart that is activated. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + chartId: string; + /** + * Gets the type of the event. See `Excel.EventType` for details. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + type: "ChartActivated"; + /** + * Gets the ID of the worksheet in which the chart is activated. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + worksheetId: string; + } + /** + * Provides information about the chart that raised the deactivated event. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export interface ChartDeactivatedEventArgs { + /** + * Gets the ID of the chart that is deactivated. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + chartId: string; + /** + * Gets the type of the event. See `Excel.EventType` for details. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + type: "ChartDeactivated"; + /** + * Gets the ID of the worksheet in which the chart is deactivated. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + worksheetId: string; + } + /** + * Provides information about the chart that raised the deleted event. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export interface ChartDeletedEventArgs { + /** + * Gets the ID of the chart that is deleted from the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + chartId: string; + /** + * Gets the source of the event. See `Excel.EventSource` for details. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + source: Excel.EventSource | "Local" | "Remote"; + /** + * Gets the type of the event. See `Excel.EventType` for details. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + type: "ChartDeleted"; + /** + * Gets the ID of the worksheet in which the chart is deleted. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + worksheetId: string; + } + /** + * Provides information about the worksheet that raised the calculated event. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export interface WorksheetCalculatedEventArgs { + /** + * The address of the range that completed calculation. + If multiple ranges completed calculation, the string is a comma-separated list of those range addresses. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + address: string; + /** + * Gets the type of the event. See `Excel.EventType` for details. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + type: "WorksheetCalculated"; + /** + * Gets the ID of the worksheet in which the calculation occurred. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + worksheetId: string; + } + /** + * Provides information about the table that raised the added event. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface TableAddedEventArgs { + /** + * Gets the source of the event. See `Excel.EventSource` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + source: Excel.EventSource | "Local" | "Remote"; + /** + * Gets the ID of the table that is added. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + tableId: string; + /** + * Gets the type of the event. See `Excel.EventType` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + type: "TableAdded"; + /** + * Gets the ID of the worksheet in which the table is added. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + worksheetId: string; + } + /** + * Provides information about the table that raised the deleted event. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface TableDeletedEventArgs { + /** + * Gets the source of the event. See `Excel.EventSource` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + source: Excel.EventSource | "Local" | "Remote"; + /** + * Gets the ID of the table that is deleted. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + tableId: string; + /** + * Gets the name of the table that is deleted. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + tableName: string; + /** + * Gets the type of the event. See `Excel.EventType` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + type: "TableDeleted"; + /** + * Gets the ID of the worksheet in which the table is deleted. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + worksheetId: string; + } + /** + * Provides information about the comments that raised the comment added event. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + export interface CommentAddedEventArgs { + /** + * Gets the `CommentDetail` array that contains the comment ID and IDs of its related replies. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + commentDetails: Excel.CommentDetail[]; + /** + * Specifies the source of the event. See `Excel.EventSource` for details. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + source: Excel.EventSource | "Local" | "Remote"; + /** + * Gets the type of the event. See `Excel.EventType` for details. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + type: "CommentAdded"; + /** + * Gets the ID of the worksheet in which the event happened. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + worksheetId: string; + } + /** + * Provides information about the comments that raised the comment deleted event. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + export interface CommentDeletedEventArgs { + /** + * Gets the `CommentDetail` array that contains the comment ID and IDs of its related replies. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + commentDetails: Excel.CommentDetail[]; + /** + * Specifies the source of the event. See `Excel.EventSource` for details. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + source: Excel.EventSource | "Local" | "Remote"; + /** + * Gets the type of the event. See `Excel.EventType` for details. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + type: "CommentDeleted"; + /** + * Gets the ID of the worksheet in which the event happened. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + worksheetId: string; + } + /** + * Occurs when existing comments are changed. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + export interface CommentChangedEventArgs { + /** + * Gets the change type that represents how the changed event is triggered. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + changeType: Excel.CommentChangeType | "CommentEdited" | "CommentResolved" | "CommentReopened" | "ReplyAdded" | "ReplyDeleted" | "ReplyEdited"; + /** + * Get the `CommentDetail` array which contains the comment ID and IDs of its related replies. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + commentDetails: Excel.CommentDetail[]; + /** + * Specifies the source of the event. See `Excel.EventSource` for details. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + source: Excel.EventSource | "Local" | "Remote"; + /** + * Gets the type of the event. See `Excel.EventType` for details. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + type: "CommentChanged"; + /** + * Gets the ID of the worksheet in which the event happened. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + worksheetId: string; + } + /** + * A structure for the comment ID and IDs of its related replies. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + export interface CommentDetail { + /** + * Represents the IDs of the related replies that belong to the comment. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + replyIds: string[]; + /** + * Represents the ID of the comment. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + commentId: string; + } + /** + * Provides information about the shape that raised the activated event. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface ShapeActivatedEventArgs { + /** + * Gets the ID of the activated shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + shapeId: string; + /** + * Gets the type of the event. See `Excel.EventType` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + type: "ShapeActivated"; + /** + * Gets the ID of the worksheet in which the shape is activated. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + worksheetId: string; + } + /** + * Provides information about the shape that raised the deactivated event. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface ShapeDeactivatedEventArgs { + /** + * Gets the ID of the shape deactivated shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + shapeId: string; + /** + * Gets the type of the event. See `Excel.EventType` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + type: "ShapeDeactivated"; + /** + * Gets the ID of the worksheet in which the shape is deactivated. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + worksheetId: string; + } + /** + * Represents the Excel Runtime class. + * + * @remarks + * [Api set: ExcelApi 1.5] + */ + export class Runtime extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Toggle JavaScript events in the current task pane or content add-in. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + enableEvents: boolean; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.RuntimeUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.Runtime): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.RuntimeLoadOptions): Excel.Runtime; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Runtime; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.Runtime; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.Runtime` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.RuntimeData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.RuntimeData; + } + /** + * Represents the Excel application that manages the workbook. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class Application extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Provides information based on current system culture settings. This includes the culture names, number formatting, and other culturally dependent settings. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + readonly cultureInfo: Excel.CultureInfo; + /** + * Returns the iterative calculation settings. + In Excel on Windows and Mac, the settings will apply to the Excel Application. + In Excel on the web and other platforms, the settings will apply to the active workbook. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly iterativeCalculation: Excel.IterativeCalculation; + /** + * Returns the Excel calculation engine version used for the last full recalculation. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly calculationEngineVersion: number; + /** + * Returns the calculation mode used in the workbook, as defined by the constants in `Excel.CalculationMode`. Possible values are: `Automatic`, where Excel controls recalculation; `AutomaticExceptTables`, where Excel controls recalculation but ignores changes in tables; `Manual`, where calculation is done when the user requests it. + * + * @remarks + * [Api set: ExcelApi 1.1 for get, 1.8 for set] + */ + calculationMode: Excel.CalculationMode | "Automatic" | "AutomaticExceptTables" | "Manual"; + /** + * Returns the calculation state of the application. See `Excel.CalculationState` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly calculationState: Excel.CalculationState | "Done" | "Calculating" | "Pending"; + /** + * Gets the string used as the decimal separator for numeric values. This is based on the local Excel settings. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + readonly decimalSeparator: string; + /** + * Gets the string used to separate groups of digits to the left of the decimal for numeric values. This is based on the local Excel settings. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + readonly thousandsSeparator: string; + /** + * Specifies if the system separators of Excel are enabled. + System separators include the decimal separator and thousands separator. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + readonly useSystemSeparators: boolean; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ApplicationUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.Application): void; + /** + * Recalculate all currently opened workbooks in Excel. + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param calculationType - Specifies the calculation type to use. See `Excel.CalculationType` for details. + */ + calculate(calculationType: Excel.CalculationType): void; + /** + * Recalculate all currently opened workbooks in Excel. + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param calculationType - Specifies the calculation type to use. See `Excel.CalculationType` for details. + */ + calculate(calculationType: "Recalculate" | "Full" | "FullRebuild"): void; + /** + * Suspends calculation until the next `context.sync()` is called. Once set, it is the developer's responsibility to re-calc the workbook, to ensure that any dependencies are propagated. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + suspendApiCalculationUntilNextSync(): void; + /** + * Suspends screen updating until the next `context.sync()` is called. + + **Note**: Don't call `suspendScreenUpdatingUntilNextSync` repeatedly (such as in a loop). Repeated calls will cause the Excel window to flicker. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + suspendScreenUpdatingUntilNextSync(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ApplicationLoadOptions): Excel.Application; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Application; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.Application; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.Application` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ApplicationData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ApplicationData; + } + /** + * Represents the iterative calculation settings. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export class IterativeCalculation extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * True if Excel will use iteration to resolve circular references. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enabled: boolean; + /** + * Specifies the maximum amount of change between each iteration as Excel resolves circular references. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + maxChange: number; + /** + * Specifies the maximum number of iterations that Excel can use to resolve a circular reference. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + maxIteration: number; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.IterativeCalculationUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.IterativeCalculation): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.IterativeCalculationLoadOptions): Excel.IterativeCalculation; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.IterativeCalculation; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.IterativeCalculation; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.IterativeCalculation` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.IterativeCalculationData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.IterativeCalculationData; + } + /** + * Workbook is the top level object which contains related workbook objects such as worksheets, tables, and ranges. + To learn more about the workbook object model, read {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-workbooks | Work with workbooks using the Excel JavaScript API}. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class Workbook extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents the Excel application instance that contains this workbook. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly application: Excel.Application; + /** + * Represents a collection of bindings that are part of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly bindings: Excel.BindingCollection; + /** + * Represents a collection of comments associated with the workbook. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readonly comments: Excel.CommentCollection; + /** + * Represents the collection of custom XML parts contained by this workbook. + * + * @remarks + * [Api set: ExcelApi 1.5] + */ + readonly customXmlParts: Excel.CustomXmlPartCollection; + /** + * Represents all data connections in the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly dataConnections: Excel.DataConnectionCollection; + /** + * Represents a collection of worksheet functions that can be used for computation. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + readonly functions: Excel.Functions; + /** + * Returns a collection of linked entity data domains that are available in the workbook. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + readonly linkedEntityDataDomains: Excel.LinkedEntityDataDomainCollection; + + /** + * Represents a collection of workbook-scoped named items (named ranges and constants). + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly names: Excel.NamedItemCollection; + /** + * Returns a collection of all the notes objects in the workbook. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + readonly notes: Excel.NoteCollection; + /** + * Represents a collection of PivotTableStyles associated with the workbook. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readonly pivotTableStyles: Excel.PivotTableStyleCollection; + /** + * Represents a collection of PivotTables associated with the workbook. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + readonly pivotTables: Excel.PivotTableCollection; + /** + * Gets the workbook properties. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly properties: Excel.DocumentProperties; + /** + * Returns the protection object for a workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly protection: Excel.WorkbookProtection; + /** + * Returns a collection of Power Query queries that are part of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + readonly queries: Excel.QueryCollection; + /** + * Represents a collection of settings associated with the workbook. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + readonly settings: Excel.SettingCollection; + /** + * Represents a collection of SlicerStyles associated with the workbook. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readonly slicerStyles: Excel.SlicerStyleCollection; + /** + * Represents a collection of slicers associated with the workbook. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readonly slicers: Excel.SlicerCollection; + /** + * Represents a collection of styles associated with the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly styles: Excel.StyleCollection; + /** + * Represents a collection of TableStyles associated with the workbook. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readonly tableStyles: Excel.TableStyleCollection; + /** + * Represents a collection of tables associated with the workbook. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly tables: Excel.TableCollection; + /** + * Represents a collection of TimelineStyles associated with the workbook. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readonly timelineStyles: Excel.TimelineStyleCollection; + /** + * Represents a collection of worksheets associated with the workbook. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly worksheets: Excel.WorksheetCollection; + /** + * Specifies if the workbook is in AutoSave mode. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly autoSave: boolean; + /** + * Returns a number about the version of Excel Calculation Engine. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly calculationEngineVersion: number; + /** + * True if all charts in the workbook are tracking the actual data points to which they are attached. + False if the charts track the index of the data points. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + chartDataPointTrack: boolean; + /** + * Specifies if changes have been made since the workbook was last saved. + You can set this property to `true` if you want to close a modified workbook without either saving it or being prompted to save it. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + isDirty: boolean; + /** + * Gets the workbook name. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly name: string; + /** + * Specifies if the workbook has ever been saved locally or online. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly previouslySaved: boolean; + /** + * Returns `true` if the workbook is open in read-only mode. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly readOnly: boolean; + /** + * True if calculations in this workbook will be done using only the precision of the numbers as they're displayed. + Data will permanently lose accuracy when switching this property from `false` to `true`. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + usePrecisionAsDisplayed: boolean; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.WorkbookUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.Workbook): void; + /** + * Close current workbook. + * + * @remarks + * [Api set: ExcelApi 1.11] + * + * @param closeBehavior - workbook close behavior. + */ + close(closeBehavior?: Excel.CloseBehavior): void; + /** + * Close current workbook. + * + * @remarks + * [Api set: ExcelApi 1.11] + * + * @param closeBehavior - workbook close behavior. + */ + close(closeBehavior?: "Save" | "SkipSave"): void; + /** + * Gets the currently active cell from the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + getActiveCell(): Excel.Range; + /** + * Gets the currently active chart in the workbook. If there is no active chart, an `ItemNotFound` exception is thrown. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + getActiveChart(): Excel.Chart; + /** + * Gets the currently active chart in the workbook. + If there is no active chart, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + getActiveChartOrNullObject(): Excel.Chart; + /** + * Gets the active shape in the workbook. + Throws an `ItemNotFound` if there is no active shape. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + getActiveShape(): Excel.Shape; + /** + * Gets the active shape in the workbook. + If there is no active shape, then this method returns an object with its `isNullObject` property set to `true`. + For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + getActiveShapeOrNullObject(): Excel.Shape; + /** + * Gets the currently active slicer in the workbook. If there is no active slicer, an `ItemNotFound` exception is thrown. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + getActiveSlicer(): Excel.Slicer; + /** + * Gets the currently active slicer in the workbook. + If there is no active slicer, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + getActiveSlicerOrNullObject(): Excel.Slicer; + /** + * Returns `true` if the workbook is being edited by multiple users (through co-authoring). + Please be aware there might be some delay between when the workbook status changes and when the changes are reflected on the result of the method. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + getIsActiveCollabSession(): OfficeExtension.ClientResult; + /** + * Returns a `LinkedEntityCellValue` based on the provided `LinkedEntityId`. + * + * @remarks + * [Api set: ExcelApi 1.16] + * + * @param linkedEntityCellValueId - An identifier that specifies an individual `LinkedEntityCellValue`. + */ + getLinkedEntityCellValue(linkedEntityCellValueId: LinkedEntityId): OfficeExtension.ClientResult; + /** + * Gets the currently selected single range from the workbook. If there are multiple ranges selected, this method will throw an error. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + getSelectedRange(): Excel.Range; + /** + * Gets the currently selected one or more ranges from the workbook. Unlike `getSelectedRange()`, this method returns a `RangeAreas` object that represents all the selected ranges. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + getSelectedRanges(): Excel.RangeAreas; + /** + * Inserts the specified worksheets from a source workbook into the current workbook. + * The `extensionHardening` Windows registry key affects this API. The file extension defined by the `base64File` param must match the real file type of the inserted file. If `extensionHardening` is set to deny mismatches and the file extension does not match the real file type, this API throws the following error: "This operation is not allowed due to the extension hardening policy." + * + * @remarks + * [Api set: ExcelApi 1.13] + * + * This API is currently only supported for Office on Windows, Mac, and the web. + * + * @param base64File - Required. The Base64-encoded string representing the source workbook file. + * @param options - Optional. The options that define which worksheets to insert and where in the workbook the new worksheets will be inserted. By default, all the worksheets from the source workbook are inserted at the end of the current workbook. + * @returns An array of IDs corresponding to each newly inserted worksheet. + */ + insertWorksheetsFromBase64(base64File: string, options?: Excel.InsertWorksheetOptions): OfficeExtension.ClientResult; + /** + * Save current workbook. + * + * @remarks + * [Api set: ExcelApi 1.11] + * + * @param saveBehavior - The save behavior must be "Save" or "Prompt". Default value is "Save". + */ + save(saveBehavior?: Excel.SaveBehavior): void; + /** + * Save current workbook. + * + * @remarks + * [Api set: ExcelApi 1.11] + * + * @param saveBehavior - The save behavior must be "Save" or "Prompt". Default value is "Save". + */ + save(saveBehavior?: "Save" | "Prompt"): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.WorkbookLoadOptions): Excel.Workbook; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Workbook; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.Workbook; + /** + * Occurs when the workbook is activated. Note: This event will not fire when the workbook is opened. + * + * @remarks + * [Api set: ExcelApi 1.13] + * + * @eventproperty + */ + readonly onActivated: OfficeExtension.EventHandlers; + /** + * Occurs when the AutoSave setting is changed on the workbook. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @eventproperty + */ + readonly onAutoSaveSettingChanged: OfficeExtension.EventHandlers; + /** + * Occurs when the selection in the document is changed. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @eventproperty + */ + readonly onSelectionChanged: OfficeExtension.EventHandlers; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.Workbook` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.WorkbookData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.WorkbookData; + } + /** + * Represents the protection of a workbook object. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + export class WorkbookProtection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Specifies if the workbook is protected. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly protected: boolean; + /** + * Protects the workbook. Fails if the workbook has been protected. + * + * @remarks + * [Api set: ExcelApi 1.7] + * + * @param password - Workbook protection password. + */ + protect(password?: string): void; + /** + * Unprotects the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + * + * @param password - Workbook protection password. + */ + unprotect(password?: string): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.WorkbookProtectionLoadOptions): Excel.WorkbookProtection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.WorkbookProtection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.WorkbookProtection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.WorkbookProtection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.WorkbookProtectionData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.WorkbookProtectionData; + } + /** + * The `WorkbookCreated` object is the top level object created by `Application.CreateWorkbook`. A `WorkbookCreated` object is a special Workbook object. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export class WorkbookCreated extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.WorkbookCreated; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.WorkbookCreated; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.WorkbookCreated` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.WorkbookCreatedData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.WorkbookCreatedData; + } + /** + * An Excel worksheet is a grid of cells. It can contain data, tables, charts, etc. + To learn more about the worksheet object model, read {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-worksheets | Work with worksheets using the Excel JavaScript API}. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class Worksheet extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents the `AutoFilter` object of the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly autoFilter: Excel.AutoFilter; + /** + * Returns a collection of charts that are part of the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly charts: Excel.ChartCollection; + /** + * Returns a collection of all the Comments objects on the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readonly comments: Excel.CommentCollection; + /** + * Gets a collection of worksheet-level custom properties. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + readonly customProperties: Excel.WorksheetCustomPropertyCollection; + /** + * Gets an object that can be used to manipulate frozen panes on the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly freezePanes: Excel.WorksheetFreezePanes; + /** + * Gets the horizontal page break collection for the worksheet. This collection only contains manual page breaks. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly horizontalPageBreaks: Excel.PageBreakCollection; + + /** + * Collection of names scoped to the current worksheet. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + readonly names: Excel.NamedItemCollection; + /** + * Returns a collection of all the notes objects in the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + readonly notes: Excel.NoteCollection; + /** + * Gets the `PageLayout` object of the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly pageLayout: Excel.PageLayout; + /** + * Collection of PivotTables that are part of the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + readonly pivotTables: Excel.PivotTableCollection; + /** + * Returns the sheet protection object for a worksheet. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + readonly protection: Excel.WorksheetProtection; + /** + * Returns the collection of all the Shape objects on the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly shapes: Excel.ShapeCollection; + /** + * Returns a collection of slicers that are part of the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readonly slicers: Excel.SlicerCollection; + /** + * Collection of tables that are part of the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly tables: Excel.TableCollection; + /** + * Gets the vertical page break collection for the worksheet. This collection only contains manual page breaks. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly verticalPageBreaks: Excel.PageBreakCollection; + /** + * Determines if Excel should recalculate the worksheet when necessary. + True if Excel recalculates the worksheet when necessary. False if Excel doesn't recalculate the sheet. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enableCalculation: boolean; + /** + * Returns a value that uniquely identifies the worksheet in a given workbook. The value of the identifier remains the same even when the worksheet is renamed or moved. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly id: string; + /** + * The display name of the worksheet. The name must be fewer than 32 characters. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + name: string; + /** + * The zero-based position of the worksheet within the workbook. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + position: number; + /** + * Specifies if data type icons are visible on the worksheet. By default, data type icons are visible. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + showDataTypeIcons: boolean; + /** + * Specifies if gridlines are visible to the user. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showGridlines: boolean; + /** + * Specifies if headings are visible to the user. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showHeadings: boolean; + /** + * Returns the standard (default) height of all the rows in the worksheet, in points. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly standardHeight: number; + /** + * Specifies the standard (default) width of all the columns in the worksheet. + One unit of column width is equal to the width of one character in the Normal style. For proportional fonts, the width of the character 0 (zero) is used. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + standardWidth: number; + /** + * The tab color of the worksheet. + When retrieving the tab color, if the worksheet is invisible, the value will be `null`. If the worksheet is visible but the tab color is set to auto, an empty string will be returned. Otherwise, the property will be set to a color, in the form #RRGGBB (e.g., "FFA500"). + When setting the color, use an empty-string to set an "auto" color, or a real color otherwise. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + tabColor: string; + /** + * Returns a value representing this worksheet that can be read by Open Office XML. This is an integer value, which is different from `worksheet.id` (which returns a globally unique identifier) and `worksheet.name` (which returns a value such as "Sheet1"). + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + readonly tabId: number; + /** + * The visibility of the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.1 for reading visibility; 1.2 for setting it.] + */ + visibility: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden"; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.WorksheetUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.Worksheet): void; + /** + * Activate the worksheet in the Excel UI. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + activate(): void; + /** + * Calculates all cells on a worksheet. + * + * @remarks + * [Api set: ExcelApi 1.6] + * + * @param markAllDirty - True, to mark all as dirty. + */ + calculate(markAllDirty: boolean): void; + /** + * Copies a worksheet and places it at the specified position. + * + * @remarks + * [Api set: ExcelApi 1.7] + * + * @param positionType - The location in the workbook to place the newly created worksheet. The default value is "None", which inserts the worksheet at the beginning of the worksheet. + * @param relativeTo - The existing worksheet which determines the newly created worksheet's position. This is only needed if `positionType` is "Before" or "After". + * @returns The newly created worksheet. + */ + copy(positionType?: Excel.WorksheetPositionType, relativeTo?: Excel.Worksheet): Excel.Worksheet; + /** + * Copies a worksheet and places it at the specified position. + * + * @remarks + * [Api set: ExcelApi 1.7] + * + * @param positionType - The location in the workbook to place the newly created worksheet. The default value is "None", which inserts the worksheet at the beginning of the worksheet. + * @param relativeTo - The existing worksheet which determines the newly created worksheet's position. This is only needed if `positionType` is "Before" or "After". + * @returns The newly created worksheet. + */ + copy(positionType?: "None" | "Before" | "After" | "Beginning" | "End", relativeTo?: Excel.Worksheet): Excel.Worksheet; + /** + * Deletes the worksheet from the workbook. Note that if the worksheet's visibility is set to "VeryHidden", the delete operation will fail with an `InvalidOperation` exception. You should first change its visibility to hidden or visible before deleting it. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + delete(): void; + /** + * Finds all occurrences of the given string based on the criteria specified and returns them as a `RangeAreas` object, comprising one or more rectangular ranges. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param text - The string to find. + * @param criteria - Additional search criteria, including whether the search needs to match the entire cell or be case-sensitive. + * @returns A `RangeAreas` object, comprising one or more rectangular ranges, that matches the search criteria. If no cells meet this criteria, an `ItemNotFound` error will be thrown. + */ + findAll(text: string, criteria: Excel.WorksheetSearchCriteria): Excel.RangeAreas; + /** + * Finds all occurrences of the given string based on the criteria specified and returns them as a `RangeAreas` object, comprising one or more rectangular ranges. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param text - The string to find. + * @param criteria - Additional search criteria, including whether the search needs to match the entire cell or be case-sensitive. + * @returns A `RangeAreas` object, comprising one or more rectangular ranges, that matches the search criteria. + If there are no matches, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + */ + findAllOrNullObject(text: string, criteria: Excel.WorksheetSearchCriteria): Excel.RangeAreas; + /** + * Gets the `Range` object containing the single cell based on row and column numbers. The cell can be outside the bounds of its parent range, so long as it stays within the worksheet grid. + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param row - The row number of the cell to be retrieved. Zero-indexed. + * @param column - The column number of the cell to be retrieved. Zero-indexed. + */ + getCell(row: number, column: number): Excel.Range; + /** + * Gets the worksheet that follows this one. If there are no worksheets following this one, this method will throw an error. + * + * @remarks + * [Api set: ExcelApi 1.5] + * + * @param visibleOnly - Optional. If `true`, considers only visible worksheets, skipping over any hidden ones. + */ + getNext(visibleOnly?: boolean): Excel.Worksheet; + /** + * Gets the worksheet that follows this one. + If there are no worksheets following this one, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.5] + * + * @param visibleOnly - Optional. If `true`, considers only visible worksheets, skipping over any hidden ones. + */ + getNextOrNullObject(visibleOnly?: boolean): Excel.Worksheet; + /** + * Gets the worksheet that precedes this one. If there are no previous worksheets, this method will throw an error. + * + * @remarks + * [Api set: ExcelApi 1.5] + * + * @param visibleOnly - Optional. If `true`, considers only visible worksheets, skipping over any hidden ones. + */ + getPrevious(visibleOnly?: boolean): Excel.Worksheet; + /** + * Gets the worksheet that precedes this one. + If there are no previous worksheets, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.5] + * + * @param visibleOnly - Optional. If `true`, considers only visible worksheets, skipping over any hidden ones. + */ + getPreviousOrNullObject(visibleOnly?: boolean): Excel.Worksheet; + /** + * Gets the `Range` object, representing a single rectangular block of cells, specified by the address or name. + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param address - Optional. The string representing the address or name of the range. For example, "A1:B2". If not specified, the entire worksheet range is returned. The `address` has a limit of 8192 characters. If the address exceeds the character limit, this method returns an `InvalidArgument` error. + */ + getRange(address?: string): Excel.Range; + /** + * Gets the `Range` object beginning at a particular row index and column index, and spanning a certain number of rows and columns. + * + * @remarks + * [Api set: ExcelApi 1.7] + * + * @param startRow - Start row (zero-indexed). + * @param startColumn - Start column (zero-indexed). + * @param rowCount - Number of rows to include in the range. + * @param columnCount - Number of columns to include in the range. + */ + getRangeByIndexes(startRow: number, startColumn: number, rowCount: number, columnCount: number): Excel.Range; + /** + * Gets the `RangeAreas` object, representing one or more blocks of rectangular ranges, specified by the address or name. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param address - Optional. A string containing the comma-separated or semicolon-separated addresses or names of the individual ranges. For example, "A1:B2, A5:B5" or "A1:B2; A5:B5". If not specified, a `RangeAreas` object for the entire worksheet is returned. + */ + getRanges(address?: string): Excel.RangeAreas; + /** + * The used range is the smallest range that encompasses any cells that have a value or formatting assigned to them. If the entire worksheet is blank, this function will return the top left cell (i.e. it will *not* throw an error). + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param valuesOnly - Optional. If `true`, considers only cells with values as used cells (ignoring formatting). [Api set: ExcelApi 1.2] + */ + getUsedRange(valuesOnly?: boolean): Excel.Range; + /** + * The used range is the smallest range that encompasses any cells that have a value or formatting assigned to them. + If the entire worksheet is blank, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.4] + * + * @param valuesOnly - Optional. Considers only cells with values as used cells. + */ + getUsedRangeOrNullObject(valuesOnly?: boolean): Excel.Range; + /** + * Finds and replaces the given string based on the criteria specified within the current worksheet. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param text - String to find. + * @param replacement - The string that replaces the original string. + * @param criteria - Additional replacement criteria. + * @returns The number of replacements performed. + */ + replaceAll(text: string, replacement: string, criteria: Excel.ReplaceCriteria): OfficeExtension.ClientResult; + /** + * Shows row or column groups by their outline levels. + Outlines groups and summarizes a list of data in the worksheet. + The `rowLevels` and `columnLevels` parameters specify how many levels of the outline will be displayed. + The acceptable argument range is between 0 and 8. + A value of 0 does not change the current display. A value greater than the current number of levels displays all the levels. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param rowLevels - The number of row levels of an outline to display. + * @param columnLevels - The number of column levels of an outline to display. + */ + showOutlineLevels(rowLevels: number, columnLevels: number): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.WorksheetLoadOptions): Excel.Worksheet; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Worksheet; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.Worksheet; + /** + * Occurs when the worksheet is activated. + * + * @remarks + * [Api set: ExcelApi 1.7] + * + * @eventproperty + */ + readonly onActivated: OfficeExtension.EventHandlers; + /** + * Occurs when the worksheet is calculated. + * + * @remarks + * [Api set: ExcelApi 1.8] + * + * @eventproperty + */ + readonly onCalculated: OfficeExtension.EventHandlers; + /** + * Occurs when data changes in a specific worksheet. + * + * @remarks + * [Api set: ExcelApi 1.7] + * + * @eventproperty + */ + readonly onChanged: OfficeExtension.EventHandlers; + /** + * Occurs when one or more columns have been sorted. This happens as the result of a left to right sort operation. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @eventproperty + */ + readonly onColumnSorted: OfficeExtension.EventHandlers; + /** + * Occurs when the worksheet is deactivated. + * + * @remarks + * [Api set: ExcelApi 1.7] + * + * @eventproperty + */ + readonly onDeactivated: OfficeExtension.EventHandlers; + /** + * Occurs when format changed on a specific worksheet. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @eventproperty + */ + readonly onFormatChanged: OfficeExtension.EventHandlers; + /** + * Occurs when one or more formulas are changed in this worksheet. This event is for when the formula itself changes, not the data value resulting from the formula's calculation. + * + * @remarks + * [Api set: ExcelApi 1.13] + * + * @eventproperty + */ + readonly onFormulaChanged: OfficeExtension.EventHandlers; + /** + * Occurs when the worksheet name is changed. + * + * @remarks + * [Api set: ExcelApi 1.17] + * + * @eventproperty + */ + readonly onNameChanged: OfficeExtension.EventHandlers; + /** + * Occurs when the worksheet protection state is changed. + * + * @remarks + * [Api set: ExcelApi 1.14] + * + * @eventproperty + */ + readonly onProtectionChanged: OfficeExtension.EventHandlers; + /** + * Occurs when the hidden state of one or more rows has changed on a specific worksheet. + * + * @remarks + * [Api set: ExcelApi 1.11] + * + * @eventproperty + */ + readonly onRowHiddenChanged: OfficeExtension.EventHandlers; + /** + * Occurs when one or more rows have been sorted. This happens as the result of a top-to-bottom sort operation. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @eventproperty + */ + readonly onRowSorted: OfficeExtension.EventHandlers; + /** + * Occurs when the selection changes on a specific worksheet. + * + * @remarks + * [Api set: ExcelApi 1.7] + * + * @eventproperty + */ + readonly onSelectionChanged: OfficeExtension.EventHandlers; + /** + * Occurs when a left-clicked/tapped action happens in the worksheet. This event will not be fired when clicking in the following cases: + + - The user drags the mouse for multi-selection. + + - The user selects a cell in the mode when cell arguments are selected for formula references. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @eventproperty + */ + readonly onSingleClicked: OfficeExtension.EventHandlers; + /** + * Occurs when the worksheet visibility is changed. + * + * @remarks + * [Api set: ExcelApi 1.17] + * + * @eventproperty + */ + readonly onVisibilityChanged: OfficeExtension.EventHandlers; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.Worksheet` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.WorksheetData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.WorksheetData; + } + /** + * Represents a collection of worksheet objects that are part of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class WorksheetCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.Worksheet[]; + /** + * Adds a new worksheet to the workbook. The worksheet will be added at the end of existing worksheets. If you wish to activate the newly added worksheet, call `.activate()` on it. + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param name - Optional. The name of the worksheet to be added. If specified, the name should be unique. If not specified, Excel determines the name of the new worksheet. + */ + add(name?: string): Excel.Worksheet; + /** + * Gets the currently active worksheet in the workbook. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + getActiveWorksheet(): Excel.Worksheet; + /** + * Gets the number of worksheets in the collection. + * + * @remarks + * [Api set: ExcelApi 1.4] + * + * @param visibleOnly - Optional. If `true`, considers only visible worksheets, skipping over any hidden ones. + */ + getCount(visibleOnly?: boolean): OfficeExtension.ClientResult; + /** + * Gets the first worksheet in the collection. + * + * @remarks + * [Api set: ExcelApi 1.5] + * + * @param visibleOnly - Optional. If `true`, considers only visible worksheets, skipping over any hidden ones. + */ + getFirst(visibleOnly?: boolean): Excel.Worksheet; + /** + * Gets a worksheet object using its name or ID. + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param key - The name or ID of the worksheet. + */ + getItem(key: string): Excel.Worksheet; + /** + * Gets a worksheet object using its name or ID. + If the worksheet does not exist, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.4] + * + * @param key - The name or ID of the worksheet. + */ + getItemOrNullObject(key: string): Excel.Worksheet; + /** + * Gets the last worksheet in the collection. + * + * @remarks + * [Api set: ExcelApi 1.5] + * + * @param visibleOnly - Optional. If `true`, considers only visible worksheets, skipping over any hidden ones. + */ + getLast(visibleOnly?: boolean): Excel.Worksheet; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.WorksheetCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.WorksheetCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.WorksheetCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.WorksheetCollection; + /** + * Occurs when any worksheet in the workbook is activated. + * + * @remarks + * [Api set: ExcelApi 1.7] + * + * @eventproperty + */ + readonly onActivated: OfficeExtension.EventHandlers; + /** + * Occurs when a new worksheet is added to the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + * + * @eventproperty + */ + readonly onAdded: OfficeExtension.EventHandlers; + /** + * Occurs when any worksheet in the workbook is calculated. + * + * @remarks + * [Api set: ExcelApi 1.8] + * + * @eventproperty + */ + readonly onCalculated: OfficeExtension.EventHandlers; + /** + * Occurs when any worksheet in the workbook is changed. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @eventproperty + */ + readonly onChanged: OfficeExtension.EventHandlers; + /** + * Occurs when one or more columns have been sorted. This happens as the result of a left-to-right sort operation. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @eventproperty + */ + readonly onColumnSorted: OfficeExtension.EventHandlers; + /** + * Occurs when any worksheet in the workbook is deactivated. + * + * @remarks + * [Api set: ExcelApi 1.7] + * + * @eventproperty + */ + readonly onDeactivated: OfficeExtension.EventHandlers; + /** + * Occurs when a worksheet is deleted from the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + * + * @eventproperty + */ + readonly onDeleted: OfficeExtension.EventHandlers; + /** + * Occurs when any worksheet in the workbook has a format changed. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @eventproperty + */ + readonly onFormatChanged: OfficeExtension.EventHandlers; + /** + * Occurs when one or more formulas are changed in any worksheet of this collection. This event is for when the formula itself changes, not the data value resulting from the formula's calculation. + * + * @remarks + * [Api set: ExcelApi 1.13] + * + * @eventproperty + */ + readonly onFormulaChanged: OfficeExtension.EventHandlers; + /** + * Occurs when a worksheet is moved within a workbook. This event only triggers when a worksheet is directly moved within a workbook. This event doesn't trigger when the position of a worksheet is indirectly changed, such as when a new worksheet is inserted and causes existing worksheets to change positions. + * + * @remarks + * [Api set: ExcelApi 1.17] + * + * @eventproperty + */ + readonly onMoved: OfficeExtension.EventHandlers; + /** + * Occurs when the worksheet name is changed in the worksheet collection. + * + * @remarks + * [Api set: ExcelApi 1.17] + * + * @eventproperty + */ + readonly onNameChanged: OfficeExtension.EventHandlers; + /** + * Occurs when the worksheet protection state is changed. + * + * @remarks + * [Api set: ExcelApi 1.14] + * + * @eventproperty + */ + readonly onProtectionChanged: OfficeExtension.EventHandlers; + /** + * Occurs when the hidden state of one or more rows has changed on a specific worksheet. + * + * @remarks + * [Api set: ExcelApi 1.11] + * + * @eventproperty + */ + readonly onRowHiddenChanged: OfficeExtension.EventHandlers; + /** + * Occurs when one or more rows have been sorted. This happens as the result of a top-to-bottom sort operation. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @eventproperty + */ + readonly onRowSorted: OfficeExtension.EventHandlers; + /** + * Occurs when the selection changes on any worksheet. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @eventproperty + */ + readonly onSelectionChanged: OfficeExtension.EventHandlers; + /** + * Occurs when left-clicked/tapped operation happens in the worksheet collection. This event will not be fired when clicking in the following cases: + - The user drags the mouse for multi-selection. + - The user selects a cell in the mode when cell arguments are selected for formula references. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @eventproperty + */ + readonly onSingleClicked: OfficeExtension.EventHandlers; + /** + * Occurs when the worksheet visibility is changed in the worksheet collection. + * + * @remarks + * [Api set: ExcelApi 1.17] + * + * @eventproperty + */ + readonly onVisibilityChanged: OfficeExtension.EventHandlers; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.WorksheetCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.WorksheetCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.WorksheetCollectionData; + } + /** + * Represents the protection of a worksheet object. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + export class WorksheetProtection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + + + + + /** + * Specifies the protection options for the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + readonly options: Excel.WorksheetProtectionOptions; + /** + * Specifies if the worksheet is protected. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + readonly protected: boolean; + + + + /** + * Protects a worksheet. Fails if the worksheet has already been protected. + * + * @remarks + * [Api set: ExcelApi 1.2 for options; 1.7 for password] + * + * @param options - Optional. Sheet protection options. + * @param password - Optional. Sheet protection password. + */ + protect(options?: Excel.WorksheetProtectionOptions, password?: string): void; + + + /** + * Unprotects a worksheet. + * + * @remarks + * [Api set: ExcelApi 1.7 for password] + * + * @param password - Sheet protection password. + */ + unprotect(password?: string): void; + + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.WorksheetProtectionLoadOptions): Excel.WorksheetProtection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.WorksheetProtection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.WorksheetProtection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.WorksheetProtection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.WorksheetProtectionData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.WorksheetProtectionData; + } + /** + * Represents the options in sheet protection. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + export interface WorksheetProtectionOptions { + /** + * Represents the worksheet protection option allowing use of the AutoFilter feature. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + allowAutoFilter?: boolean; + /** + * Represents the worksheet protection option allowing deleting of columns. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + allowDeleteColumns?: boolean; + /** + * Represents the worksheet protection option allowing deleting of rows. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + allowDeleteRows?: boolean; + /** + * Represents the worksheet protection option allowing editing of objects. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + allowEditObjects?: boolean; + /** + * Represents the worksheet protection option allowing editing of scenarios. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + allowEditScenarios?: boolean; + /** + * Represents the worksheet protection option allowing formatting of cells. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + allowFormatCells?: boolean; + /** + * Represents the worksheet protection option allowing formatting of columns. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + allowFormatColumns?: boolean; + /** + * Represents the worksheet protection option allowing formatting of rows. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + allowFormatRows?: boolean; + /** + * Represents the worksheet protection option allowing inserting of columns. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + allowInsertColumns?: boolean; + /** + * Represents the worksheet protection option allowing inserting of hyperlinks. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + allowInsertHyperlinks?: boolean; + /** + * Represents the worksheet protection option allowing inserting of rows. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + allowInsertRows?: boolean; + /** + * Represents the worksheet protection option allowing use of the PivotTable feature. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + allowPivotTables?: boolean; + /** + * Represents the worksheet protection option allowing use of the sort feature. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + allowSort?: boolean; + /** + * Represents the worksheet protection option of selection mode. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + selectionMode?: Excel.ProtectionSelectionMode | "Normal" | "Unlocked" | "None"; + } + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + export class WorksheetFreezePanes extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Sets the frozen cells in the active worksheet view. + The range provided corresponds to cells that will be frozen in the top- and left-most pane. + * + * @remarks + * [Api set: ExcelApi 1.7] + * + * @param frozenRange - A range that represents the cells to be frozen, or `null` to remove all frozen panes. + */ + freezeAt(frozenRange: Range | string): void; + /** + * Freeze the first column or columns of the worksheet in place. + * + * @remarks + * [Api set: ExcelApi 1.7] + * + * @param count - Optional number of columns to freeze, or zero to unfreeze all columns + */ + freezeColumns(count?: number): void; + /** + * Freeze the top row or rows of the worksheet in place. + * + * @remarks + * [Api set: ExcelApi 1.7] + * + * @param count - Optional number of rows to freeze, or zero to unfreeze all rows + */ + freezeRows(count?: number): void; + /** + * Gets a range that describes the frozen cells in the active worksheet view. + The frozen range corresponds to cells that are frozen in the top- and left-most pane. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + getLocation(): Excel.Range; + /** + * Gets a range that describes the frozen cells in the active worksheet view. + The frozen range corresponds to cells that are frozen in the top- and left-most pane. + If there is no frozen pane, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + getLocationOrNullObject(): Excel.Range; + /** + * Removes all frozen panes in the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + unfreeze(): void; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.WorksheetFreezePanes` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.WorksheetFreezePanesData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): { + [key: string]: string; + }; + } + /** + * The options that define which worksheets to insert and where in the workbook the new worksheets will be inserted. + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + export interface InsertWorksheetOptions { + /** + * The insert position, in the current workbook, of the new worksheets. See `Excel.WorksheetPositionType` for details. The default position is "End". + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + positionType?: Excel.WorksheetPositionType | "None" | "Before" | "After" | "Beginning" | "End"; + /** + * The worksheet in the current workbook that is referenced for the `WorksheetPositionType` parameter. The default is `null`. If the `relativeTo` parameter is not set, worksheets will be inserted based on `positionType`, at the start or end of the current workbook. + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + relativeTo?: Worksheet | string; + /** + * The names of individual worksheets to insert. By default, all the worksheets from the source workbook are inserted. + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + sheetNamesToInsert?: string[]; + } + /** + * Range represents a set of one or more contiguous cells such as a cell, a row, a column, or a block of cells. + To learn more about how ranges are used throughout the API, start with {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-core-concepts#ranges | Ranges in the Excel JavaScript API}. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class Range extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * The collection of `ConditionalFormats` that intersect the range. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + readonly conditionalFormats: Excel.ConditionalFormatCollection; + /** + * Returns a data validation object. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly dataValidation: Excel.DataValidation; + /** + * Returns a format object, encapsulating the range's font, fill, borders, alignment, and other properties. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly format: Excel.RangeFormat; + /** + * Represents the range sort of the current range. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + readonly sort: Excel.RangeSort; + /** + * The worksheet containing the current range. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly worksheet: Excel.Worksheet; + /** + * Specifies the range reference in A1-style. Address value contains the sheet reference (e.g., "Sheet1!A1:B4"). + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly address: string; + /** + * Represents the range reference for the specified range in the language of the user. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly addressLocal: string; + /** + * Specifies the number of cells in the range. This API will return -1 if the cell count exceeds 2^31-1 (2,147,483,647). + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly cellCount: number; + /** + * Specifies the total number of columns in the range. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly columnCount: number; + /** + * Represents if all columns in the current range are hidden. Value is `true` when all columns in a range are hidden. Value is `false` when no columns in the range are hidden. Value is `null` when some columns in a range are hidden and other columns in the same range are not hidden. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + columnHidden: boolean; + /** + * Specifies the column number of the first cell in the range. Zero-indexed. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly columnIndex: number; + /** + * Accesses the cell control applied to this range. + If the range has multiple cell controls, this returns `EmptyCellControl`. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + control: CellControl; + /** + * Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + formulas: any[][]; + /** + * Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. If a cell has no formula, its value is returned instead. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + formulasLocal: any[][]; + /** + * Represents the formula in R1C1-style notation. If a cell has no formula, its value is returned instead. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + formulasR1C1: any[][]; + /** + * Represents if all cells have a spill border. + Returns `true` if all cells have a spill border, or `false` if all cells do not have a spill border. + Returns `null` if there are cells both with and without spill borders within the range. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + readonly hasSpill: boolean; + /** + * Returns the distance in points, for 100% zoom, from the top edge of the range to the bottom edge of the range. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readonly height: number; + /** + * Represents if all cells in the current range are hidden. Value is `true` when all cells in a range are hidden. Value is `false` when no cells in the range are hidden. Value is `null` when some cells in a range are hidden and other cells in the same range are not hidden. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + readonly hidden: boolean; + /** + * Represents the hyperlink for the current range. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + hyperlink: Excel.RangeHyperlink; + /** + * Represents if the current range is an entire column. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly isEntireColumn: boolean; + /** + * Represents if the current range is an entire row. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly isEntireRow: boolean; + /** + * Returns the distance in points, for 100% zoom, from the left edge of the worksheet to the left edge of the range. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readonly left: number; + /** + * Represents the data type state of each cell. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly linkedDataTypeState: Excel.LinkedDataTypeState[][]; + /** + * Represents Excel's number format code for the given range. For more information about Excel number formatting, see {@link https://support.microsoft.com/office/5026bbd6-04bc-48cd-bf33-80f18b4eae68 | Number format codes}. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + numberFormat: any[][]; + /** + * Represents the category of number format of each cell. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + readonly numberFormatCategories: Excel.NumberFormatCategory[][]; + /** + * Represents Excel's number format code for the given range, based on the language settings of the user. + Excel does not perform any language or format coercion when getting or setting the `numberFormatLocal` property. + Any returned text uses the locally-formatted strings based on the language specified in the system settings. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + numberFormatLocal: any[][]; + /** + * Returns the total number of rows in the range. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly rowCount: number; + /** + * Represents if all rows in the current range are hidden. Value is `true` when all rows in a range are hidden. Value is `false` when no rows in the range are hidden. Value is `null` when some rows in a range are hidden and other rows in the same range are not hidden. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + rowHidden: boolean; + /** + * Returns the row number of the first cell in the range. Zero-indexed. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly rowIndex: number; + /** + * Represents if all the cells would be saved as an array formula. + Returns `true` if all cells would be saved as an array formula, or `false` if all cells would not be saved as an array formula. + Returns `null` if some cells would be saved as an array formula and some would not be. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + readonly savedAsArray: boolean; + /** + * Represents the style of the current range. + If the styles of the cells are inconsistent, `null` will be returned. + For custom styles, the style name will be returned. For built-in styles, a string representing a value in the `BuiltInStyle` enum will be returned. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + style: string; + /** + * Text values of the specified range. The text value will not depend on the cell width. The number sign (#) substitution that happens in the Excel UI will not affect the text value returned by the API. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly text: string[][]; + /** + * Returns the distance in points, for 100% zoom, from the top edge of the worksheet to the top edge of the range. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readonly top: number; + /** + * Specifies the type of data in each cell. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly valueTypes: Excel.RangeValueType[][]; + /** + * Represents the raw values of the specified range. The data returned could be a string, number, or boolean. Cells that contain an error will return the error string. + If the returned value starts with a plus ("+"), minus ("-"), or equal sign ("="), Excel interprets this value as a formula. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + values: any[][]; + /** + * A JSON representation of the values in the cells in this range. + Unlike `Range.values`, `Range.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `Range.valuesAsJsonLocal`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJson: CellValue[][]; + /** + * A JSON representation of the values in the cells in this range. + Unlike `Range.values`, `Range.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `Range.valuesAsJson`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJsonLocal: CellValue[][]; + /** + * Returns the distance in points, for 100% zoom, from the left edge of the range to the right edge of the range. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readonly width: number; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.RangeUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.Range): void; + /** + * Fills a range from the current range to the destination range using the specified AutoFill logic. + The destination range can be `null` or can extend the source range either horizontally or vertically. + Discontiguous ranges are not supported. + + For more information, see {@link https://support.microsoft.com/office/2e79a709-c814-4b27-8bc2-c4dc84d49464 | Use AutoFill and Flash Fill}. + * + * @remarks + * [Api set: ExcelApi 1.9, ExcelApi Preview for null `destinationRange`] + * + * @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(destinationRange?: Range | string, autoFillType?: Excel.AutoFillType): void; + /** + * Fills a range from the current range to the destination range using the specified AutoFill logic. + The destination range can be `null` or can extend the source range either horizontally or vertically. + Discontiguous ranges are not supported. + + For more information, see {@link https://support.microsoft.com/office/2e79a709-c814-4b27-8bc2-c4dc84d49464 | Use AutoFill and Flash Fill}. + * + * @remarks + * [Api set: ExcelApi 1.9, ExcelApi Preview for null `destinationRange`] + * + * @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(destinationRange?: Range | string, autoFillType?: "FillDefault" | "FillCopy" | "FillSeries" | "FillFormats" | "FillValues" | "FillDays" | "FillWeekdays" | "FillMonths" | "FillYears" | "LinearTrend" | "GrowthTrend" | "FlashFill"): void; + /** + * Calculates a range of cells on a worksheet. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + calculate(): void; + /** + * Clear range values and formatting, such as fill and border. + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param applyTo - Optional. Determines the type of clear action. See `Excel.ClearApplyTo` for details. + */ + clear(applyTo?: Excel.ClearApplyTo): void; + /** + * Clear range values and formatting, such as fill and border. + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param applyTo - Optional. Determines the type of clear action. See `Excel.ClearApplyTo` for details. + */ + clear(applyTo?: "All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks" | "ResetContents"): void; + /** + * Clears the values of the cells in the range, with special consideration given to cells containing controls. + If the range contains only blank values and controls set to their default value, then the values and control formatting are removed. + Otherwise, this sets the cells with controls to their default value and clears the values of the other cells in the range. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + clearOrResetContents(): void; + /** + * Converts the range cells with data types into text. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + convertDataTypeToText(): void; + /** + * Converts the range cells into linked data types in the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param serviceID - The service ID which will be used to query the data. + * @param languageCulture - Language culture to query the service for. + */ + convertToLinkedDataType(serviceID: number, languageCulture: string): void; + /** + * Copies cell data or formatting from the source range or `RangeAreas` to the current range. The destination range can be a different size than the source range or `RangeAreas`. The destination is expanded automatically if it's smaller than the source. + Note: Like the copy functionality in the Excel UI, if the destination range is an exact multiple greater than the source range in either rows or columns, then the source content is replicated multiple times. For example, a 2x2 range copy into a 2x6 range will result in 3 copies of the original 2x2 range. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param sourceRange - The source range or `RangeAreas` to copy from. When the source `RangeAreas` has multiple ranges, their form must be able to be created by removing full rows or columns from a rectangular range. + * @param copyType - The type of cell data or formatting to copy over. Default is "All". + * @param skipBlanks - True if to skip blank cells in the source range. Default is false. + * @param transpose - True if to transpose the cells in the destination range. Default is false. + */ + copyFrom(sourceRange: Range | RangeAreas | string, copyType?: Excel.RangeCopyType, skipBlanks?: boolean, transpose?: boolean): void; + /** + * Copies cell data or formatting from the source range or `RangeAreas` to the current range. The destination range can be a different size than the source range or `RangeAreas`. The destination is expanded automatically if it's smaller than the source. + Note: Like the copy functionality in the Excel UI, if the destination range is an exact multiple greater than the source range in either rows or columns, then the source content is replicated multiple times. For example, a 2x2 range copy into a 2x6 range will result in 3 copies of the original 2x2 range. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param sourceRange - The source range or `RangeAreas` to copy from. When the source `RangeAreas` has multiple ranges, their form must be able to be created by removing full rows or columns from a rectangular range. + * @param copyType - The type of cell data or formatting to copy over. Default is "All". + * @param skipBlanks - True if to skip blank cells in the source range. Default is false. + * @param transpose - True if to transpose the cells in the destination range. Default is false. + */ + copyFrom(sourceRange: Range | RangeAreas | string, copyType?: "All" | "Formulas" | "Values" | "Formats" | "Link", skipBlanks?: boolean, transpose?: boolean): void; + /** + * Deletes the cells associated with the range. + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param shift - Specifies which way to shift the cells. See `Excel.DeleteShiftDirection` for details. + */ + delete(shift: Excel.DeleteShiftDirection): void; + /** + * Deletes the cells associated with the range. + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param shift - Specifies which way to shift the cells. See `Excel.DeleteShiftDirection` for details. + */ + delete(shift: "Up" | "Left"): void; + /** + * Finds the given string based on the criteria specified. + If the current range is larger than a single cell, then the search will be limited to that range, else the search will cover the entire sheet starting after that cell. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param text - The string to find. + * @param criteria - Additional search criteria, including the search direction and whether the search needs to match the entire cell or be case-sensitive. + * @returns The `Range` object representing the first cell that contains a value matching the search text and criteria. + */ + find(text: string, criteria: Excel.SearchCriteria): Excel.Range; + /** + * Finds the given string based on the criteria specified. + If the current range is larger than a single cell, then the search will be limited to that range, else the search will cover the entire sheet starting after that cell. + If there are no matches, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param text - The string to find. + * @param criteria - Additional search criteria, including the search direction and whether the search needs to match the entire cell or be case-sensitive. + * @returns The `Range` which matched the search criteria. + */ + findOrNullObject(text: string, criteria: Excel.SearchCriteria): Excel.Range; + /** + * Does a Flash Fill to the current range. Flash Fill automatically fills data when it senses a pattern, so the range must be a single column range and have data around it in order to find a pattern. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + flashFill(): void; + /** + * Gets a `Range` object with the same top-left cell as the current `Range` object, but with the specified numbers of rows and columns. + * + * @remarks + * [Api set: ExcelApi 1.7] + * + * @param numRows - The number of rows of the new range size. + * @param numColumns - The number of columns of the new range size. + */ + getAbsoluteResizedRange(numRows: number, numColumns: number): Excel.Range; + /** + * Gets the smallest range object that encompasses the given ranges. For example, the `GetBoundingRect` of "B2:C5" and "D10:E15" is "B2:E15". + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param anotherRange - The range object, address, or range name. + */ + getBoundingRect(anotherRange: Range | string): Excel.Range; + /** + * Gets the range object containing the single cell based on row and column numbers. The cell can be outside the bounds of its parent range, so long as it stays within the worksheet grid. The returned cell is located relative to the top left cell of the range. + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param row - Row number of the cell to be retrieved. Zero-indexed. + * @param column - Column number of the cell to be retrieved. Zero-indexed. + */ + getCell(row: number, column: number): Excel.Range; + /** + * Returns a 2D array, encapsulating the data for each cell's font, fill, borders, alignment, and other properties. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param cellPropertiesLoadOptions - An object that represents which cell properties to load. + * @returns A 2D array where each item represents the requested properties of the corresponding cell. + */ + getCellProperties(cellPropertiesLoadOptions: CellPropertiesLoadOptions): OfficeExtension.ClientResult; + /** + * Gets a column contained in the range. + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param column - Column number of the range to be retrieved. Zero-indexed. + */ + getColumn(column: number): Excel.Range; + /** + * Returns a single-dimensional array, encapsulating the data for each column's font, fill, borders, alignment, and other properties. For properties that are not consistent across each cell within a given column, null will be returned. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param columnPropertiesLoadOptions - An object that represents which column properties to load. + * @returns An array where each item represents the requested properties of the corresponding column. + */ + getColumnProperties(columnPropertiesLoadOptions: ColumnPropertiesLoadOptions): OfficeExtension.ClientResult; + /** + * Gets a certain number of columns to the right of the current `Range` object. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param count - Optional. The number of columns to include in the resulting range. In general, use a positive number to create a range outside the current range. You can also use a negative number to create a range within the current range. The default value is 1. + */ + getColumnsAfter(count?: number): Excel.Range; + /** + * Gets a certain number of columns to the left of the current `Range` object. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param count - Optional. The number of columns to include in the resulting range. In general, use a positive number to create a range outside the current range. You can also use a negative number to create a range within the current range. The default value is 1. + */ + getColumnsBefore(count?: number): Excel.Range; + /** + * Returns a `WorkbookRangeAreas` object that represents the range containing all the dependent cells of a specified range in the same worksheet or across multiple worksheets. + Throws an `ItemNotFound` error if no dependents are found. + * + * @remarks + * [Api set: ExcelApi 1.15] + */ + getDependents(): Excel.WorkbookRangeAreas; + /** + * Returns a `WorkbookRangeAreas` object that represents the range containing all the direct dependent cells of a specified range in the same worksheet or across multiple worksheets. + Throws an `ItemNotFound` error if no dependents are found. + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + getDirectDependents(): Excel.WorkbookRangeAreas; + /** + * Returns a `WorkbookRangeAreas` object that represents the range containing all the direct precedent cells of a specified range in the same worksheet or across multiple worksheets. + Throws an `ItemNotFound` error if no precedents are found. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + getDirectPrecedents(): Excel.WorkbookRangeAreas; + /** + * Returns a 2D array, encapsulating the display data for each cell's font, fill, borders, alignment, and other properties. + Unlike `getCellProperties`, which only shows properties that are set directly for the cell, this returns properties that are displayed from indirect sources, such as conditional formatting or styles. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * @param cellPropertiesLoadOptions - An object that represents which cell properties to load. + * @returns A 2D array where each item represents the requested display properties of the corresponding cell. + */ + getDisplayedCellProperties(cellPropertiesLoadOptions: CellPropertiesLoadOptions): OfficeExtension.ClientResult; + /** + * Gets an object that represents the entire column of the range (for example, if the current range represents cells "B4:E11", its `getEntireColumn` is a range that represents columns "B:E"). + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + getEntireColumn(): Excel.Range; + /** + * Gets an object that represents the entire row of the range (for example, if the current range represents cells "B4:E11", its `GetEntireRow` is a range that represents rows "4:11"). + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + getEntireRow(): Excel.Range; + /** + * Returns a range object that includes the current range and up to the edge of the range, based on the provided direction. This matches the Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + * + * @remarks + * [Api set: ExcelApi 1.13] + * + * @param direction - The direction from the active cell. + * @param activeCell - The active cell in this range. By default, the active cell is the top-left cell of the range. An error is thrown if the active cell is not in this range. + */ + getExtendedRange(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range; + /** + * Returns a range object that includes the current range and up to the edge of the range, based on the provided direction. This matches the Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + * + * @remarks + * [Api set: ExcelApi 1.13] + * + * @param direction - The direction from the active cell. + * @param activeCell - The active cell in this range. By default, the active cell is the top-left cell of the range. An error is thrown if the active cell is not in this range. + */ + getExtendedRange(direction: "Left" | "Right" | "Up" | "Down", activeCell?: Range | string): Excel.Range; + /** + * Renders the range as a Base64-encoded PNG image. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + getImage(): OfficeExtension.ClientResult; + /** + * Gets the range object that represents the rectangular intersection of the given ranges. + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param anotherRange - The range object or range address that will be used to determine the intersection of ranges. + */ + getIntersection(anotherRange: Range | string): Excel.Range; + /** + * Gets the range object that represents the rectangular intersection of the given ranges. + If no intersection is found, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.4] + * + * @param anotherRange - The range object or range address that will be used to determine the intersection of ranges. + */ + getIntersectionOrNullObject(anotherRange: Range | string): Excel.Range; + /** + * Gets the last cell within the range. For example, the last cell of "B2:D5" is "D5". + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + getLastCell(): Excel.Range; + /** + * Gets the last column within the range. For example, the last column of "B2:D5" is "D2:D5". + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + getLastColumn(): Excel.Range; + /** + * Gets the last row within the range. For example, the last row of "B2:D5" is "B5:D5". + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + getLastRow(): Excel.Range; + /** + * Returns a `RangeAreas` object that represents the merged areas in this range. Note that if the merged areas count in this range is more than 512, then this method will fail to return the result. + If the `RangeAreas` object doesn't exist, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + getMergedAreasOrNullObject(): Excel.RangeAreas; + /** + * Gets an object which represents a range that's offset from the specified range. The dimension of the returned range will match this range. If the resulting range is forced outside the bounds of the worksheet grid, an error will be thrown. + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param rowOffset - The number of rows (positive, negative, or 0) by which the range is to be offset. Positive values are offset downward, and negative values are offset upward. + * @param columnOffset - The number of columns (positive, negative, or 0) by which the range is to be offset. Positive values are offset to the right, and negative values are offset to the left. + */ + getOffsetRange(rowOffset: number, columnOffset: number): Excel.Range; + /** + * Gets a scoped collection of PivotTables that overlap with the range. + * + * @remarks + * [Api set: ExcelApi 1.12] + * + * @param fullyContained - If `true`, returns only PivotTables that are fully contained within the range bounds. The default value is `false`. + * @returns + */ + getPivotTables(fullyContained?: boolean): Excel.PivotTableScopedCollection; + /** + * Returns a `WorkbookRangeAreas` object that represents the range containing all the precedent cells of a specified range in the same worksheet or across multiple worksheets. + Throws an `ItemNotFound` error if no precedents are found. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + getPrecedents(): Excel.WorkbookRangeAreas; + /** + * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. + * + * @remarks + * [Api set: ExcelApi 1.13] + * + * @param direction - The direction from the active cell. + * @param activeCell - The active cell in this range. By default, the active cell is the top-left cell of the range. An error is thrown if the active cell is not in this range. + */ + getRangeEdge(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range; + /** + * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. + * + * @remarks + * [Api set: ExcelApi 1.13] + * + * @param direction - The direction from the active cell. + * @param activeCell - The active cell in this range. By default, the active cell is the top-left cell of the range. An error is thrown if the active cell is not in this range. + */ + getRangeEdge(direction: "Left" | "Right" | "Up" | "Down", activeCell?: Range | string): Excel.Range; + /** + * Gets a `Range` object similar to the current `Range` object, but with its bottom-right corner expanded (or contracted) by some number of rows and columns. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param deltaRows - The number of rows by which to expand the bottom-right corner, relative to the current range. Use a positive number to expand the range, or a negative number to decrease it. + * @param deltaColumns - The number of columns by which to expand the bottom-right corner, relative to the current range. Use a positive number to expand the range, or a negative number to decrease it. + */ + getResizedRange(deltaRows: number, deltaColumns: number): Excel.Range; + /** + * Gets a row contained in the range. + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param row - Row number of the range to be retrieved. Zero-indexed. + */ + getRow(row: number): Excel.Range; + /** + * Returns a single-dimensional array, encapsulating the data for each row's font, fill, borders, alignment, and other properties. For properties that are not consistent across each cell within a given row, `null` will be returned. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param rowPropertiesLoadOptions - An object that represents which row properties to load. + * @returns An array where each item represents the requested properties of the corresponding row. + */ + getRowProperties(rowPropertiesLoadOptions: RowPropertiesLoadOptions): OfficeExtension.ClientResult; + /** + * Gets a certain number of rows above the current `Range` object. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param count - Optional. The number of rows to include in the resulting range. In general, use a positive number to create a range outside the current range. You can also use a negative number to create a range within the current range. The default value is 1. + */ + getRowsAbove(count?: number): Excel.Range; + /** + * Gets a certain number of rows below the current `Range` object. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param count - Optional. The number of rows to include in the resulting range. In general, use a positive number to create a range outside the current range. You can also use a negative number to create a range within the current range. The default value is 1. + */ + getRowsBelow(count?: number): Excel.Range; + /** + * Gets the `RangeAreas` object, comprising one or more rectangular ranges, that represents all the cells that match the specified type and value. + If no special cells are found, an `ItemNotFound` error will be thrown. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param cellType - The type of cells to include. + * @param cellValueType - If `cellType` is either `constants` or `formulas`, this argument is used to determine which types of cells to include in the result. These values can be combined together to return more than one type. The default is to select all constants or formulas, no matter what the type. + */ + getSpecialCells(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas; + /** + * Gets the `RangeAreas` object, comprising one or more rectangular ranges, that represents all the cells that match the specified type and value. + If no special cells are found, an `ItemNotFound` error will be thrown. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param cellType - The type of cells to include. + * @param cellValueType - If `cellType` is either `constants` or `formulas`, this argument is used to determine which types of cells to include in the result. These values can be combined together to return more than one type. The default is to select all constants or formulas, no matter what the type. + */ + getSpecialCells(cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueType?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas; + /** + * Gets the `RangeAreas` object, comprising one or more ranges, that represents all the cells that match the specified type and value. + If no special cells are found, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param cellType - The type of cells to include. + * @param cellValueType - If `cellType` is either `constants` or `formulas`, this argument is used to determine which types of cells to include in the result. These values can be combined together to return more than one type. The default is to select all constants or formulas, no matter what the type. + */ + getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas; + /** + * Gets the `RangeAreas` object, comprising one or more ranges, that represents all the cells that match the specified type and value. + If no special cells are found, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param cellType - The type of cells to include. + * @param cellValueType - If `cellType` is either `constants` or `formulas`, this argument is used to determine which types of cells to include in the result. These values can be combined together to return more than one type. The default is to select all constants or formulas, no matter what the type. + */ + getSpecialCellsOrNullObject(cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueType?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas; + /** + * Gets the range object containing the anchor cell for a cell getting spilled into. Fails if applied to a range with more than one cell. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + getSpillParent(): Excel.Range; + /** + * Gets the range object containing the anchor cell for the cell getting spilled into. + If it's not a spilled cell, or more than one cell is given, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + getSpillParentOrNullObject(): Excel.Range; + /** + * Gets the range object containing the spill range when called on an anchor cell. Fails if applied to a range with more than one cell. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + getSpillingToRange(): Excel.Range; + /** + * Gets the range object containing the spill range when called on an anchor cell. + If the range isn't an anchor cell or the spill range can't be found, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + getSpillingToRangeOrNullObject(): Excel.Range; + /** + * Returns a `Range` object that represents the surrounding region for the top-left cell in this range. A surrounding region is a range bounded by any combination of blank rows and blank columns relative to this range. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + getSurroundingRegion(): Excel.Range; + /** + * Gets a scoped collection of tables that overlap with the range. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param fullyContained - If `true`, returns only tables that are fully contained within the range bounds. The default value is `false`. + */ + getTables(fullyContained?: boolean): Excel.TableScopedCollection; + /** + * Returns the used range of the given range object. If there are no used cells within the range, this function will throw an `ItemNotFound` error. + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param valuesOnly - Considers only cells with values as used cells. [Api set: ExcelApi 1.2] + */ + getUsedRange(valuesOnly?: boolean): Excel.Range; + /** + * Returns the used range of the given range object. + If there are no used cells within the range, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.4] + * + * @param valuesOnly - Considers only cells with values as used cells. + */ + getUsedRangeOrNullObject(valuesOnly?: boolean): Excel.Range; + /** + * Represents the visible rows of the current range. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + getVisibleView(): Excel.RangeView; + /** + * Groups columns and rows for an outline. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param groupOption - Specifies how the range can be grouped by rows or columns. + * An `InvalidArgument` error is thrown when the group option differs from the range's + * `isEntireRow` or `isEntireColumn` property (i.e., `range.isEntireRow` is true and `groupOption` is "ByColumns" + * or `range.isEntireColumn` is true and `groupOption` is "ByRows"). + */ + group(groupOption: Excel.GroupOption): void; + /** + * Groups columns and rows for an outline. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param groupOption - Specifies how the range can be grouped by rows or columns. + * An `InvalidArgument` error is thrown when the group option differs from the range's + * `isEntireRow` or `isEntireColumn` property (i.e., `range.isEntireRow` is true and `groupOption` is "ByColumns" + * or `range.isEntireColumn` is true and `groupOption` is "ByRows"). + */ + group(groupOption: "ByRows" | "ByColumns"): void; + /** + * Hides the details of the row or column group. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param groupOption - Specifies whether to hide the details of grouped rows or grouped columns. + */ + hideGroupDetails(groupOption: Excel.GroupOption): void; + /** + * Hides the details of the row or column group. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param groupOption - Specifies whether to hide the details of grouped rows or grouped columns. + */ + hideGroupDetails(groupOption: "ByRows" | "ByColumns"): void; + /** + * Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. Returns a new `Range` object at the now blank space. + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param shift - Specifies which way to shift the cells. See `Excel.InsertShiftDirection` for details. + */ + insert(shift: Excel.InsertShiftDirection): Excel.Range; + /** + * Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. Returns a new `Range` object at the now blank space. + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param shift - Specifies which way to shift the cells. See `Excel.InsertShiftDirection` for details. + */ + insert(shift: "Down" | "Right"): Excel.Range; + /** + * Merge the range cells into one region in the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param across - Optional. Set `true` to merge cells in each row of the specified range as separate merged cells. The default value is `false`. + */ + merge(across?: boolean): void; + /** + * Moves cell values, formatting, and formulas from current range to the destination range, replacing the old information in those cells. + The destination range will be expanded automatically if it is smaller than the current range. Any cells in the destination range that are outside of the original range's area are not changed. + * + * @remarks + * [Api set: ExcelApi 1.11] + * + * @param destinationRange - destinationRange Specifies the range to where the information in this range will be moved. + */ + moveTo(destinationRange: Range | string): void; + /** + * Removes duplicate values from the range specified by the columns. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param columns - The columns inside the range that may contain duplicates. At least one column needs to be specified. Zero-indexed. + * @param includesHeader - True if the input data contains header. Default is false. + * @returns The resulting object that contains the number of rows removed and the number of remaining unique rows. + */ + removeDuplicates(columns: number[], includesHeader: boolean): Excel.RemoveDuplicatesResult; + /** + * Finds and replaces the given string based on the criteria specified within the current range. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param text - String to find. + * @param replacement - The string that replaces the original string. + * @param criteria - Additional replacement criteria. + * @returns The number of replacements performed. + */ + replaceAll(text: string, replacement: string, criteria: Excel.ReplaceCriteria): OfficeExtension.ClientResult; + /** + * Selects the specified range in the Excel UI. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + select(): void; + /** + * Updates the range based on a 2D array of cell properties, encapsulating things like font, fill, borders, and alignment. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param cellPropertiesData - A 2D array that represents which properties to set in each cell. + */ + setCellProperties(cellPropertiesData: SettableCellProperties[][]): void; + /** + * Updates the range based on a single-dimensional array of column properties, encapsulating things like font, fill, borders, and alignment. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param columnPropertiesData - An array that represents which properties to set in each column. + */ + setColumnProperties(columnPropertiesData: SettableColumnProperties[]): void; + /** + * Set a range to be recalculated when the next recalculation occurs. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + setDirty(): void; + /** + * Updates the range based on a single-dimensional array of row properties, encapsulating things like font, fill, borders, and alignment. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param rowPropertiesData - An array that represents which properties to set in each row. + */ + setRowProperties(rowPropertiesData: SettableRowProperties[]): void; + /** + * Displays the card for an active cell if it has rich value content. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showCard(): void; + /** + * Shows the details of the row or column group. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param groupOption - Specifies whether to show the details of grouped rows or grouped columns. + */ + showGroupDetails(groupOption: Excel.GroupOption): void; + /** + * Shows the details of the row or column group. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param groupOption - Specifies whether to show the details of grouped rows or grouped columns. + */ + showGroupDetails(groupOption: "ByRows" | "ByColumns"): void; + /** + * Ungroups columns and rows for an outline. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param groupOption - Specifies how the range can be ungrouped by rows or columns. + */ + ungroup(groupOption: Excel.GroupOption): void; + /** + * Ungroups columns and rows for an outline. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param groupOption - Specifies how the range can be ungrouped by rows or columns. + */ + ungroup(groupOption: "ByRows" | "ByColumns"): void; + /** + * Unmerge the range cells into separate cells. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + unmerge(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.RangeLoadOptions): Excel.Range; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Range; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.Range; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. + */ + track(): Excel.Range; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Excel.Range; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.Range` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.RangeData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.RangeData; + } + /** + * Represents a string reference of the form "SheetName!A1:B5", or a global or local named range. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + export interface RangeReference { + /** + * The address of the range, for example "SheetName!A1:B5". + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + address: string; + } + /** + * Represents the necessary strings to get/set a hyperlink (XHL) object. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + export interface RangeHyperlink { + /** + * Represents the URL target for the hyperlink. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + address?: string; + /** + * Represents the document reference target for the hyperlink. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + documentReference?: string; + /** + * Represents the string displayed when hovering over the hyperlink. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + screenTip?: string; + /** + * Represents the string that is displayed in the top left most cell in the range. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + textToDisplay?: string; + } + /** + * `RangeAreas` represents a collection of one or more rectangular ranges in the same worksheet. + To learn how to use discontiguous ranges, read {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-multiple-ranges | Work with multiple ranges simultaneously in Excel add-ins}. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export class RangeAreas extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns a collection of rectangular ranges that comprise this `RangeAreas` object. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly areas: Excel.RangeCollection; + /** + * Returns a collection of conditional formats that intersect with any cells in this `RangeAreas` object. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly conditionalFormats: Excel.ConditionalFormatCollection; + /** + * Returns a data validation object for all ranges in the `RangeAreas`. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly dataValidation: Excel.DataValidation; + /** + * Returns a `RangeFormat` object, encapsulating the font, fill, borders, alignment, and other properties for all ranges in the `RangeAreas` object. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly format: Excel.RangeFormat; + /** + * Returns the worksheet for the current `RangeAreas`. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly worksheet: Excel.Worksheet; + /** + * Returns the `RangeAreas` reference in A1-style. Address value will contain the worksheet name for each rectangular block of cells (e.g., "Sheet1!A1:B4, Sheet1!D1:D4"). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly address: string; + /** + * Returns the `RangeAreas` reference in the user locale. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly addressLocal: string; + /** + * Returns the number of rectangular ranges that comprise this `RangeAreas` object. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly areaCount: number; + /** + * Returns the number of cells in the `RangeAreas` object, summing up the cell counts of all of the individual rectangular ranges. Returns -1 if the cell count exceeds 2^31-1 (2,147,483,647). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly cellCount: number; + /** + * Specifies if all the ranges on this `RangeAreas` object represent entire columns (e.g., "A:C, Q:Z"). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly isEntireColumn: boolean; + /** + * Specifies if all the ranges on this `RangeAreas` object represent entire rows (e.g., "1:3, 5:7"). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly isEntireRow: boolean; + /** + * Represents the style for all ranges in this `RangeAreas` object. + If the styles of the cells are inconsistent, `null` will be returned. + For custom styles, the style name will be returned. For built-in styles, a string representing a value in the `BuiltInStyle` enum will be returned. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + style: string; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.RangeAreasUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.RangeAreas): void; + /** + * Calculates all cells in the `RangeAreas`. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + calculate(): void; + /** + * Clears values, format, fill, border, and other properties on each of the areas that comprise this `RangeAreas` object. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param applyTo - Optional. Determines the type of clear action. See `Excel.ClearApplyTo` for details. Default is "All". + */ + clear(applyTo?: Excel.ClearApplyTo): void; + /** + * Clears values, format, fill, border, and other properties on each of the areas that comprise this `RangeAreas` object. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param applyTo - Optional. Determines the type of clear action. See `Excel.ClearApplyTo` for details. Default is "All". + */ + clear(applyTo?: "All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks" | "ResetContents"): void; + /** + * Clears the values of the cells in the ranges, with special consideration given to cells containing controls. + If the ranges contain only blank values and controls set to their default value, then the values and control formatting are removed. + Otherwise, this sets the cells with controls to their default value and clears the values of the other cells in the ranges. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + clearOrResetContents(): void; + /** + * Converts all cells in the `RangeAreas` with data types into text. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + convertDataTypeToText(): void; + /** + * Converts all cells in the `RangeAreas` into linked data types. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param serviceID - The service ID which will be used to query the data. + * @param languageCulture - Language culture to query the service for. + */ + convertToLinkedDataType(serviceID: number, languageCulture: string): void; + /** + * Copies cell data or formatting from the source range or `RangeAreas` to the current `RangeAreas`. + The destination `RangeAreas` can be a different size than the source range or `RangeAreas`. The destination will be expanded automatically if it is smaller than the source. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param sourceRange - The source range or `RangeAreas` to copy from. When the source `RangeAreas` has multiple ranges, their form must able to be created by removing full rows or columns from a rectangular range. + * @param copyType - The type of cell data or formatting to copy over. Default is "All". + * @param skipBlanks - True if to skip blank cells in the source range or `RangeAreas`. Default is false. + * @param transpose - True if to transpose the cells in the destination `RangeAreas`. Default is false. + */ + copyFrom(sourceRange: Range | RangeAreas | string, copyType?: Excel.RangeCopyType, skipBlanks?: boolean, transpose?: boolean): void; + /** + * Copies cell data or formatting from the source range or `RangeAreas` to the current `RangeAreas`. + The destination `RangeAreas` can be a different size than the source range or `RangeAreas`. The destination will be expanded automatically if it is smaller than the source. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param sourceRange - The source range or `RangeAreas` to copy from. When the source `RangeAreas` has multiple ranges, their form must able to be created by removing full rows or columns from a rectangular range. + * @param copyType - The type of cell data or formatting to copy over. Default is "All". + * @param skipBlanks - True if to skip blank cells in the source range or `RangeAreas`. Default is false. + * @param transpose - True if to transpose the cells in the destination `RangeAreas`. Default is false. + */ + copyFrom(sourceRange: Range | RangeAreas | string, copyType?: "All" | "Formulas" | "Values" | "Formats" | "Link", skipBlanks?: boolean, transpose?: boolean): void; + /** + * Returns a `RangeAreas` object that represents the entire columns of the `RangeAreas` (for example, if the current `RangeAreas` represents cells "B4:E11, H2", it returns a `RangeAreas` that represents columns "B:E, H:H"). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + getEntireColumn(): Excel.RangeAreas; + /** + * Returns a `RangeAreas` object that represents the entire rows of the `RangeAreas` (for example, if the current `RangeAreas` represents cells "B4:E11", it returns a `RangeAreas` that represents rows "4:11"). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + getEntireRow(): Excel.RangeAreas; + /** + * Returns the `RangeAreas` object that represents the intersection of the given ranges or `RangeAreas`. If no intersection is found, an `ItemNotFound` error will be thrown. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param anotherRange - The range, `RangeAreas` object, or range address that will be used to determine the intersection. + */ + getIntersection(anotherRange: Range | RangeAreas | string): Excel.RangeAreas; + /** + * Returns the `RangeAreas` object that represents the intersection of the given ranges or `RangeAreas`. + If no intersection is found, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param anotherRange - The range, `RangeAreas` object, or address that will be used to determine the intersection. + */ + getIntersectionOrNullObject(anotherRange: Range | RangeAreas | string): Excel.RangeAreas; + /** + * Returns a `RangeAreas` object that is shifted by the specific row and column offset. The dimension of the returned `RangeAreas` will match the original object. If the resulting `RangeAreas` is forced outside the bounds of the worksheet grid, an error will be thrown. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param rowOffset - The number of rows (positive, negative, or 0) by which the `RangeAreas` is to be offset. Positive values are offset downward, and negative values are offset upward. + * @param columnOffset - The number of columns (positive, negative, or 0) by which the `RangeAreas` is to be offset. Positive values are offset to the right, and negative values are offset to the left. + */ + getOffsetRangeAreas(rowOffset: number, columnOffset: number): Excel.RangeAreas; + /** + * Returns a `RangeAreas` object that represents all the cells that match the specified type and value. Throws an error if no special cells are found that match the criteria. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param cellType - The type of cells to include. + * @param cellValueType - If `cellType` is either `constants` or `formulas`, this argument is used to determine which types of cells to include in the result. These values can be combined together to return more than one type. The default is to select all constants or formulas, no matter what the type. + */ + getSpecialCells(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas; + /** + * Returns a `RangeAreas` object that represents all the cells that match the specified type and value. Throws an error if no special cells are found that match the criteria. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param cellType - The type of cells to include. + * @param cellValueType - If `cellType` is either `constants` or `formulas`, this argument is used to determine which types of cells to include in the result. These values can be combined together to return more than one type. The default is to select all constants or formulas, no matter what the type. + */ + getSpecialCells(cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueType?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas; + /** + * Returns a `RangeAreas` object that represents all the cells that match the specified type and value. + If no special cells are found that match the criteria, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param cellType - The type of cells to include. + * @param cellValueType - If `cellType` is either `constants` or `formulas`, this argument is used to determine which types of cells to include in the result. These values can be combined together to return more than one type. The default is to select all constants or formulas, no matter what the type. + */ + getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas; + /** + * Returns a `RangeAreas` object that represents all the cells that match the specified type and value. + If no special cells are found that match the criteria, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param cellType - The type of cells to include. + * @param cellValueType - If `cellType` is either `constants` or `formulas`, this argument is used to determine which types of cells to include in the result. These values can be combined together to return more than one type. The default is to select all constants or formulas, no matter what the type. + */ + getSpecialCellsOrNullObject(cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueType?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas; + /** + * Returns a scoped collection of tables that overlap with any range in this `RangeAreas` object. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param fullyContained - If `true`, returns only tables that are fully contained within the range bounds. Default is `false`. + */ + getTables(fullyContained?: boolean): Excel.TableScopedCollection; + /** + * Returns the used `RangeAreas` that comprises all the used areas of individual rectangular ranges in the `RangeAreas` object. + If there are no used cells within the `RangeAreas`, the `ItemNotFound` error will be thrown. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param valuesOnly - Whether to only consider cells with values as used cells. Default is `false`. + */ + getUsedRangeAreas(valuesOnly?: boolean): Excel.RangeAreas; + /** + * Returns the used `RangeAreas` that comprises all the used areas of individual rectangular ranges in the `RangeAreas` object. + If there are no used cells within the `RangeAreas`, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param valuesOnly - Whether to only consider cells with values as used cells. + */ + getUsedRangeAreasOrNullObject(valuesOnly?: boolean): Excel.RangeAreas; + /** + * Selects the specified range areas in the Excel UI. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + select(): void; + /** + * Sets the `RangeAreas` to be recalculated when the next recalculation occurs. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + setDirty(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.RangeAreasLoadOptions): Excel.RangeAreas; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.RangeAreas; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.RangeAreas; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. + */ + track(): Excel.RangeAreas; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Excel.RangeAreas; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.RangeAreas` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.RangeAreasData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.RangeAreasData; + } + /** + * Represents a collection of one or more rectangular ranges in multiple worksheets. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + export class WorkbookRangeAreas extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns the `RangeAreasCollection` object. Each `RangeAreas` in the collection represent one or more rectangle ranges in one worksheet. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + readonly areas: Excel.RangeAreasCollection; + /** + * Returns ranges that comprise this object in a `RangeCollection` object. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + readonly ranges: Excel.RangeCollection; + /** + * Returns an array of addresses in A1-style. Address values contain the worksheet name for each rectangular block of cells (e.g., "Sheet1!A1:B4, Sheet1!D1:D4"). Read-only. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + readonly addresses: string[]; + /** + * Returns the `RangeAreas` object based on worksheet ID or name in the collection. + * + * @remarks + * [Api set: ExcelApi 1.12] + * + * @param key - The name or ID of the worksheet. + */ + getRangeAreasBySheet(key: string): Excel.RangeAreas; + /** + * Returns the `RangeAreas` object based on worksheet name or ID in the collection. + If the worksheet does not exist, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.12] + * + * @param key - The name or ID of the worksheet. + */ + getRangeAreasOrNullObjectBySheet(key: string): Excel.RangeAreas; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.WorkbookRangeAreasLoadOptions): Excel.WorkbookRangeAreas; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.WorkbookRangeAreas; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.WorkbookRangeAreas; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. + */ + track(): Excel.WorkbookRangeAreas; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Excel.WorkbookRangeAreas; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.WorkbookRangeAreas` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.WorkbookRangeAreasData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.WorkbookRangeAreasData; + } + /** + * Represents the search criteria to be used. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface SearchCriteria { + /** + * Specifies if the match needs to be complete or partial. + A complete match matches the entire contents of the cell. A partial match matches a substring within the content of the cell (e.g., `cat` partially matches `caterpillar` and `scatter`). + Default is `false` (partial). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + completeMatch?: boolean; + /** + * Specifies if the match is case-sensitive. Default is `false` (case-insensitive). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + matchCase?: boolean; + /** + * Specifies the search direction. Default is forward. See `Excel.SearchDirection`. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + searchDirection?: Excel.SearchDirection | "Forward" | "Backwards"; + } + /** + * Represents the worksheet search criteria to be used. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface WorksheetSearchCriteria { + /** + * Specifies if the match needs to be complete or partial. + A complete match matches the entire contents of the cell. A partial match matches a substring within the content of the cell (e.g., `cat` partially matches `caterpillar` and `scatter`). + Default is `false` (partial). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + completeMatch?: boolean; + /** + * Specifies if the match is case-sensitive. Default is `false` (case-insensitive). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + matchCase?: boolean; + } + /** + * Represents the replace criteria to be used. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface ReplaceCriteria { + /** + * Specifies if the match needs to be complete or partial. + A complete match matches the entire contents of the cell. A partial match matches a substring within the content of the cell (e.g., `cat` partially matches `caterpillar` and `scatter`). + Default is `false` (partial). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + completeMatch?: boolean; + /** + * Specifies if the match is case-sensitive. Default is `false` (case-insensitive). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + matchCase?: boolean; + } + /** + * Specifies which properties to load on the `format.fill` object. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface CellPropertiesFillLoadOptions { + /** + * Specifies whether to load the `color` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + color?: boolean; + /** + * Specifies whether to load the `pattern` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + pattern?: boolean; + /** + * Specifies whether to load the `patternColor` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + patternColor?: boolean; + /** + * Specifies whether to load the `patternTintAndShade` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + patternTintAndShade?: boolean; + /** + * Specifies whether to load the `tintAndShade` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + tintAndShade?: boolean; + } + /** + * Specifies which properties to load on the `format.font` object. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface CellPropertiesFontLoadOptions { + /** + * Specifies whether to load the `bold` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + bold?: boolean; + /** + * Specifies whether to load the `color` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + color?: boolean; + /** + * Specifies whether to load the `italic` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + italic?: boolean; + /** + * Specifies whether to load the `name` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + name?: boolean; + /** + * Specifies whether to load the `size` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + size?: boolean; + /** + * Specifies whether to load the `strikethrough` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + strikethrough?: boolean; + /** + * Specifies whether to load the `subscript` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + subscript?: boolean; + /** + * Specifies whether to load the `superscript` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + superscript?: boolean; + /** + * Specifies whether to load the `tintAndShade` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + tintAndShade?: boolean; + /** + * Specifies whether to load the `underline` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + underline?: boolean; + } + /** + * Specifies which properties to load on the `format.borders` object. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface CellPropertiesBorderLoadOptions { + /** + * Specifies whether to load the `color` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + color?: boolean; + /** + * Specifies whether to load the `style` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + style?: boolean; + /** + * Specifies whether to load the `tintAndShade` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + tintAndShade?: boolean; + /** + * Specifies whether to load the `weight` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + weight?: boolean; + } + /** + * Represents a sequence of one or more characters that share the same font attributes in a cell. Can be used as the `textRuns` properties of `getCellProperties` or the `textRuns` input parameter of `setCellProperties`. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + export interface RangeTextRun { + /** + * The font attributes (such as font name, font size, and color) applied to this text run. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + font?: Excel.CellPropertiesFont; + /** + * The text of this text run. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + text: string; + } + /** + * Represents the `format.protection` properties of `getCellProperties`, `getRowProperties`, and `getColumnProperties`, or the `format.protection` input parameter of `setCellProperties`, `setRowProperties`, and `setColumnProperties`. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface CellPropertiesProtection { + /** + * Represents the `format.protection.formulaHidden` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + formulaHidden?: boolean; + /** + * Represents the `format.protection.locked` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + locked?: boolean; + } + /** + * Represents the `format.fill` properties of `getCellProperties`, `getRowProperties`, and `getColumnProperties` or the `format.fill` input parameter of `setCellProperties`, `setRowProperties`, and `setColumnProperties`. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface CellPropertiesFill { + /** + * Represents the `format.fill.color` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + color?: string; + /** + * Represents the `format.fill.pattern` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + pattern?: Excel.FillPattern | "None" | "Solid" | "Gray50" | "Gray75" | "Gray25" | "Horizontal" | "Vertical" | "Down" | "Up" | "Checker" | "SemiGray75" | "LightHorizontal" | "LightVertical" | "LightDown" | "LightUp" | "Grid" | "CrissCross" | "Gray16" | "Gray8" | "LinearGradient" | "RectangularGradient"; + /** + * Represents the `format.fill.patternColor` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + patternColor?: string; + /** + * Represents the `format.fill.patternTintAndShade` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + patternTintAndShade?: number; + /** + * Represents the `format.fill.tintAndShade` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + tintAndShade?: number; + } + /** + * Represents the `format.font` properties of `getCellProperties`, `getRowProperties`, and `getColumnProperties`, or the `format.font` input parameter of `setCellProperties`, `setRowProperties`, and `setColumnProperties`. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface CellPropertiesFont { + /** + * Represents the `format.font.bold` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + bold?: boolean; + /** + * Represents the `format.font.color` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + color?: string; + /** + * Represents the `format.font.italic` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + italic?: boolean; + /** + * Represents the `format.font.name` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + name?: string; + /** + * Represents the `format.font.size` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + size?: number; + /** + * Represents the `format.font.strikethrough` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + strikethrough?: boolean; + /** + * Represents the `format.font.subscript` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + subscript?: boolean; + /** + * Represents the `format.font.superscript` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + superscript?: boolean; + /** + * Represents the `format.font.tintAndShade` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + tintAndShade?: number; + /** + * Represents the `format.font.underline` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + underline?: Excel.RangeUnderlineStyle | "None" | "Single" | "Double" | "SingleAccountant" | "DoubleAccountant"; + } + /** + * Represents the `format.borders` properties of `getCellProperties`, `getRowProperties`, and `getColumnProperties`, or the `format.borders` input parameter of `setCellProperties`, `setRowProperties`, and `setColumnProperties`. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface CellBorderCollection { + /** + * Represents the `format.borders.bottom` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + bottom?: Excel.CellBorder; + /** + * Represents the `format.borders.diagonalDown` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + diagonalDown?: Excel.CellBorder; + /** + * Represents the `format.borders.diagonalUp` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + diagonalUp?: Excel.CellBorder; + /** + * Represents the `format.borders.horizontal` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + horizontal?: Excel.CellBorder; + /** + * Represents the `format.borders.left` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + left?: Excel.CellBorder; + /** + * Represents the `format.borders.right` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + right?: Excel.CellBorder; + /** + * Represents the `format.borders.top` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + top?: Excel.CellBorder; + /** + * Represents the `format.borders.vertical` property. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + vertical?: Excel.CellBorder; + } + /** + * Represents the properties of a single border returned by `getCellProperties`, `getRowProperties`, and `getColumnProperties`, or the border property input parameter of `setCellProperties`, `setRowProperties`, and `setColumnProperties`. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface CellBorder { + /** + * Represents the `color` property of a single border. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + color?: string; + /** + * Represents the `style` property of a single border. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + style?: Excel.BorderLineStyle | "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot" | "Double" | "SlantDashDot"; + /** + * Represents the `tintAndShade` property of a single border. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + tintAndShade?: number; + /** + * Represents the `weight` property of a single border. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + weight?: Excel.BorderWeight | "Hairline" | "Thin" | "Medium" | "Thick"; + } + /** + * RangeView represents a set of visible cells of the parent range. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + export class RangeView extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents a collection of range views associated with the range. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + readonly rows: Excel.RangeViewCollection; + /** + * Represents the cell addresses of the `RangeView`. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + readonly cellAddresses: any[][]; + /** + * The number of visible columns. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + readonly columnCount: number; + /** + * Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + formulas: any[][]; + /** + * Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. If a cell has no formula, its value is returned instead. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + formulasLocal: any[][]; + /** + * Represents the formula in R1C1-style notation. If a cell has no formula, its value is returned instead. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + formulasR1C1: any[][]; + /** + * Returns a value that represents the index of the `RangeView`. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + readonly index: number; + /** + * Represents Excel's number format code for the given cell. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + numberFormat: any[][]; + /** + * The number of visible rows. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + readonly rowCount: number; + /** + * Text values of the specified range. The text value will not depend on the cell width. The # sign substitution that happens in Excel UI will not affect the text value returned by the API. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + readonly text: string[][]; + /** + * Represents the type of data of each cell. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + readonly valueTypes: Excel.RangeValueType[][]; + /** + * Represents the raw values of the specified range view. The data returned could be of type string, number, or a boolean. Cells that contain an error will return the error string. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + values: any[][]; + /** + * A JSON representation of the values in the cells in this range. + Unlike `RangeView.values`, `RangeView.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `RangeView.valuesAsJsonLocal`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJson: CellValue[][]; + /** + * A JSON representation of the values in the cells in this range. + Unlike `RangeView.values`, `RangeView.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `RangeView.valuesAsJson`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJsonLocal: CellValue[][]; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.RangeViewUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.RangeView): void; + /** + * Gets the parent range associated with the current `RangeView`. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + getRange(): Excel.Range; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.RangeViewLoadOptions): Excel.RangeView; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.RangeView; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.RangeView; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.RangeView` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.RangeViewData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.RangeViewData; + } + /** + * Represents a collection of `RangeView` objects. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + export class RangeViewCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.RangeView[]; + /** + * Gets the number of `RangeView` objects in the collection. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a `RangeView` row via its index. Zero-indexed. + * + * @remarks + * [Api set: ExcelApi 1.3] + * + * @param index - Index of the visible row. + */ + getItemAt(index: number): Excel.RangeView; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.RangeViewCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.RangeViewCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.RangeViewCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.RangeViewCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.RangeViewCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.RangeViewCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.RangeViewCollectionData; + } + /** + * Represents a collection of key-value pair setting objects that are part of the workbook. The scope is limited to per file and add-in (task-pane or content) combination. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + export class SettingCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.Setting[]; + /** + * Sets or adds the specified setting to the workbook. + * + * @remarks + * [Api set: ExcelApi 1.4] + * + * @param key - The key of the new setting. + * @param value - The value for the new setting. + */ + add(key: string, value: string | number | boolean | Date | any[] | any): Excel.Setting; + /** + * Gets the number of settings in the collection. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a setting entry via the key. + * + * @remarks + * [Api set: ExcelApi 1.4] + * + * @param key - Key of the setting. + */ + getItem(key: string): Excel.Setting; + /** + * Gets a setting entry via the key. + If the setting does not exist, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.4] + * + * @param key - The key of the setting. + */ + getItemOrNullObject(key: string): Excel.Setting; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.SettingCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.SettingCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.SettingCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.SettingCollection; + /** + * Occurs when the settings in the document are changed. + * + * @remarks + * [Api set: ExcelApi 1.4] + * + * @eventproperty + */ + readonly onSettingsChanged: OfficeExtension.EventHandlers; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.SettingCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.SettingCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.SettingCollectionData; + } + /** + * Setting represents a key-value pair of a setting persisted to the document (per file, per add-in). These custom key-value pair can be used to store state or lifecycle information needed by the content or task-pane add-in. Note that settings are persisted in the document and hence it is not a place to store any sensitive or protected information such as user information and password. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + export class Setting extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * The key that represents the ID of the setting. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + readonly key: string; + /** + * Represents the value stored for this setting. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + value: any; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.SettingUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.Setting): void; + /** + * Deletes the setting. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + delete(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.SettingLoadOptions): Excel.Setting; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Setting; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.Setting; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.Setting` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.SettingData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.SettingData; + } + /** + * A collection of all the `NamedItem` objects that are part of the workbook or worksheet, depending on how it was reached. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class NamedItemCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.NamedItem[]; + /** + * Adds a new name to the collection of the given scope. + * + * @remarks + * [Api set: ExcelApi 1.4] + * + * @param name - The name of the named item. + * @param reference - The formula or the range that the name will refer to. + * @param comment - Optional. The comment associated with the named item. + * @returns + */ + add(name: string, reference: Range | string, comment?: string): Excel.NamedItem; + /** + * Adds a new name to the collection of the given scope using the user's locale for the formula. + * + * @remarks + * [Api set: ExcelApi 1.4] + * + * @param name - The name of the named item. + * @param formula - The formula in the user's locale that the name will refer to. + * @param comment - Optional. The comment associated with the named item. + * @returns + */ + addFormulaLocal(name: string, formula: string, comment?: string): Excel.NamedItem; + /** + * Gets the number of named items in the collection. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a `NamedItem` object using its name. + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param name - Nameditem name. + */ + getItem(name: string): Excel.NamedItem; + /** + * Gets a `NamedItem` object using its name. + If the object does not exist, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.4] + * + * @param name - Nameditem name. + */ + getItemOrNullObject(name: string): Excel.NamedItem; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.NamedItemCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.NamedItemCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.NamedItemCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.NamedItemCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.NamedItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.NamedItemCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.NamedItemCollectionData; + } + /** + * Represents a defined name for a range of cells or value. Names can be primitive named objects (as seen in the type below), range object, or a reference to a range. This object can be used to obtain range object associated with names. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class NamedItem extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns an object containing values and types of the named item. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly arrayValues: Excel.NamedItemArrayValues; + /** + * Returns the worksheet on which the named item is scoped to. Throws an error if the item is scoped to the workbook instead. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + readonly worksheet: Excel.Worksheet; + /** + * Returns the worksheet to which the named item is scoped. + If the item is scoped to the workbook instead, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + readonly worksheetOrNullObject: Excel.Worksheet; + /** + * Specifies the comment associated with this name. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + comment: string; + /** + * The formula of the named item. Formulas always start with an equal sign ("="). + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + formula: any; + /** + * The name of the object. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly name: string; + /** + * Specifies if the name is scoped to the workbook or to a specific worksheet. Possible values are: Worksheet, Workbook. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + readonly scope: Excel.NamedItemScope | "Worksheet" | "Workbook"; + /** + * Specifies the type of the value returned by the name's formula. See `Excel.NamedItemType` for details. + * + * @remarks + * [Api set: ExcelApi 1.1 for String,Integer,Double,Boolean,Range,Error; 1.7 for Array] + */ + readonly type: Excel.NamedItemType | "String" | "Integer" | "Double" | "Boolean" | "Range" | "Error" | "Array"; + /** + * 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 + * [Api set: ExcelApi 1.1] + */ + readonly value: any; + /** + * A JSON representation of the values in this named item. + Unlike `NamedItem.value`, `NamedItem.valueAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `NamedItem.valueAsJsonLocal`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + readonly valueAsJson: CellValue | string; + /** + * A JSON representation of the values in this named item. + Unlike `NamedItem.value`, `NamedItem.valueAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `NamedItem.valueAsJson`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + readonly valueAsJsonLocal: CellValue | string; + /** + * Specifies if the object is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + visible: boolean; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.NamedItemUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.NamedItem): void; + /** + * Deletes the given name. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + delete(): void; + /** + * Returns the range object that is associated with the name. Throws an error if the named item's type is not a range. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + getRange(): Excel.Range; + /** + * Returns the range object that is associated with the name. + If the named item's type is not a range, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + getRangeOrNullObject(): Excel.Range; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.NamedItemLoadOptions): Excel.NamedItem; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.NamedItem; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.NamedItem; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.NamedItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.NamedItemData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.NamedItemData; + } + /** + * Represents an object containing values and types of a named item. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + export class NamedItemArrayValues extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents the types for each item in the named item array + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly types: Excel.RangeValueType[][]; + /** + * Represents the values of each item in the named item array. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly values: any[][]; + /** + * A JSON representation of the values in this named item array. + Unlike `NamedItemArrayValues.values`, `NamedItemArrayValues.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `NamedItemArrayValues.valuesAsJsonLocal`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + readonly valuesAsJson: CellValue[][]; + /** + * A JSON representation of the values in this named item array. + Unlike `NamedItemArrayValues.values`, `NamedItemArrayValues.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `NamedItemArrayValues.valuesAsJson`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + readonly valuesAsJsonLocal: CellValue[][]; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.NamedItemArrayValuesLoadOptions): Excel.NamedItemArrayValues; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.NamedItemArrayValues; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.NamedItemArrayValues; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.NamedItemArrayValues` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.NamedItemArrayValuesData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.NamedItemArrayValuesData; + } + /** + * Represents an Office.js binding that is defined in the workbook. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class Binding extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents the binding identifier. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly id: string; + /** + * Returns the type of the binding. See `Excel.BindingType` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly type: Excel.BindingType | "Range" | "Table" | "Text"; + /** + * Deletes the binding. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + delete(): void; + /** + * Returns the range represented by the binding. Will throw an error if the binding is not of the correct type. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + getRange(): Excel.Range; + /** + * Returns the table represented by the binding. Will throw an error if the binding is not of the correct type. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + getTable(): Excel.Table; + /** + * Returns the text represented by the binding. Will throw an error if the binding is not of the correct type. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + getText(): OfficeExtension.ClientResult; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.BindingLoadOptions): Excel.Binding; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Binding; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.Binding; + /** + * Occurs when data or formatting within the binding is changed. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @eventproperty + */ + readonly onDataChanged: OfficeExtension.EventHandlers; + /** + * Occurs when the selected content in the binding is changed. + + **Note**: If multiple, discontiguous cells are selected, `Binding.onSelectionChanged` only reports row and column information for one selection. Use `Worksheet.onSelectionChanged` for multiple selected ranges. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @eventproperty + */ + readonly onSelectionChanged: OfficeExtension.EventHandlers; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.Binding` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.BindingData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.BindingData; + } + /** + * Represents the collection of all the binding objects that are part of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class BindingCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.Binding[]; + /** + * Returns the number of bindings in the collection. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly count: number; + /** + * Add a new binding to a particular Range. + * + * @remarks + * [Api set: ExcelApi 1.3] + * + * @param range - Range to bind the binding to. May be a `Range` object or a string. If string, must contain the full address, including the sheet name + * @param bindingType - Type of binding. See `Excel.BindingType`. + * @param id - Name of the binding. + */ + add(range: Range | string, bindingType: Excel.BindingType, id: string): Excel.Binding; + /** + * Add a new binding to a particular Range. + * + * @remarks + * [Api set: ExcelApi 1.3] + * + * @param range - Range to bind the binding to. May be a `Range` object or a string. If string, must contain the full address, including the sheet name + * @param bindingType - Type of binding. See `Excel.BindingType`. + * @param id - Name of the binding. + */ + add(range: Range | string, bindingType: "Range" | "Table" | "Text", id: string): Excel.Binding; + /** + * Add a new binding based on a named item in the workbook. + If the named item references to multiple areas, the `InvalidReference` error will be returned. + * + * @remarks + * [Api set: ExcelApi 1.3] + * + * @param name - Name from which to create binding. + * @param bindingType - Type of binding. See `Excel.BindingType`. + * @param id - Name of the binding. + */ + addFromNamedItem(name: string, bindingType: Excel.BindingType, id: string): Excel.Binding; + /** + * Add a new binding based on a named item in the workbook. + If the named item references to multiple areas, the `InvalidReference` error will be returned. + * + * @remarks + * [Api set: ExcelApi 1.3] + * + * @param name - Name from which to create binding. + * @param bindingType - Type of binding. See `Excel.BindingType`. + * @param id - Name of the binding. + */ + addFromNamedItem(name: string, bindingType: "Range" | "Table" | "Text", id: string): Excel.Binding; + /** + * Add a new binding based on the current selection. + If the selection has multiple areas, the `InvalidReference` error will be returned. + * + * @remarks + * [Api set: ExcelApi 1.3] + * + * @param bindingType - Type of binding. See `Excel.BindingType`. + * @param id - Name of the binding. + */ + addFromSelection(bindingType: Excel.BindingType, id: string): Excel.Binding; + /** + * Add a new binding based on the current selection. + If the selection has multiple areas, the `InvalidReference` error will be returned. + * + * @remarks + * [Api set: ExcelApi 1.3] + * + * @param bindingType - Type of binding. See `Excel.BindingType`. + * @param id - Name of the binding. + */ + addFromSelection(bindingType: "Range" | "Table" | "Text", id: string): Excel.Binding; + /** + * Gets the number of bindings in the collection. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a binding object by ID. + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param id - ID of the binding object to be retrieved. + */ + getItem(id: string): Excel.Binding; + /** + * Gets a binding object based on its position in the items array. + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param index - Index value of the object to be retrieved. Zero-indexed. + */ + getItemAt(index: number): Excel.Binding; + /** + * Gets a binding object by ID. + If the binding object does not exist, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.4] + * + * @param id - ID of the binding object to be retrieved. + */ + getItemOrNullObject(id: string): Excel.Binding; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.BindingCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.BindingCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.BindingCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.BindingCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.BindingCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.BindingCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.BindingCollectionData; + } + /** + * Represents a collection of all the tables that are part of the workbook or worksheet, depending on how it was reached. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class TableCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.Table[]; + /** + * Returns the number of tables in the workbook. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly count: number; + /** + * Creates a new table. The range object or source address determines the worksheet under which the table will be added. If the table cannot be added (e.g., because the address is invalid, or the table would overlap with another table), an error will be thrown. + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param address - A `Range` object, or a string address or name of the range representing the data source. If the address does not contain a sheet name, the currently-active sheet is used. [Api set: ExcelApi 1.1 / 1.3. Prior to ExcelApi 1.3, this parameter must be a string. Starting with Excel Api 1.3, this parameter may be a Range object or a string.] + * @param hasHeaders - A boolean value that indicates whether the data being imported has column labels. If the source does not contain headers (i.e., when this property set to `false`), Excel will automatically generate a header and shift the data down by one row. + */ + add(address: Range | string, hasHeaders: boolean): Excel.Table; + /** + * Gets the number of tables in the collection. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a table by name or ID. + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param key - Name or ID of the table to be retrieved. + */ + getItem(key: string): Excel.Table; + /** + * Gets a table based on its position in the collection. + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param index - Index value of the object to be retrieved. Zero-indexed. + */ + getItemAt(index: number): Excel.Table; + /** + * Gets a table by name or ID. + If the table doesn't exist, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.4] + * + * @param key - Name or ID of the table to be retrieved. + */ + getItemOrNullObject(key: string): Excel.Table; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.TableCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TableCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.TableCollection; + /** + * Occurs when a new table is added in a workbook. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @eventproperty + */ + readonly onAdded: OfficeExtension.EventHandlers; + /** + * Occurs when data changes on any table in a workbook, or a worksheet. + * + * @remarks + * [Api set: ExcelApi 1.7] + * + * @eventproperty + */ + readonly onChanged: OfficeExtension.EventHandlers; + /** + * Occurs when the specified table is deleted in a workbook. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @eventproperty + */ + readonly onDeleted: OfficeExtension.EventHandlers; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.TableCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.TableCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.TableCollectionData; + } + /** + * Represents a scoped collection of tables. For each table its top-left corner is considered its anchor location, and the tables are sorted top-to-bottom and then left-to-right. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export class TableScopedCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.Table[]; + /** + * Gets the number of tables in the collection. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets the first table in the collection. The tables in the collection are sorted top-to-bottom and left-to-right, such that top-left table is the first table in the collection. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + getFirst(): Excel.Table; + /** + * Gets a table by name or ID. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param key - Name or ID of the table to be retrieved. + */ + getItem(key: string): Excel.Table; + /** + * Gets a table by name or ID. + If the table object does not exist, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.14] + * + * @param key - Name or ID of the table to be retrieved. + */ + getItemOrNullObject(key: string): Excel.Table; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.TableScopedCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableScopedCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TableScopedCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.TableScopedCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.TableScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.TableScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.TableScopedCollectionData; + } + /** + * Represents an Excel table. + To learn more about the table object model, read {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-tables | Work with tables using the Excel JavaScript API}. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class Table extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents the `AutoFilter` object of the table. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly autoFilter: Excel.AutoFilter; + /** + * Represents a collection of all the columns in the table. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly columns: Excel.TableColumnCollection; + /** + * Represents a collection of all the rows in the table. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly rows: Excel.TableRowCollection; + /** + * Represents the sorting for the table. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + readonly sort: Excel.TableSort; + /** + * The worksheet containing the current table. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + readonly worksheet: Excel.Worksheet; + /** + * Specifies if the first column contains special formatting. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + highlightFirstColumn: boolean; + /** + * Specifies if the last column contains special formatting. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + highlightLastColumn: boolean; + /** + * Returns a value that uniquely identifies the table in a given workbook. The value of the identifier remains the same even when the table is renamed. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly id: string; + /** + * Returns a numeric ID. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly legacyId: string; + /** + * Name of the table. + + The set name of the table must follow the guidelines specified in the {@link https://support.microsoft.com/office/fbf49a4f-82a3-43eb-8ba2-44d21233b114 | Rename an Excel table} article. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + name: string; + /** + * Specifies if the columns show banded formatting in which odd columns are highlighted differently from even ones, to make reading the table easier. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + showBandedColumns: boolean; + /** + * Specifies if the rows show banded formatting in which odd rows are highlighted differently from even ones, to make reading the table easier. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + showBandedRows: boolean; + /** + * Specifies if the filter buttons are visible at the top of each column header. Setting this is only allowed if the table contains a header row. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + showFilterButton: boolean; + /** + * Specifies if the header row is visible. This value can be set to show or remove the header row. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + showHeaders: boolean; + /** + * Specifies if the total row is visible. This value can be set to show or remove the total row. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + showTotals: boolean; + /** + * Constant value that represents the table style. Possible values are: "TableStyleLight1" through "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", "TableStyleDark1" through "TableStyleDark11". A custom user-defined style present in the workbook can also be specified. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + style: string; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.TableUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.Table): void; + /** + * Clears all the filters currently applied on the table. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + clearFilters(): void; + /** + * Converts the table into a normal range of cells. All data is preserved. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + convertToRange(): Excel.Range; + /** + * Deletes the table. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + delete(): void; + /** + * Gets the range object associated with the data body of the table. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + getDataBodyRange(): Excel.Range; + /** + * Gets the range object associated with the header row of the table. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + getHeaderRowRange(): Excel.Range; + /** + * Gets the range object associated with the entire table. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + getRange(): Excel.Range; + /** + * Gets the range object associated with the totals row of the table. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + getTotalRowRange(): Excel.Range; + /** + * Reapplies all the filters currently on the table. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + reapplyFilters(): void; + /** + * Resize the table to the new range. The new range must overlap with the original table range and the headers (or the top of the table) must be in the same row. + * + * @remarks + * [Api set: ExcelApi 1.13] + * + * @param newRange - The range object or range address that will be used to determine the new size of the table. + */ + resize(newRange: Range | string): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.TableLoadOptions): Excel.Table; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Table; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.Table; + /** + * Occurs when data in cells changes on a specific table. + * + * @remarks + * [Api set: ExcelApi 1.7] + * + * @eventproperty + */ + readonly onChanged: OfficeExtension.EventHandlers; + /** + * Occurs when the selection changes on a specific table. + * + * @remarks + * [Api set: ExcelApi 1.7] + * + * @eventproperty + */ + readonly onSelectionChanged: OfficeExtension.EventHandlers; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.Table` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.TableData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.TableData; + } + /** + * Represents a collection of all the columns that are part of the table. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class TableColumnCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.TableColumn[]; + /** + * Returns the number of columns in the table. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly count: number; + /** + * Adds a new column to the table. + * + * @remarks + * [Api set: ExcelApi 1.1 requires an index smaller than the total column count; 1.4 allows index to be optional (null or -1) and will append a column at the end; 1.4 allows name parameter at creation time.] + * + * @param index - Optional. Specifies the relative position of the new column. If null or -1, the addition happens at the end. Columns with a higher index will be shifted to the side. Zero-indexed. + * @param values - Optional. A 2D array of unformatted values of the table column. + * @param name - Optional. Specifies the name of the new column. If `null`, the default name will be used. + */ + add(index?: number, values?: Array> | boolean | string | number, name?: string): Excel.TableColumn; + /** + * Adds a new column to the table. + Unlike `add()`, `addAsJson()` takes any type of cell value, such as image or entity data types. + * + * @remarks + * [Api set: ExcelApi 1.16] + * + * @param index - Optional. Specifies the relative position of the new column. If null or -1, the addition happens at the end. Columns with a higher index will be shifted to the side. Zero-indexed. + * @param values - Optional. A 2D array of cell values of the table column. + * @param name - Optional. Specifies the name of the new column. If `null`, the default name will be used. + */ + addAsJson(index?: number, values?: CellValue[][], name?: string): Excel.TableColumn; + /** + * Gets the number of columns in the table. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a column object by name or ID. + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param key - Column name or ID. + */ + getItem(key: number | string): Excel.TableColumn; + /** + * Gets a column based on its position in the collection. + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param index - Index value of the object to be retrieved. Zero-indexed. + */ + getItemAt(index: number): Excel.TableColumn; + /** + * Gets a column object by name or ID. + If the column doesn't exist, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.4] + * + * @param key - Column name or ID. + */ + getItemOrNullObject(key: number | string): Excel.TableColumn; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.TableColumnCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableColumnCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TableColumnCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.TableColumnCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.TableColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.TableColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.TableColumnCollectionData; + } + /** + * Represents a column in a table. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class TableColumn extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Retrieves the filter applied to the column. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + readonly filter: Excel.Filter; + /** + * Returns a unique key that identifies the column within the table. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly id: number; + /** + * Returns the index number of the column within the columns collection of the table. Zero-indexed. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly index: number; + /** + * Specifies the name of the table column. + * + * @remarks + * [Api set: ExcelApi 1.1 for getting the name; 1.4 for setting it.] + */ + name: string; + /** + * Represents the raw values of the specified range. The data returned could be a string, number, or boolean. Cells that contain an error will return the error string. + If the returned value starts with a plus ("+"), minus ("-"), or equal sign ("="), Excel interprets this value as a formula. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + values: any[][]; + /** + * A JSON representation of the values in the cells in this table column. + Unlike `TableColumn.values`, `TableColumn.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `TableColumn.valuesAsJsonLocal`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJson: CellValue[][]; + /** + * A JSON representation of the values in the cells in this table column. + Unlike `TableColumn.values`, `TableColumn.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `TableColumn.valuesAsJson`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJsonLocal: CellValue[][]; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.TableColumnUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.TableColumn): void; + /** + * Deletes the column from the table. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + delete(): void; + /** + * Gets the range object associated with the data body of the column. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + getDataBodyRange(): Excel.Range; + /** + * Gets the range object associated with the header row of the column. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + getHeaderRowRange(): Excel.Range; + /** + * Gets the range object associated with the entire column. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + getRange(): Excel.Range; + /** + * Gets the range object associated with the totals row of the column. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + getTotalRowRange(): Excel.Range; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.TableColumnLoadOptions): Excel.TableColumn; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TableColumn; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.TableColumn; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.TableColumn` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.TableColumnData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.TableColumnData; + } + /** + * Represents a collection of all the rows that are part of the table. + + Note that unlike ranges or columns, which will adjust if new rows or columns are added before them, + a `TableRow` object represents the physical location of the table row, but not the data. + That is, if the data is sorted or if new rows are added, a table row will continue + to point at the index for which it was created. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class TableRowCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.TableRow[]; + /** + * Returns the number of rows in the table. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly count: number; + /** + * Adds one or more rows to the table. The return object will be the top of the newly added row(s). + + Note that unlike ranges or columns, which will adjust if new rows or columns are added before them, + a `TableRow` object represents the physical location of the table row, but not the data. + That is, if the data is sorted or if new rows are added, a table row will continue + to point at the index for which it was created. + * + * @remarks + * [Api set: ExcelApi 1.1 for adding a single row; 1.4 allows adding of multiple rows; 1.15 for adding `alwaysInsert` parameter.] + * + * @param index - Optional. Specifies the relative position of the new row. If null or -1, the addition happens at the end. Any rows below the inserted row are shifted downwards. Zero-indexed. + * @param values - Optional. A 2D array of unformatted values of the table row. + * @param alwaysInsert - Optional. Specifies whether the new rows will be inserted into the table when new rows are added. If `true`, the new rows will be inserted into the table. If `false`, the new rows will be added below the table. Default is `true`. + */ + add(index?: number, values?: Array> | boolean | string | number, alwaysInsert?: boolean): Excel.TableRow; + /** + * Adds one or more rows to the table. The returned object will be the top row of the newly added row or rows. + Unlike `add()`, `addAsJson()` takes any type of cell value, such as image or entity data types. + + Note that unlike ranges or columns, which will adjust if new rows or columns are added before them, + a `TableRow` object represents the physical location of the table row, but not the data. + That is, if the data is sorted or if new rows are added, a table row will continue + to point at the index for which it was created. + * + * @remarks + * [Api set: ExcelApi 1.16] + * + * @param index - Optional. Specifies the relative position of the new row. If null or -1, the addition happens at the end. Any rows below the inserted row are shifted downwards. Zero-indexed. + * @param values - Optional. A 2D array of cell values of the table row. + * @param alwaysInsert - Optional. Specifies whether the new rows will be inserted into the table when new rows are added. If `true`, the new rows will be inserted into the table. If `false`, the new rows will be added below the table. Default is `true`. + */ + addAsJson(index?: number, values?: CellValue[][], alwaysInsert?: boolean): Excel.TableRow; + + + /** + * Gets the number of rows in the table. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a row based on its position in the collection. + + Note that unlike ranges or columns, which will adjust if new rows or columns are added before them, + a `TableRow` object represents the physical location of the table row, but not the data. + That is, if the data is sorted or if new rows are added, a table row will continue + to point at the index for which it was created. + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param index - Index value of the object to be retrieved. Zero-indexed. + */ + getItemAt(index: number): Excel.TableRow; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.TableRowCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableRowCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TableRowCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.TableRowCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.TableRowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.TableRowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.TableRowCollectionData; + } + /** + * Represents a row in a table. + + Note that unlike ranges or columns, which will adjust if new rows or columns are added before them, + a `TableRow` object represents the physical location of the table row, but not the data. + That is, if the data is sorted or if new rows are added, a table row will continue + to point at the index for which it was created. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class TableRow extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns the index number of the row within the rows collection of the table. Zero-indexed. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly index: number; + /** + * Represents the raw values of the specified range. The data returned could be a string, number, or boolean. Cells that contain an error will return the error string. + If the returned value starts with a plus ("+"), minus ("-"), or equal sign ("="), Excel interprets this value as a formula. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + values: any[][]; + /** + * A JSON representation of the values in the cells in this table row. + Unlike `TableRow.values`, `TableRow.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `TableRow.valuesAsJsonLocal`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJson: CellValue[][]; + /** + * A JSON representation of the values in the cells in this table row. + Unlike `TableRow.values`, `TableRow.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `TableRow.valuesAsJson`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJsonLocal: CellValue[][]; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.TableRowUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.TableRow): void; + /** + * Deletes the row from the table. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + delete(): void; + /** + * Returns the range object associated with the entire row. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + getRange(): Excel.Range; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.TableRowLoadOptions): Excel.TableRow; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TableRow; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.TableRow; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.TableRow` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.TableRowData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.TableRowData; + } + /** + * Represents the data validation applied to the current range. + To learn more about the data validation object model, read {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-data-validation | Add data validation to Excel ranges}. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export class DataValidation extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Error alert when user enters invalid data. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + errorAlert: Excel.DataValidationErrorAlert; + /** + * Specifies if data validation will be performed on blank cells. Default is `true`. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + ignoreBlanks: boolean; + /** + * Prompt when users select a cell. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + prompt: Excel.DataValidationPrompt; + /** + * Data validation rule that contains different type of data validation criteria. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + rule: Excel.DataValidationRule; + /** + * Type of the data validation, see `Excel.DataValidationType` for details. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly type: Excel.DataValidationType | "None" | "WholeNumber" | "Decimal" | "List" | "Date" | "Time" | "TextLength" | "Custom" | "Inconsistent" | "MixedCriteria"; + /** + * Represents if all cell values are valid according to the data validation rules. + Returns `true` if all cell values are valid, or `false` if all cell values are invalid. + Returns `null` if there are both valid and invalid cell values within the range. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly valid: boolean; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.DataValidationUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.DataValidation): void; + /** + * Clears the data validation from the current range. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + clear(): void; + /** + * Returns a `RangeAreas` object, comprising one or more rectangular ranges, with invalid cell values. If all cell values are valid, this function will throw an `ItemNotFound` error. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + getInvalidCells(): Excel.RangeAreas; + /** + * Returns a `RangeAreas` object, comprising one or more rectangular ranges, with invalid cell values. If all cell values are valid, this function will return `null`. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + getInvalidCellsOrNullObject(): Excel.RangeAreas; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.DataValidationLoadOptions): Excel.DataValidation; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.DataValidation; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.DataValidation; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.DataValidation` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.DataValidationData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.DataValidationData; + } + /** + * A data validation rule contains different types of data validation. You can only use one of them at a time according the `Excel.DataValidationType`. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export interface DataValidationRule { + /** + * Custom data validation criteria. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + custom?: Excel.CustomDataValidation; + /** + * Date data validation criteria. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + date?: Excel.DateTimeDataValidation; + /** + * Decimal data validation criteria. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + decimal?: Excel.BasicDataValidation; + /** + * List data validation criteria. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + list?: Excel.ListDataValidation; + /** + * Text length data validation criteria. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + textLength?: Excel.BasicDataValidation; + /** + * Time data validation criteria. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + time?: Excel.DateTimeDataValidation; + /** + * Whole number data validation criteria. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + wholeNumber?: Excel.BasicDataValidation; + } + /** + * Represents the results from `Range.removeDuplicates`. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export class RemoveDuplicatesResult extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Number of duplicated rows removed by the operation. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly removed: number; + /** + * Number of remaining unique rows present in the resulting range. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly uniqueRemaining: number; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.RemoveDuplicatesResultLoadOptions): Excel.RemoveDuplicatesResult; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.RemoveDuplicatesResult; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.RemoveDuplicatesResult; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.RemoveDuplicatesResult` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.RemoveDuplicatesResultData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.RemoveDuplicatesResultData; + } + /** + * Represents the basic type data validation criteria. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export interface BasicDataValidation { + /** + * Specifies the right-hand operand when the operator property is set to a binary operator such as GreaterThan (the left-hand operand is the value the user tries to enter in the cell). With the ternary operators Between and NotBetween, specifies the lower bound operand. + For example, setting formula1 to 10 and operator to GreaterThan means that valid data for the range must be greater than 10. + When setting the value, it can be passed in as a number, a range object, or a string formula (where the string is either a stringified number, a cell reference like "=A1", or a formula like "=MIN(A1, B1)"). + When retrieving the value, it will always be returned as a string formula, for example: "=10", "=A1", "=SUM(A1:B5)", etc. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + formula1: string | number | Range; + /** + * With the ternary operators Between and NotBetween, specifies the upper bound operand. Is not used with the binary operators, such as GreaterThan. + When setting the value, it can be passed in as a number, a range object, or a string formula (where the string is either a stringified number, a cell reference like "=A1", or a formula like "=MIN(A1, B1)"). + When retrieving the value, it will always be returned as a string formula, for example: "=10", "=A1", "=SUM(A1:B5)", etc. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + formula2?: string | number | Range; + /** + * The operator to use for validating the data. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + operator: Excel.DataValidationOperator | "Between" | "NotBetween" | "EqualTo" | "NotEqualTo" | "GreaterThan" | "LessThan" | "GreaterThanOrEqualTo" | "LessThanOrEqualTo"; + } + /** + * Represents the date data validation criteria. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export interface DateTimeDataValidation { + /** + * Specifies the right-hand operand when the operator property is set to a binary operator such as GreaterThan (the left-hand operand is the value the user tries to enter in the cell). With the ternary operators Between and NotBetween, specifies the lower bound operand. + When setting the value, it can be passed in as a Date, a Range object, or a string formula (where the string is either a stringified date/time in ISO8601 format, a cell reference like "=A1", or a formula like "=MIN(A1, B1)"). + When retrieving the value, it will always be returned as a string formula, for example: "=10", "=A1", "=SUM(A1:B5)", etc. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + formula1: string | Date | Range; + /** + * With the ternary operators Between and NotBetween, specifies the upper bound operand. Is not used with the binary operators, such as GreaterThan. + When setting the value, it can be passed in as a Date, a Range object, or a string (where the string is either a stringified date/time in ISO8601 format, a cell reference like "=A1", or a formula like "=MIN(A1, B1)"). + When retrieving the value, it will always be returned as a string formula, for example: "=10", "=A1", "=SUM(A1:B5)", etc. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + formula2?: string | Date | Range; + /** + * The operator to use for validating the data. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + operator: Excel.DataValidationOperator | "Between" | "NotBetween" | "EqualTo" | "NotEqualTo" | "GreaterThan" | "LessThan" | "GreaterThanOrEqualTo" | "LessThanOrEqualTo"; + } + /** + * Represents the List data validation criteria. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export interface ListDataValidation { + /** + * Specifies whether to display the list in a cell drop-down. The default is `true`. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + inCellDropDown: boolean; + /** + * Source of the list for data validation + When setting the value, it can be passed in as a `Range` object, or a string that contains a comma-separated number, boolean, or date. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + source: string | Range; + } + /** + * Represents the custom data validation criteria. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export interface CustomDataValidation { + /** + * A custom data validation formula. This creates special input rules, such as preventing duplicates, or limiting the total in a range of cells. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + formula: string; + } + /** + * Represents the error alert properties for the data validation. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export interface DataValidationErrorAlert { + /** + * Represents the error alert message. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + message: string; + /** + * Specifies whether to show an error alert dialog when a user enters invalid data. The default is `true`. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showAlert: boolean; + /** + * The data validation alert type, please see `Excel.DataValidationAlertStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + style: Excel.DataValidationAlertStyle | "Stop" | "Warning" | "Information"; + /** + * Represents the error alert dialog title. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + title: string; + } + /** + * Represents the user prompt properties for the data validation. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export interface DataValidationPrompt { + /** + * Specifies the message of the prompt. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + message: string; + /** + * Specifies if a prompt is shown when a user selects a cell with data validation. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showPrompt: boolean; + /** + * Specifies the title for the prompt. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + title: string; + } + /** + * A format object encapsulating the range's font, fill, borders, alignment, and other properties. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class RangeFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Collection of border objects that apply to the overall range. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly borders: Excel.RangeBorderCollection; + /** + * Returns the fill object defined on the overall range. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly fill: Excel.RangeFill; + /** + * Returns the font object defined on the overall range. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly font: Excel.RangeFont; + /** + * Returns the format protection object for a range. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + readonly protection: Excel.FormatProtection; + /** + * Specifies if text is automatically indented when text alignment is set to equal distribution. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + autoIndent: boolean; + /** + * Specifies the width of all columns within the range. If the column widths are not uniform, `null` will be returned. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + columnWidth: number; + /** + * Represents the horizontal alignment for the specified object. See `Excel.HorizontalAlignment` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + horizontalAlignment: Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed"; + /** + * An integer from 0 to 250 that indicates the indent level. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + indentLevel: number; + /** + * The reading order for the range. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readingOrder: Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft"; + /** + * The height of all rows in the range. If the row heights are not uniform, `null` will be returned. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + rowHeight: number; + /** + * Specifies if text automatically shrinks to fit in the available column width. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + shrinkToFit: boolean; + /** + * The text orientation of all the cells within the range. + The text orientation should be an integer either from -90 to 90, or 180 for vertically-oriented text. + If the orientation within a range are not uniform, then `null` will be returned. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + textOrientation: number; + /** + * Determines if the row height of the `Range` object equals the standard height of the sheet. + Returns `true` if the row height of the `Range` object equals the standard height of the sheet. + Returns `null` if the range contains more than one row and the rows aren't all the same height. + Returns `false` otherwise. + Note: This property is only intended to be set to `true`. Setting it to `false` has no effect. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + useStandardHeight: boolean; + /** + * Specifies if the column width of the `Range` object equals the standard width of the sheet. + Returns `true` if the column width of the `Range` object equals the standard width of the sheet. + Returns `null` if the range contains more than one column and the columns aren't all the same height. + Returns `false` otherwise. + Note: This property is only intended to be set to `true`. Setting it to `false` has no effect. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + useStandardWidth: boolean; + /** + * Represents the vertical alignment for the specified object. See `Excel.VerticalAlignment` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + verticalAlignment: Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed"; + /** + * Specifies if Excel wraps the text in the object. A `null` value indicates that the entire range doesn't have a uniform wrap setting + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + wrapText: boolean; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.RangeFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.RangeFormat): void; + /** + * Adjusts the indentation of the range formatting. The indent value ranges from 0 to 250 and is measured in characters. + * + * @remarks + * [Api set: ExcelApi 1.11] + * + * @param amount - The number of character spaces by which the current indent is adjusted. This value should be between -250 and 250. + * **Note**: If the amount would raise the indent level above 250, the indent level stays with 250. + * Similarly, if the amount would lower the indent level below 0, the indent level stays 0. + */ + adjustIndent(amount: number): void; + /** + * Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + autofitColumns(): void; + /** + * Changes the height of the rows of the current range to achieve the best fit, based on the current data in the columns. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + autofitRows(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.RangeFormatLoadOptions): Excel.RangeFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.RangeFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.RangeFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.RangeFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.RangeFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.RangeFormatData; + } + /** + * Represents the format protection of a range object. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + export class FormatProtection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Specifies if Excel hides the formula for the cells in the range. A `null` value indicates that the entire range doesn't have a uniform formula hidden setting. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + formulaHidden: boolean; + /** + * Specifies if Excel locks the cells in the object. A `null` value indicates that the entire range doesn't have a uniform lock setting. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + locked: boolean; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.FormatProtectionUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.FormatProtection): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.FormatProtectionLoadOptions): Excel.FormatProtection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.FormatProtection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.FormatProtection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.FormatProtection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.FormatProtectionData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.FormatProtectionData; + } + /** + * Represents the background of a range object. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class RangeFill extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * HTML color code representing the color of the background, in the form #RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange") + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + color: string; + /** + * The pattern of a range. See `Excel.FillPattern` for details. LinearGradient and RectangularGradient are not supported. + A `null` value indicates that the entire range doesn't have a uniform pattern setting. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + pattern: Excel.FillPattern | "None" | "Solid" | "Gray50" | "Gray75" | "Gray25" | "Horizontal" | "Vertical" | "Down" | "Up" | "Checker" | "SemiGray75" | "LightHorizontal" | "LightVertical" | "LightDown" | "LightUp" | "Grid" | "CrissCross" | "Gray16" | "Gray8" | "LinearGradient" | "RectangularGradient"; + /** + * The HTML color code representing the color of the range pattern, in the form #RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange"). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + patternColor: string; + /** + * Specifies a double that lightens or darkens a pattern color for the range fill. The value is between -1 (darkest) and 1 (brightest), with 0 for the original color. + A `null` value indicates that the range doesn't have uniform `patternTintAndShade` settings. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + patternTintAndShade: number; + /** + * Specifies a double that lightens or darkens a color for the range fill. The value is between -1 (darkest) and 1 (brightest), with 0 for the original color. + A `null` value indicates that the range doesn't have uniform `tintAndShade` settings. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + tintAndShade: number; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.RangeFillUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.RangeFill): void; + /** + * Resets the range background. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + clear(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.RangeFillLoadOptions): Excel.RangeFill; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.RangeFill; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.RangeFill; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.RangeFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.RangeFillData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.RangeFillData; + } + /** + * Represents the border of an object. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class RangeBorder extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * HTML color code representing the color of the border line, in the form #RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange"). + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + color: string; + /** + * Constant value that indicates the specific side of the border. See `Excel.BorderIndex` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly sideIndex: Excel.BorderIndex | "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight" | "InsideVertical" | "InsideHorizontal" | "DiagonalDown" | "DiagonalUp"; + /** + * One of the constants of line style specifying the line style for the border. See `Excel.BorderLineStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + style: Excel.BorderLineStyle | "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot" | "Double" | "SlantDashDot"; + /** + * Specifies a double that lightens or darkens a color for the range border, the value is between -1 (darkest) and 1 (brightest), with 0 for the original color. + A `null` value indicates that the border doesn't have a uniform `tintAndShade` setting. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + tintAndShade: number; + /** + * Specifies the weight of the border around a range. See `Excel.BorderWeight` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + weight: Excel.BorderWeight | "Hairline" | "Thin" | "Medium" | "Thick"; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.RangeBorderUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.RangeBorder): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.RangeBorderLoadOptions): Excel.RangeBorder; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.RangeBorder; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.RangeBorder; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.RangeBorder` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.RangeBorderData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.RangeBorderData; + } + /** + * Represents the border objects that make up the range border. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class RangeBorderCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.RangeBorder[]; + /** + * Number of border objects in the collection. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly count: number; + /** + * Specifies a double that lightens or darkens a color for range borders. The value is between -1 (darkest) and 1 (brightest), with 0 for the original color. + A `null` value indicates that the entire border collection doesn't have a uniform `tintAndShade` setting. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + tintAndShade: number; + /** + * Gets a border object using its name. + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param index - Index value of the border object to be retrieved. See `Excel.BorderIndex` for details. + */ + getItem(index: Excel.BorderIndex): Excel.RangeBorder; + /** + * Gets a border object using its name. + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param index - Index value of the border object to be retrieved. See `Excel.BorderIndex` for details. + */ + getItem(index: "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight" | "InsideVertical" | "InsideHorizontal" | "DiagonalDown" | "DiagonalUp"): Excel.RangeBorder; + /** + * Gets a border object using its index. + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param index - Index value of the object to be retrieved. Zero-indexed. + */ + getItemAt(index: number): Excel.RangeBorder; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.RangeBorderCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.RangeBorderCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.RangeBorderCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.RangeBorderCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.RangeBorderCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.RangeBorderCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.RangeBorderCollectionData; + } + /** + * This object represents the font attributes (font name, font size, color, etc.) for an object. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class RangeFont extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents the bold status of the font. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + bold: boolean; + /** + * HTML color code representation of the text color (e.g., #FF0000 represents Red). + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + color: string; + /** + * Specifies the italic status of the font. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + italic: boolean; + /** + * Font name (e.g., "Calibri"). The name's length should not be greater than 31 characters. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + name: string; + /** + * Font size. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + size: number; + /** + * Specifies the strikethrough status of font. A `null` value indicates that the entire range doesn't have a uniform strikethrough setting. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + strikethrough: boolean; + /** + * Specifies the subscript status of font. + Returns `true` if all the fonts of the range are subscript. + Returns `false` if all the fonts of the range are superscript or normal (neither superscript, nor subscript). + Returns `null` otherwise. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + subscript: boolean; + /** + * Specifies the superscript status of font. + Returns `true` if all the fonts of the range are superscript. + Returns `false` if all the fonts of the range are subscript or normal (neither superscript, nor subscript). + Returns `null` otherwise. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + superscript: boolean; + /** + * Specifies a double that lightens or darkens a color for the range font. The value is between -1 (darkest) and 1 (brightest), with 0 for the original color. + A `null` value indicates that the entire range doesn't have a uniform font `tintAndShade` setting. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + tintAndShade: number; + /** + * Type of underline applied to the font. See `Excel.RangeUnderlineStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + underline: Excel.RangeUnderlineStyle | "None" | "Single" | "Double" | "SingleAccountant" | "DoubleAccountant"; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.RangeFontUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.RangeFont): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.RangeFontLoadOptions): Excel.RangeFont; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.RangeFont; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.RangeFont; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.RangeFont` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.RangeFontData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.RangeFontData; + } + /** + * A collection of all the chart objects on a worksheet. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class ChartCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.Chart[]; + /** + * Returns the number of charts in the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly count: number; + /** + * Creates a new chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param type - Represents the type of a chart. See `Excel.ChartType` for details. + * @param sourceData - The `Range` object corresponding to the source data. + * @param seriesBy - Optional. Specifies the way columns or rows are used as data series on the chart. See `Excel.ChartSeriesBy` for details. + */ + add(type: Excel.ChartType, sourceData: Range, seriesBy?: Excel.ChartSeriesBy): Excel.Chart; + /** + * Creates a new chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param type - Represents the type of a chart. See `Excel.ChartType` for details. + * @param sourceData - The `Range` object corresponding to the source data. + * @param seriesBy - Optional. Specifies the way columns or rows are used as data series on the chart. See `Excel.ChartSeriesBy` for details. + */ + add(type: "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel", sourceData: Range, seriesBy?: "Auto" | "Columns" | "Rows"): Excel.Chart; + /** + * Returns the number of charts in the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a chart using its name. If there are multiple charts with the same name, the first one will be returned. + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param name - Name of the chart to be retrieved. + */ + getItem(name: string): Excel.Chart; + /** + * Gets a chart based on its position in the collection. + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param index - Index value of the object to be retrieved. Zero-indexed. + */ + getItemAt(index: number): Excel.Chart; + /** + * Gets a chart using its name. If there are multiple charts with the same name, the first one will be returned. + If the chart doesn't exist, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.4] + * + * @param name - Name of the chart to be retrieved. + */ + getItemOrNullObject(name: string): Excel.Chart; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ChartCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.ChartCollection; + /** + * Occurs when a chart is activated. + * + * @remarks + * [Api set: ExcelApi 1.8] + * + * @eventproperty + */ + readonly onActivated: OfficeExtension.EventHandlers; + /** + * Occurs when a new chart is added to the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.8] + * + * @eventproperty + */ + readonly onAdded: OfficeExtension.EventHandlers; + /** + * Occurs when a chart is deactivated. + * + * @remarks + * [Api set: ExcelApi 1.8] + * + * @eventproperty + */ + readonly onDeactivated: OfficeExtension.EventHandlers; + /** + * Occurs when a chart is deleted. + * + * @remarks + * [Api set: ExcelApi 1.8] + * + * @eventproperty + */ + readonly onDeleted: OfficeExtension.EventHandlers; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.ChartCollectionData; + } + /** + * Represents a chart object in a workbook. + To learn more about the chart object model, see {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-charts | Work with charts using the Excel JavaScript API}. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class Chart extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents chart axes. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly axes: Excel.ChartAxes; + /** + * Represents the data labels on the chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly dataLabels: Excel.ChartDataLabels; + /** + * Encapsulates the format properties for the chart area. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly format: Excel.ChartAreaFormat; + /** + * Represents the legend for the chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly legend: Excel.ChartLegend; + /** + * Encapsulates the options for a pivot chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly pivotOptions: Excel.ChartPivotOptions; + /** + * Represents the plot area for the chart. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly plotArea: Excel.ChartPlotArea; + /** + * Represents either a single series or collection of series in the chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly series: Excel.ChartSeriesCollection; + /** + * Represents the title of the specified chart, including the text, visibility, position, and formatting of the title. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly title: Excel.ChartTitle; + /** + * The worksheet containing the current chart. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + readonly worksheet: Excel.Worksheet; + /** + * Specifies a chart category label level enumeration constant, referring to the level of the source category labels. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + categoryLabelLevel: number; + /** + * Specifies the type of the chart. See `Excel.ChartType` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + chartType: Excel.ChartType | "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel"; + /** + * Specifies the way that blank cells are plotted on a chart. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + displayBlanksAs: Excel.ChartDisplayBlanksAs | "NotPlotted" | "Zero" | "Interplotted"; + /** + * Specifies the height, in points, of the chart object. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + height: number; + /** + * The unique ID of chart. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly id: string; + /** + * The distance, in points, from the left side of the chart to the worksheet origin. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + left: number; + /** + * Specifies the name of a chart object. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + name: string; + /** + * Specifies the way columns or rows are used as data series on the chart. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + plotBy: Excel.ChartPlotBy | "Rows" | "Columns"; + /** + * True if only visible cells are plotted. False if both visible and hidden cells are plotted. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + plotVisibleOnly: boolean; + /** + * Specifies a chart series name level enumeration constant, referring to the level of the source series names. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + seriesNameLevel: number; + /** + * Specifies whether to display all field buttons on a PivotChart. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showAllFieldButtons: boolean; + /** + * Specifies whether to show the data labels when the value is greater than the maximum value on the value axis. + If the value axis becomes smaller than the size of the data points, you can use this property to set whether to show the data labels. + This property applies to 2-D charts only. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showDataLabelsOverMaximum: boolean; + /** + * Specifies the chart style for the chart. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + style: number; + /** + * Specifies the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart). + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + top: number; + /** + * Specifies the width, in points, of the chart object. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + width: number; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.Chart): void; + /** + * Activates the chart in the Excel UI. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + activate(): void; + /** + * Deletes the chart object. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + delete(): void; + /** + * Gets the data table on the chart. If the chart doesn't allow a data table, it will throw an exception. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + getDataTable(): Excel.ChartDataTable; + /** + * Gets the data table on the chart. + If the chart doesn't allow a data table, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + getDataTableOrNullObject(): Excel.ChartDataTable; + /** + * Renders the chart as a Base64-encoded image by scaling the chart to fit the specified dimensions. + The aspect ratio is preserved as part of the resizing. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param height - Optional. The desired height of the resulting image. + * @param width - Optional. The desired width of the resulting image. + * @param fittingMode - Optional. The method used to scale the chart to the specified dimensions (if both height and width are set). + */ + getImage(width?: number, height?: number, fittingMode?: Excel.ImageFittingMode): OfficeExtension.ClientResult; + /** + * Renders the chart as a Base64-encoded image by scaling the chart to fit the specified dimensions. + The aspect ratio is preserved as part of the resizing. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param height - Optional. The desired height of the resulting image. + * @param width - Optional. The desired width of the resulting image. + * @param fittingMode - Optional. The method used to scale the chart to the specified dimensions (if both height and width are set). + */ + getImage(width?: number, height?: number, fittingMode?: "Fit" | "FitAndCenter" | "Fill"): OfficeExtension.ClientResult; + /** + * Resets the source data for the chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param sourceData - The range object corresponding to the source data. + * @param seriesBy - Specifies the way columns or rows are used as data series on the chart. Can be one of the following: Auto (default), Rows, and Columns. See `Excel.ChartSeriesBy` for details. + */ + setData(sourceData: Range, seriesBy?: Excel.ChartSeriesBy): void; + /** + * Resets the source data for the chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param sourceData - The range object corresponding to the source data. + * @param seriesBy - Specifies the way columns or rows are used as data series on the chart. Can be one of the following: Auto (default), Rows, and Columns. See `Excel.ChartSeriesBy` for details. + */ + setData(sourceData: Range, seriesBy?: "Auto" | "Columns" | "Rows"): void; + /** + * Positions the chart relative to cells on the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param startCell - The start cell. This is where the chart will be moved to. The start cell is the top-left or top-right cell, depending on the user's right-to-left display settings. + * @param endCell - Optional. The end cell. If specified, the chart's width and height will be set to fully cover up this cell/range. + */ + setPosition(startCell: Range | string, endCell?: Range | string): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartLoadOptions): Excel.Chart; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Chart; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.Chart; + /** + * Occurs when the chart is activated. + * + * @remarks + * [Api set: ExcelApi 1.8] + * + * @eventproperty + */ + readonly onActivated: OfficeExtension.EventHandlers; + /** + * Occurs when the chart is deactivated. + * + * @remarks + * [Api set: ExcelApi 1.8] + * + * @eventproperty + */ + readonly onDeactivated: OfficeExtension.EventHandlers; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.Chart` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartData; + } + /** + * Encapsulates the options for the pivot chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export class ChartPivotOptions extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Specifies whether to display the axis field buttons on a PivotChart. The `showAxisFieldButtons` property corresponds to the "Show Axis Field Buttons" command on the "Field Buttons" drop-down list of the "Analyze" tab, which is available when a PivotChart is selected. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showAxisFieldButtons: boolean; + /** + * Specifies whether to display the legend field buttons on a PivotChart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showLegendFieldButtons: boolean; + /** + * Specifies whether to display the report filter field buttons on a PivotChart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showReportFilterFieldButtons: boolean; + /** + * Specifies whether to display the show value field buttons on a PivotChart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showValueFieldButtons: boolean; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartPivotOptionsUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartPivotOptions): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartPivotOptionsLoadOptions): Excel.ChartPivotOptions; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartPivotOptions; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartPivotOptions; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartPivotOptions` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartPivotOptionsData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartPivotOptionsData; + } + /** + * Encapsulates the format properties for the overall chart area. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class ChartAreaFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents the border format of chart area, which includes color, linestyle, and weight. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly border: Excel.ChartBorder; + /** + * Represents the fill format of an object, which includes background formatting information. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly fill: Excel.ChartFill; + /** + * Represents the font attributes (font name, font size, color, etc.) for the current object. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly font: Excel.ChartFont; + /** + * Specifies the color scheme of the chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + colorScheme: Excel.ChartColorScheme | "ColorfulPalette1" | "ColorfulPalette2" | "ColorfulPalette3" | "ColorfulPalette4" | "MonochromaticPalette1" | "MonochromaticPalette2" | "MonochromaticPalette3" | "MonochromaticPalette4" | "MonochromaticPalette5" | "MonochromaticPalette6" | "MonochromaticPalette7" | "MonochromaticPalette8" | "MonochromaticPalette9" | "MonochromaticPalette10" | "MonochromaticPalette11" | "MonochromaticPalette12" | "MonochromaticPalette13"; + /** + * Specifies if the chart area of the chart has rounded corners. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + roundedCorners: boolean; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartAreaFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartAreaFormat): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartAreaFormatLoadOptions): Excel.ChartAreaFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartAreaFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartAreaFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartAreaFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartAreaFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartAreaFormatData; + } + /** + * Represents a collection of chart series. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class ChartSeriesCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.ChartSeries[]; + /** + * Returns the number of series in the collection. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly count: number; + /** + * Add a new series to the collection. The new added series is not visible until values, x-axis values, or bubble sizes for it are set (depending on chart type). + * + * @remarks + * [Api set: ExcelApi 1.7] + * + * @param name - Optional. Name of the series. + * @param index - Optional. Index value of the series to be added. Zero-indexed. + */ + add(name?: string, index?: number): Excel.ChartSeries; + /** + * Returns the number of series in the collection. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Retrieves a series based on its position in the collection. + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param index - Index value of the object to be retrieved. Zero-indexed. + */ + getItemAt(index: number): Excel.ChartSeries; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartSeriesCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ChartSeriesCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartSeriesCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.ChartSeriesCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartSeriesCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartSeriesCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.ChartSeriesCollectionData; + } + /** + * Represents a series in a chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class ChartSeries extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Encapsulates the bin options for histogram charts and pareto charts. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly binOptions: Excel.ChartBinOptions; + /** + * Encapsulates the options for the box and whisker charts. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly boxwhiskerOptions: Excel.ChartBoxwhiskerOptions; + /** + * Represents a collection of all data labels in the series. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly dataLabels: Excel.ChartDataLabels; + /** + * Represents the formatting of a chart series, which includes fill and line formatting. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly format: Excel.ChartSeriesFormat; + /** + * Encapsulates the options for a region map chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly mapOptions: Excel.ChartMapOptions; + /** + * Returns a collection of all points in the series. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly points: Excel.ChartPointsCollection; + /** + * The collection of trendlines in the series. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly trendlines: Excel.ChartTrendlineCollection; + /** + * Represents the error bar object of a chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly xErrorBars: Excel.ChartErrorBars; + /** + * Represents the error bar object of a chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly yErrorBars: Excel.ChartErrorBars; + /** + * Specifies the group for the specified series. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + axisGroup: Excel.ChartAxisGroup | "Primary" | "Secondary"; + /** + * This can be an integer value from 0 (zero) to 300, representing the percentage of the default size. This property only applies to bubble charts. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + bubbleScale: number; + /** + * Represents the chart type of a series. See `Excel.ChartType` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + chartType: Excel.ChartType | "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel"; + /** + * Represents the doughnut hole size of a chart series. Only valid on doughnut and doughnut exploded charts. + Throws an `InvalidArgument` error on invalid charts. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + doughnutHoleSize: number; + /** + * Specifies the explosion value for a pie-chart or doughnut-chart slice. Returns 0 (zero) if there's no explosion (the tip of the slice is in the center of the pie). + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + explosion: number; + /** + * Specifies if the series is filtered. Not applicable for surface charts. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + filtered: boolean; + /** + * Specifies the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical). Applies only to pie, 3-D pie, and doughnut charts. Can be a value from 0 through 360. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + firstSliceAngle: number; + /** + * Represents the gap width of a chart series. Only valid on bar and column charts, as well as + specific classes of line and pie charts. Throws an invalid argument exception on invalid charts. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + gapWidth: number; + /** + * Specifies the color for maximum value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMaximumColor: string; + /** + * Specifies the type for maximum value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMaximumType: Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent"; + /** + * Specifies the maximum value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMaximumValue: number; + /** + * Specifies the color for the midpoint value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMidpointColor: string; + /** + * Specifies the type for the midpoint value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMidpointType: Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent"; + /** + * Specifies the midpoint value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMidpointValue: number; + /** + * Specifies the color for the minimum value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMinimumColor: string; + /** + * Specifies the type for the minimum value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMinimumType: Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent"; + /** + * Specifies the minimum value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMinimumValue: number; + /** + * Specifies the series gradient style of a region map chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientStyle: Excel.ChartGradientStyle | "TwoPhaseColor" | "ThreePhaseColor"; + /** + * Specifies if the series has data labels. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + hasDataLabels: boolean; + /** + * Specifies the fill color for negative data points in a series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + invertColor: string; + /** + * True if Excel inverts the pattern in the item when it corresponds to a negative number. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + invertIfNegative: boolean; + /** + * Specifies the marker background color of a chart series. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + markerBackgroundColor: string; + /** + * Specifies the marker foreground color of a chart series. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + markerForegroundColor: string; + /** + * Specifies the marker size of a chart series. + The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + markerSize: number; + /** + * Specifies the marker style of a chart series. See `Excel.ChartMarkerStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + markerStyle: Excel.ChartMarkerStyle | "Invalid" | "Automatic" | "None" | "Square" | "Diamond" | "Triangle" | "X" | "Star" | "Dot" | "Dash" | "Circle" | "Plus" | "Picture"; + /** + * Specifies the name of a series in a chart. The name's length should not be greater than 255 characters. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + name: string; + /** + * Specifies how bars and columns are positioned. Can be a value between -100 and 100. Applies only to 2-D bar and 2-D column charts. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + overlap: number; + /** + * Specifies the series parent label strategy area for a treemap chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + parentLabelStrategy: Excel.ChartParentLabelStrategy | "None" | "Banner" | "Overlapping"; + /** + * Specifies the plot order of a chart series within the chart group. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + plotOrder: number; + /** + * Specifies the size of the secondary section of either a pie-of-pie chart or a bar-of-pie chart, as a percentage of the size of the primary pie. Can be a value from 5 to 200. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + secondPlotSize: number; + /** + * Specifies whether connector lines are shown in waterfall charts. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showConnectorLines: boolean; + /** + * Specifies whether leader lines are displayed for each data label in the series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showLeaderLines: boolean; + /** + * Specifies if the series has a shadow. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showShadow: boolean; + /** + * Specifies if the series is smooth. Only applicable to line and scatter charts. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + smooth: boolean; + /** + * Specifies the way the two sections of either a pie-of-pie chart or a bar-of-pie chart are split. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + splitType: Excel.ChartSplitType | "SplitByPosition" | "SplitByValue" | "SplitByPercentValue" | "SplitByCustomSplit"; + /** + * Specifies the threshold value that separates two sections of either a pie-of-pie chart or a bar-of-pie chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + splitValue: number; + /** + * True if Excel assigns a different color or pattern to each data marker. The chart must contain only one series. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + varyByCategories: boolean; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartSeriesUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartSeries): void; + /** + * Deletes the chart series. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + 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. + * + * @remarks + * [Api set: ExcelApi 1.15] + * + * @param dimension - The dimension of the axis where the data is from. + */ + getDimensionDataSourceString(dimension: Excel.ChartSeriesDimension): OfficeExtension.ClientResult; + /** + * Gets the string representation of the data source of the chart series. The string representation could be information such as a cell address. + * + * @remarks + * [Api set: ExcelApi 1.15] + * + * @param dimension - The dimension of the axis where the data is from. + */ + getDimensionDataSourceString(dimension: "Categories" | "Values" | "XValues" | "YValues" | "BubbleSizes"): OfficeExtension.ClientResult; + /** + * Gets the data source type of the chart series. + * + * @remarks + * [Api set: ExcelApi 1.15] + * + * @param dimension - The dimension of the axis where the data is from. + */ + getDimensionDataSourceType(dimension: Excel.ChartSeriesDimension): OfficeExtension.ClientResult; + /** + * Gets the data source type of the chart series. + * + * @remarks + * [Api set: ExcelApi 1.15] + * + * @param dimension - The dimension of the axis where the data is from. + */ + getDimensionDataSourceType(dimension: "Categories" | "Values" | "XValues" | "YValues" | "BubbleSizes"): OfficeExtension.ClientResult; + /** + * Gets the values from a single dimension of the chart series. These could be either category values or data values, depending on the dimension specified and how the data is mapped for the chart series. + * + * @remarks + * [Api set: ExcelApi 1.12] + * + * @param dimension - The dimension of the axis where the data is from. + */ + getDimensionValues(dimension: Excel.ChartSeriesDimension): OfficeExtension.ClientResult; + /** + * Gets the values from a single dimension of the chart series. These could be either category values or data values, depending on the dimension specified and how the data is mapped for the chart series. + * + * @remarks + * [Api set: ExcelApi 1.12] + * + * @param dimension - The dimension of the axis where the data is from. + */ + getDimensionValues(dimension: "Categories" | "Values" | "XValues" | "YValues" | "BubbleSizes"): OfficeExtension.ClientResult; + /** + * Sets the bubble sizes for a chart series. Only works for bubble charts. + * + * @remarks + * [Api set: ExcelApi 1.7] + * + * @param sourceData - The `Range` object corresponding to the source data. + */ + setBubbleSizes(sourceData: Range): void; + /** + * Sets the values for a chart series. For scatter charts, it refers to y-axis values. + * + * @remarks + * [Api set: ExcelApi 1.7] + * + * @param sourceData - The `Range` object corresponding to the source data. + */ + setValues(sourceData: Range): void; + /** + * Sets the values of the x-axis for a chart series. + * + * @remarks + * [Api set: ExcelApi 1.7] + * + * @param sourceData - The `Range` object corresponding to the source data. + */ + setXAxisValues(sourceData: Range): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartSeriesLoadOptions): Excel.ChartSeries; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartSeries; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartSeries; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartSeries` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartSeriesData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartSeriesData; + } + /** + * Encapsulates the format properties for the chart series + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class ChartSeriesFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents the fill format of a chart series, which includes background formatting information. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly fill: Excel.ChartFill; + /** + * Represents line formatting. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly line: Excel.ChartLineFormat; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartSeriesFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartSeriesFormat): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartSeriesFormatLoadOptions): Excel.ChartSeriesFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartSeriesFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartSeriesFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartSeriesFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartSeriesFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartSeriesFormatData; + } + /** + * A collection of all the chart points within a series inside a chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class ChartPointsCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.ChartPoint[]; + /** + * Returns the number of chart points in the series. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly count: number; + /** + * Returns the number of chart points in the series. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Retrieve a point based on its position within the series. + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param index - Index value of the object to be retrieved. Zero-indexed. + */ + getItemAt(index: number): Excel.ChartPoint; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartPointsCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ChartPointsCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartPointsCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.ChartPointsCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartPointsCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartPointsCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.ChartPointsCollectionData; + } + /** + * Represents a point of a series in a chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class ChartPoint extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns the data label of a chart point. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly dataLabel: Excel.ChartDataLabel; + /** + * Encapsulates the format properties chart point. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly format: Excel.ChartPointFormat; + /** + * Represents whether a data point has a data label. Not applicable for surface charts. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + hasDataLabel: boolean; + /** + * HTML color code representation of the marker background color of a data point (e.g., #FF0000 represents Red). + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + markerBackgroundColor: string; + /** + * HTML color code representation of the marker foreground color of a data point (e.g., #FF0000 represents Red). + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + markerForegroundColor: string; + /** + * Represents marker size of a data point. + The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + markerSize: number; + /** + * Represents marker style of a chart data point. See `Excel.ChartMarkerStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + markerStyle: Excel.ChartMarkerStyle | "Invalid" | "Automatic" | "None" | "Square" | "Diamond" | "Triangle" | "X" | "Star" | "Dot" | "Dash" | "Circle" | "Plus" | "Picture"; + /** + * Returns the value of a chart point. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly value: any; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartPointUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartPoint): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartPointLoadOptions): Excel.ChartPoint; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartPoint; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartPoint; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartPoint` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartPointData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartPointData; + } + /** + * Represents the formatting object for chart points. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class ChartPointFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents the border format of a chart data point, which includes color, style, and weight information. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly border: Excel.ChartBorder; + /** + * Represents the fill format of a chart, which includes background formatting information. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly fill: Excel.ChartFill; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartPointFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartPointFormat): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartPointFormatLoadOptions): Excel.ChartPointFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartPointFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartPointFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartPointFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartPointFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartPointFormatData; + } + /** + * Represents the chart axes. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class ChartAxes extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents the category axis in a chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly categoryAxis: Excel.ChartAxis; + /** + * Represents the series axis of a 3-D chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly seriesAxis: Excel.ChartAxis; + /** + * Represents the value axis in an axis. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly valueAxis: Excel.ChartAxis; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartAxesUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartAxes): void; + /** + * Returns the specific axis identified by type and group. + * + * @remarks + * [Api set: ExcelApi 1.7] + * + * @param type - Specifies the axis type. See `Excel.ChartAxisType` for details. + * @param group - Optional. Specifies the axis group. See `Excel.ChartAxisGroup` for details. + */ + getItem(type: Excel.ChartAxisType, group?: Excel.ChartAxisGroup): Excel.ChartAxis; + /** + * Returns the specific axis identified by type and group. + * + * @remarks + * [Api set: ExcelApi 1.7] + * + * @param type - Specifies the axis type. See `Excel.ChartAxisType` for details. + * @param group - Optional. Specifies the axis group. See `Excel.ChartAxisGroup` for details. + */ + getItem(type: "Invalid" | "Category" | "Value" | "Series", group?: "Primary" | "Secondary"): Excel.ChartAxis; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartAxesLoadOptions): Excel.ChartAxes; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartAxes; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartAxes; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartAxes` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartAxesData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartAxesData; + } + /** + * Represents a single axis in a chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class ChartAxis extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents the formatting of a chart object, which includes line and font formatting. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly format: Excel.ChartAxisFormat; + /** + * Returns an object that represents the major gridlines for the specified axis. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly majorGridlines: Excel.ChartGridlines; + /** + * Returns an object that represents the minor gridlines for the specified axis. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly minorGridlines: Excel.ChartGridlines; + /** + * Represents the axis title. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly title: Excel.ChartAxisTitle; + /** + * Specifies the alignment for the specified axis tick label. See `Excel.ChartTextHorizontalAlignment` for detail. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + alignment: Excel.ChartTickLabelAlignment | "Center" | "Left" | "Right"; + /** + * Specifies the group for the specified axis. See `Excel.ChartAxisGroup` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly axisGroup: Excel.ChartAxisGroup | "Primary" | "Secondary"; + /** + * Specifies the base unit for the specified category axis. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + baseTimeUnit: Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years"; + /** + * Specifies the category axis type. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + categoryType: Excel.ChartAxisCategoryType | "Automatic" | "TextAxis" | "DateAxis"; + /** + * Specifies the custom axis display unit value. To set this property, please use the `SetCustomDisplayUnit(double)` method. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly customDisplayUnit: number; + /** + * Represents the axis display unit. See `Excel.ChartAxisDisplayUnit` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + displayUnit: Excel.ChartAxisDisplayUnit | "None" | "Hundreds" | "Thousands" | "TenThousands" | "HundredThousands" | "Millions" | "TenMillions" | "HundredMillions" | "Billions" | "Trillions" | "Custom"; + /** + * Specifies the height, in points, of the chart axis. Returns `null` if the axis is not visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly height: number; + /** + * Specifies if the value axis crosses the category axis between categories. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + isBetweenCategories: boolean; + /** + * Specifies the distance, in points, from the left edge of the axis to the left of chart area. Returns `null` if the axis is not visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly left: number; + /** + * Specifies if the number format is linked to the cells. If `true`, the number format will change in the labels when it changes in the cells. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + linkNumberFormat: boolean; + /** + * Specifies the base of the logarithm when using logarithmic scales. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + logBase: number; + /** + * Specifies the type of major tick mark for the specified axis. See `Excel.ChartAxisTickMark` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + majorTickMark: Excel.ChartAxisTickMark | "None" | "Cross" | "Inside" | "Outside"; + /** + * Specifies the major unit scale value for the category axis when the `categoryType` property is set to `dateAxis`. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + majorTimeUnitScale: Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years"; + /** + * Represents the interval between two major tick marks. Can be set to a numeric value or an empty string. The returned value is always a number. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + majorUnit: any; + /** + * Represents the maximum value on the value axis. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + maximum: any; + /** + * Represents the minimum value on the value axis. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + minimum: any; + /** + * Specifies the type of minor tick mark for the specified axis. See `Excel.ChartAxisTickMark` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + minorTickMark: Excel.ChartAxisTickMark | "None" | "Cross" | "Inside" | "Outside"; + /** + * Specifies the minor unit scale value for the category axis when the `categoryType` property is set to `dateAxis`. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + minorTimeUnitScale: Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years"; + /** + * Represents the interval between two minor tick marks. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + minorUnit: any; + /** + * Specifies if an axis is multilevel. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + multiLevel: boolean; + /** + * Specifies the format code for the axis tick label. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + numberFormat: string; + /** + * Specifies the distance between the levels of labels, and the distance between the first level and the axis line. The value should be an integer from 0 to 1000. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + offset: number; + /** + * Specifies the specified axis position where the other axis crosses. See `Excel.ChartAxisPosition` for details. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + position: Excel.ChartAxisPosition | "Automatic" | "Maximum" | "Minimum" | "Custom"; + /** + * Specifies the axis position where the other axis crosses. You should use the `SetPositionAt(double)` method to set this property. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly positionAt: number; + /** + * Specifies if Excel plots data points from last to first. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + reversePlotOrder: boolean; + /** + * Specifies the value axis scale type. See `Excel.ChartAxisScaleType` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + scaleType: Excel.ChartAxisScaleType | "Linear" | "Logarithmic"; + /** + * Specifies if the axis display unit label is visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showDisplayUnitLabel: boolean; + /** + * Specifies the angle to which the text is oriented for the chart axis tick label. The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + textOrientation: any; + /** + * Specifies the position of tick-mark labels on the specified axis. See `Excel.ChartAxisTickLabelPosition` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + tickLabelPosition: Excel.ChartAxisTickLabelPosition | "NextToAxis" | "High" | "Low" | "None"; + /** + * Specifies the number of categories or series between tick-mark labels. Can be a value from 1 through 31999 or an empty string for automatic setting. The returned value is always a number. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + tickLabelSpacing: any; + /** + * Specifies the number of categories or series between tick marks. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + tickMarkSpacing: number; + /** + * Specifies the distance, in points, from the top edge of the axis to the top of chart area. Returns `null` if the axis is not visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly top: number; + /** + * Specifies the axis type. See `Excel.ChartAxisType` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly type: Excel.ChartAxisType | "Invalid" | "Category" | "Value" | "Series"; + /** + * Specifies if the axis is visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + visible: boolean; + /** + * Specifies the width, in points, of the chart axis. Returns `null` if the axis is not visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly width: number; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartAxisUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartAxis): void; + /** + * Sets all the category names for the specified axis. + * + * @remarks + * [Api set: ExcelApi 1.7] + * + * @param sourceData - The `Range` object corresponding to the source data. + */ + setCategoryNames(sourceData: Range): void; + /** + * Sets the axis display unit to a custom value. + * + * @remarks + * [Api set: ExcelApi 1.7] + * + * @param value - Custom value of the display unit. + */ + setCustomDisplayUnit(value: number): void; + /** + * Sets the specified axis position where the other axis crosses. + * + * @remarks + * [Api set: ExcelApi 1.8] + * + * @param value - Custom value of the crossing point. + */ + setPositionAt(value: number): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartAxisLoadOptions): Excel.ChartAxis; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartAxis; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartAxis; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartAxis` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartAxisData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartAxisData; + } + /** + * Encapsulates the format properties for the chart axis. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class ChartAxisFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Specifies chart fill formatting. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly fill: Excel.ChartFill; + /** + * Specifies the font attributes (font name, font size, color, etc.) for a chart axis element. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly font: Excel.ChartFont; + /** + * Specifies chart line formatting. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly line: Excel.ChartLineFormat; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartAxisFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartAxisFormat): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartAxisFormatLoadOptions): Excel.ChartAxisFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartAxisFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartAxisFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartAxisFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartAxisFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartAxisFormatData; + } + /** + * Represents the title of a chart axis. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class ChartAxisTitle extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Specifies the formatting of the chart axis title. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly format: Excel.ChartAxisTitleFormat; + /** + * Specifies the axis title. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + text: string; + /** + * Specifies the angle to which the text is oriented for the chart axis title. The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + textOrientation: number; + /** + * Specifies if the axis title is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + visible: boolean; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartAxisTitleUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartAxisTitle): void; + /** + * A string value that represents the formula of chart axis title using A1-style notation. + * + * @remarks + * [Api set: ExcelApi 1.8] + * + * @param formula - A string that represents the formula to set. + */ + setFormula(formula: string): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartAxisTitleLoadOptions): Excel.ChartAxisTitle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartAxisTitle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartAxisTitle; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartAxisTitle` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartAxisTitleData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartAxisTitleData; + } + /** + * Represents the chart axis title formatting. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class ChartAxisTitleFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Specifies the chart axis title's border format, which includes color, linestyle, and weight. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly border: Excel.ChartBorder; + /** + * Specifies the chart axis title's fill formatting. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly fill: Excel.ChartFill; + /** + * Specifies the chart axis title's font attributes, such as font name, font size, or color, of the chart axis title object. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly font: Excel.ChartFont; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartAxisTitleFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartAxisTitleFormat): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartAxisTitleFormatLoadOptions): Excel.ChartAxisTitleFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartAxisTitleFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartAxisTitleFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartAxisTitleFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartAxisTitleFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartAxisTitleFormatData; + } + /** + * Represents a collection of all the data labels on a chart point. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class ChartDataLabels extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Specifies the format of chart data labels, which includes fill and font formatting. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly format: Excel.ChartDataLabelFormat; + /** + * Gets an object that represents the leader lines of the data labels. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + readonly leaderLines: Excel.ChartLeaderLines; + /** + * Specifies if data labels automatically generate appropriate text based on context. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + autoText: boolean; + /** + * Specifies the geometric shape type of the data labels. See `Excel.GeometricShapeType` for more details. + Value is `null` if the data labels are not geometric shapes. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + geometricShapeType: Excel.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"; + /** + * Specifies the horizontal alignment for chart data label. See `Excel.ChartTextHorizontalAlignment` for details. + This property is valid only when the `TextOrientation` of data label is 0. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + horizontalAlignment: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"; + /** + * Specifies if the number format is linked to the cells. If `true`, the number format will change in the labels when it changes in the cells. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + linkNumberFormat: boolean; + /** + * Specifies the format code for data labels. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + numberFormat: string; + /** + * Value that represents the position of the data label. See `Excel.ChartDataLabelPosition` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + position: Excel.ChartDataLabelPosition | "Invalid" | "None" | "Center" | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" | "Right" | "Top" | "Bottom" | "BestFit" | "Callout"; + /** + * String representing the separator used for the data labels on a chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + separator: string; + /** + * Specifies if the data labels are shown as a callout with the tail anchor attached to the data point. + If `true`, the callout is one of the following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or "WedgeEllipseCallout". + See {@link Excel.GeometricShapeType | GeometricShapeType} for more details. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + readonly showAsStickyCallout: boolean; + /** + * Specifies if the data label bubble size is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + showBubbleSize: boolean; + /** + * Specifies if the data label category name is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + showCategoryName: boolean; + /** + * Specifies if leader lines are displayed for the data labels. `true` if leader lines are shown; otherwise, `false`. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + showLeaderLines: boolean; + /** + * Specifies if the data label legend key is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + showLegendKey: boolean; + /** + * Specifies if the data label percentage is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + showPercentage: boolean; + /** + * Specifies if the data label series name is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + showSeriesName: boolean; + /** + * Specifies if the data label value is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + showValue: boolean; + /** + * Represents the angle to which the text is oriented for data labels. The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + textOrientation: number; + /** + * Represents the vertical alignment of chart data label. See `Excel.ChartTextVerticalAlignment` for details. + This property is valid only when `TextOrientation` of the data label is -90, 90, or 180. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartDataLabelsUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartDataLabels): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartDataLabelsLoadOptions): Excel.ChartDataLabels; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartDataLabels; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartDataLabels; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartDataLabels` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartDataLabelsData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartDataLabelsData; + } + /** + * Represents the data label of a chart point. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + export class ChartDataLabel extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents the format of chart data label. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly format: Excel.ChartDataLabelFormat; + /** + * Specifies if the data label automatically generates appropriate text based on context. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + autoText: boolean; + /** + * String value that represents the formula of chart data label using A1-style notation. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + formula: string; + /** + * Specifies the geometric shape type of the data label. See `Excel.GeometricShapeType` for more details. + Value is `null` if the data label is not a geometric shape. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + geometricShapeType: Excel.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"; + /** + * Returns the height, in points, of the chart data label. + Value is `null` if the chart data label is not visible. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly height: number; + /** + * Represents the horizontal alignment for chart data label. + See `Excel.ChartTextHorizontalAlignment` for details. + This property is valid only when `TextOrientation` of data label is -90, 90, or 180. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + horizontalAlignment: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"; + /** + * Represents the distance, in points, from the left edge of chart data label to the left edge of chart area. Value is `null` if the chart data label is not visible. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + left: number; + /** + * Specifies if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + linkNumberFormat: boolean; + /** + * Specifies the format code for data label. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + numberFormat: string; + /** + * Value that represents the position of the data label. + See `Excel.ChartDataLabelPosition` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + position: Excel.ChartDataLabelPosition | "Invalid" | "None" | "Center" | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" | "Right" | "Top" | "Bottom" | "BestFit" | "Callout"; + /** + * String representing the separator used for the data label on a chart. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + separator: string; + /** + * Specifies if the data label is shown as a callout with the tail anchor attached to the data point. + If `true`, the callout is one of the following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or "WedgeEllipseCallout". + See {@link Excel.GeometricShapeType | GeometricShapeType} for more details. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + readonly showAsStickyCallout: boolean; + /** + * Specifies if the data label bubble size is visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showBubbleSize: boolean; + /** + * Specifies if the data label category name is visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showCategoryName: boolean; + /** + * Specifies if the data label legend key is visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showLegendKey: boolean; + /** + * Specifies if the data label percentage is visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showPercentage: boolean; + /** + * Specifies if the data label series name is visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showSeriesName: boolean; + /** + * Specifies if the data label value is visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showValue: boolean; + /** + * String representing the text of the data label on a chart. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + text: string; + /** + * Represents the angle to which the text is oriented for the chart data label. + The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + textOrientation: number; + /** + * Represents the distance, in points, from the top edge of chart data label to the top of chart area. Value is `null` if the chart data label is not visible. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + top: number; + /** + * Represents the vertical alignment of chart data label. + See `Excel.ChartTextVerticalAlignment` for details. + This property is valid only when `TextOrientation` of data label is 0. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"; + /** + * Returns the width, in points, of the chart data label. + Value is `null` if the chart data label is not visible. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly width: number; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartDataLabelUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartDataLabel): void; + /** + * Returns a substring of the data label. The line break character '\n' counts as one character. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * @param start - The zero-based starting character position of a substring in the data label. + * @param length - Optional. The number of characters in the substring. If length is omitted, all the characters from start to the end of the data label are retrieved. + */ + getSubstring(start: number, length?: number): Excel.ChartFormatString; + /** + * Returns the tail anchor of the data label which is shown as a sticky callout. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + getTailAnchor(): Excel.ChartDataLabelAnchor; + /** + * Sets the height of the data label in points. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * @param height - The height of the data label in points. + */ + setHeight(height: number): void; + /** + * Sets the width of the data label in points. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * @param width - The width of the data label in points. + */ + setWidth(width: number): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartDataLabelLoadOptions): Excel.ChartDataLabel; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartDataLabel; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartDataLabel; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartDataLabel` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartDataLabelData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartDataLabelData; + } + /** + * Encapsulates the format properties for the chart data labels. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class ChartDataLabelFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents the border format, which includes color, linestyle, and weight. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly border: Excel.ChartBorder; + /** + * Represents the fill format of the current chart data label. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly fill: Excel.ChartFill; + /** + * Represents the font attributes (such as font name, font size, and color) for a chart data label. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly font: Excel.ChartFont; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartDataLabelFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartDataLabelFormat): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartDataLabelFormatLoadOptions): Excel.ChartDataLabelFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartDataLabelFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartDataLabelFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartDataLabelFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartDataLabelFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartDataLabelFormatData; + } + /** + * Represents the chart data label anchor. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + export class ChartDataLabelAnchor extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Specifies the distance, in points, from the anchor to the left edge of the chart data label. + Note that when getting the value, it may differ slightly from the set value. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + left: number; + /** + * Specifies the distance, in points, from the anchor to the top edge of the chart data label. + Note that when getting the value, it may differ slightly from the set value. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + top: number; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartDataLabelAnchorUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartDataLabelAnchor): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartDataLabelAnchorLoadOptions): Excel.ChartDataLabelAnchor; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartDataLabelAnchor; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartDataLabelAnchor; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartDataLabelAnchor` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartDataLabelAnchorData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartDataLabelAnchorData; + } + /** + * Represents the data table object of a chart. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + export class ChartDataTable extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents the format of a chart data table, which includes fill, font, and border format. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + readonly format: Excel.ChartDataTableFormat; + /** + * Specifies whether to display the horizontal border of the data table. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + showHorizontalBorder: boolean; + /** + * Specifies whether to show the legend key of the data table. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + showLegendKey: boolean; + /** + * Specifies whether to display the outline border of the data table. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + showOutlineBorder: boolean; + /** + * Specifies whether to display the vertical border of the data table. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + showVerticalBorder: boolean; + /** + * Specifies whether to show the data table of the chart. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + visible: boolean; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartDataTableUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartDataTable): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartDataTableLoadOptions): Excel.ChartDataTable; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartDataTable; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartDataTable; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartDataTable` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartDataTableData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartDataTableData; + } + /** + * Represents the format of a chart data table. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + export class ChartDataTableFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents the border format of chart data table, which includes color, line style, and weight. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + readonly border: Excel.ChartBorder; + /** + * Represents the fill format of an object, which includes background formatting information. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + readonly fill: Excel.ChartFill; + /** + * Represents the font attributes (such as font name, font size, and color) for the current object. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + readonly font: Excel.ChartFont; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartDataTableFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartDataTableFormat): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartDataTableFormatLoadOptions): Excel.ChartDataTableFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartDataTableFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartDataTableFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartDataTableFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartDataTableFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartDataTableFormatData; + } + /** + * This object represents the attributes for a chart's error bars. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export class ChartErrorBars extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Specifies the formatting type of the error bars. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly format: Excel.ChartErrorBarsFormat; + /** + * Specifies if error bars have an end style cap. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + endStyleCap: boolean; + /** + * Specifies which parts of the error bars to include. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + include: Excel.ChartErrorBarsInclude | "Both" | "MinusValues" | "PlusValues"; + /** + * The type of range marked by the error bars. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + type: Excel.ChartErrorBarsType | "FixedValue" | "Percent" | "StDev" | "StError" | "Custom"; + /** + * Specifies whether the error bars are displayed. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + visible: boolean; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartErrorBarsUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartErrorBars): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartErrorBarsLoadOptions): Excel.ChartErrorBars; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartErrorBars; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartErrorBars; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartErrorBars` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartErrorBarsData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartErrorBarsData; + } + /** + * Encapsulates the format properties for chart error bars. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export class ChartErrorBarsFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents the chart line formatting. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly line: Excel.ChartLineFormat; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartErrorBarsFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartErrorBarsFormat): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartErrorBarsFormatLoadOptions): Excel.ChartErrorBarsFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartErrorBarsFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartErrorBarsFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartErrorBarsFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartErrorBarsFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartErrorBarsFormatData; + } + /** + * Represents major or minor gridlines on a chart axis. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class ChartGridlines extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents the formatting of chart gridlines. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly format: Excel.ChartGridlinesFormat; + /** + * Specifies if the axis gridlines are visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + visible: boolean; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartGridlinesUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartGridlines): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartGridlinesLoadOptions): Excel.ChartGridlines; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartGridlines; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartGridlines; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartGridlines` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartGridlinesData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartGridlinesData; + } + /** + * Encapsulates the format properties for chart gridlines. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class ChartGridlinesFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents chart line formatting. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly line: Excel.ChartLineFormat; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartGridlinesFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartGridlinesFormat): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartGridlinesFormatLoadOptions): Excel.ChartGridlinesFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartGridlinesFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartGridlinesFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartGridlinesFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartGridlinesFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartGridlinesFormatData; + } + /** + * Represents the legend in a chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class ChartLegend extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents the formatting of a chart legend, which includes fill and font formatting. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly format: Excel.ChartLegendFormat; + /** + * Represents a collection of legendEntries in the legend. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly legendEntries: Excel.ChartLegendEntryCollection; + /** + * Specifies the height, in points, of the legend on the chart. Value is `null` if the legend is not visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + height: number; + /** + * Specifies the left value, in points, of the legend on the chart. Value is `null` if the legend is not visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + left: number; + /** + * Specifies if the chart legend should overlap with the main body of the chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + overlay: boolean; + /** + * Specifies the position of the legend on the chart. See `Excel.ChartLegendPosition` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + position: Excel.ChartLegendPosition | "Invalid" | "Top" | "Bottom" | "Left" | "Right" | "Corner" | "Custom"; + /** + * Specifies if the legend has a shadow on the chart. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showShadow: boolean; + /** + * Specifies the top of a chart legend. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + top: number; + /** + * Specifies if the chart legend is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + visible: boolean; + /** + * Specifies the width, in points, of the legend on the chart. Value is `null` if the legend is not visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + width: number; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartLegendUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartLegend): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartLegendLoadOptions): Excel.ChartLegend; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartLegend; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartLegend; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartLegend` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartLegendData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartLegendData; + } + /** + * Represents the legend entry in `legendEntryCollection`. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + export class ChartLegendEntry extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Specifies the height of the legend entry on the chart legend. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly height: number; + /** + * Specifies the index of the legend entry in the chart legend. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly index: number; + /** + * Specifies the left value of a chart legend entry. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly left: number; + /** + * Specifies the top of a chart legend entry. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly top: number; + /** + * Represents the visibility of a chart legend entry. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + visible: boolean; + /** + * Represents the width of the legend entry on the chart Legend. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly width: number; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartLegendEntryUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartLegendEntry): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartLegendEntryLoadOptions): Excel.ChartLegendEntry; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartLegendEntry; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartLegendEntry; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartLegendEntry` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartLegendEntryData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartLegendEntryData; + } + /** + * Represents a collection of legend entries. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + export class ChartLegendEntryCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.ChartLegendEntry[]; + /** + * Returns the number of legend entries in the collection. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Returns a legend entry at the given index. + * + * @remarks + * [Api set: ExcelApi 1.7] + * + * @param index - Index of the legend entry to be retrieved. + */ + getItemAt(index: number): Excel.ChartLegendEntry; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartLegendEntryCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ChartLegendEntryCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartLegendEntryCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.ChartLegendEntryCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartLegendEntryCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartLegendEntryCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.ChartLegendEntryCollectionData; + } + /** + * Encapsulates the format properties of a chart legend. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class ChartLegendFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents the border format, which includes color, linestyle, and weight. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly border: Excel.ChartBorder; + /** + * Represents the fill format of an object, which includes background formatting information. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly fill: Excel.ChartFill; + /** + * Represents the font attributes such as font name, font size, and color of a chart legend. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly font: Excel.ChartFont; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartLegendFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartLegendFormat): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartLegendFormatLoadOptions): Excel.ChartLegendFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartLegendFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartLegendFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartLegendFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartLegendFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartLegendFormatData; + } + /** + * Encapsulates the properties for a region map chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export class ChartMapOptions extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Specifies the series map labels strategy of a region map chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + labelStrategy: Excel.ChartMapLabelStrategy | "None" | "BestFit" | "ShowAll"; + /** + * Specifies the series mapping level of a region map chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + level: Excel.ChartMapAreaLevel | "Automatic" | "DataOnly" | "City" | "County" | "State" | "Country" | "Continent" | "World"; + /** + * Specifies the series projection type of a region map chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + projectionType: Excel.ChartMapProjectionType | "Automatic" | "Mercator" | "Miller" | "Robinson" | "Albers"; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartMapOptionsUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartMapOptions): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartMapOptionsLoadOptions): Excel.ChartMapOptions; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartMapOptions; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartMapOptions; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartMapOptions` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartMapOptionsData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartMapOptionsData; + } + /** + * Represents a chart title object of a chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class ChartTitle extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents the formatting of a chart title, which includes fill and font formatting. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly format: Excel.ChartTitleFormat; + /** + * Returns the height, in points, of the chart title. Value is `null` if the chart title is not visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly height: number; + /** + * Specifies the horizontal alignment for chart title. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + horizontalAlignment: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"; + /** + * Specifies the distance, in points, from the left edge of chart title to the left edge of chart area. Value is `null` if the chart title is not visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + left: number; + /** + * Specifies if the chart title will overlay the chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + overlay: boolean; + /** + * Represents the position of chart title. See `Excel.ChartTitlePosition` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + position: Excel.ChartTitlePosition | "Automatic" | "Top" | "Bottom" | "Left" | "Right"; + /** + * Represents a boolean value that determines if the chart title has a shadow. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showShadow: boolean; + /** + * Specifies the chart's title text. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + text: string; + /** + * Specifies the angle to which the text is oriented for the chart title. The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + textOrientation: number; + /** + * Specifies the distance, in points, from the top edge of chart title to the top of chart area. Value is `null` if the chart title is not visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + top: number; + /** + * Specifies the vertical alignment of chart title. See `Excel.ChartTextVerticalAlignment` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"; + /** + * Specifies if the chart title is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + visible: boolean; + /** + * Specifies the width, in points, of the chart title. Value is `null` if the chart title is not visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly width: number; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartTitleUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartTitle): void; + /** + * Get the substring of a chart title. Line break '\n' counts one character. + * + * @remarks + * [Api set: ExcelApi 1.7] + * + * @param start - Start position of substring to be retrieved. Zero-indexed. + * @param length - Length of the substring to be retrieved. + */ + getSubstring(start: number, length: number): Excel.ChartFormatString; + /** + * Sets a string value that represents the formula of chart title using A1-style notation. + * + * @remarks + * [Api set: ExcelApi 1.7] + * + * @param formula - A string that represents the formula to set. + */ + setFormula(formula: string): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartTitleLoadOptions): Excel.ChartTitle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartTitle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartTitle; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartTitle` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartTitleData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartTitleData; + } + /** + * Represents the substring in chart related objects that contain text, like a `ChartTitle` object or `ChartAxisTitle` object. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + export class ChartFormatString extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents the font attributes, such as font name, font size, and color of a chart characters object. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly font: Excel.ChartFont; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartFormatStringUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartFormatString): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartFormatStringLoadOptions): Excel.ChartFormatString; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartFormatString; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartFormatString; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartFormatString` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartFormatStringData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartFormatStringData; + } + /** + * Provides access to the formatting options for a chart title. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class ChartTitleFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents the border format of chart title, which includes color, linestyle, and weight. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly border: Excel.ChartBorder; + /** + * Represents the fill format of an object, which includes background formatting information. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly fill: Excel.ChartFill; + /** + * Represents the font attributes (such as font name, font size, and color) for an object. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + readonly font: Excel.ChartFont; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartTitleFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartTitleFormat): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartTitleFormatLoadOptions): Excel.ChartTitleFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartTitleFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartTitleFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartTitleFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartTitleFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartTitleFormatData; + } + /** + * Represents the fill formatting for a chart element. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class ChartFill extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Clears the fill color of a chart element. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + clear(): void; + /** + * Gets the uniform color fill formatting of a chart element. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + getSolidColor(): OfficeExtension.ClientResult; + /** + * Sets the fill formatting of a chart element to a uniform color. + * + * @remarks + * [Api set: ExcelApi 1.1] + * + * @param color - HTML color code representing the color of the background, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + */ + setSolidColor(color: string): void; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartFillData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): { + [key: string]: string; + }; + } + /** + * Represents the border formatting of a chart element. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + export class ChartBorder extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * HTML color code representing the color of borders in the chart. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + color: string; + /** + * Represents the line style of the border. See `Excel.ChartLineStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + lineStyle: Excel.ChartLineStyle | "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot" | "Grey25" | "Grey50" | "Grey75" | "Automatic" | "RoundDot"; + /** + * Represents weight of the border, in points. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + weight: number; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartBorderUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartBorder): void; + /** + * Clear the border format of a chart element. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + clear(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartBorderLoadOptions): Excel.ChartBorder; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartBorder; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartBorder; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartBorder` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartBorderData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartBorderData; + } + /** + * Encapsulates the bin options for histogram charts and pareto charts. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export class ChartBinOptions extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Specifies if bin overflow is enabled in a histogram chart or pareto chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + allowOverflow: boolean; + /** + * Specifies if bin underflow is enabled in a histogram chart or pareto chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + allowUnderflow: boolean; + /** + * Specifies the bin count of a histogram chart or pareto chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + count: number; + /** + * Specifies the bin overflow value of a histogram chart or pareto chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + overflowValue: number; + /** + * Specifies the bin's type for a histogram chart or pareto chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + type: Excel.ChartBinType | "Category" | "Auto" | "BinWidth" | "BinCount"; + /** + * Specifies the bin underflow value of a histogram chart or pareto chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + underflowValue: number; + /** + * Specifies the bin width value of a histogram chart or pareto chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + width: number; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartBinOptionsUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartBinOptions): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartBinOptionsLoadOptions): Excel.ChartBinOptions; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartBinOptions; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartBinOptions; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartBinOptions` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartBinOptionsData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartBinOptionsData; + } + /** + * Represents the properties of a box and whisker chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export class ChartBoxwhiskerOptions extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Specifies if the quartile calculation type of a box and whisker chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + quartileCalculation: Excel.ChartBoxQuartileCalculation | "Inclusive" | "Exclusive"; + /** + * Specifies if inner points are shown in a box and whisker chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showInnerPoints: boolean; + /** + * Specifies if the mean line is shown in a box and whisker chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showMeanLine: boolean; + /** + * Specifies if the mean marker is shown in a box and whisker chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showMeanMarker: boolean; + /** + * Specifies if outlier points are shown in a box and whisker chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showOutlierPoints: boolean; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartBoxwhiskerOptionsUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartBoxwhiskerOptions): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartBoxwhiskerOptionsLoadOptions): Excel.ChartBoxwhiskerOptions; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartBoxwhiskerOptions; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartBoxwhiskerOptions; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartBoxwhiskerOptions` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartBoxwhiskerOptionsData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartBoxwhiskerOptionsData; + } + /** + * Encapsulates the formatting options for line elements. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class ChartLineFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * HTML color code representing the color of lines in the chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + color: string; + /** + * Represents the line style. See `Excel.ChartLineStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + lineStyle: Excel.ChartLineStyle | "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot" | "Grey25" | "Grey50" | "Grey75" | "Automatic" | "RoundDot"; + /** + * Represents weight of the line, in points. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + weight: number; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartLineFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartLineFormat): void; + /** + * Clears the line format of a chart element. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + clear(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartLineFormatLoadOptions): Excel.ChartLineFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartLineFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartLineFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartLineFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartLineFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartLineFormatData; + } + /** + * This object represents the font attributes (such as font name, font size, and color) for a chart object. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export class ChartFont extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents the bold status of font. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + bold: boolean; + /** + * HTML color code representation of the text color (e.g., #FF0000 represents Red). + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + color: string; + /** + * Represents the italic status of the font. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + italic: boolean; + /** + * Font name (e.g., "Calibri") + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + name: string; + /** + * Size of the font (e.g., 11) + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + size: number; + /** + * Type of underline applied to the font. See `Excel.ChartUnderlineStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + underline: Excel.ChartUnderlineStyle | "None" | "Single"; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartFontUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartFont): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartFontLoadOptions): Excel.ChartFont; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartFont; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartFont; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartFont` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartFontData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartFontData; + } + /** + * This object represents the attributes for a chart trendline object. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + export class ChartTrendline extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents the formatting of a chart trendline. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly format: Excel.ChartTrendlineFormat; + /** + * Represents the label of a chart trendline. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly label: Excel.ChartTrendlineLabel; + /** + * Represents the number of periods that the trendline extends backward. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + backwardPeriod: number; + /** + * Represents the number of periods that the trendline extends forward. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + forwardPeriod: number; + /** + * Represents the intercept value of the trendline. Can be set to a numeric value or an empty string (for automatic values). The returned value is always a number. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + intercept: any; + /** + * Represents the period of a chart trendline. Only applicable to trendlines with the type `MovingAverage`. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + movingAveragePeriod: number; + /** + * Represents the name of the trendline. Can be set to a string value, a `null` value represents automatic values. The returned value is always a string + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + name: string; + /** + * Represents the order of a chart trendline. Only applicable to trendlines with the type `Polynomial`. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + polynomialOrder: number; + /** + * True if the equation for the trendline is displayed on the chart. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showEquation: boolean; + /** + * True if the r-squared value for the trendline is displayed on the chart. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showRSquared: boolean; + /** + * Represents the type of a chart trendline. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + type: Excel.ChartTrendlineType | "Linear" | "Exponential" | "Logarithmic" | "MovingAverage" | "Polynomial" | "Power"; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartTrendlineUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartTrendline): void; + /** + * Delete the trendline object. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + delete(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartTrendlineLoadOptions): Excel.ChartTrendline; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartTrendline; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartTrendline; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartTrendline` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartTrendlineData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartTrendlineData; + } + /** + * Represents a collection of chart trendlines. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + export class ChartTrendlineCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.ChartTrendline[]; + /** + * Adds a new trendline to trendline collection. + * + * @remarks + * [Api set: ExcelApi 1.7] + * + * @param type - Specifies the trendline type. The default value is "Linear". See `Excel.ChartTrendline` for details. + */ + add(type?: Excel.ChartTrendlineType): Excel.ChartTrendline; + /** + * Adds a new trendline to trendline collection. + * + * @remarks + * [Api set: ExcelApi 1.7] + * + * @param type - Specifies the trendline type. The default value is "Linear". See `Excel.ChartTrendline` for details. + */ + add(type?: "Linear" | "Exponential" | "Logarithmic" | "MovingAverage" | "Polynomial" | "Power"): Excel.ChartTrendline; + /** + * Returns the number of trendlines in the collection. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a trendline object by index, which is the insertion order in the items array. + * + * @remarks + * [Api set: ExcelApi 1.7] + * + * @param index - Represents the insertion order in the items array. + */ + getItem(index: number): Excel.ChartTrendline; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartTrendlineCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ChartTrendlineCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartTrendlineCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.ChartTrendlineCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartTrendlineCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartTrendlineCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.ChartTrendlineCollectionData; + } + /** + * Represents the format properties for the chart trendline. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + export class ChartTrendlineFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents chart line formatting. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly line: Excel.ChartLineFormat; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartTrendlineFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartTrendlineFormat): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartTrendlineFormatLoadOptions): Excel.ChartTrendlineFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartTrendlineFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartTrendlineFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartTrendlineFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartTrendlineFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartTrendlineFormatData; + } + /** + * This object represents the attributes for a chart trendline label object. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export class ChartTrendlineLabel extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * The format of the chart trendline label. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly format: Excel.ChartTrendlineLabelFormat; + /** + * Specifies if the trendline label automatically generates appropriate text based on context. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + autoText: boolean; + /** + * String value that represents the formula of the chart trendline label using A1-style notation. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + formula: string; + /** + * Returns the height, in points, of the chart trendline label. Value is `null` if the chart trendline label is not visible. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly height: number; + /** + * Represents the horizontal alignment of the chart trendline label. See `Excel.ChartTextHorizontalAlignment` for details. + This property is valid only when `TextOrientation` of a trendline label is -90, 90, or 180. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + horizontalAlignment: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"; + /** + * Represents the distance, in points, from the left edge of the chart trendline label to the left edge of the chart area. Value is `null` if the chart trendline label is not visible. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + left: number; + /** + * Specifies if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + linkNumberFormat: boolean; + /** + * String value that represents the format code for the trendline label. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + numberFormat: string; + /** + * String representing the text of the trendline label on a chart. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + text: string; + /** + * Represents the angle to which the text is oriented for the chart trendline label. The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + textOrientation: number; + /** + * Represents the distance, in points, from the top edge of the chart trendline label to the top of the chart area. Value is `null` if the chart trendline label is not visible. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + top: number; + /** + * Represents the vertical alignment of the chart trendline label. See `Excel.ChartTextVerticalAlignment` for details. + This property is valid only when `TextOrientation` of a trendline label is 0. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"; + /** + * Returns the width, in points, of the chart trendline label. Value is `null` if the chart trendline label is not visible. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly width: number; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartTrendlineLabelUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartTrendlineLabel): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartTrendlineLabelLoadOptions): Excel.ChartTrendlineLabel; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartTrendlineLabel; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartTrendlineLabel; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartTrendlineLabel` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartTrendlineLabelData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartTrendlineLabelData; + } + /** + * Encapsulates the format properties for the chart trendline label. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export class ChartTrendlineLabelFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Specifies the border format, which includes color, linestyle, and weight. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly border: Excel.ChartBorder; + /** + * Specifies the fill format of the current chart trendline label. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly fill: Excel.ChartFill; + /** + * Specifies the font attributes (such as font name, font size, and color) for a chart trendline label. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly font: Excel.ChartFont; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartTrendlineLabelFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartTrendlineLabelFormat): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartTrendlineLabelFormatLoadOptions): Excel.ChartTrendlineLabelFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartTrendlineLabelFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartTrendlineLabelFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartTrendlineLabelFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartTrendlineLabelFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartTrendlineLabelFormatData; + } + /** + * This object represents the attributes for a chart plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export class ChartPlotArea extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Specifies the formatting of a chart plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly format: Excel.ChartPlotAreaFormat; + /** + * Specifies the height value of a plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + height: number; + /** + * Specifies the inside height value of a plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + insideHeight: number; + /** + * Specifies the inside left value of a plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + insideLeft: number; + /** + * Specifies the inside top value of a plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + insideTop: number; + /** + * Specifies the inside width value of a plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + insideWidth: number; + /** + * Specifies the left value of a plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + left: number; + /** + * Specifies the position of a plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + position: Excel.ChartPlotAreaPosition | "Automatic" | "Custom"; + /** + * Specifies the top value of a plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + top: number; + /** + * Specifies the width value of a plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + width: number; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartPlotAreaUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartPlotArea): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartPlotAreaLoadOptions): Excel.ChartPlotArea; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartPlotArea; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartPlotArea; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartPlotArea` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartPlotAreaData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartPlotAreaData; + } + /** + * Represents the format properties for a chart plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export class ChartPlotAreaFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Specifies the border attributes of a chart plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly border: Excel.ChartBorder; + /** + * Specifies the fill format of an object, which includes background formatting information. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly fill: Excel.ChartFill; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartPlotAreaFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartPlotAreaFormat): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartPlotAreaFormatLoadOptions): Excel.ChartPlotAreaFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartPlotAreaFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartPlotAreaFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartPlotAreaFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartPlotAreaFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartPlotAreaFormatData; + } + /** + * Gets an object that represents the formatting of chart leader lines. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + export class ChartLeaderLines extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents the formatting of leader lines of data labels in a series. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + readonly format: Excel.ChartLeaderLinesFormat; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartLeaderLinesUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartLeaderLines): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartLeaderLinesLoadOptions): Excel.ChartLeaderLines; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartLeaderLines; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartLeaderLines; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartLeaderLines` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartLeaderLinesData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartLeaderLinesData; + } + /** + * Encapsulates the format properties for leader lines. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + export class ChartLeaderLinesFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Gets an object that represents the line formatting of chart leader lines. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + readonly line: Excel.ChartLineFormat; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ChartLeaderLinesFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ChartLeaderLinesFormat): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ChartLeaderLinesFormatLoadOptions): Excel.ChartLeaderLinesFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ChartLeaderLinesFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ChartLeaderLinesFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ChartLeaderLinesFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartLeaderLinesFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ChartLeaderLinesFormatData; + } + /** + * Manages sorting operations on `Range` objects. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + export class RangeSort extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Perform a sort operation. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param fields - The list of conditions to sort on. + * @param matchCase - Optional. Whether to have the casing impact string ordering. + * @param hasHeaders - Optional. Whether the range has a header. + * @param orientation - Optional. Whether the operation is sorting rows or columns. + * @param method - Optional. The ordering method used for Chinese characters. + */ + apply(fields: Excel.SortField[], matchCase?: boolean, hasHeaders?: boolean, orientation?: Excel.SortOrientation, method?: Excel.SortMethod): void; + /** + * Perform a sort operation. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param fields - The list of conditions to sort on. + * @param matchCase - Optional. Whether to have the casing impact string ordering. + * @param hasHeaders - Optional. Whether the range has a header. + * @param orientation - Optional. Whether the operation is sorting rows or columns. + * @param method - Optional. The ordering method used for Chinese characters. + */ + apply(fields: Excel.SortField[], matchCase?: boolean, hasHeaders?: boolean, orientation?: "Rows" | "Columns", method?: "PinYin" | "StrokeCount"): void; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.RangeSort` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.RangeSortData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): { + [key: string]: string; + }; + } + /** + * Manages sorting operations on `Table` objects. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + export class TableSort extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Specifies the current conditions used to last sort the table. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + readonly fields: Excel.SortField[]; + /** + * Specifies if the casing impacts the last sort of the table. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + readonly matchCase: boolean; + /** + * Represents the Chinese character ordering method last used to sort the table. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + readonly method: Excel.SortMethod | "PinYin" | "StrokeCount"; + /** + * Perform a sort operation. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param fields - The list of conditions to sort on. + * @param matchCase - Optional. Whether to have the casing impact string ordering. + * @param method - Optional. The ordering method used for Chinese characters. + */ + apply(fields: Excel.SortField[], matchCase?: boolean, method?: Excel.SortMethod): void; + /** + * Perform a sort operation. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param fields - The list of conditions to sort on. + * @param matchCase - Optional. Whether to have the casing impact string ordering. + * @param method - Optional. The ordering method used for Chinese characters. + */ + apply(fields: Excel.SortField[], matchCase?: boolean, method?: "PinYin" | "StrokeCount"): void; + /** + * Clears the sorting that is currently on the table. While this doesn't modify the table's ordering, it clears the state of the header buttons. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + clear(): void; + /** + * Reapplies the current sorting parameters to the table. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + reapply(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.TableSortLoadOptions): Excel.TableSort; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TableSort; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.TableSort; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.TableSort` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.TableSortData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.TableSortData; + } + /** + * Represents a condition in a sorting operation. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + export interface SortField { + /** + * Specifies if the sorting is done in an ascending fashion. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + ascending?: boolean; + /** + * Specifies the color that is the target of the condition if the sorting is on font or cell color. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + color?: string; + /** + * Represents additional sorting options for this field. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + dataOption?: Excel.SortDataOption | "Normal" | "TextAsNumber"; + /** + * Specifies the icon that is the target of the condition, if the sorting is on the cell's icon. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + icon?: Excel.Icon; + /** + * Specifies the column (or row, depending on the sort orientation) that the condition is on. Represented as an offset from the first column (or row). + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + key: number; + /** + * Specifies the type of sorting of this condition. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + sortOn?: Excel.SortOn | "Value" | "CellColor" | "FontColor" | "Icon"; + /** + * Specifies the subfield that is the target property name of a rich value to sort on. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + subField?: string; + } + /** + * Manages the filtering of a table's column. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + export class Filter extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * The currently applied filter on the given column. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + readonly criteria: Excel.FilterCriteria; + /** + * Apply the given filter criteria on the given column. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param criteria - The criteria to apply. + */ + apply(criteria: Excel.FilterCriteria): void; + /** + * Apply a "Bottom Item" filter to the column for the given number of elements. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param count - The number of elements from the bottom to show. + */ + applyBottomItemsFilter(count: number): void; + /** + * Apply a "Bottom Percent" filter to the column for the given percentage of elements. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param percent - The percentage of elements from the bottom to show. + */ + applyBottomPercentFilter(percent: number): void; + /** + * Apply a "Cell Color" filter to the column for the given color. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param color - The background color of the cells to show. + */ + applyCellColorFilter(color: string): void; + /** + * Apply an "Icon" filter to the column for the given criteria strings. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param criteria1 - The first criteria string. + * @param criteria2 - Optional. The second criteria string. + * @param oper - Optional. The operator that describes how the two criteria are joined. + */ + applyCustomFilter(criteria1: string, criteria2?: string, oper?: Excel.FilterOperator): void; + /** + * Apply an "Icon" filter to the column for the given criteria strings. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param criteria1 - The first criteria string. + * @param criteria2 - Optional. The second criteria string. + * @param oper - Optional. The operator that describes how the two criteria are joined. + */ + applyCustomFilter(criteria1: string, criteria2?: string, oper?: "And" | "Or"): void; + /** + * Apply a "Dynamic" filter to the column. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param criteria - The dynamic criteria to apply. + */ + applyDynamicFilter(criteria: Excel.DynamicFilterCriteria): void; + /** + * Apply a "Dynamic" filter to the column. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param criteria - The dynamic criteria to apply. + */ + applyDynamicFilter(criteria: "Unknown" | "AboveAverage" | "AllDatesInPeriodApril" | "AllDatesInPeriodAugust" | "AllDatesInPeriodDecember" | "AllDatesInPeriodFebruray" | "AllDatesInPeriodJanuary" | "AllDatesInPeriodJuly" | "AllDatesInPeriodJune" | "AllDatesInPeriodMarch" | "AllDatesInPeriodMay" | "AllDatesInPeriodNovember" | "AllDatesInPeriodOctober" | "AllDatesInPeriodQuarter1" | "AllDatesInPeriodQuarter2" | "AllDatesInPeriodQuarter3" | "AllDatesInPeriodQuarter4" | "AllDatesInPeriodSeptember" | "BelowAverage" | "LastMonth" | "LastQuarter" | "LastWeek" | "LastYear" | "NextMonth" | "NextQuarter" | "NextWeek" | "NextYear" | "ThisMonth" | "ThisQuarter" | "ThisWeek" | "ThisYear" | "Today" | "Tomorrow" | "YearToDate" | "Yesterday"): void; + /** + * Apply a "Font Color" filter to the column for the given color. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param color - The font color of the cells to show. + */ + applyFontColorFilter(color: string): void; + /** + * Apply an "Icon" filter to the column for the given icon. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param icon - The icons of the cells to show. + */ + applyIconFilter(icon: Excel.Icon): void; + /** + * Apply a "Top Item" filter to the column for the given number of elements. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param count - The number of elements from the top to show. + */ + applyTopItemsFilter(count: number): void; + /** + * Apply a "Top Percent" filter to the column for the given percentage of elements. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param percent - The percentage of elements from the top to show. + */ + applyTopPercentFilter(percent: number): void; + /** + * Apply a "Values" filter to the column for the given values. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - The list of values to show. This must be an array of strings or an array of `Excel.FilterDateTime` objects. + */ + applyValuesFilter(values: Array): void; + /** + * Clear the filter on the given column. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + clear(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.FilterLoadOptions): Excel.Filter; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Filter; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.Filter; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.Filter` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.FilterData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.FilterData; + } + /** + * Represents the filtering criteria applied to a column. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + export interface FilterCriteria { + /** + * The HTML color string used to filter cells. Used with `cellColor` and `fontColor` filtering. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + color?: string; + /** + * The first criterion used to filter data. Used as an operator in the case of `custom` filtering. + For example ">50" for numbers greater than 50, or "=*s" for values ending in "s". + + Used as a number in the case of top/bottom items/percents (e.g., "5" for the top 5 items if `filterOn` is set to `topItems`). + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + criterion1?: string; + /** + * The second criterion used to filter data. Only used as an operator in the case of `custom` filtering. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + criterion2?: string; + /** + * The dynamic criteria from the `Excel.DynamicFilterCriteria` set to apply on this column. Used with `dynamic` filtering. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + dynamicCriteria?: Excel.DynamicFilterCriteria | "Unknown" | "AboveAverage" | "AllDatesInPeriodApril" | "AllDatesInPeriodAugust" | "AllDatesInPeriodDecember" | "AllDatesInPeriodFebruray" | "AllDatesInPeriodJanuary" | "AllDatesInPeriodJuly" | "AllDatesInPeriodJune" | "AllDatesInPeriodMarch" | "AllDatesInPeriodMay" | "AllDatesInPeriodNovember" | "AllDatesInPeriodOctober" | "AllDatesInPeriodQuarter1" | "AllDatesInPeriodQuarter2" | "AllDatesInPeriodQuarter3" | "AllDatesInPeriodQuarter4" | "AllDatesInPeriodSeptember" | "BelowAverage" | "LastMonth" | "LastQuarter" | "LastWeek" | "LastYear" | "NextMonth" | "NextQuarter" | "NextWeek" | "NextYear" | "ThisMonth" | "ThisQuarter" | "ThisWeek" | "ThisYear" | "Today" | "Tomorrow" | "YearToDate" | "Yesterday"; + /** + * The property used by the filter to determine whether the values should stay visible. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + filterOn: Excel.FilterOn | "BottomItems" | "BottomPercent" | "CellColor" | "Dynamic" | "FontColor" | "Values" | "TopItems" | "TopPercent" | "Icon" | "Custom"; + /** + * The icon used to filter cells. Used with `icon` filtering. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + icon?: Excel.Icon; + /** + * The operator used to combine criterion 1 and 2 when using `custom` filtering. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + operator?: Excel.FilterOperator | "And" | "Or"; + /** + * The property used by the filter to do a rich filter on rich values. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + subField?: string; + /** + * The set of values to be used as part of `values` filtering. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + values?: Array; + } + /** + * Represents how to filter a date when filtering on values. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + export interface FilterDatetime { + /** + * The date in ISO8601 format used to filter data. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + date: string; + /** + * How specific the date should be used to keep data. For example, if the date is 2005-04-02 and the specificity is set to "month", the filter operation will keep all rows with a date in the month of April 2005. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + specificity: Excel.FilterDatetimeSpecificity | "Year" | "Month" | "Day" | "Hour" | "Minute" | "Second"; + } + /** + * Represents the `AutoFilter` object. + AutoFilter turns the values in Excel column into specific filters based on the cell contents. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export class AutoFilter extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * An array that holds all the filter criteria in the autofiltered range. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly criteria: Excel.FilterCriteria[]; + /** + * Specifies if the AutoFilter is enabled. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly enabled: boolean; + /** + * Specifies if the AutoFilter has filter criteria. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly isDataFiltered: boolean; + /** + * Applies the AutoFilter to a range. This filters the column if column index and filter criteria are specified. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param range - The range on which the AutoFilter will apply. + * @param columnIndex - The zero-based column index to which the AutoFilter is applied. + * @param criteria - The filter criteria. + */ + apply(range: Range | string, columnIndex?: number, criteria?: Excel.FilterCriteria): void; + /** + * Clears the column filter criteria of the AutoFilter. + * + * @remarks + * [Api set: ExcelApi 1.14] + * + * @param columnIndex - The zero-based column index, which represents which column filter needs to be cleared. + * If the index value is not supported (for example, if the value is a negative number, or if the value is greater than the number of available columns in the range), + * then an `InvalidArgument` error will be thrown. + */ + clearColumnCriteria(columnIndex: number): void; + /** + * Clears the filter criteria and sort state of the AutoFilter. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + clearCriteria(): void; + /** + * Returns the `Range` object that represents the range to which the AutoFilter applies. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + getRange(): Excel.Range; + /** + * Returns the `Range` object that represents the range to which the AutoFilter applies. + If there is no `Range` object associated with the AutoFilter, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + getRangeOrNullObject(): Excel.Range; + /** + * Applies the specified AutoFilter object currently on the range. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + reapply(): void; + /** + * Removes the AutoFilter for the range. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + remove(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.AutoFilterLoadOptions): Excel.AutoFilter; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.AutoFilter; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.AutoFilter; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.AutoFilter` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.AutoFilterData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.AutoFilterData; + } + /** + * Provides information based on current system culture settings. This includes the culture names, number formatting, and other culturally dependent settings. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + export class CultureInfo extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Defines the culturally appropriate format of displaying date and time. This is based on current system culture settings. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + readonly datetimeFormat: Excel.DatetimeFormatInfo; + /** + * Defines the culturally appropriate format of displaying numbers. This is based on current system culture settings. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + readonly numberFormat: Excel.NumberFormatInfo; + /** + * Gets the culture name in the format languagecode2-country/regioncode2 (e.g., "zh-cn" or "en-us"). This is based on current system settings. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + readonly name: string; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.CultureInfoLoadOptions): Excel.CultureInfo; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.CultureInfo; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.CultureInfo; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.CultureInfo` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.CultureInfoData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.CultureInfoData; + } + /** + * Defines the culturally appropriate format of displaying numbers. This is based on current system culture settings. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + export class NumberFormatInfo extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Gets the currency symbol for currency values. This is based on current system settings. + * + * @remarks + * [Api set: ExcelApi 1.17] + */ + readonly currencySymbol: string; + /** + * Gets the string used as the decimal separator for numeric values. This is based on current system settings. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + readonly numberDecimalSeparator: string; + /** + * Gets the string used to separate groups of digits to the left of the decimal for numeric values. This is based on current system settings. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + readonly numberGroupSeparator: string; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.NumberFormatInfoLoadOptions): Excel.NumberFormatInfo; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.NumberFormatInfo; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.NumberFormatInfo; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.NumberFormatInfo` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.NumberFormatInfoData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.NumberFormatInfoData; + } + /** + * Defines the culturally appropriate format of displaying numbers. This is based on current system culture settings. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + export class DatetimeFormatInfo extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Gets the string used as the date separator. This is based on current system settings. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + readonly dateSeparator: string; + /** + * Gets the format string for a long date value. This is based on current system settings. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + readonly longDatePattern: string; + /** + * Gets the format string for a long time value. This is based on current system settings. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + readonly longTimePattern: string; + /** + * Gets the format string for a short date value. This is based on current system settings. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + readonly shortDatePattern: string; + /** + * Gets the string used as the time separator. This is based on current system settings. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + readonly timeSeparator: string; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.DatetimeFormatInfoLoadOptions): Excel.DatetimeFormatInfo; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.DatetimeFormatInfo; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.DatetimeFormatInfo; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.DatetimeFormatInfo` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.DatetimeFormatInfoData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.DatetimeFormatInfoData; + } + /** + * Represents a cell icon. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + export interface Icon { + /** + * Specifies the index of the icon in the given set. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + index: number; + /** + * Specifies the set that the icon is part of. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + set: Excel.IconSet | "Invalid" | "ThreeArrows" | "ThreeArrowsGray" | "ThreeFlags" | "ThreeTrafficLights1" | "ThreeTrafficLights2" | "ThreeSigns" | "ThreeSymbols" | "ThreeSymbols2" | "FourArrows" | "FourArrowsGray" | "FourRedToBlack" | "FourRating" | "FourTrafficLights" | "FiveArrows" | "FiveArrowsGray" | "FiveRating" | "FiveQuarters" | "ThreeStars" | "ThreeTriangles" | "FiveBoxes"; + } + /** + * A scoped collection of custom XML parts. + A scoped collection is the result of some operation (e.g., filtering by namespace). + A scoped collection cannot be scoped any further. + * + * @remarks + * [Api set: ExcelApi 1.5] + */ + export class CustomXmlPartScopedCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.CustomXmlPart[]; + /** + * Gets the number of CustomXML parts in this collection. + * + * @remarks + * [Api set: ExcelApi 1.5] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a custom XML part based on its ID. + * + * @remarks + * [Api set: ExcelApi 1.5] + * + * @param id - ID of the object to be retrieved. + */ + getItem(id: string): Excel.CustomXmlPart; + /** + * Gets a custom XML part based on its ID. + If the `CustomXmlPart` does not exist, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.5] + * + * @param id - ID of the object to be retrieved. + */ + getItemOrNullObject(id: string): Excel.CustomXmlPart; + /** + * If the collection contains exactly one item, this method returns it. + Otherwise, this method produces an error. + * + * @remarks + * [Api set: ExcelApi 1.5] + */ + getOnlyItem(): Excel.CustomXmlPart; + /** + * If the collection contains exactly one item, this method returns it. + Otherwise, this method returns `null`. + * + * @remarks + * [Api set: ExcelApi 1.5] + */ + getOnlyItemOrNullObject(): Excel.CustomXmlPart; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.CustomXmlPartScopedCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CustomXmlPartScopedCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.CustomXmlPartScopedCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.CustomXmlPartScopedCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.CustomXmlPartScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.CustomXmlPartScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.CustomXmlPartScopedCollectionData; + } + /** + * A collection of custom XML parts. + * + * @remarks + * [Api set: ExcelApi 1.5] + */ + export class CustomXmlPartCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.CustomXmlPart[]; + /** + * Adds a new custom XML part to the workbook. + * + * @remarks + * [Api set: ExcelApi 1.5] + * + * @param xml - XML content. Must be a valid XML fragment. + */ + add(xml: string): Excel.CustomXmlPart; + /** + * Gets a new scoped collection of custom XML parts whose namespaces match the given namespace. + * + * @remarks + * [Api set: ExcelApi 1.5] + * + * @param namespaceUri - This must be a fully qualified schema URI; for example, "http://schemas.contoso.com/review/1.0". + */ + getByNamespace(namespaceUri: string): Excel.CustomXmlPartScopedCollection; + /** + * Gets the number of custom XML parts in the collection. + * + * @remarks + * [Api set: ExcelApi 1.5] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a custom XML part based on its ID. + * + * @remarks + * [Api set: ExcelApi 1.5] + * + * @param id - ID of the object to be retrieved. + */ + getItem(id: string): Excel.CustomXmlPart; + /** + * Gets a custom XML part based on its ID. + If the `CustomXmlPart` does not exist, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.5] + * + * @param id - ID of the object to be retrieved. + */ + getItemOrNullObject(id: string): Excel.CustomXmlPart; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.CustomXmlPartCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CustomXmlPartCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.CustomXmlPartCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.CustomXmlPartCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.CustomXmlPartCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.CustomXmlPartCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.CustomXmlPartCollectionData; + } + /** + * Represents a custom XML part object in a workbook. + * + * @remarks + * [Api set: ExcelApi 1.5] + */ + export class CustomXmlPart extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * The custom XML part's ID. + * + * @remarks + * [Api set: ExcelApi 1.5] + */ + readonly id: string; + /** + * The custom XML part's namespace URI. + * + * @remarks + * [Api set: ExcelApi 1.5] + */ + readonly namespaceUri: string; + /** + * Deletes the custom XML part. + * + * @remarks + * [Api set: ExcelApi 1.5] + */ + delete(): void; + /** + * Gets the custom XML part's full XML content. + * + * @remarks + * [Api set: ExcelApi 1.5] + */ + getXml(): OfficeExtension.ClientResult; + /** + * Sets the custom XML part's full XML content. + * + * @remarks + * [Api set: ExcelApi 1.5] + * + * @param xml - XML content for the part. + */ + setXml(xml: string): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.CustomXmlPartLoadOptions): Excel.CustomXmlPart; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.CustomXmlPart; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.CustomXmlPart; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.CustomXmlPart` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.CustomXmlPartData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.CustomXmlPartData; + } + /** + * Represents a scoped collection of PivotTables. The PivotTables are sorted based on the location of the PivotTable's top-left corner. They are ordered top-to-bottom and then left-to-right. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + export class PivotTableScopedCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.PivotTable[]; + /** + * Gets the number of PivotTables in the collection. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets the first PivotTable in the collection. The PivotTables in the collection are sorted top-to-bottom and left-to-right, such that top-left table is the first PivotTable in the collection. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + getFirst(): Excel.PivotTable; + /** + * Gets the first PivotTable in the collection. + The PivotTables in the collection are sorted top-to-bottom and left-to-right, such that the top-left table is the first PivotTable in the collection. + If the collection is empty, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.15] + */ + getFirstOrNullObject(): Excel.PivotTable; + /** + * Gets a PivotTable by name. + * + * @remarks + * [Api set: ExcelApi 1.12] + * + * @param key - Name of the PivotTable to be retrieved. + */ + getItem(key: string): Excel.PivotTable; + /** + * Gets a PivotTable by name. + If the PivotTable does not exist, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.12] + * + * @param name - Name of the PivotTable to be retrieved. + */ + getItemOrNullObject(name: string): Excel.PivotTable; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.PivotTableScopedCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotTableScopedCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PivotTableScopedCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.PivotTableScopedCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.PivotTableScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.PivotTableScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.PivotTableScopedCollectionData; + } + /** + * Represents a collection of all the PivotTables that are part of the workbook or worksheet. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + export class PivotTableCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.PivotTable[]; + /** + * Add a PivotTable based on the specified source data and insert it at the top-left cell of the destination range. + * + * @remarks + * [Api set: ExcelApi 1.8] + * + * @param name - The name of the new PivotTable. + * @param source - The source data for the new PivotTable, this can either be a range (or string address including the worksheet name) or a table. + * @param destination - The cell in the upper-left corner of the PivotTable report's destination range (the range on the worksheet where the resulting report will be placed). + * @returns Returns the newly inserted PivotTable. + */ + add(name: string, source: Range | string | Table, destination: Range | string): Excel.PivotTable; + /** + * Gets the number of pivot tables in the collection. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a PivotTable by name. + * + * @remarks + * [Api set: ExcelApi 1.3] + * + * @param name - Name of the PivotTable to be retrieved. + */ + getItem(name: string): Excel.PivotTable; + /** + * Gets a PivotTable by name. + If the PivotTable does not exist, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.4] + * + * @param name - Name of the PivotTable to be retrieved. + */ + getItemOrNullObject(name: string): Excel.PivotTable; + /** + * Refreshes all the pivot tables in the collection. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + refreshAll(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.PivotTableCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotTableCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PivotTableCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.PivotTableCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.PivotTableCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.PivotTableCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.PivotTableCollectionData; + } + /** + * Represents an Excel PivotTable. + To learn more about the PivotTable object model, read {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-pivottables | Work with PivotTables using the Excel JavaScript API}. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + export class PivotTable extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * The Column Pivot Hierarchies of the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly columnHierarchies: Excel.RowColumnPivotHierarchyCollection; + /** + * The Data Pivot Hierarchies of the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly dataHierarchies: Excel.DataPivotHierarchyCollection; + /** + * The Filter Pivot Hierarchies of the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly filterHierarchies: Excel.FilterPivotHierarchyCollection; + /** + * The Pivot Hierarchies of the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly hierarchies: Excel.PivotHierarchyCollection; + /** + * The PivotLayout describing the layout and visual structure of the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly layout: Excel.PivotLayout; + /** + * The Row Pivot Hierarchies of the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly rowHierarchies: Excel.RowColumnPivotHierarchyCollection; + /** + * The worksheet containing the current PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + readonly worksheet: Excel.Worksheet; + /** + * Specifies if the PivotTable allows the application of multiple PivotFilters on a given PivotField in the table. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + allowMultipleFiltersPerField: boolean; + /** + * Specifies if the PivotTable allows values in the data body to be edited by the user. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enableDataValueEditing: boolean; + /** + * ID of the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.5] + */ + readonly id: string; + /** + * Name of the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + name: string; + /** + * Specifies whether the PivotTable refreshes when the workbook opens. Corresponds to "Refresh on load" setting in the UI. + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + refreshOnOpen: boolean; + /** + * Specifies if the PivotTable uses custom lists when sorting. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + useCustomSortLists: boolean; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.PivotTableUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.PivotTable): void; + /** + * Deletes the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + delete(): void; + /** + * Returns the string representation of the data source for the PivotTable. + This method currently supports string representations for table and range objects. + Otherwise, it returns an empty string. + * + * @remarks + * [Api set: ExcelApi 1.15] + */ + getDataSourceString(): OfficeExtension.ClientResult; + /** + * Gets the type of the data source for the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.15] + */ + getDataSourceType(): OfficeExtension.ClientResult; + /** + * Refreshes the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + refresh(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.PivotTableLoadOptions): Excel.PivotTable; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PivotTable; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.PivotTable; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.PivotTable` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.PivotTableData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.PivotTableData; + } + /** + * Represents the visual layout of the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export class PivotLayout extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * The alt text description of the PivotTable. + + Alt text provides alternative, text-based representations of the information contained in the PivotTable. + This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table. + A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content. + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + altTextDescription: string; + /** + * The alt text title of the PivotTable. + + Alt text provides alternative, text-based representations of the information contained in the PivotTable. + This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table. + A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content. + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + altTextTitle: string; + /** + * Specifies if formatting will be automatically formatted when it's refreshed or when fields are moved. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + autoFormat: boolean; + /** + * The text that is automatically filled into any empty cell in the PivotTable if `fillEmptyCells == true`. + Note that this value persists if `fillEmptyCells` is set to `false`, and that setting this value does not set that property to `true`. + By default, this is an empty string. + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + emptyCellText: string; + /** + * Specifies if the field list can be shown in the UI. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + enableFieldList: boolean; + /** + * Specifies whether empty cells in the PivotTable should be populated with the `emptyCellText`. Default is `false`. + Note that the value of `emptyCellText` persists when this property is set to `false`. + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + fillEmptyCells: boolean; + /** + * This property indicates the PivotLayoutType of all fields on the PivotTable. + If fields have different states, this will be null. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + layoutType: Excel.PivotLayoutType | "Compact" | "Tabular" | "Outline"; + /** + * Specifies if formatting is preserved when the report is refreshed or recalculated by operations such as pivoting, sorting, or changing page field items. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + preserveFormatting: boolean; + /** + * Specifies if the PivotTable report shows grand totals for columns. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showColumnGrandTotals: boolean; + /** + * Specifies whether the PivotTable displays field headers (field captions and filter drop-downs). + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + showFieldHeaders: boolean; + /** + * Specifies if the PivotTable report shows grand totals for rows. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showRowGrandTotals: boolean; + /** + * This property indicates the `SubtotalLocationType` of all fields on the PivotTable. + If fields have different states, this will be `null`. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + subtotalLocation: Excel.SubtotalLocationType | "AtTop" | "AtBottom" | "Off"; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.PivotLayoutUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.PivotLayout): void; + /** + * Sets whether or not to display a blank line after each item. This is set at the global level for the PivotTable and applied to individual PivotFields. + This function overwrites the setting for all fields in the PivotTable to the value of `display` parameter. + * + * @remarks + * [Api set: ExcelApi 1.13] + * + * @param display - True turns on the blank-line display setting. False turns it off. + */ + displayBlankLineAfterEachItem(display: boolean): void; + /** + * Returns the range where the PivotTable's column labels reside. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + getColumnLabelRange(): Excel.Range; + /** + * Returns the range where the PivotTable's data values reside. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + getDataBodyRange(): Excel.Range; + /** + * Gets the DataHierarchy that is used to calculate the value in a specified range within the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param cell - A single cell within the PivotTable data body. + * @returns The DataPivotHierarchy object used to calculate the value in the specified cell. + */ + getDataHierarchy(cell: Range | string): Excel.DataPivotHierarchy; + /** + * Returns the range of the PivotTable's filter area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + getFilterAxisRange(): Excel.Range; + /** + * Gets the PivotItems from an axis that make up the value in a specified range within the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param axis - The axis from which to get the PivotItems. Must be either "row" or "column." + * @param cell - A single cell within the PivotTable's data body. + * @returns A PivotItemCollection of the PivotItems that are used to calculate the values in the specified row. + */ + getPivotItems(axis: Excel.PivotAxis, cell: Range | string): Excel.PivotItemCollection; + /** + * Gets the PivotItems from an axis that make up the value in a specified range within the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param axis - The axis from which to get the PivotItems. Must be either "row" or "column." + * @param cell - A single cell within the PivotTable's data body. + * @returns A PivotItemCollection of the PivotItems that are used to calculate the values in the specified row. + */ + getPivotItems(axis: "Unknown" | "Row" | "Column" | "Data" | "Filter", cell: Range | string): Excel.PivotItemCollection; + /** + * Returns the range the PivotTable exists on, excluding the filter area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + getRange(): Excel.Range; + /** + * Returns the range where the PivotTable's row labels reside. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + getRowLabelRange(): Excel.Range; + /** + * Sets the "repeat all item labels" setting across all fields in the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.13] + * + * @param repeatLabels - True turns on the label-repetition display setting. False turns it off. + */ + repeatAllItemLabels(repeatLabels: boolean): void; + /** + * Sets the PivotTable to automatically sort using the specified cell to automatically select all necessary criteria and context. This behaves identically to applying an autosort from the UI. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param cell - A single cell to use get the criteria from for applying the autosort. + * @param sortBy - The direction of the sort. + */ + setAutoSortOnCell(cell: Range | string, sortBy: Excel.SortBy): void; + /** + * Sets the PivotTable to automatically sort using the specified cell to automatically select all necessary criteria and context. This behaves identically to applying an autosort from the UI. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param cell - A single cell to use get the criteria from for applying the autosort. + * @param sortBy - The direction of the sort. + */ + setAutoSortOnCell(cell: Range | string, sortBy: "Ascending" | "Descending"): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.PivotLayoutLoadOptions): Excel.PivotLayout; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PivotLayout; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.PivotLayout; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.PivotLayout` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.PivotLayoutData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.PivotLayoutData; + } + /** + * Represents a collection of all the PivotHierarchies that are part of the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export class PivotHierarchyCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.PivotHierarchy[]; + /** + * Gets the number of pivot hierarchies in the collection. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a PivotHierarchy by its name or ID. + * + * @remarks + * [Api set: ExcelApi 1.8] + * + * @param name - Name of the PivotHierarchy to be retrieved. + */ + getItem(name: string): Excel.PivotHierarchy; + /** + * Gets a PivotHierarchy by name. + If the PivotHierarchy does not exist, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.8] + * + * @param name - Name of the PivotHierarchy to be retrieved. + */ + getItemOrNullObject(name: string): Excel.PivotHierarchy; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.PivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotHierarchyCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PivotHierarchyCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.PivotHierarchyCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.PivotHierarchyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.PivotHierarchyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.PivotHierarchyCollectionData; + } + /** + * Represents the Excel PivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export class PivotHierarchy extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns the PivotFields associated with the PivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly fields: Excel.PivotFieldCollection; + /** + * ID of the PivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly id: string; + /** + * Name of the PivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + name: string; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.PivotHierarchyUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.PivotHierarchy): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.PivotHierarchyLoadOptions): Excel.PivotHierarchy; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PivotHierarchy; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.PivotHierarchy; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.PivotHierarchy` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.PivotHierarchyData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.PivotHierarchyData; + } + /** + * Represents a collection of RowColumnPivotHierarchy items associated with the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export class RowColumnPivotHierarchyCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.RowColumnPivotHierarchy[]; + /** + * Adds the PivotHierarchy to the current axis. If the hierarchy is present elsewhere on the row, column, + or filter axis, it will be removed from that location. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + add(pivotHierarchy: Excel.PivotHierarchy): Excel.RowColumnPivotHierarchy; + /** + * Gets the number of pivot hierarchies in the collection. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a RowColumnPivotHierarchy by its name or ID. + * + * @remarks + * [Api set: ExcelApi 1.8] + * + * @param name - Name of the RowColumnPivotHierarchy to be retrieved. + */ + getItem(name: string): Excel.RowColumnPivotHierarchy; + /** + * Gets a RowColumnPivotHierarchy by name. + If the RowColumnPivotHierarchy does not exist, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.8] + * + * @param name - Name of the RowColumnPivotHierarchy to be retrieved. + */ + getItemOrNullObject(name: string): Excel.RowColumnPivotHierarchy; + /** + * Removes the PivotHierarchy from the current axis. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + remove(rowColumnPivotHierarchy: Excel.RowColumnPivotHierarchy): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.RowColumnPivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.RowColumnPivotHierarchyCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.RowColumnPivotHierarchyCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.RowColumnPivotHierarchyCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.RowColumnPivotHierarchyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.RowColumnPivotHierarchyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.RowColumnPivotHierarchyCollectionData; + } + /** + * Represents the Excel RowColumnPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export class RowColumnPivotHierarchy extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns the PivotFields associated with the RowColumnPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly fields: Excel.PivotFieldCollection; + /** + * ID of the RowColumnPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly id: string; + /** + * Name of the RowColumnPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + name: string; + /** + * Position of the RowColumnPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + position: number; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.RowColumnPivotHierarchyUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.RowColumnPivotHierarchy): void; + /** + * Reset the RowColumnPivotHierarchy back to its default values. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + setToDefault(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.RowColumnPivotHierarchyLoadOptions): Excel.RowColumnPivotHierarchy; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.RowColumnPivotHierarchy; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.RowColumnPivotHierarchy; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.RowColumnPivotHierarchy` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.RowColumnPivotHierarchyData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.RowColumnPivotHierarchyData; + } + /** + * Represents a collection of FilterPivotHierarchy items associated with the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export class FilterPivotHierarchyCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.FilterPivotHierarchy[]; + /** + * Adds the PivotHierarchy to the current axis. If the hierarchy is present elsewhere on the row, column, + or filter axis, it will be removed from that location. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + add(pivotHierarchy: Excel.PivotHierarchy): Excel.FilterPivotHierarchy; + /** + * Gets the number of pivot hierarchies in the collection. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a FilterPivotHierarchy by its name or ID. + * + * @remarks + * [Api set: ExcelApi 1.8] + * + * @param name - Name of the FilterPivotHierarchy to be retrieved. + */ + getItem(name: string): Excel.FilterPivotHierarchy; + /** + * Gets a FilterPivotHierarchy by name. + If the FilterPivotHierarchy does not exist, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.8] + * + * @param name - Name of the FilterPivotHierarchy to be retrieved. + */ + getItemOrNullObject(name: string): Excel.FilterPivotHierarchy; + /** + * Removes the PivotHierarchy from the current axis. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + remove(filterPivotHierarchy: Excel.FilterPivotHierarchy): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.FilterPivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.FilterPivotHierarchyCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.FilterPivotHierarchyCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.FilterPivotHierarchyCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.FilterPivotHierarchyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.FilterPivotHierarchyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.FilterPivotHierarchyCollectionData; + } + /** + * Represents the Excel FilterPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export class FilterPivotHierarchy extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns the PivotFields associated with the FilterPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly fields: Excel.PivotFieldCollection; + /** + * Determines whether to allow multiple filter items. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + enableMultipleFilterItems: boolean; + /** + * ID of the FilterPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly id: string; + /** + * Name of the FilterPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + name: string; + /** + * Position of the FilterPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + position: number; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.FilterPivotHierarchyUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.FilterPivotHierarchy): void; + /** + * Reset the FilterPivotHierarchy back to its default values. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + setToDefault(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.FilterPivotHierarchyLoadOptions): Excel.FilterPivotHierarchy; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.FilterPivotHierarchy; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.FilterPivotHierarchy; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.FilterPivotHierarchy` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.FilterPivotHierarchyData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.FilterPivotHierarchyData; + } + /** + * Represents a collection of DataPivotHierarchy items associated with the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export class DataPivotHierarchyCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.DataPivotHierarchy[]; + /** + * Adds the PivotHierarchy to the current axis. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + add(pivotHierarchy: Excel.PivotHierarchy): Excel.DataPivotHierarchy; + /** + * Gets the number of pivot hierarchies in the collection. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a DataPivotHierarchy by its name or ID. + * + * @remarks + * [Api set: ExcelApi 1.8] + * + * @param name - Name of the DataPivotHierarchy to be retrieved. + */ + getItem(name: string): Excel.DataPivotHierarchy; + /** + * Gets a DataPivotHierarchy by name. + If the DataPivotHierarchy does not exist, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.8] + * + * @param name - Name of the DataPivotHierarchy to be retrieved. + */ + getItemOrNullObject(name: string): Excel.DataPivotHierarchy; + /** + * Removes the PivotHierarchy from the current axis. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + remove(DataPivotHierarchy: Excel.DataPivotHierarchy): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.DataPivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.DataPivotHierarchyCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.DataPivotHierarchyCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.DataPivotHierarchyCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.DataPivotHierarchyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.DataPivotHierarchyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.DataPivotHierarchyCollectionData; + } + /** + * Represents the Excel DataPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export class DataPivotHierarchy extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns the PivotFields associated with the DataPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly field: Excel.PivotField; + /** + * ID of the DataPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly id: string; + /** + * Name of the DataPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + name: string; + /** + * Number format of the DataPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + numberFormat: string; + /** + * Position of the DataPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + position: number; + /** + * Specifies if the data should be shown as a specific summary calculation. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showAs: Excel.ShowAsRule; + /** + * Specifies if all items of the DataPivotHierarchy are shown. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + summarizeBy: Excel.AggregationFunction | "Unknown" | "Automatic" | "Sum" | "Count" | "Average" | "Max" | "Min" | "Product" | "CountNumbers" | "StandardDeviation" | "StandardDeviationP" | "Variance" | "VarianceP"; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.DataPivotHierarchyUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.DataPivotHierarchy): void; + /** + * Reset the DataPivotHierarchy back to its default values. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + setToDefault(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.DataPivotHierarchyLoadOptions): Excel.DataPivotHierarchy; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.DataPivotHierarchy; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.DataPivotHierarchy; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.DataPivotHierarchy` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.DataPivotHierarchyData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.DataPivotHierarchyData; + } + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + export interface ShowAsRule { + /** + * The PivotField to base the `ShowAs` calculation on, if applicable according to the `ShowAsCalculation` type, else `null`. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + baseField?: Excel.PivotField; + /** + * The item to base the `ShowAs` calculation on, if applicable according to the `ShowAsCalculation` type, else `null`. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + baseItem?: Excel.PivotItem; + /** + * The `ShowAs` calculation to use for the PivotField. See `Excel.ShowAsCalculation` for details. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + calculation: Excel.ShowAsCalculation | "Unknown" | "None" | "PercentOfGrandTotal" | "PercentOfRowTotal" | "PercentOfColumnTotal" | "PercentOfParentRowTotal" | "PercentOfParentColumnTotal" | "PercentOfParentTotal" | "PercentOf" | "RunningTotal" | "PercentRunningTotal" | "DifferenceFrom" | "PercentDifferenceFrom" | "RankAscending" | "RankDecending" | "Index"; + } + /** + * Represents a collection of all the PivotFields that are part of a PivotTable's hierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export class PivotFieldCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.PivotField[]; + /** + * Gets the number of pivot fields in the collection. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a PivotField by its name or ID. + * + * @remarks + * [Api set: ExcelApi 1.8] + * + * @param name - Name of the PivotField to be retrieved. + */ + getItem(name: string): Excel.PivotField; + /** + * Gets a PivotField by name. + If the PivotField does not exist, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.8] + * + * @param name - Name of the PivotField to be retrieved. + */ + getItemOrNullObject(name: string): Excel.PivotField; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.PivotFieldCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotFieldCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PivotFieldCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.PivotFieldCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.PivotFieldCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.PivotFieldCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.PivotFieldCollectionData; + } + /** + * Represents the Excel PivotField. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export class PivotField extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns the PivotItems associated with the PivotField. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly items: Excel.PivotItemCollection; + /** + * ID of the PivotField. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly id: string; + /** + * Name of the PivotField. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + name: string; + /** + * Determines whether to show all items of the PivotField. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showAllItems: boolean; + /** + * Subtotals of the PivotField. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + subtotals: Excel.Subtotals; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.PivotFieldUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.PivotField): void; + /** + * Sets one or more of the field's current PivotFilters and applies them to the field. + If the provided filters are invalid or cannot be applied, an exception is thrown. + * + * @remarks + * [Api set: ExcelApi 1.12] + * + * @param filter - A configured specific PivotFilter, or a PivotFilters interface containing multiple configured filters. + */ + applyFilter(filter: Excel.PivotFilters): void; + /** + * Clears all criteria from all of the field's filters. This removes any active filtering on the field. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + clearAllFilters(): void; + /** + * Clears all existing criteria from the field's filter of the given type (if one is currently applied). + * + * @remarks + * [Api set: ExcelApi 1.12] + * + * @param filterType - The type of filter on the field of which to clear all criteria. + */ + clearFilter(filterType: Excel.PivotFilterType): void; + /** + * Clears all existing criteria from the field's filter of the given type (if one is currently applied). + * + * @remarks + * [Api set: ExcelApi 1.12] + * + * @param filterType - The type of filter on the field of which to clear all criteria. + */ + clearFilter(filterType: "Unknown" | "Value" | "Manual" | "Label" | "Date"): void; + /** + * Gets all filters currently applied on the field. + * + * @remarks + * [Api set: ExcelApi 1.12] + * @returns A PivotFilters interface with all active filters. + */ + getFilters(): OfficeExtension.ClientResult; + /** + * Checks if there are any applied filters on the field. + * + * @remarks + * [Api set: ExcelApi 1.12] + * + * @param filterType - The filter type to check. If no type is provided, this method will check if any filter is applied. + * @returns True if the field has a filter of type `filterType` applied. If `filterType` is not specified, `true` is returned if the field has any applied filters. + */ + isFiltered(filterType?: Excel.PivotFilterType): OfficeExtension.ClientResult; + /** + * Checks if there are any applied filters on the field. + * + * @remarks + * [Api set: ExcelApi 1.12] + * + * @param filterType - The filter type to check. If no type is provided, this method will check if any filter is applied. + * @returns True if the field has a filter of type `filterType` applied. If `filterType` is not specified, `true` is returned if the field has any applied filters. + */ + isFiltered(filterType?: "Unknown" | "Value" | "Manual" | "Label" | "Date"): OfficeExtension.ClientResult; + /** + * Sorts the PivotField. If a DataPivotHierarchy is specified, then sort will be applied based on it, if not sort will be based on the PivotField itself. + * + * @remarks + * [Api set: ExcelApi 1.8] + * + * @param sortBy - Specifies if the sorting is done in ascending or descending order. + */ + sortByLabels(sortBy: SortBy): void; + /** + * Sorts the PivotField by specified values in a given scope. The scope defines which specific values will be used to sort when + there are multiple values from the same DataPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param sortBy - Specifies if the sorting is done in ascending or descending order. + * @param valuesHierarchy - Specifies the values hierarchy on the data axis to be used for sorting. + * @param pivotItemScope - The items that should be used for the scope of the sorting. These will be the + * items that make up the row or column that you want to sort on. If a string is used instead of a PivotItem, + * the string represents the ID of the PivotItem. If there are no items other than data hierarchy on the axis + * you want to sort on, this can be empty. + */ + sortByValues(sortBy: Excel.SortBy, valuesHierarchy: Excel.DataPivotHierarchy, pivotItemScope?: Array): void; + /** + * Sorts the PivotField by specified values in a given scope. The scope defines which specific values will be used to sort when + there are multiple values from the same DataPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param sortBy - Specifies if the sorting is done in ascending or descending order. + * @param valuesHierarchy - Specifies the values hierarchy on the data axis to be used for sorting. + * @param pivotItemScope - The items that should be used for the scope of the sorting. These will be the + * items that make up the row or column that you want to sort on. If a string is used instead of a PivotItem, + * the string represents the ID of the PivotItem. If there are no items other than data hierarchy on the axis + * you want to sort on, this can be empty. + */ + sortByValues(sortBy: "Ascending" | "Descending", valuesHierarchy: Excel.DataPivotHierarchy, pivotItemScope?: Array): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.PivotFieldLoadOptions): Excel.PivotField; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PivotField; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.PivotField; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.PivotField` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.PivotFieldData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.PivotFieldData; + } + /** + * Represents a collection of all the PivotItems related to their parent PivotField. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export class PivotItemCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.PivotItem[]; + /** + * Gets the number of PivotItems in the collection. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a PivotItem by its name or ID. + * + * @remarks + * [Api set: ExcelApi 1.8] + * + * @param name - Name of the PivotItem to be retrieved. + */ + getItem(name: string): Excel.PivotItem; + /** + * Gets a PivotItem by name. + If the PivotItem does not exist, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.8] + * + * @param name - Name of the PivotItem to be retrieved. + */ + getItemOrNullObject(name: string): Excel.PivotItem; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.PivotItemCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotItemCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PivotItemCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.PivotItemCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.PivotItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.PivotItemCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.PivotItemCollectionData; + } + /** + * Represents the Excel PivotItem. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export class PivotItem extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * ID of the PivotItem. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readonly id: string; + /** + * Determines whether the item is expanded to show child items or if it's collapsed and child items are hidden. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + isExpanded: boolean; + /** + * Name of the PivotItem. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + name: string; + /** + * Specifies if the PivotItem is visible. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + visible: boolean; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.PivotItemUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.PivotItem): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.PivotItemLoadOptions): Excel.PivotItem; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PivotItem; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.PivotItem; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.PivotItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.PivotItemData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.PivotItemData; + } + /** + * Subtotals for the Pivot Field. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export interface Subtotals { + /** + * If `Automatic` is set to `true`, then all other values will be ignored when setting the `Subtotals`. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + automatic?: boolean; + average?: boolean; + count?: boolean; + countNumbers?: boolean; + max?: boolean; + min?: boolean; + product?: boolean; + standardDeviation?: boolean; + standardDeviationP?: boolean; + sum?: boolean; + variance?: boolean; + varianceP?: boolean; + } + /** + * Represents the criteria for the top/bottom values filter. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum PivotFilterTopBottomCriterion { + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + invalid = "Invalid", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + topItems = "TopItems", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + topPercent = "TopPercent", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + topSum = "TopSum", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + bottomItems = "BottomItems", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + bottomPercent = "BottomPercent", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + bottomSum = "BottomSum" + } + /** + * Represents the sort direction. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + enum SortBy { + /** + * Ascending sort. Smallest to largest or A to Z. + * @remarks + * [Api set: ExcelApi 1.8] + */ + ascending = "Ascending", + /** + * Descending sort. Largest to smallest or Z to A. + * @remarks + * [Api set: ExcelApi 1.8] + */ + descending = "Descending" + } + /** + * Aggregation function for the `DataPivotHierarchy`. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + enum AggregationFunction { + /** + * Aggregation function is unknown or unsupported. + * @remarks + * [Api set: ExcelApi 1.8] + */ + unknown = "Unknown", + /** + * Excel will automatically select the aggregation based on the data items. + * @remarks + * [Api set: ExcelApi 1.8] + */ + automatic = "Automatic", + /** + * Aggregate using the sum of the data, equivalent to the SUM function. + * @remarks + * [Api set: ExcelApi 1.8] + */ + sum = "Sum", + /** + * Aggregate using the count of items in the data, equivalent to the COUNTA function. + * @remarks + * [Api set: ExcelApi 1.8] + */ + count = "Count", + /** + * Aggregate using the average of the data, equivalent to the AVERAGE function. + * @remarks + * [Api set: ExcelApi 1.8] + */ + average = "Average", + /** + * Aggregate using the maximum value of the data, equivalent to the MAX function. + * @remarks + * [Api set: ExcelApi 1.8] + */ + max = "Max", + /** + * Aggregate using the minimum value of the data, equivalent to the MIN function. + * @remarks + * [Api set: ExcelApi 1.8] + */ + min = "Min", + /** + * Aggregate using the product of the data, equivalent to the PRODUCT function. + * @remarks + * [Api set: ExcelApi 1.8] + */ + product = "Product", + /** + * Aggregate using the count of numbers in the data, equivalent to the COUNT function. + * @remarks + * [Api set: ExcelApi 1.8] + */ + countNumbers = "CountNumbers", + /** + * Aggregate using the standard deviation of the data, equivalent to the STDEV function. + * @remarks + * [Api set: ExcelApi 1.8] + */ + standardDeviation = "StandardDeviation", + /** + * Aggregate using the standard deviation of the data, equivalent to the STDEVP function. + * @remarks + * [Api set: ExcelApi 1.8] + */ + standardDeviationP = "StandardDeviationP", + /** + * Aggregate using the variance of the data, equivalent to the VAR function. + * @remarks + * [Api set: ExcelApi 1.8] + */ + variance = "Variance", + /** + * Aggregate using the variance of the data, equivalent to the VARP function. + * @remarks + * [Api set: ExcelApi 1.8] + */ + varianceP = "VarianceP" + } + /** + * The ShowAs calculation function for the DataPivotField. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + enum ShowAsCalculation { + /** + * Calculation is unknown or unsupported. + * @remarks + * [Api set: ExcelApi 1.8] + */ + unknown = "Unknown", + /** + * No calculation is applied. + * @remarks + * [Api set: ExcelApi 1.8] + */ + none = "None", + /** + * Percent of the grand total. + * @remarks + * [Api set: ExcelApi 1.8] + */ + percentOfGrandTotal = "PercentOfGrandTotal", + /** + * Percent of the row total. + * @remarks + * [Api set: ExcelApi 1.8] + */ + percentOfRowTotal = "PercentOfRowTotal", + /** + * Percent of the column total. + * @remarks + * [Api set: ExcelApi 1.8] + */ + percentOfColumnTotal = "PercentOfColumnTotal", + /** + * Percent of the row total for the specified Base field. + * @remarks + * [Api set: ExcelApi 1.8] + */ + percentOfParentRowTotal = "PercentOfParentRowTotal", + /** + * Percent of the column total for the specified Base field. + * @remarks + * [Api set: ExcelApi 1.8] + */ + percentOfParentColumnTotal = "PercentOfParentColumnTotal", + /** + * Percent of the grand total for the specified Base field. + * @remarks + * [Api set: ExcelApi 1.8] + */ + percentOfParentTotal = "PercentOfParentTotal", + /** + * Percent of the specified Base field and Base item. + * @remarks + * [Api set: ExcelApi 1.8] + */ + percentOf = "PercentOf", + /** + * Running total of the specified Base field. + * @remarks + * [Api set: ExcelApi 1.8] + */ + runningTotal = "RunningTotal", + /** + * Percent running total of the specified Base field. + * @remarks + * [Api set: ExcelApi 1.8] + */ + percentRunningTotal = "PercentRunningTotal", + /** + * Difference from the specified Base field and Base item. + * @remarks + * [Api set: ExcelApi 1.8] + */ + differenceFrom = "DifferenceFrom", + /** + * Difference from the specified Base field and Base item. + * @remarks + * [Api set: ExcelApi 1.8] + */ + percentDifferenceFrom = "PercentDifferenceFrom", + /** + * Ascending rank of the specified Base field. + * @remarks + * [Api set: ExcelApi 1.8] + */ + rankAscending = "RankAscending", + /** + * Descending rank of the specified Base field. + * @remarks + * [Api set: ExcelApi 1.8] + */ + rankDecending = "RankDecending", + /** + * Calculates the values as follows: + ((value in cell) x (Grand Total of Grand Totals)) / ((Grand Row Total) x (Grand Column Total)) + * @remarks + * [Api set: ExcelApi 1.8] + */ + index = "Index" + } + /** + * Represents the axis from which to get the PivotItems. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum PivotAxis { + /** + * The axis or region is unknown or unsupported. + * @remarks + * [Api set: ExcelApi 1.9] + */ + unknown = "Unknown", + /** + * The row axis. + * @remarks + * [Api set: ExcelApi 1.9] + */ + row = "Row", + /** + * The column axis. + * @remarks + * [Api set: ExcelApi 1.9] + */ + column = "Column", + /** + * The data axis. + * @remarks + * [Api set: ExcelApi 1.9] + */ + data = "Data", + /** + * The filter axis. + * @remarks + * [Api set: ExcelApi 1.9] + */ + filter = "Filter" + } + /** + * Represents a worksheet-level custom property. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + export class WorksheetCustomProperty extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Gets the key of the custom property. Custom property keys are case-insensitive. The key is limited to 255 characters (larger values will cause an `InvalidArgument` error to be thrown.) + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + readonly key: string; + /** + * Gets or sets the value of the custom property. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + value: string; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.WorksheetCustomPropertyUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.WorksheetCustomProperty): void; + /** + * Deletes the custom property. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + delete(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.WorksheetCustomPropertyLoadOptions): Excel.WorksheetCustomProperty; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.WorksheetCustomProperty; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.WorksheetCustomProperty; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.WorksheetCustomProperty` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.WorksheetCustomPropertyData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.WorksheetCustomPropertyData; + } + /** + * Contains the collection of worksheet-level custom property. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + export class WorksheetCustomPropertyCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.WorksheetCustomProperty[]; + /** + * Adds a new custom property that maps to the provided key. This overwrites existing custom properties with that key. + * + * @remarks + * [Api set: ExcelApi 1.12] + * + * @param key - The key that identifies the custom property object. It is case-insensitive.The key is limited to 255 characters (larger values will cause an `InvalidArgument` error to be thrown.) + * @param value - The value of this custom property. + */ + add(key: string, value: string): Excel.WorksheetCustomProperty; + /** + * Gets the number of custom properties on this worksheet. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a custom property object by its key, which is case-insensitive. Throws an error if the custom property does not exist. + * + * @remarks + * [Api set: ExcelApi 1.12] + * + * @param key - The key that identifies the custom property object. It is case-insensitive. + */ + getItem(key: string): Excel.WorksheetCustomProperty; + /** + * Gets a custom property object by its key, which is case-insensitive. + If the custom property doesn't exist, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.12] + * + * @param key - The key that identifies the custom property object. It is case-insensitive. + */ + getItemOrNullObject(key: string): Excel.WorksheetCustomProperty; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.WorksheetCustomPropertyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.WorksheetCustomPropertyCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.WorksheetCustomPropertyCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.WorksheetCustomPropertyCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.WorksheetCustomPropertyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.WorksheetCustomPropertyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.WorksheetCustomPropertyCollectionData; + } + /** + * Represents workbook properties. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + export class DocumentProperties extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Gets the collection of custom properties of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly custom: Excel.CustomPropertyCollection; + /** + * The author of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + author: string; + /** + * The category of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + category: string; + /** + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + comments: string; + /** + * The company of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + company: string; + /** + * Gets the creation date of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly creationDate: Date; + /** + * The keywords of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + keywords: string; + /** + * Gets the last author of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly lastAuthor: string; + /** + * The manager of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + manager: string; + /** + * Gets the revision number of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + revisionNumber: number; + /** + * The subject of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + subject: string; + /** + * The title of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + title: string; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.DocumentPropertiesUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.DocumentProperties): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.DocumentPropertiesLoadOptions): Excel.DocumentProperties; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.DocumentProperties; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.DocumentProperties; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.DocumentProperties` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.DocumentPropertiesData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.DocumentPropertiesData; + } + /** + * Represents a custom property. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + export class CustomProperty extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * The key of the custom property. The key is limited to 255 characters outside of Excel on the web (larger keys are automatically trimmed to 255 characters on other platforms). + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly key: string; + /** + * The type of the value used for the custom property. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly type: Excel.DocumentPropertyType | "Number" | "Boolean" | "Date" | "String" | "Float"; + /** + * The value of the custom property. The value is limited to 255 characters outside of Excel on the web (larger values are automatically trimmed to 255 characters on other platforms). + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + value: any; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.CustomPropertyUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.CustomProperty): void; + /** + * Deletes the custom property. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + delete(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.CustomPropertyLoadOptions): Excel.CustomProperty; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.CustomProperty; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.CustomProperty; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.CustomProperty` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.CustomPropertyData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.CustomPropertyData; + } + /** + * Contains the collection of custom properties. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + export class CustomPropertyCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.CustomProperty[]; + /** + * Creates a new or sets an existing custom property. + * + * @remarks + * [Api set: ExcelApi 1.7] + * + * @param key - Required. The custom property's key, which is case-insensitive. The key is limited to 255 characters outside of Excel on the web (larger keys are automatically trimmed to 255 characters on other platforms). + * @param value - Required. The custom property's value. The value is limited to 255 characters outside of Excel on the web (larger values are automatically trimmed to 255 characters on other platforms). + */ + add(key: string, value: any): Excel.CustomProperty; + /** + * Deletes all custom properties in this collection. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + deleteAll(): void; + /** + * Gets the count of custom properties. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a custom property object by its key, which is case-insensitive. Throws an error if the custom property does not exist. + * + * @remarks + * [Api set: ExcelApi 1.7] + * + * @param key - The key that identifies the custom property object. + */ + getItem(key: string): Excel.CustomProperty; + /** + * Gets a custom property object by its key, which is case-insensitive. + If the custom property doesn't exist, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.7] + * + * @param key - Required. The key that identifies the custom property object. + */ + getItemOrNullObject(key: string): Excel.CustomProperty; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.CustomPropertyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CustomPropertyCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.CustomPropertyCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.CustomPropertyCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.CustomPropertyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.CustomPropertyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.CustomPropertyCollectionData; + } + /** + * Represents a collection of all the conditional formats that are overlap the range. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export class ConditionalFormatCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.ConditionalFormat[]; + /** + * Adds a new conditional format to the collection at the first/top priority. + * + * @remarks + * [Api set: ExcelApi 1.6] + * + * @param type - The type of conditional format being added. See `Excel.ConditionalFormatType` for details. + */ + add(type: Excel.ConditionalFormatType): Excel.ConditionalFormat; + /** + * Adds a new conditional format to the collection at the first/top priority. + * + * @remarks + * [Api set: ExcelApi 1.6] + * + * @param type - The type of conditional format being added. See `Excel.ConditionalFormatType` for details. + */ + add(type: "Custom" | "DataBar" | "ColorScale" | "IconSet" | "TopBottom" | "PresetCriteria" | "ContainsText" | "CellValue"): Excel.ConditionalFormat; + /** + * Clears all conditional formats active on the current specified range. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + clearAll(): void; + /** + * Returns the number of conditional formats in the workbook. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Returns a conditional format for the given ID. + * + * @remarks + * [Api set: ExcelApi 1.6] + * + * @param id - The ID of the conditional format. + * @returns Conditional format object. + */ + getItem(id: string): Excel.ConditionalFormat; + /** + * Returns a conditional format at the given index. + * + * @remarks + * [Api set: ExcelApi 1.6] + * + * @param index - Index of the conditional formats to be retrieved. + */ + getItemAt(index: number): Excel.ConditionalFormat; + /** + * Returns a conditional format identified by its ID. + If the conditional format object does not exist, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.14] + * + * @param id - The ID of the conditional format. + */ + getItemOrNullObject(id: string): Excel.ConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ConditionalFormatCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ConditionalFormatCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ConditionalFormatCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.ConditionalFormatCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ConditionalFormatCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ConditionalFormatCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.ConditionalFormatCollectionData; + } + /** + * An object encapsulating a conditional format's range, format, rule, and other properties. + To learn more about the conditional formatting object model, read {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-conditional-formatting | Apply conditional formatting to Excel ranges}. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export class ConditionalFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns the cell value conditional format properties if the current conditional format is a `CellValue` type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + readonly cellValue: Excel.CellValueConditionalFormat; + /** + * Returns the cell value conditional format properties if the current conditional format is a `CellValue` type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + readonly cellValueOrNullObject: Excel.CellValueConditionalFormat; + /** + * Returns the color scale conditional format properties if the current conditional format is a `ColorScale` type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + readonly colorScale: Excel.ColorScaleConditionalFormat; + /** + * Returns the color scale conditional format properties if the current conditional format is a `ColorScale` type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + readonly colorScaleOrNullObject: Excel.ColorScaleConditionalFormat; + /** + * Returns the custom conditional format properties if the current conditional format is a custom type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + readonly custom: Excel.CustomConditionalFormat; + /** + * Returns the custom conditional format properties if the current conditional format is a custom type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + readonly customOrNullObject: Excel.CustomConditionalFormat; + /** + * Returns the data bar properties if the current conditional format is a data bar. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + readonly dataBar: Excel.DataBarConditionalFormat; + /** + * Returns the data bar properties if the current conditional format is a data bar. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + readonly dataBarOrNullObject: Excel.DataBarConditionalFormat; + /** + * Returns the icon set conditional format properties if the current conditional format is an `IconSet` type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + readonly iconSet: Excel.IconSetConditionalFormat; + /** + * Returns the icon set conditional format properties if the current conditional format is an `IconSet` type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + readonly iconSetOrNullObject: Excel.IconSetConditionalFormat; + /** + * Returns the preset criteria conditional format. See `Excel.PresetCriteriaConditionalFormat` for more details. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + readonly preset: Excel.PresetCriteriaConditionalFormat; + /** + * Returns the preset criteria conditional format. See `Excel.PresetCriteriaConditionalFormat` for more details. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + readonly presetOrNullObject: Excel.PresetCriteriaConditionalFormat; + /** + * Returns the specific text conditional format properties if the current conditional format is a text type. + For example, to format cells matching the word "Text". + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + readonly textComparison: Excel.TextConditionalFormat; + /** + * Returns the specific text conditional format properties if the current conditional format is a text type. + For example, to format cells matching the word "Text". + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + readonly textComparisonOrNullObject: Excel.TextConditionalFormat; + /** + * Returns the top/bottom conditional format properties if the current conditional format is a `TopBottom` type. + For example, to format the top 10% or bottom 10 items. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + readonly topBottom: Excel.TopBottomConditionalFormat; + /** + * Returns the top/bottom conditional format properties if the current conditional format is a `TopBottom` type. + For example, to format the top 10% or bottom 10 items. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + readonly topBottomOrNullObject: Excel.TopBottomConditionalFormat; + /** + * The priority of the conditional format in the current `ConditionalFormatCollection`. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + readonly id: string; + /** + * The priority (or index) within the conditional format collection that this conditional format currently exists in. Changing this also + changes other conditional formats' priorities, to allow for a contiguous priority order. + Use a negative priority to begin from the back. + Priorities greater than the bounds will get and set to the maximum (or minimum if negative) priority. + Also note that if you change the priority, you have to re-fetch a new copy of the object at that new priority location if you want to make further changes to it. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + priority: number; + /** + * If the conditions of this conditional format are met, no lower-priority formats shall take effect on that cell. + Value is `null` on data bars, icon sets, and color scales as there's no concept of `StopIfTrue` for these. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + stopIfTrue: boolean; + /** + * A type of conditional format. Only one can be set at a time. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + readonly type: Excel.ConditionalFormatType | "Custom" | "DataBar" | "ColorScale" | "IconSet" | "TopBottom" | "PresetCriteria" | "ContainsText" | "CellValue"; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ConditionalFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ConditionalFormat): void; + /** + * Change the conditional format rule type to cell value. + * + * @remarks + * [Api set: ExcelApi 1.17] + * + * @param properties - The properties to set for the cell value conditional format rule. + */ + changeRuleToCellValue(properties: Excel.ConditionalCellValueRule): void; + /** + * Change the conditional format rule type to color scale. + * + * @remarks + * [Api set: ExcelApi 1.17] + */ + changeRuleToColorScale(): void; + /** + * Change the conditional format rule type to text comparison. + * + * @remarks + * [Api set: ExcelApi 1.17] + * + * @param properties - The properties to set for the text comparison conditional format rule. + */ + changeRuleToContainsText(properties: Excel.ConditionalTextComparisonRule): void; + /** + * Change the conditional format rule type to custom. + * + * @remarks + * [Api set: ExcelApi 1.17] + * + * @param formula - The formula to set for the custom conditional format rule. + */ + changeRuleToCustom(formula: string): void; + /** + * Change the conditional format rule type to data bar. + * + * @remarks + * [Api set: ExcelApi 1.17] + */ + changeRuleToDataBar(): void; + /** + * Change the conditional format rule type to icon set. + * + * @remarks + * [Api set: ExcelApi 1.17] + */ + changeRuleToIconSet(): void; + /** + * Change the conditional format rule type to preset criteria. + * + * @remarks + * [Api set: ExcelApi 1.17] + * + * @param properties - The properties to set for the preset criteria conditional format rule. + */ + changeRuleToPresetCriteria(properties: Excel.ConditionalPresetCriteriaRule): void; + /** + * Change the conditional format rule type to top/bottom. + * + * @remarks + * [Api set: ExcelApi 1.17] + * + * @param properties - The properties to set for the top/bottom conditional format rule. + */ + changeRuleToTopBottom(properties: Excel.ConditionalTopBottomRule): void; + /** + * Deletes this conditional format. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + delete(): void; + /** + * Returns the range the conditional format is applied to. Throws an error if the conditional format is applied to multiple ranges. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + getRange(): Excel.Range; + /** + * Returns the range to which the conditional format is applied. + If the conditional format is applied to multiple ranges, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + getRangeOrNullObject(): Excel.Range; + /** + * Returns the `RangeAreas`, comprising one or more rectangular ranges, to which the conditional format is applied. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + getRanges(): Excel.RangeAreas; + /** + * Set the ranges that the conditional format rule is applied to. + * + * @remarks + * [Api set: ExcelApi 1.17] + * + * @param ranges - Collection of one or more ranges for this rule to be applied to. + */ + setRanges(ranges: Range | RangeAreas | string): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ConditionalFormatLoadOptions): Excel.ConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ConditionalFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ConditionalFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ConditionalFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ConditionalFormatData; + } + /** + * Represents an Excel conditional data bar type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export class DataBarConditionalFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Representation of all values to the left of the axis in an Excel data bar. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + readonly negativeFormat: Excel.ConditionalDataBarNegativeFormat; + /** + * Representation of all values to the right of the axis in an Excel data bar. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + readonly positiveFormat: Excel.ConditionalDataBarPositiveFormat; + /** + * HTML color code representing the color of the Axis line, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + Value is "" (an empty string) if no axis is present or set. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + axisColor: string; + /** + * Representation of how the axis is determined for an Excel data bar. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + axisFormat: Excel.ConditionalDataBarAxisFormat | "Automatic" | "None" | "CellMidPoint"; + /** + * Specifies the direction that the data bar graphic should be based on. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + barDirection: Excel.ConditionalDataBarDirection | "Context" | "LeftToRight" | "RightToLeft"; + /** + * The rule for what constitutes the lower bound (and how to calculate it, if applicable) for a data bar. + The `ConditionalDataBarRule` object must be set as a JSON object (use `x.lowerBoundRule = {...}` instead of `x.lowerBoundRule.formula = ...`). + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + lowerBoundRule: Excel.ConditionalDataBarRule; + /** + * If `true`, hides the values from the cells where the data bar is applied. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + showDataBarOnly: boolean; + /** + * The rule for what constitutes the upper bound (and how to calculate it, if applicable) for a data bar. + The `ConditionalDataBarRule` object must be set as a JSON object (use `x.upperBoundRule = {...}` instead of `x.upperBoundRule.formula = ...`). + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + upperBoundRule: Excel.ConditionalDataBarRule; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.DataBarConditionalFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.DataBarConditionalFormat): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.DataBarConditionalFormatLoadOptions): Excel.DataBarConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.DataBarConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.DataBarConditionalFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.DataBarConditionalFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.DataBarConditionalFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.DataBarConditionalFormatData; + } + /** + * Represents a conditional format for the positive side of the data bar. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export class ConditionalDataBarPositiveFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * HTML color code representing the color of the border line, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + Value is "" (an empty string) if no border is present or set. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + borderColor: string; + /** + * HTML color code representing the fill color, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + fillColor: string; + /** + * Specifies if the data bar has a gradient. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + gradientFill: boolean; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ConditionalDataBarPositiveFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ConditionalDataBarPositiveFormat): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ConditionalDataBarPositiveFormatLoadOptions): Excel.ConditionalDataBarPositiveFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ConditionalDataBarPositiveFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ConditionalDataBarPositiveFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ConditionalDataBarPositiveFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ConditionalDataBarPositiveFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ConditionalDataBarPositiveFormatData; + } + /** + * Represents a conditional format for the negative side of the data bar. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export class ConditionalDataBarNegativeFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * HTML color code representing the color of the border line, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + Value is "" (an empty string) if no border is present or set. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + borderColor: string; + /** + * HTML color code representing the fill color, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + fillColor: string; + /** + * Specifies if the negative data bar has the same border color as the positive data bar. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + matchPositiveBorderColor: boolean; + /** + * Specifies if the negative data bar has the same fill color as the positive data bar. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + matchPositiveFillColor: boolean; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ConditionalDataBarNegativeFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ConditionalDataBarNegativeFormat): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ConditionalDataBarNegativeFormatLoadOptions): Excel.ConditionalDataBarNegativeFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ConditionalDataBarNegativeFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ConditionalDataBarNegativeFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ConditionalDataBarNegativeFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ConditionalDataBarNegativeFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ConditionalDataBarNegativeFormatData; + } + /** + * Represents a rule-type for a data bar. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export interface ConditionalDataBarRule { + /** + * The formula, if required, on which to evaluate the data bar rule. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + formula?: string; + /** + * The type of rule for the data bar. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + type: Excel.ConditionalFormatRuleType | "Invalid" | "Automatic" | "LowestValue" | "HighestValue" | "Number" | "Percent" | "Formula" | "Percentile"; + } + /** + * Represents a custom conditional format type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export class CustomConditionalFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + readonly format: Excel.ConditionalRangeFormat; + /** + * Specifies the `Rule` object on this conditional format. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + readonly rule: Excel.ConditionalFormatRule; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.CustomConditionalFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.CustomConditionalFormat): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.CustomConditionalFormatLoadOptions): Excel.CustomConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.CustomConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.CustomConditionalFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.CustomConditionalFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.CustomConditionalFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.CustomConditionalFormatData; + } + /** + * Represents a rule, for all traditional rule/format pairings. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export class ConditionalFormatRule extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * The formula, if required, on which to evaluate the conditional format rule. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + formula: string; + /** + * The formula, if required, on which to evaluate the conditional format rule in the user's language. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + formulaLocal: string; + /** + * The formula, if required, on which to evaluate the conditional format rule in R1C1-style notation. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + formulaR1C1: string; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ConditionalFormatRuleUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ConditionalFormatRule): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ConditionalFormatRuleLoadOptions): Excel.ConditionalFormatRule; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ConditionalFormatRule; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ConditionalFormatRule; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ConditionalFormatRule` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ConditionalFormatRuleData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ConditionalFormatRuleData; + } + /** + * Represents an icon set criteria for conditional formatting. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export class IconSetConditionalFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * An array of criteria and icon sets for the rules and potential custom icons for conditional icons. Note that for the first criterion only the custom icon can be modified, while type, formula, and operator will be ignored when set. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + criteria: Excel.ConditionalIconCriterion[]; + /** + * If `true`, reverses the icon orders for the icon set. Note that this cannot be set if custom icons are used. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + reverseIconOrder: boolean; + /** + * If `true`, hides the values and only shows icons. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + showIconOnly: boolean; + /** + * If set, displays the icon set option for the conditional format. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + style: Excel.IconSet | "Invalid" | "ThreeArrows" | "ThreeArrowsGray" | "ThreeFlags" | "ThreeTrafficLights1" | "ThreeTrafficLights2" | "ThreeSigns" | "ThreeSymbols" | "ThreeSymbols2" | "FourArrows" | "FourArrowsGray" | "FourRedToBlack" | "FourRating" | "FourTrafficLights" | "FiveArrows" | "FiveArrowsGray" | "FiveRating" | "FiveQuarters" | "ThreeStars" | "ThreeTriangles" | "FiveBoxes"; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.IconSetConditionalFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.IconSetConditionalFormat): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.IconSetConditionalFormatLoadOptions): Excel.IconSetConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.IconSetConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.IconSetConditionalFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.IconSetConditionalFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.IconSetConditionalFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.IconSetConditionalFormatData; + } + /** + * Represents an icon criterion which contains a type, value, an operator, and an optional custom icon, if not using an icon set. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export interface ConditionalIconCriterion { + /** + * The custom icon for the current criterion, if different from the default icon set, else `null` will be returned. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + customIcon?: Excel.Icon; + /** + * A number or a formula depending on the type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + formula: string; + /** + * `greaterThan` or `greaterThanOrEqual` for each of the rule types for the icon conditional format. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + operator: Excel.ConditionalIconCriterionOperator | "Invalid" | "GreaterThan" | "GreaterThanOrEqual"; + /** + * What the icon conditional formula should be based on. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + type: Excel.ConditionalFormatIconRuleType | "Invalid" | "Number" | "Percent" | "Formula" | "Percentile"; + } + /** + * Represents the color scale criteria for conditional formatting. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export class ColorScaleConditionalFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * The criteria of the color scale. Midpoint is optional when using a two point color scale. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + criteria: Excel.ConditionalColorScaleCriteria; + /** + * If `true`, the color scale will have three points (minimum, midpoint, maximum), otherwise it will have two (minimum, maximum). + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + readonly threeColorScale: boolean; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ColorScaleConditionalFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ColorScaleConditionalFormat): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ColorScaleConditionalFormatLoadOptions): Excel.ColorScaleConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ColorScaleConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ColorScaleConditionalFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ColorScaleConditionalFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ColorScaleConditionalFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ColorScaleConditionalFormatData; + } + /** + * Represents the criteria of the color scale. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export interface ConditionalColorScaleCriteria { + /** + * The maximum point of the color scale criterion. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + maximum: Excel.ConditionalColorScaleCriterion; + /** + * The midpoint of the color scale criterion, if the color scale is a 3-color scale. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + midpoint?: Excel.ConditionalColorScaleCriterion; + /** + * The minimum point of the color scale criterion. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + minimum: Excel.ConditionalColorScaleCriterion; + } + /** + * Represents a color scale criterion which contains a type, value, and a color. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export interface ConditionalColorScaleCriterion { + /** + * HTML color code representation of the color scale color (e.g., #FF0000 represents Red). + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + color?: string; + /** + * A number, a formula, or `null` (if `type` is `lowestValue`). + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + formula?: string; + /** + * What the criterion conditional formula should be based on. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + type: Excel.ConditionalFormatColorCriterionType | "Invalid" | "LowestValue" | "HighestValue" | "Number" | "Percent" | "Formula" | "Percentile"; + } + /** + * Represents a top/bottom conditional format. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export class TopBottomConditionalFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns a format object, encapsulating the conditional format's font, fill, borders, and other properties. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + readonly format: Excel.ConditionalRangeFormat; + /** + * The criteria of the top/bottom conditional format. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + rule: Excel.ConditionalTopBottomRule; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.TopBottomConditionalFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.TopBottomConditionalFormat): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.TopBottomConditionalFormatLoadOptions): Excel.TopBottomConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TopBottomConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.TopBottomConditionalFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.TopBottomConditionalFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.TopBottomConditionalFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.TopBottomConditionalFormatData; + } + /** + * Represents the rule of the top/bottom conditional format. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export interface ConditionalTopBottomRule { + /** + * The rank between 1 and 1000 for numeric ranks or 1 and 100 for percent ranks. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + rank: number; + /** + * Format values based on the top or bottom rank. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + type: Excel.ConditionalTopBottomCriterionType | "Invalid" | "TopItems" | "TopPercent" | "BottomItems" | "BottomPercent"; + } + /** + * Represents the preset criteria conditional format such as above average, below average, unique values, contains blank, nonblank, error, and noerror. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export class PresetCriteriaConditionalFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + readonly format: Excel.ConditionalRangeFormat; + /** + * The rule of the conditional format. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + rule: Excel.ConditionalPresetCriteriaRule; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.PresetCriteriaConditionalFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.PresetCriteriaConditionalFormat): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.PresetCriteriaConditionalFormatLoadOptions): Excel.PresetCriteriaConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PresetCriteriaConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.PresetCriteriaConditionalFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.PresetCriteriaConditionalFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.PresetCriteriaConditionalFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.PresetCriteriaConditionalFormatData; + } + /** + * Represents the preset criteria conditional format rule. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export interface ConditionalPresetCriteriaRule { + /** + * The criterion of the conditional format. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + criterion: Excel.ConditionalFormatPresetCriterion | "Invalid" | "Blanks" | "NonBlanks" | "Errors" | "NonErrors" | "Yesterday" | "Today" | "Tomorrow" | "LastSevenDays" | "LastWeek" | "ThisWeek" | "NextWeek" | "LastMonth" | "ThisMonth" | "NextMonth" | "AboveAverage" | "BelowAverage" | "EqualOrAboveAverage" | "EqualOrBelowAverage" | "OneStdDevAboveAverage" | "OneStdDevBelowAverage" | "TwoStdDevAboveAverage" | "TwoStdDevBelowAverage" | "ThreeStdDevAboveAverage" | "ThreeStdDevBelowAverage" | "UniqueValues" | "DuplicateValues"; + } + /** + * Represents a specific text conditional format. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export class TextConditionalFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns a format object, encapsulating the conditional format's font, fill, borders, and other properties. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + readonly format: Excel.ConditionalRangeFormat; + /** + * The rule of the conditional format. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + rule: Excel.ConditionalTextComparisonRule; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.TextConditionalFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.TextConditionalFormat): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.TextConditionalFormatLoadOptions): Excel.TextConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TextConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.TextConditionalFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.TextConditionalFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.TextConditionalFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.TextConditionalFormatData; + } + /** + * Represents a cell value conditional format rule. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export interface ConditionalTextComparisonRule { + /** + * The operator of the text conditional format. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + operator: Excel.ConditionalTextOperator | "Invalid" | "Contains" | "NotContains" | "BeginsWith" | "EndsWith"; + /** + * The text value of the conditional format. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + text: string; + } + /** + * Represents a cell value conditional format. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export class CellValueConditionalFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + readonly format: Excel.ConditionalRangeFormat; + /** + * Specifies the rule object on this conditional format. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + rule: Excel.ConditionalCellValueRule; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.CellValueConditionalFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.CellValueConditionalFormat): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.CellValueConditionalFormatLoadOptions): Excel.CellValueConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.CellValueConditionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.CellValueConditionalFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.CellValueConditionalFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.CellValueConditionalFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.CellValueConditionalFormatData; + } + /** + * Represents a cell value conditional format rule. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export interface ConditionalCellValueRule { + /** + * The formula, if required, on which to evaluate the conditional format rule. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + formula1: string; + /** + * The formula, if required, on which to evaluate the conditional format rule. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + formula2?: string; + /** + * The operator of the cell value conditional format. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + operator: Excel.ConditionalCellValueOperator | "Invalid" | "Between" | "NotBetween" | "EqualTo" | "NotEqualTo" | "GreaterThan" | "LessThan" | "GreaterThanOrEqual" | "LessThanOrEqual"; + } + /** + * A format object encapsulating the conditional formats range's font, fill, borders, and other properties. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export class ConditionalRangeFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Collection of border objects that apply to the overall conditional format range. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + readonly borders: Excel.ConditionalRangeBorderCollection; + /** + * Returns the fill object defined on the overall conditional format range. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + readonly fill: Excel.ConditionalRangeFill; + /** + * Returns the font object defined on the overall conditional format range. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + readonly font: Excel.ConditionalRangeFont; + /** + * Represents Excel's number format code for the given range. For more information about Excel number formatting, see {@link https://support.microsoft.com/office/5026bbd6-04bc-48cd-bf33-80f18b4eae68 | Number format codes}. + Cleared if `null` is passed in. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + numberFormat: any; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ConditionalRangeFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ConditionalRangeFormat): void; + /** + * Remove the format properties from a conditional format rule. This creates a rule with no format settings. + * + * @remarks + * [Api set: ExcelApi 1.17] + */ + clearFormat(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ConditionalRangeFormatLoadOptions): Excel.ConditionalRangeFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ConditionalRangeFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ConditionalRangeFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ConditionalRangeFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ConditionalRangeFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ConditionalRangeFormatData; + } + /** + * This object represents the font attributes (font style, color, etc.) for an object. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export class ConditionalRangeFont extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Specifies if the font is bold. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + bold: boolean; + /** + * HTML color code representation of the text color (e.g., #FF0000 represents Red). + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + color: string; + /** + * Specifies if the font is italic. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + italic: boolean; + /** + * Specifies the strikethrough status of the font. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + strikethrough: boolean; + /** + * The type of underline applied to the font. See `Excel.ConditionalRangeFontUnderlineStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + underline: Excel.ConditionalRangeFontUnderlineStyle | "None" | "Single" | "Double"; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ConditionalRangeFontUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ConditionalRangeFont): void; + /** + * Resets the font formats. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + clear(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ConditionalRangeFontLoadOptions): Excel.ConditionalRangeFont; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ConditionalRangeFont; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ConditionalRangeFont; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ConditionalRangeFont` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ConditionalRangeFontData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ConditionalRangeFontData; + } + /** + * Represents the background of a conditional range object. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export class ConditionalRangeFill extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * HTML color code representing the color of the fill, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + color: string; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ConditionalRangeFillUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ConditionalRangeFill): void; + /** + * Resets the fill. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + clear(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ConditionalRangeFillLoadOptions): Excel.ConditionalRangeFill; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ConditionalRangeFill; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ConditionalRangeFill; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ConditionalRangeFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ConditionalRangeFillData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ConditionalRangeFillData; + } + /** + * Represents the border of an object. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export class ConditionalRangeBorder extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * HTML color code representing the color of the border line, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + color: string; + /** + * Constant value that indicates the specific side of the border. See `Excel.ConditionalRangeBorderIndex` for details. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + readonly sideIndex: Excel.ConditionalRangeBorderIndex | "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight"; + /** + * One of the constants of line style specifying the line style for the border. See `Excel.BorderLineStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + style: Excel.ConditionalRangeBorderLineStyle | "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot"; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ConditionalRangeBorderUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ConditionalRangeBorder): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ConditionalRangeBorderLoadOptions): Excel.ConditionalRangeBorder; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ConditionalRangeBorder; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ConditionalRangeBorder; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ConditionalRangeBorder` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ConditionalRangeBorderData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ConditionalRangeBorderData; + } + /** + * Represents the border objects that make up range border. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export class ConditionalRangeBorderCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Gets the bottom border. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + readonly bottom: Excel.ConditionalRangeBorder; + /** + * Gets the left border. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + readonly left: Excel.ConditionalRangeBorder; + /** + * Gets the right border. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + readonly right: Excel.ConditionalRangeBorder; + /** + * Gets the top border. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + readonly top: Excel.ConditionalRangeBorder; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.ConditionalRangeBorder[]; + /** + * Number of border objects in the collection. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + readonly count: number; + /** + * Gets a border object using its name. + * + * @remarks + * [Api set: ExcelApi 1.6] + * + * @param index - Index value of the border object to be retrieved. See `Excel.ConditionalRangeBorderIndex` for details. + */ + getItem(index: Excel.ConditionalRangeBorderIndex): Excel.ConditionalRangeBorder; + /** + * Gets a border object using its name. + * + * @remarks + * [Api set: ExcelApi 1.6] + * + * @param index - Index value of the border object to be retrieved. See `Excel.ConditionalRangeBorderIndex` for details. + */ + getItem(index: "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight"): Excel.ConditionalRangeBorder; + /** + * Gets a border object using its index. + * + * @remarks + * [Api set: ExcelApi 1.6] + * + * @param index - Index value of the object to be retrieved. Zero-indexed. + */ + getItemAt(index: number): Excel.ConditionalRangeBorder; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ConditionalRangeBorderCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ConditionalRangeBorderCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ConditionalRangeBorderCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.ConditionalRangeBorderCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ConditionalRangeBorderCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ConditionalRangeBorderCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.ConditionalRangeBorderCollectionData; + } + /** + * Manages settings on custom functions. + * + * @remarks + * [Api set: ExcelApi 1.20] + */ + export class CustomFunctionManager extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Show or hide custom functions in Excel AutoComplete. + * + * @remarks + * [Api set: ExcelApi 1.20] + * + * @param customFunctionVisibilityOptions - Specifies which custom functions to show or hide. + */ + static setVisibility(customFunctionVisibilityOptions: Excel.CustomFunctionVisibilityOptions): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.CustomFunctionManager; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * + * @remarks + * [Api set: ExcelApi 1.20] + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.CustomFunctionManager; + /** + * Create a new instance of the `Excel.CustomFunctionManager` object. + * @remarks + * [Api set: ExcelApi 1.20] + */ + static newObject(context: OfficeExtension.ClientRequestContext): Excel.CustomFunctionManager; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.CustomFunctionManager` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.CustomFunctionManagerData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.CustomFunctionManagerData; + } + /** + * Represents which custom functions to show or hide in Excel AutoComplete. + * + * @remarks + * [Api set: ExcelApi 1.20] + */ + export interface CustomFunctionVisibilityOptions { + /** + * A list of custom functions to hide from Excel AutoComplete. + * + * @remarks + * [Api set: ExcelApi 1.20] + */ + hide?: string[]; + /** + * A list of custom functions to show in Excel AutoComplete. + * + * @remarks + * [Api set: ExcelApi 1.20] + */ + show?: string[]; + } + /** + * An object encapsulating a style's format and other properties. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + export class Style extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * A collection of four border objects that represent the style of the four borders. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly borders: Excel.RangeBorderCollection; + /** + * The fill of the style. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly fill: Excel.RangeFill; + /** + * A `Font` object that represents the font of the style. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly font: Excel.RangeFont; + /** + * Specifies if text is automatically indented when the text alignment in a cell is set to equal distribution. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + autoIndent: boolean; + /** + * Specifies if the style is a built-in style. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly builtIn: boolean; + /** + * Specifies if the formula will be hidden when the worksheet is protected. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + formulaHidden: boolean; + /** + * Represents the horizontal alignment for the style. See `Excel.HorizontalAlignment` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + horizontalAlignment: Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed"; + /** + * Specifies if the style includes the auto indent, horizontal alignment, vertical alignment, wrap text, indent level, and text orientation properties. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + includeAlignment: boolean; + /** + * Specifies if the style includes the color, color index, line style, and weight border properties. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + includeBorder: boolean; + /** + * Specifies if the style includes the background, bold, color, color index, font style, italic, name, size, strikethrough, subscript, superscript, and underline font properties. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + includeFont: boolean; + /** + * Specifies if the style includes the number format property. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + includeNumber: boolean; + /** + * Specifies if the style includes the color, color index, invert if negative, pattern, pattern color, and pattern color index interior properties. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + includePatterns: boolean; + /** + * Specifies if the style includes the formula hidden and locked protection properties. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + includeProtection: boolean; + /** + * An integer from 0 to 250 that indicates the indent level for the style. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + indentLevel: number; + /** + * Specifies if the object is locked when the worksheet is protected. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + locked: boolean; + /** + * The name of the style. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readonly name: string; + /** + * The format code of the number format for the style. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + numberFormat: string; + /** + * The localized format code of the number format for the style. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + numberFormatLocal: string; + /** + * The reading order for the style. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readingOrder: Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft"; + /** + * Specifies if text automatically shrinks to fit in the available column width. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + shrinkToFit: boolean; + /** + * The text orientation for the style. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + textOrientation: number; + /** + * Specifies the vertical alignment for the style. See `Excel.VerticalAlignment` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + verticalAlignment: Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed"; + /** + * Specifies if Excel wraps the text in the object. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + wrapText: boolean; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.StyleUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.Style): void; + /** + * Deletes this style. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + delete(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.StyleLoadOptions): Excel.Style; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Style; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.Style; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.Style` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.StyleData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.StyleData; + } + /** + * Represents a collection of all the styles. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + export class StyleCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.Style[]; + /** + * Adds a new style to the collection. + * + * @remarks + * [Api set: ExcelApi 1.7] + * + * @param name - Name of the style to be added. + */ + add(name: string): void; + /** + * Gets the number of styles in the collection. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a `Style` by name. + * + * @remarks + * [Api set: ExcelApi 1.7] + * + * @param name - Name of the style to be retrieved. + */ + getItem(name: string): Excel.Style; + /** + * Gets a style based on its position in the collection. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param index - Index value of the style object to be retrieved. Zero-indexed. + */ + getItemAt(index: number): Excel.Style; + /** + * Gets a style by name. + If the style object does not exist, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.14] + * + * @param name - Name of the style to be retrieved. + */ + getItemOrNullObject(name: string): Excel.Style; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.StyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.StyleCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.StyleCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.StyleCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.StyleCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.StyleCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.StyleCollectionData; + } + /** + * Represents a collection of table styles. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + export class TableStyleCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.TableStyle[]; + /** + * Creates a blank `TableStyle` with the specified name. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param name - The unique name for the new table style. Will throw an `InvalidArgument` error if the name is already in use. + * @param makeUniqueName - Optional. Defaults to `false`. If `true`, will append numbers to the name in order to make it unique, if needed. + * @returns The newly created `TableStyle`. + */ + add(name: string, makeUniqueName?: boolean): Excel.TableStyle; + /** + * Gets the number of table styles in the collection. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets the default table style for the parent object's scope. + * + * @remarks + * [Api set: ExcelApi 1.10] + * @returns The `TableStyle` object that is the current default table style. + */ + getDefault(): Excel.TableStyle; + /** + * Gets a `TableStyle` by name. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param name - Name of the table style to be retrieved. + * @returns The `TableStyle` object whose name matches the input. + */ + getItem(name: string): Excel.TableStyle; + /** + * Gets a `TableStyle` by name. + If the table style does not exist, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param name - Name of the table style to be retrieved. + * @returns The `TableStyle` object whose name matches the input. + */ + getItemOrNullObject(name: string): Excel.TableStyle; + /** + * Sets the default table style for use in the parent object's scope. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param newDefaultStyle - The `TableStyle` object, or name of the `TableStyle` object, that should be the new default. + */ + setDefault(newDefaultStyle: TableStyle | string): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.TableStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableStyleCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TableStyleCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.TableStyleCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.TableStyleCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.TableStyleCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.TableStyleCollectionData; + } + /** + * Represents a table style, which defines the style elements by region of the table. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + export class TableStyle extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Specifies the name of the table style. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + name: string; + /** + * Specifies if this `TableStyle` object is read-only. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readonly readOnly: boolean; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.TableStyleUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.TableStyle): void; + /** + * Deletes the table style. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + delete(): void; + /** + * Creates a duplicate of this table style with copies of all the style elements. + * + * @remarks + * [Api set: ExcelApi 1.10] + * @returns The new `TableStyle` object that has been duplicated from this table style. + */ + duplicate(): Excel.TableStyle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.TableStyleLoadOptions): Excel.TableStyle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TableStyle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.TableStyle; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.TableStyle` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.TableStyleData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.TableStyleData; + } + /** + * Represents a collection of PivotTable styles. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + export class PivotTableStyleCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.PivotTableStyle[]; + /** + * Creates a blank `PivotTableStyle` with the specified name. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param name - The unique name for the new PivotTable style. Will throw an `InvalidArgument` error if the name is already in use. + * @param makeUniqueName - Optional. Defaults to `false`. If `true`, will append numbers to the name in order to make it unique, if needed. + * @returns The newly created `PivotTableStyle`. + */ + add(name: string, makeUniqueName?: boolean): Excel.PivotTableStyle; + /** + * Gets the number of PivotTable styles in the collection. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets the default PivotTable style for the parent object's scope. + * + * @remarks + * [Api set: ExcelApi 1.10] + * @returns The `PivotTableStyle` object that is the current default PivotTable style. + */ + getDefault(): Excel.PivotTableStyle; + /** + * Gets a `PivotTableStyle` by name. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param name - Name of the PivotTable style to be retrieved. + * @returns The `PivotTableStyle` object whose name matches the input. + */ + getItem(name: string): Excel.PivotTableStyle; + /** + * Gets a `PivotTableStyle` by name. + If the `PivotTableStyle` does not exist, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param name - Name of the PivotTable style to be retrieved. + * @returns The `PivotTableStyle` object whose name matches the input. + */ + getItemOrNullObject(name: string): Excel.PivotTableStyle; + /** + * Sets the default PivotTable style for use in the parent object's scope. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param newDefaultStyle - The `PivotTableStyle` object, or name of the `PivotTableStyle` object, that should be the new default. + */ + setDefault(newDefaultStyle: PivotTableStyle | string): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.PivotTableStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotTableStyleCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PivotTableStyleCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.PivotTableStyleCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.PivotTableStyleCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.PivotTableStyleCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.PivotTableStyleCollectionData; + } + /** + * Represents a PivotTable style, which defines style elements by PivotTable region. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + export class PivotTableStyle extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Specifies the name of the PivotTable style. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + name: string; + /** + * Specifies if this `PivotTableStyle` object is read-only. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readonly readOnly: boolean; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.PivotTableStyleUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.PivotTableStyle): void; + /** + * Deletes the PivotTable style. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + delete(): void; + /** + * Creates a duplicate of this PivotTable style with copies of all the style elements. + * + * @remarks + * [Api set: ExcelApi 1.10] + * @returns The new `PivotTableStyle` object that has been duplicated from this PivotTable style. + */ + duplicate(): Excel.PivotTableStyle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.PivotTableStyleLoadOptions): Excel.PivotTableStyle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PivotTableStyle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.PivotTableStyle; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.PivotTableStyle` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.PivotTableStyleData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.PivotTableStyleData; + } + /** + * Represents a collection of `SlicerStyle` objects. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + export class SlicerStyleCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.SlicerStyle[]; + /** + * Creates a blank slicer style with the specified name. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param name - The unique name for the new slicer style. Will throw an `InvalidArgument` exception if the name is already in use. + * @param makeUniqueName - Optional. Defaults to `false`. If `true`, will append numbers to the name in order to make it unique, if needed. + * @returns The newly created `SlicerStyle`. + */ + add(name: string, makeUniqueName?: boolean): Excel.SlicerStyle; + /** + * Gets the number of slicer styles in the collection. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets the default `SlicerStyle` for the parent object's scope. + * + * @remarks + * [Api set: ExcelApi 1.10] + * @returns The `SlicerStyle` object that is the current default slicer style. + */ + getDefault(): Excel.SlicerStyle; + /** + * Gets a `SlicerStyle` by name. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param name - Name of the slicer style to be retrieved. + * @returns The `SlicerStyle` object whose name matches the input. + */ + getItem(name: string): Excel.SlicerStyle; + /** + * Gets a `SlicerStyle` by name. + If the slicer style doesn't exist, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param name - Name of the slicer style to be retrieved. + * @returns The `SlicerStyle` object whose name matches the input. + */ + getItemOrNullObject(name: string): Excel.SlicerStyle; + /** + * Sets the default slicer style for use in the parent object's scope. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param newDefaultStyle - The `SlicerStyle` object, or name of the `SlicerStyle` object, that should be the new default. + */ + setDefault(newDefaultStyle: SlicerStyle | string): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.SlicerStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.SlicerStyleCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.SlicerStyleCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.SlicerStyleCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.SlicerStyleCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.SlicerStyleCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.SlicerStyleCollectionData; + } + /** + * Represents a slicer style, which defines style elements by region of the slicer. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + export class SlicerStyle extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Specifies the name of the slicer style. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + name: string; + /** + * Specifies if this `SlicerStyle` object is read-only. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readonly readOnly: boolean; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.SlicerStyleUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.SlicerStyle): void; + /** + * Deletes the slicer style. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + delete(): void; + /** + * Creates a duplicate of this slicer style with copies of all the style elements. + * + * @remarks + * [Api set: ExcelApi 1.10] + * @returns The new `SlicerStyle` object that has been duplicated from this slicer style. + */ + duplicate(): Excel.SlicerStyle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.SlicerStyleLoadOptions): Excel.SlicerStyle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.SlicerStyle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.SlicerStyle; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.SlicerStyle` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.SlicerStyleData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.SlicerStyleData; + } + /** + * Represents a collection of timeline styles. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + export class TimelineStyleCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.TimelineStyle[]; + /** + * Creates a blank `TimelineStyle` with the specified name. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param name - The unique name for the new timeline style. Will throw an `InvalidArgument` error if the name is already in use. + * @param makeUniqueName - Optional. Defaults to `false`. If `true`, will append numbers to the name in order to make it unique, if needed. + * @returns The newly created `TimelineStyle`. + */ + add(name: string, makeUniqueName?: boolean): Excel.TimelineStyle; + /** + * Gets the number of timeline styles in the collection. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets the default timeline style for the parent object's scope. + * + * @remarks + * [Api set: ExcelApi 1.10] + * @returns The `TimelineStyle` object that is the current default timeline style. + */ + getDefault(): Excel.TimelineStyle; + /** + * Gets a `TimelineStyle` by name. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param name - Name of the timeline style to be retrieved. + * @returns The `TimelineStyle` object whose name matches the input. + */ + getItem(name: string): Excel.TimelineStyle; + /** + * Gets a `TimelineStyle` by name. + If the timeline style doesn't exist, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param name - Name of the timeline style to be retrieved. + * @returns The `TimelineStyle` object whose name matches the input. + */ + getItemOrNullObject(name: string): Excel.TimelineStyle; + /** + * Sets the default timeline style for use in the parent object's scope. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param newDefaultStyle - The `TimelineStyle` object, or name of the `TimelineStyle` object, that should be the new default. + */ + setDefault(newDefaultStyle: TimelineStyle | string): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.TimelineStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TimelineStyleCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TimelineStyleCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.TimelineStyleCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.TimelineStyleCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.TimelineStyleCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.TimelineStyleCollectionData; + } + /** + * Represents a `TimelineStyle`, which defines style elements by region in the timeline. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + export class TimelineStyle extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Specifies the name of the timeline style. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + name: string; + /** + * Specifies if this `TimelineStyle` object is read-only. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readonly readOnly: boolean; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.TimelineStyleUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.TimelineStyle): void; + /** + * Deletes the table style. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + delete(): void; + /** + * Creates a duplicate of this timeline style with copies of all the style elements. + * + * @remarks + * [Api set: ExcelApi 1.10] + * @returns The new `TimelineStyle` object that has been duplicated from this timeline style. + */ + duplicate(): Excel.TimelineStyle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.TimelineStyleLoadOptions): Excel.TimelineStyle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TimelineStyle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.TimelineStyle; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.TimelineStyle` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.TimelineStyleData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.TimelineStyleData; + } + /** + * Represents layout and print settings that are not dependent on any printer-specific implementation. These settings include margins, orientation, page numbering, title rows, and print area. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export class PageLayout extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Header and footer configuration for the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly headersFooters: Excel.HeaderFooterGroup; + /** + * The worksheet's black and white print option. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + blackAndWhite: boolean; + /** + * The worksheet's bottom page margin to use for printing in points. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + bottomMargin: number; + /** + * The worksheet's center horizontally flag. This flag determines whether the worksheet will be centered horizontally when it's printed. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + centerHorizontally: boolean; + /** + * The worksheet's center vertically flag. This flag determines whether the worksheet will be centered vertically when it's printed. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + centerVertically: boolean; + /** + * The worksheet's draft mode option. If `true`, the sheet will be printed without graphics. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + draftMode: boolean; + /** + * The worksheet's first page number to print. A `null` value represents "auto" page numbering. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + firstPageNumber: number | ""; + /** + * The worksheet's footer margin, in points, for use when printing. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + footerMargin: number; + /** + * The worksheet's header margin, in points, for use when printing. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + headerMargin: number; + /** + * The worksheet's left margin, in points, for use when printing. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + leftMargin: number; + /** + * The worksheet's orientation of the page. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + orientation: Excel.PageOrientation | "Portrait" | "Landscape"; + /** + * The worksheet's paper size of the page. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + paperSize: Excel.PaperType | "Letter" | "LetterSmall" | "Tabloid" | "Ledger" | "Legal" | "Statement" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "Folio" | "Quatro" | "Paper10x14" | "Paper11x17" | "Note" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "Csheet" | "Dsheet" | "Esheet" | "EnvelopeDL" | "EnvelopeC5" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "FanfoldUS" | "FanfoldStdGerman" | "FanfoldLegalGerman"; + /** + * Specifies if the worksheet's comments should be displayed when printing. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + printComments: Excel.PrintComments | "NoComments" | "EndSheet" | "InPlace"; + /** + * The worksheet's print errors option. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + printErrors: Excel.PrintErrorType | "AsDisplayed" | "Blank" | "Dash" | "NotAvailable"; + /** + * Specifies if the worksheet's gridlines will be printed. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + printGridlines: boolean; + /** + * Specifies if the worksheet's headings will be printed. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + printHeadings: boolean; + /** + * The worksheet's page print order option. This specifies the order to use for processing the page number printed. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + printOrder: Excel.PrintOrder | "DownThenOver" | "OverThenDown"; + /** + * The worksheet's right margin, in points, for use when printing. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + rightMargin: number; + /** + * The worksheet's top margin, in points, for use when printing. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + topMargin: number; + /** + * The worksheet's print zoom options. + The `PageLayoutZoomOptions` object must be set as a JSON object (use `x.zoom = {...}` instead of `x.zoom.scale = ...`). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + zoom: Excel.PageLayoutZoomOptions; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.PageLayoutUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.PageLayout): void; + /** + * Gets the `RangeAreas` object, comprising one or more rectangular ranges, that represents the print area for the worksheet. If there is no print area, an `ItemNotFound` error will be thrown. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + getPrintArea(): Excel.RangeAreas; + /** + * Gets the `RangeAreas` object, comprising one or more rectangular ranges, that represents the print area for the worksheet. + If there is no print area, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + getPrintAreaOrNullObject(): Excel.RangeAreas; + /** + * Gets the range object representing the title columns. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + getPrintTitleColumns(): Excel.Range; + /** + * Gets the range object representing the title columns. + If not set, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + getPrintTitleColumnsOrNullObject(): Excel.Range; + /** + * Gets the range object representing the title rows. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + getPrintTitleRows(): Excel.Range; + /** + * Gets the range object representing the title rows. + If not set, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + getPrintTitleRowsOrNullObject(): Excel.Range; + /** + * Sets the worksheet's print area. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param printArea - The range or ranges of the content to print. + */ + setPrintArea(printArea: Range | RangeAreas | string): void; + /** + * Sets the worksheet's page margins with units. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param unit - Measurement unit for the margins provided. + * @param marginOptions - Margin values to set. Margins not provided remain unchanged. + */ + setPrintMargins(unit: Excel.PrintMarginUnit, marginOptions: Excel.PageLayoutMarginOptions): void; + /** + * Sets the worksheet's page margins with units. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param unit - Measurement unit for the margins provided. + * @param marginOptions - Margin values to set. Margins not provided remain unchanged. + */ + setPrintMargins(unit: "Points" | "Inches" | "Centimeters", marginOptions: Excel.PageLayoutMarginOptions): void; + /** + * Sets the columns that contain the cells to be repeated at the left of each page of the worksheet for printing. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param printTitleColumns - The columns to be repeated to the left of each page. The range must span the entire column to be valid. + */ + setPrintTitleColumns(printTitleColumns: Range | string): void; + /** + * Sets the rows that contain the cells to be repeated at the top of each page of the worksheet for printing. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param printTitleRows - The rows to be repeated at the top of each page. The range must span the entire row to be valid. + */ + setPrintTitleRows(printTitleRows: Range | string): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.PageLayoutLoadOptions): Excel.PageLayout; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PageLayout; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.PageLayout; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.PageLayout` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.PageLayoutData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.PageLayoutData; + } + /** + * Represents page zoom properties. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface PageLayoutZoomOptions { + /** + * Number of pages to fit horizontally. This value can be `null` if percentage scale is used. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + horizontalFitToPages?: number; + /** + * Print page scale value can be between 10 and 400. This value can be `null` if fit to page tall or wide is specified. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + scale?: number; + /** + * Number of pages to fit vertically. This value can be `null` if percentage scale is used. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + verticalFitToPages?: number; + } + /** + * Represents the options in page layout margins. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface PageLayoutMarginOptions { + /** + * Specifies the page layout bottom margin in the unit specified to use for printing. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + bottom?: number; + /** + * Specifies the page layout footer margin in the unit specified to use for printing. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + footer?: number; + /** + * Specifies the page layout header margin in the unit specified to use for printing. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + header?: number; + /** + * Specifies the page layout left margin in the unit specified to use for printing. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + left?: number; + /** + * Specifies the page layout right margin in the unit specified to use for printing. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + right?: number; + /** + * Specifies the page layout top margin in the unit specified to use for printing. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + top?: number; + } + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + export class HeaderFooter extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * The center footer of the worksheet. + To apply font formatting or insert a variable value, use format codes specified here: https://msdn.microsoft.com/library/bb225426.aspx. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + centerFooter: string; + /** + * The center header of the worksheet. + To apply font formatting or insert a variable value, use format codes specified here: https://msdn.microsoft.com/library/bb225426.aspx. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + centerHeader: string; + /** + * The left footer of the worksheet. + To apply font formatting or insert a variable value, use format codes specified here: https://msdn.microsoft.com/library/bb225426.aspx. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + leftFooter: string; + /** + * The left header of the worksheet. + To apply font formatting or insert a variable value, use format codes specified here: https://msdn.microsoft.com/library/bb225426.aspx. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + leftHeader: string; + /** + * The right footer of the worksheet. + To apply font formatting or insert a variable value, use format codes specified here: https://msdn.microsoft.com/library/bb225426.aspx. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + rightFooter: string; + /** + * The right header of the worksheet. + To apply font formatting or insert a variable value, use format codes specified here: https://msdn.microsoft.com/library/bb225426.aspx. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + rightHeader: string; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.HeaderFooterUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.HeaderFooter): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.HeaderFooterLoadOptions): Excel.HeaderFooter; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.HeaderFooter; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.HeaderFooter; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.HeaderFooter` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.HeaderFooterData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.HeaderFooterData; + } + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + export class HeaderFooterGroup extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * The general header/footer, used for all pages unless even/odd or first page is specified. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly defaultForAllPages: Excel.HeaderFooter; + /** + * The header/footer to use for even pages, odd header/footer needs to be specified for odd pages. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly evenPages: Excel.HeaderFooter; + /** + * The first page header/footer, for all other pages general or even/odd is used. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly firstPage: Excel.HeaderFooter; + /** + * The header/footer to use for odd pages, even header/footer needs to be specified for even pages. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly oddPages: Excel.HeaderFooter; + /** + * The state by which headers/footers are set. See `Excel.HeaderFooterState` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + state: Excel.HeaderFooterState | "Default" | "FirstAndDefault" | "OddAndEven" | "FirstOddAndEven"; + /** + * Gets or sets a flag indicating if headers/footers are aligned with the page margins set in the page layout options for the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + useSheetMargins: boolean; + /** + * Gets or sets a flag indicating if headers/footers should be scaled by the page percentage scale set in the page layout options for the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + useSheetScale: boolean; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.HeaderFooterGroupUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.HeaderFooterGroup): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.HeaderFooterGroupLoadOptions): Excel.HeaderFooterGroup; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.HeaderFooterGroup; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.HeaderFooterGroup; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.HeaderFooterGroup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.HeaderFooterGroupData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.HeaderFooterGroupData; + } + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + export class PageBreak extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Specifies the column index for the page break. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly columnIndex: number; + /** + * Specifies the row index for the page break. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly rowIndex: number; + /** + * Deletes a page break object. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + delete(): void; + /** + * Gets the first cell after the page break. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + getCellAfterBreak(): Excel.Range; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.PageBreakLoadOptions): Excel.PageBreak; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PageBreak; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.PageBreak; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.PageBreak` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.PageBreakData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.PageBreakData; + } + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + export class PageBreakCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.PageBreak[]; + /** + * Adds a page break before the top-left cell of the range specified. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param pageBreakRange - The range immediately after the page break to be added. + */ + add(pageBreakRange: Range | string): Excel.PageBreak; + /** + * Gets the number of page breaks in the collection. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a page break object via the index. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param index - Index of the page break. + */ + getItem(index: number): Excel.PageBreak; + /** + * Resets all manual page breaks in the collection. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + removePageBreaks(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.PageBreakCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PageBreakCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PageBreakCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.PageBreakCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.PageBreakCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.PageBreakCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.PageBreakCollectionData; + } + /** + * Represents a collection of all the data connections that are part of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + export class DataConnectionCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Refreshes data connections in the collection, such as from a PivotTable to a Power BI dataset, or a Data Model to a table or range in the same workbook. + Data connections unsupported by this method are: Power Query connections, data connections outside the original workbook (except Power BI connections), and connections to data protected by a firewall. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + refreshAll(): void; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.DataConnectionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.DataConnectionCollectionData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): { + [key: string]: string; + }; + } + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + export class RangeCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.Range[]; + /** + * Returns the number of ranges in the `RangeCollection`. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Returns the range object based on its position in the `RangeCollection`. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param index - Index value of the range object to be retrieved. Zero-indexed. + */ + getItemAt(index: number): Excel.Range; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.RangeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.RangeCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.RangeCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.RangeCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.RangeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.RangeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.RangeCollectionData; + } + /** + * Contains the collection of cross-workbook level ranges. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + export class RangeAreasCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.RangeAreas[]; + /** + * Gets the number of `RangeAreas` objects in this collection. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Returns the `RangeAreas` object based on position in the collection. + * + * @remarks + * [Api set: ExcelApi 1.12] + * + * @param index - Index value of the range object to be retrieved. Zero-indexed. + */ + getItemAt(index: number): Excel.RangeAreas; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.RangeAreasCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.RangeAreasCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.RangeAreasCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.RangeAreasCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.RangeAreasCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.RangeAreasCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.RangeAreasCollectionData; + } + /** + * Represents the entity that is mentioned in comments. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + export interface CommentMention { + /** + * The email address of the entity that is mentioned in a comment. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + email: string; + /** + * The ID of the entity. The ID matches one of the IDs in `CommentRichContent.richContent`. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + id: number; + /** + * The name of the entity that is mentioned in a comment. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + name: string; + } + /** + * Represents the content contained within a comment or comment reply. Rich content incudes the text string and any other objects contained within the comment body, such as mentions. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + export interface CommentRichContent { + /** + * An array containing all the entities (e.g., people) mentioned within the comment. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + mentions?: Excel.CommentMention[]; + /** + * Specifies the rich content of the comment (e.g., comment content with mentions, the first mentioned entity has an ID attribute of 0, and the second mentioned entity has an ID attribute of 1). + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + richContent: string; + } + /** + * Represents a collection of comment objects that are part of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + export class CommentCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.Comment[]; + /** + * Creates a new comment with the given content on the given cell. An `InvalidArgument` error is thrown if the provided range is larger than one cell. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param cellAddress - The cell to which the comment is added. This can be a `Range` object or a string. If it's a string, it must contain the full address, including the sheet name. An `InvalidArgument` error is thrown if the provided range is larger than one cell. + * @param content - The comment's content. This can be either a string or `CommentRichContent` object. Strings are used for plain text. `CommentRichContent` objects allow for other comment features, such as mentions. [Api set: ExcelApi 1.10 for string, 1.11 for CommentRichContent object] + * @param contentType - Optional. The type of content contained within the comment. The default value is enum `ContentType.Plain`. [Api set: ExcelApi 1.10 for Enum ContentType.Plain, 1.11 for Enum ContentType.Mention] + */ + add(cellAddress: Range | string, content: CommentRichContent | string, contentType?: Excel.ContentType): Excel.Comment; + /** + * Creates a new comment with the given content on the given cell. An `InvalidArgument` error is thrown if the provided range is larger than one cell. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param cellAddress - The cell to which the comment is added. This can be a `Range` object or a string. If it's a string, it must contain the full address, including the sheet name. An `InvalidArgument` error is thrown if the provided range is larger than one cell. + * @param content - The comment's content. This can be either a string or `CommentRichContent` object. Strings are used for plain text. `CommentRichContent` objects allow for other comment features, such as mentions. [Api set: ExcelApi 1.10 for string, 1.11 for CommentRichContent object] + * @param contentType - Optional. The type of content contained within the comment. The default value is enum `ContentType.Plain`. [Api set: ExcelApi 1.10 for Enum ContentType.Plain, 1.11 for Enum ContentType.Mention] + */ + add(cellAddress: Range | string, content: CommentRichContent | string, contentType?: "Plain" | "Mention"): Excel.Comment; + /** + * Gets the number of comments in the collection. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a comment from the collection based on its ID. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param commentId - The identifier for the comment. + */ + getItem(commentId: string): Excel.Comment; + /** + * Gets a comment from the collection based on its position. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param index - Index value of the object to be retrieved. Zero-indexed. + */ + getItemAt(index: number): Excel.Comment; + /** + * Gets the comment from the specified cell. If there is no comment in the cell, an error is thrown. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param cellAddress - The cell which the comment is on. This can be a `Range` object or a string. If it's a string, it must contain the full address, including the sheet name. An `InvalidArgument` error is thrown if the provided range is larger than one cell. + */ + getItemByCell(cellAddress: Range | string): Excel.Comment; + /** + * Gets the comment to which the given reply is connected. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param replyId - The identifier of comment reply. + */ + getItemByReplyId(replyId: string): Excel.Comment; + /** + * Gets a comment from the collection based on its ID. + If the comment object does not exist, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.14] + * + * @param commentId - The identifier for the comment. + */ + getItemOrNullObject(commentId: string): Excel.Comment; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.CommentCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CommentCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.CommentCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.CommentCollection; + /** + * Occurs when the comments are added. + * + * @remarks + * [Api set: ExcelApi 1.12] + * + * @eventproperty + */ + readonly onAdded: OfficeExtension.EventHandlers; + /** + * Occurs when comments or replies in a comment collection are changed, including when replies are deleted. + * + * @remarks + * [Api set: ExcelApi 1.12] + * + * @eventproperty + */ + readonly onChanged: OfficeExtension.EventHandlers; + /** + * Occurs when comments are deleted in the comment collection. + * + * @remarks + * [Api set: ExcelApi 1.12] + * + * @eventproperty + */ + readonly onDeleted: OfficeExtension.EventHandlers; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.CommentCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.CommentCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.CommentCollectionData; + } + /** + * Represents a comment in the workbook. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + export class Comment extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents a collection of reply objects associated with the comment. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readonly replies: Excel.CommentReplyCollection; + /** + * Gets the email of the comment's author. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readonly authorEmail: string; + /** + * Gets the name of the comment's author. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readonly authorName: string; + /** + * The comment's content. The string is plain text. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + content: string; + /** + * Gets the content type of the comment. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + readonly contentType: Excel.ContentType | "Plain" | "Mention"; + /** + * Gets the creation time of the comment. Returns `null` if the comment was converted from a note, since the comment does not have a creation date. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readonly creationDate: Date; + /** + * Specifies the comment identifier. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readonly id: string; + /** + * Gets the entities (e.g., people) that are mentioned in comments. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + readonly mentions: Excel.CommentMention[]; + /** + * The comment thread status. A value of `true` means that the comment thread is resolved. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + resolved: boolean; + /** + * Gets the rich comment content (e.g., mentions in comments). This string is not meant to be displayed to end-users. Your add-in should only use this to parse rich comment content. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + readonly richContent: string; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.CommentUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.Comment): void; + /** + * Deletes the comment and all the connected replies. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + delete(): void; + /** + * Gets the cell where this comment is located. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + getLocation(): Excel.Range; + /** + * Updates the comment content with a specially formatted string and a list of mentions. + * + * @remarks + * [Api set: ExcelApi 1.11] + * + * @param contentWithMentions - The content for the comment. This contains a specially formatted string and a list of mentions that will be parsed into the string when displayed by Excel. + */ + updateMentions(contentWithMentions: Excel.CommentRichContent): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.CommentLoadOptions): Excel.Comment; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Comment; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.Comment; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.Comment` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.CommentData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.CommentData; + } + /** + * Represents a collection of comment reply objects that are part of the comment. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + export class CommentReplyCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.CommentReply[]; + /** + * Creates a comment reply for a comment. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param content - The comment's content. This can be either a string or a `CommentRichContent` object (e.g., for comments with mentions). [Api set: ExcelApi 1.10 for string, 1.11 for CommentRichContent object] + * @param contentType - Optional. The type of content contained within the comment. The default value is enum `ContentType.Plain`. [Api set: ExcelApi 1.10 for Enum ContentType.Plain, 1.11 for Enum ContentType.Mention] + */ + add(content: CommentRichContent | string, contentType?: Excel.ContentType): Excel.CommentReply; + /** + * Creates a comment reply for a comment. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param content - The comment's content. This can be either a string or a `CommentRichContent` object (e.g., for comments with mentions). [Api set: ExcelApi 1.10 for string, 1.11 for CommentRichContent object] + * @param contentType - Optional. The type of content contained within the comment. The default value is enum `ContentType.Plain`. [Api set: ExcelApi 1.10 for Enum ContentType.Plain, 1.11 for Enum ContentType.Mention] + */ + add(content: CommentRichContent | string, contentType?: "Plain" | "Mention"): Excel.CommentReply; + /** + * Gets the number of comment replies in the collection. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Returns a comment reply identified by its ID. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param commentReplyId - The identifier for the comment reply. + */ + getItem(commentReplyId: string): Excel.CommentReply; + /** + * Gets a comment reply based on its position in the collection. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param index - The index value of the comment reply to be retrieved. The collection uses zero-based indexing. + */ + getItemAt(index: number): Excel.CommentReply; + /** + * Returns a comment reply identified by its ID. + If the comment reply object does not exist, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.14] + * + * @param commentReplyId - The identifier for the comment reply. + */ + getItemOrNullObject(commentReplyId: string): Excel.CommentReply; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.CommentReplyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CommentReplyCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.CommentReplyCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.CommentReplyCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.CommentReplyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.CommentReplyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.CommentReplyCollectionData; + } + /** + * Represents a comment reply in the workbook. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + export class CommentReply extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Gets the email of the comment reply's author. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readonly authorEmail: string; + /** + * Gets the name of the comment reply's author. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readonly authorName: string; + /** + * The comment reply's content. The string is plain text. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + content: string; + /** + * The content type of the reply. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + readonly contentType: Excel.ContentType | "Plain" | "Mention"; + /** + * Gets the creation time of the comment reply. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readonly creationDate: Date; + /** + * Specifies the comment reply identifier. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readonly id: string; + /** + * The entities (e.g., people) that are mentioned in comments. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + readonly mentions: Excel.CommentMention[]; + /** + * The comment reply status. A value of `true` means the reply is in the resolved state. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + readonly resolved: boolean; + /** + * The rich comment content (e.g., mentions in comments). This string is not meant to be displayed to end-users. Your add-in should only use this to parse rich comment content. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + readonly richContent: string; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.CommentReplyUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.CommentReply): void; + /** + * Deletes the comment reply. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + delete(): void; + /** + * Gets the cell where this comment reply is located. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + getLocation(): Excel.Range; + /** + * Gets the parent comment of this reply. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + getParentComment(): Excel.Comment; + /** + * Updates the comment content with a specially formatted string and a list of mentions. + * + * @remarks + * [Api set: ExcelApi 1.11] + * + * @param contentWithMentions - The content for the comment. This contains a specially formatted string and a list of mentions that will be parsed into the string when displayed by Excel. + */ + updateMentions(contentWithMentions: Excel.CommentRichContent): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.CommentReplyLoadOptions): Excel.CommentReply; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.CommentReply; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.CommentReply; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.CommentReply` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.CommentReplyData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.CommentReplyData; + } + /** + * Represents a collection of all the shapes in the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export class ShapeCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.Shape[]; + /** + * Adds a geometric shape to the worksheet. Returns a `Shape` object that represents the new shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param geometricShapeType - Represents the type of the geometric shape. See `Excel.GeometricShapeType` for details. + */ + addGeometricShape(geometricShapeType: Excel.GeometricShapeType): Excel.Shape; + /** + * Adds a geometric shape to the worksheet. Returns a `Shape` object that represents the new shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param geometricShapeType - Represents the type of the geometric shape. See `Excel.GeometricShapeType` for details. + */ + addGeometricShape(geometricShapeType: "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"): Excel.Shape; + /** + * Groups a subset of shapes in this collection's worksheet. Returns a `Shape` object that represents the new group of shapes. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param values - An array of shape IDs or shape objects. + */ + addGroup(values: Array): Excel.Shape; + /** + * Creates an image from a Base64-encoded string and adds it to the worksheet. Returns the `Shape` object that represents the new image. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param base64ImageString - A Base64-encoded string representing an image in either JPEG or PNG format. + */ + addImage(base64ImageString: string): Excel.Shape; + /** + * Adds a line to worksheet. Returns a `Shape` object that represents the new line. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param startLeft - The distance, in points, from the start of the line to the left side of the worksheet. + * @param startTop - The distance, in points, from the start of the line to the top of the worksheet. + * @param endLeft - The distance, in points, from the end of the line to the left of the worksheet. + * @param endTop - The distance, in points, from the end of the line to the top of the worksheet. + * @param connectorType - Represents the connector type. See `Excel.ConnectorType` for details. + */ + addLine(startLeft: number, startTop: number, endLeft: number, endTop: number, connectorType?: Excel.ConnectorType): Excel.Shape; + /** + * Adds a line to worksheet. Returns a `Shape` object that represents the new line. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param startLeft - The distance, in points, from the start of the line to the left side of the worksheet. + * @param startTop - The distance, in points, from the start of the line to the top of the worksheet. + * @param endLeft - The distance, in points, from the end of the line to the left of the worksheet. + * @param endTop - The distance, in points, from the end of the line to the top of the worksheet. + * @param connectorType - Represents the connector type. See `Excel.ConnectorType` for details. + */ + addLine(startLeft: number, startTop: number, endLeft: number, endTop: number, connectorType?: "Straight" | "Elbow" | "Curve"): Excel.Shape; + /** + * Adds a text box to the worksheet with the provided text as the content. Returns a `Shape` object that represents the new text box. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param text - Represents the text that will be shown in the created text box. + */ + addTextBox(text?: string): Excel.Shape; + /** + * Returns the number of shapes in the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a shape using its name or ID. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param key - The name or ID of the shape to be retrieved. + */ + getItem(key: string): Excel.Shape; + /** + * Gets a shape using its position in the collection. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param index - The zero-based index of the shape to be retrieved. + */ + getItemAt(index: number): Excel.Shape; + /** + * Gets a shape using its name or ID. + If the shape object does not exist, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.14] + * + * @param key - The name or ID of the shape to be retrieved. + */ + getItemOrNullObject(key: string): Excel.Shape; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ShapeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ShapeCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ShapeCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.ShapeCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ShapeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ShapeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.ShapeCollectionData; + } + /** + * Represents a generic shape object in the worksheet. A shape could be a geometric shape, a line, a group of shapes, etc. + To learn more about the shape object model, read {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-shapes | Work with shapes using the Excel JavaScript API}. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export class Shape extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns the fill formatting of this shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly fill: Excel.ShapeFill; + /** + * Returns the geometric shape associated with the shape. An error will be thrown if the shape type is not "GeometricShape". + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly geometricShape: Excel.GeometricShape; + /** + * Returns the shape group associated with the shape. An error will be thrown if the shape type is not "GroupShape". + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly group: Excel.ShapeGroup; + /** + * Returns the image associated with the shape. An error will be thrown if the shape type is not "Image". + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly image: Excel.Image; + /** + * Returns the line associated with the shape. An error will be thrown if the shape type is not "Line". + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly line: Excel.Line; + /** + * Returns the line formatting of this shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly lineFormat: Excel.ShapeLineFormat; + /** + * Specifies the parent group of this shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly parentGroup: Excel.Shape; + /** + * Returns the text frame object of this shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly textFrame: Excel.TextFrame; + /** + * Specifies the alternative description text for a `Shape` object. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + altTextDescription: string; + /** + * Specifies the alternative title text for a `Shape` object. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + altTextTitle: string; + /** + * Returns the number of connection sites on this shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly connectionSiteCount: number; + /** + * Gets the display name of the shape. + A newly created shape has a generated name that is localized and may not match its `name`. + In this scenario, you can use this API to get the name that is displayed in the UI. + * + * @remarks + * [Api set: ExcelApi 1.15] + */ + readonly displayName: string; + /** + * Specifies the geometric shape type of this geometric shape. See `Excel.GeometricShapeType` for details. Returns `null` if the shape type is not "GeometricShape". + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + geometricShapeType: Excel.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"; + /** + * Specifies the height, in points, of the shape. + Throws an `InvalidArgument` exception when set with a negative value or zero as an input. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + height: number; + /** + * Specifies the shape identifier. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly id: string; + /** + * The distance, in points, from the left side of the shape to the left side of the worksheet. + Throws an `InvalidArgument` exception when set with a negative value as an input. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + left: number; + /** + * Specifies the level of the specified shape. For example, a level of 0 means that the shape is not part of any groups, a level of 1 means the shape is part of a top-level group, and a level of 2 means the shape is part of a sub-group of the top level. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly level: number; + /** + * Specifies if the aspect ratio of this shape is locked. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + lockAspectRatio: boolean; + /** + * Specifies the name of the shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + name: string; + /** + * Represents how the object is attached to the cells below it. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + placement: Excel.Placement | "TwoCell" | "OneCell" | "Absolute"; + /** + * Specifies the rotation, in degrees, of the shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + rotation: number; + /** + * The distance, in points, from the top edge of the shape to the top edge of the worksheet. + Throws an `InvalidArgument` exception when set with a negative value as an input. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + top: number; + /** + * Returns the type of this shape. See `Excel.ShapeType` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly type: Excel.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line"; + /** + * Specifies if the shape is visible. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + visible: boolean; + /** + * Specifies the width, in points, of the shape. + Throws an `InvalidArgument` exception when set with a negative value or zero as an input. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + width: number; + /** + * Returns the position of the specified shape in the z-order, with 0 representing the bottom of the order stack. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly zOrderPosition: number; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ShapeUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.Shape): void; + /** + * Copies and pastes a `Shape` object. + The pasted shape is copied to the same pixel location as this shape. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param destinationSheet - The sheet to which the shape object will be pasted. The default value is the copied shape's worksheet. + */ + copyTo(destinationSheet?: Worksheet | string): Excel.Shape; + /** + * Removes the shape from the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + delete(): void; + /** + * Converts the shape to an image and returns the image as a Base64-encoded string. The DPI is 96. The only supported formats are `Excel.PictureFormat.BMP`, `Excel.PictureFormat.PNG`, `Excel.PictureFormat.JPEG`, and `Excel.PictureFormat.GIF`. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param format - Specifies the format of the image. + */ + getAsImage(format: Excel.PictureFormat): OfficeExtension.ClientResult; + /** + * Converts the shape to an image and returns the image as a Base64-encoded string. The DPI is 96. The only supported formats are `Excel.PictureFormat.BMP`, `Excel.PictureFormat.PNG`, `Excel.PictureFormat.JPEG`, and `Excel.PictureFormat.GIF`. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param format - Specifies the format of the image. + */ + getAsImage(format: "UNKNOWN" | "BMP" | "JPEG" | "GIF" | "PNG" | "SVG"): OfficeExtension.ClientResult; + /** + * Moves the shape horizontally by the specified number of points. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param increment - The increment, in points, the shape will be horizontally moved. A positive value moves the shape to the right and a negative value moves it to the left. If the sheet is right-to-left oriented, this is reversed: positive values will move the shape to the left and negative values will move it to the right. + */ + incrementLeft(increment: number): void; + /** + * Rotates the shape clockwise around the z-axis by the specified number of degrees. + Use the `rotation` property to set the absolute rotation of the shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param increment - How many degrees the shape will be rotated. A positive value rotates the shape clockwise and a negative value rotates it counterclockwise. + */ + incrementRotation(increment: number): void; + /** + * Moves the shape vertically by the specified number of points. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param increment - The increment, in points, the shape will be vertically moved. A positive value moves the shape down and a negative value moves it up. + */ + incrementTop(increment: number): void; + /** + * Scales the height of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param scaleFactor - Specifies the ratio between the height of the shape after you resize it and the current or original height. + * @param scaleType - Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. + * @param scaleFrom - Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents the shape's upper left corner retains its position. + */ + scaleHeight(scaleFactor: number, scaleType: Excel.ShapeScaleType, scaleFrom?: Excel.ShapeScaleFrom): void; + /** + * Scales the height of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param scaleFactor - Specifies the ratio between the height of the shape after you resize it and the current or original height. + * @param scaleType - Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. + * @param scaleFrom - Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents the shape's upper left corner retains its position. + */ + scaleHeight(scaleFactor: number, scaleType: "CurrentSize" | "OriginalSize", scaleFrom?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void; + /** + * Scales the width of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current width. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param scaleFactor - Specifies the ratio between the width of the shape after you resize it and the current or original width. + * @param scaleType - Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. + * @param scaleFrom - Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents the shape's upper left corner retains its position. + */ + scaleWidth(scaleFactor: number, scaleType: Excel.ShapeScaleType, scaleFrom?: Excel.ShapeScaleFrom): void; + /** + * Scales the width of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current width. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param scaleFactor - Specifies the ratio between the width of the shape after you resize it and the current or original width. + * @param scaleType - Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. + * @param scaleFrom - Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents the shape's upper left corner retains its position. + */ + scaleWidth(scaleFactor: number, scaleType: "CurrentSize" | "OriginalSize", scaleFrom?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void; + /** + * Moves the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param position - Where to move the shape in the z-order stack relative to the other shapes. See `Excel.ShapeZOrder` for details. + */ + setZOrder(position: Excel.ShapeZOrder): void; + /** + * Moves the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param position - Where to move the shape in the z-order stack relative to the other shapes. See `Excel.ShapeZOrder` for details. + */ + setZOrder(position: "BringToFront" | "BringForward" | "SendToBack" | "SendBackward"): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ShapeLoadOptions): Excel.Shape; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Shape; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.Shape; + /** + * Occurs when the shape is activated. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @eventproperty + */ + readonly onActivated: OfficeExtension.EventHandlers; + /** + * Occurs when the shape is deactivated. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @eventproperty + */ + readonly onDeactivated: OfficeExtension.EventHandlers; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.Shape` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ShapeData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ShapeData; + } + /** + * Represents a geometric shape inside a worksheet. A geometric shape can be a rectangle, block arrow, equation symbol, flowchart item, star, banner, callout, or any other basic shape in Excel. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export class GeometricShape extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns the `Shape` object for the geometric shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly shape: Excel.Shape; + /** + * Returns the shape identifier. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly id: string; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.GeometricShapeLoadOptions): Excel.GeometricShape; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.GeometricShape; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.GeometricShape; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.GeometricShape` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.GeometricShapeData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.GeometricShapeData; + } + /** + * Represents an image in the worksheet. To get the corresponding `Shape` object, use `Image.shape`. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export class Image extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns the `Shape` object associated with the image. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly shape: Excel.Shape; + /** + * Specifies the shape identifier for the image object. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly id: string; + /** + * Returns the format of the image. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly format: Excel.PictureFormat | "UNKNOWN" | "BMP" | "JPEG" | "GIF" | "PNG" | "SVG"; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ImageLoadOptions): Excel.Image; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Image; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.Image; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.Image` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ImageData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ImageData; + } + /** + * Represents a shape group inside a worksheet. To get the corresponding `Shape` object, use `ShapeGroup.shape`. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export class ShapeGroup extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns the `Shape` object associated with the group. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly shape: Excel.Shape; + /** + * Returns the collection of `Shape` objects. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly shapes: Excel.GroupShapeCollection; + /** + * Specifies the shape identifier. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly id: string; + /** + * Ungroups any grouped shapes in the specified shape group. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + ungroup(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ShapeGroupLoadOptions): Excel.ShapeGroup; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ShapeGroup; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ShapeGroup; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ShapeGroup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ShapeGroupData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ShapeGroupData; + } + /** + * Represents the shape collection inside a shape group. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export class GroupShapeCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.Shape[]; + /** + * Returns the number of shapes in the shape group. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a shape using its name or ID. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param key - The name or ID of the shape to be retrieved. + */ + getItem(key: string): Excel.Shape; + /** + * Gets a shape based on its position in the collection. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param index - The zero-based index value of the object to be retrieved. + */ + getItemAt(index: number): Excel.Shape; + /** + * Gets a shape using its name or ID. + If the shape object does not exist, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.14] + * + * @param key - The name or ID of the shape to be retrieved. + */ + getItemOrNullObject(key: string): Excel.Shape; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.GroupShapeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.GroupShapeCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.GroupShapeCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.GroupShapeCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.GroupShapeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.GroupShapeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.GroupShapeCollectionData; + } + /** + * Represents a line inside a worksheet. To get the corresponding `Shape` object, use `Line.shape`. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export class Line extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents the shape to which the beginning of the specified line is attached. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly beginConnectedShape: Excel.Shape; + /** + * Represents the shape to which the end of the specified line is attached. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly endConnectedShape: Excel.Shape; + /** + * Returns the `Shape` object associated with the line. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly shape: Excel.Shape; + /** + * Represents the length of the arrowhead at the beginning of the specified line. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + beginArrowheadLength: Excel.ArrowheadLength | "Short" | "Medium" | "Long"; + /** + * Represents the style of the arrowhead at the beginning of the specified line. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + beginArrowheadStyle: Excel.ArrowheadStyle | "None" | "Triangle" | "Stealth" | "Diamond" | "Oval" | "Open"; + /** + * Represents the width of the arrowhead at the beginning of the specified line. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + beginArrowheadWidth: Excel.ArrowheadWidth | "Narrow" | "Medium" | "Wide"; + /** + * Represents the connection site to which the beginning of a connector is connected. Returns `null` when the beginning of the line is not attached to any shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly beginConnectedSite: number; + /** + * Represents the length of the arrowhead at the end of the specified line. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + endArrowheadLength: Excel.ArrowheadLength | "Short" | "Medium" | "Long"; + /** + * Represents the style of the arrowhead at the end of the specified line. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + endArrowheadStyle: Excel.ArrowheadStyle | "None" | "Triangle" | "Stealth" | "Diamond" | "Oval" | "Open"; + /** + * Represents the width of the arrowhead at the end of the specified line. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + endArrowheadWidth: Excel.ArrowheadWidth | "Narrow" | "Medium" | "Wide"; + /** + * Represents the connection site to which the end of a connector is connected. Returns `null` when the end of the line is not attached to any shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly endConnectedSite: number; + /** + * Specifies the shape identifier. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly id: string; + /** + * Specifies if the beginning of the specified line is connected to a shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly isBeginConnected: boolean; + /** + * Specifies if the end of the specified line is connected to a shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly isEndConnected: boolean; + /** + * Represents the connector type for the line. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + connectorType: Excel.ConnectorType | "Straight" | "Elbow" | "Curve"; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.LineUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.Line): void; + /** + * Attaches the beginning of the specified connector to a specified shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param shape - The shape to connect. + * @param connectionSite - The connection site on the shape to which the beginning of the connector is attached. Must be an integer between 0 (inclusive) and the connection-site count of the specified shape (exclusive). + */ + connectBeginShape(shape: Excel.Shape, connectionSite: number): void; + /** + * Attaches the end of the specified connector to a specified shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param shape - The shape to connect. + * @param connectionSite - The connection site on the shape to which the end of the connector is attached. Must be an integer between 0 (inclusive) and the connection-site count of the specified shape (exclusive). + */ + connectEndShape(shape: Excel.Shape, connectionSite: number): void; + /** + * Detaches the beginning of the specified connector from a shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + disconnectBeginShape(): void; + /** + * Detaches the end of the specified connector from a shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + disconnectEndShape(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.LineLoadOptions): Excel.Line; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Line; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.Line; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.Line` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.LineData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.LineData; + } + /** + * Represents the fill formatting of a shape object. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export class ShapeFill extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents the shape fill foreground color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange") + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + foregroundColor: string; + /** + * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + transparency: number; + /** + * Returns the fill type of the shape. See `Excel.ShapeFillType` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly type: Excel.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "Mixed"; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ShapeFillUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ShapeFill): void; + /** + * Clears the fill formatting of this shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + clear(): void; + /** + * Sets the fill formatting of the shape to a uniform color. This changes the fill type to "Solid". + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param color - A string that represents the fill color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + */ + setSolidColor(color: string): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ShapeFillLoadOptions): Excel.ShapeFill; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ShapeFill; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ShapeFill; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ShapeFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ShapeFillData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ShapeFillData; + } + /** + * Represents the line formatting for the shape object. For images and geometric shapes, line formatting represents the border of the shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export class ShapeLineFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + color: string; + /** + * Represents the line style of the shape. Returns `null` when the line is not visible or there are inconsistent dash styles. See `Excel.ShapeLineDashStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + dashStyle: Excel.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot"; + /** + * Represents the line style of the shape. Returns `null` when the line is not visible or there are inconsistent styles. See `Excel.ShapeLineStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + style: Excel.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin"; + /** + * Represents the degree of transparency of the specified line as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` when the shape has inconsistent transparencies. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + transparency: number; + /** + * Specifies if the line formatting of a shape element is visible. Returns `null` when the shape has inconsistent visibilities. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + visible: boolean; + /** + * Represents the weight of the line, in points. Returns `null` when the line is not visible or there are inconsistent line weights. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + weight: number; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ShapeLineFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ShapeLineFormat): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ShapeLineFormatLoadOptions): Excel.ShapeLineFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ShapeLineFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ShapeLineFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ShapeLineFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ShapeLineFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ShapeLineFormatData; + } + /** + * Represents the text frame of a shape object. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export class TextFrame extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents the text that is attached to a shape in the text frame, and properties and methods for manipulating the text. See `Excel.TextRange` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly textRange: Excel.TextRange; + /** + * The automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + autoSizeSetting: Excel.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed"; + /** + * Represents the bottom margin, in points, of the text frame. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + bottomMargin: number; + /** + * Specifies if the text frame contains text. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly hasText: boolean; + /** + * Represents the horizontal alignment of the text frame. See `Excel.ShapeTextHorizontalAlignment` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + horizontalAlignment: Excel.ShapeTextHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed"; + /** + * Represents the horizontal overflow behavior of the text frame. See `Excel.ShapeTextHorizontalOverflow` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + horizontalOverflow: Excel.ShapeTextHorizontalOverflow | "Overflow" | "Clip"; + /** + * Represents the left margin, in points, of the text frame. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + leftMargin: number; + /** + * Represents the angle to which the text is oriented for the text frame. See `Excel.ShapeTextOrientation` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + orientation: Excel.ShapeTextOrientation | "Horizontal" | "Vertical" | "Vertical270" | "WordArtVertical" | "EastAsianVertical" | "MongolianVertical" | "WordArtVerticalRTL"; + /** + * Represents the reading order of the text frame, either left-to-right or right-to-left. See `Excel.ShapeTextReadingOrder` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readingOrder: Excel.ShapeTextReadingOrder | "LeftToRight" | "RightToLeft"; + /** + * Represents the right margin, in points, of the text frame. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + rightMargin: number; + /** + * Represents the top margin, in points, of the text frame. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + topMargin: number; + /** + * Represents the vertical alignment of the text frame. See `Excel.ShapeTextVerticalAlignment` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + verticalAlignment: Excel.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom" | "Justified" | "Distributed"; + /** + * Represents the vertical overflow behavior of the text frame. See `Excel.ShapeTextVerticalOverflow` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + verticalOverflow: Excel.ShapeTextVerticalOverflow | "Overflow" | "Ellipsis" | "Clip"; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.TextFrameUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.TextFrame): void; + /** + * Deletes all the text in the text frame. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + deleteText(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.TextFrameLoadOptions): Excel.TextFrame; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TextFrame; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.TextFrame; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.TextFrame` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.TextFrameData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.TextFrameData; + } + /** + * Contains the text that is attached to a shape, in addition to properties and methods for manipulating the text. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export class TextRange extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns a `ShapeFont` object that represents the font attributes for the text range. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readonly font: Excel.ShapeFont; + /** + * Represents the plain text content of the text range. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + text: string; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.TextRangeUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.TextRange): void; + /** + * Returns a TextRange object for the substring in the given range. + * + * @remarks + * [Api set: ExcelApi 1.9] + * + * @param start - The zero-based index of the first character to get from the text range. + * @param length - Optional. The number of characters to be returned in the new text range. If length is omitted, all the characters from start to the end of the text range's last paragraph will be returned. + */ + getSubstring(start: number, length?: number): Excel.TextRange; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.TextRangeLoadOptions): Excel.TextRange; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TextRange; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.TextRange; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.TextRange` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.TextRangeData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.TextRangeData; + } + /** + * Represents the font attributes, such as font name, font size, and color, for a shape's `TextRange` object. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export class ShapeFont extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + bold: boolean; + /** + * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + color: string; + /** + * Represents the italic status of font. Returns `null` if the `TextRange` includes both italic and non-italic text fragments. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + italic: boolean; + /** + * Represents font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + name: string; + /** + * Represents font size in points (e.g., 11). Returns `null` if the `TextRange` includes text fragments with different font sizes. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + size: number; + /** + * Type of underline applied to the font. Returns `null` if the `TextRange` includes text fragments with different underline styles. See `Excel.ShapeFontUnderlineStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + underline: Excel.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble"; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ShapeFontUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.ShapeFont): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.ShapeFontLoadOptions): Excel.ShapeFont; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.ShapeFont; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.ShapeFont; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.ShapeFont` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ShapeFontData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.ShapeFontData; + } + /** + * Represents a `Slicer` object in the workbook. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + export class Slicer extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents the collection of slicer items that are part of the slicer. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readonly slicerItems: Excel.SlicerItemCollection; + /** + * Represents the worksheet containing the slicer. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readonly worksheet: Excel.Worksheet; + /** + * Represents the caption of the slicer. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + caption: string; + /** + * Specifies the height, in points, of the slicer. + Throws an `InvalidArgument` exception when set with a negative value or zero as an input. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + height: number; + /** + * Represents the unique ID of the slicer. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readonly id: string; + /** + * Value is `true` if all filters currently applied on the slicer are cleared. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readonly isFilterCleared: boolean; + /** + * Represents the distance, in points, from the left side of the slicer to the left of the worksheet. + Throws an `InvalidArgument` error when set with a negative value as an input. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + left: number; + /** + * Represents the name of the slicer. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + name: string; + /** + * Specifies the sort order of the items in the slicer. + Possible values are: "DataSourceOrder", "Ascending", "Descending". + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + sortBy: Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | "Descending"; + /** + * Constant value that represents the slicer style. + Possible values are: "SlicerStyleLight1" through "SlicerStyleLight6", "TableStyleOther1" through "TableStyleOther2", "SlicerStyleDark1" through "SlicerStyleDark6". A custom user-defined style present in the workbook can also be specified. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + style: string; + /** + * Represents the distance, in points, from the top edge of the slicer to the top of the worksheet. + Throws an `InvalidArgument` error when set with a negative value as an input. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + top: number; + /** + * Represents the width, in points, of the slicer. + Throws an `InvalidArgument` error when set with a negative value or zero as an input. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + width: number; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.SlicerUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.Slicer): void; + /** + * Clears all the filters currently applied on the slicer. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + clearFilters(): void; + /** + * Deletes the slicer. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + delete(): void; + /** + * Returns an array of selected items' keys. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + getSelectedItems(): OfficeExtension.ClientResult; + /** + * Selects slicer items based on their keys. The previous selections are cleared. + All items will be selected by default if the array is empty. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param items - Optional. The specified slicer item names to be selected. + */ + selectItems(items?: string[]): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.SlicerLoadOptions): Excel.Slicer; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Slicer; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.Slicer; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.Slicer` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.SlicerData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.SlicerData; + } + /** + * Represents a collection of all the slicer objects in the workbook or a worksheet. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + export class SlicerCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.Slicer[]; + /** + * Adds a new slicer to the workbook. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param slicerSource - The data source that the new slicer will be based on. It can be a `PivotTable` object, a `Table` object, or a string. When a PivotTable object is passed, the data source is the source of the `PivotTable` object. When a `Table` object is passed, the data source is the `Table` object. When a string is passed, it is interpreted as the name or ID of a PivotTable or table. + * @param sourceField - The field in the data source to filter by. It can be a `PivotField` object, a `TableColumn` object, the ID of a `PivotField` or the name or ID of a `TableColumn`. + * @param slicerDestination - Optional. The worksheet in which the new slicer will be created. It can be a `Worksheet` object or the name or ID of a worksheet. This parameter can be omitted if the slicer collection is retrieved from a worksheet. + * @returns The new slicer. + */ + add(slicerSource: string | PivotTable | Table, sourceField: string | PivotField | number | TableColumn, slicerDestination?: string | Worksheet): Excel.Slicer; + /** + * Returns the number of slicers in the collection. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a slicer object using its name or ID. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param key - The name or ID of the slicer. + */ + getItem(key: string): Excel.Slicer; + /** + * Gets a slicer based on its position in the collection. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param index - Index value of the object to be retrieved. Zero-indexed. + */ + getItemAt(index: number): Excel.Slicer; + /** + * Gets a slicer using its name or ID. + If the slicer doesn't exist, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param key - Name or ID of the slicer to be retrieved. + */ + getItemOrNullObject(key: string): Excel.Slicer; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.SlicerCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.SlicerCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.SlicerCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.SlicerCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.SlicerCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.SlicerCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.SlicerCollectionData; + } + /** + * Represents a slicer item in a slicer. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + export class SlicerItem extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Value is `true` if the slicer item has data. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readonly hasData: boolean; + /** + * Value is `true` if the slicer item is selected. + Setting this value will not clear the selected state of other slicer items. + By default, if the slicer item is the only one selected, when it is deselected, all items will be selected. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + isSelected: boolean; + /** + * Represents the unique value representing the slicer item. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readonly key: string; + /** + * Represents the title displayed in the Excel UI. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readonly name: string; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.SlicerItemUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.SlicerItem): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.SlicerItemLoadOptions): Excel.SlicerItem; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.SlicerItem; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.SlicerItem; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.SlicerItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.SlicerItemData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.SlicerItemData; + } + /** + * Represents a collection of all the slicer item objects in the slicer. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + export class SlicerItemCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.SlicerItem[]; + /** + * Returns the number of slicer items in the slicer. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a slicer item object using its key or name. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param key - The key or name of the slicer item. + */ + getItem(key: string): Excel.SlicerItem; + /** + * Gets a slicer item based on its position in the collection. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param index - Index value of the object to be retrieved. Zero-indexed. + */ + getItemAt(index: number): Excel.SlicerItem; + /** + * Gets a slicer item using its key or name. + If the slicer item doesn't exist, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.10] + * + * @param key - Key or name of the slicer to be retrieved. + */ + getItemOrNullObject(key: string): Excel.SlicerItem; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.SlicerItemCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.SlicerItemCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.SlicerItemCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.SlicerItemCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.SlicerItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.SlicerItemCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.SlicerItemCollectionData; + } + /** + * Represents a specific category or field of information that shares some common characteristics or attributes. + A data domain is linked to a data provider, that acts as the data source for `LinkedEntityCellValue` objects in the workbook. + A data domain is a category of data, such as stocks, geography, or currencies. A data provider is a service, such as Bing, Power BI, or an Office Add-in. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This class isn't supported in Excel on the web. + */ + export class LinkedEntityDataDomain extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Gets the name of the data provider for the linked entity data domain. + This name can change based on the information provided by the data provider. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + readonly dataProvider: string; + /** + * Gets the ID of the linked entity data domain defined by Office Add-ins. + This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + readonly id: string; + /** + * Gets the date and time (in the local time zone) since the workbook was opened and the `LinkedEntityCellValue` objects of this linked entity data domain were last refreshed. + Returns `undefined` if `LinkedEntityCellValue` objects have not been refreshed since the workbook was opened. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + readonly lastRefreshed: Date; + /** + * Gets the ID of the custom function that is called on demand to resolve or refresh the `LinkedEntityCellValue` objects of the linked entity data domain defined by Office Add-ins. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/excel/custom-functions-json-autogeneration#id | Autogenerate JSON metadata for custom functions: ID}. + This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + readonly loadFunctionId: string; + /** + * Gets the name of the linked entity data domain. + This name can change based on the information provided by the data provider. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + readonly name: string; + /** + * Gets the frequency, in seconds, at which `LinkedEntityCellValue` objects of this linked entity data domain are refreshed automatically. + The refresh interval only applies if the `refreshMode` is set to "Periodic". + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + readonly periodicRefreshInterval: number; + /** + * Specifies the refresh mode that defines how and when the `LinkedEntityCellValue` objects of this linked entity data domain are refreshed. + If the refresh mode being set is not supported by this linked entity data domain, then the current refresh mode is not changed. + If the refresh mode is set to "Periodic", the refresh interval is set to the `periodicRefreshInterval` of this linked entity data domain. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + refreshMode: Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic"; + /** + * Gets the service ID of the linked entity data domain. + This ID is a permanently reserved value for all linked entity data domains which are defined by service data providers, such as Bing or Power BI, or defined by Office Add-ins. + This ID never changes across user sessions. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + readonly serviceId: number; + /** + * Gets all the refresh modes supported by the linked entity data domain. + This array can change based on the information provided by the data provider. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + readonly supportedRefreshModes: Excel.LinkedEntityDataDomainRefreshMode[]; + /** + * Deletes this object from the `LinkedEntityDataDomainCollection`. + Once the linked entity data domain is deleted, new `LinkedEntityCellValue` objects of this linked entity data domain can't be created and existing `LinkedEntityCellValue` objects can't be refreshed. + An Office Add-in can only delete linked entity data domains that it created. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This method isn't supported in Excel on the web. + */ + delete(): void; + /** + * Refreshes all `LinkedEntityCellValue` objects of this linked entity data domain. + The refresh request can fail if the data provider is busy or temporarily inaccessible. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This method isn't supported in Excel on the web. + */ + refresh(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.LinkedEntityDataDomainLoadOptions): Excel.LinkedEntityDataDomain; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.LinkedEntityDataDomain; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.LinkedEntityDataDomain; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.LinkedEntityDataDomain` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.LinkedEntityDataDomainData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.LinkedEntityDataDomainData; + } + /** + * Provides information about the identity of the linked entity data domain that was just added to the workbook. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This interface isn't supported in Excel on the web. + */ + export interface LinkedEntityDataDomainAddedEventArgs { + /** + * Gets the ID of the linked entity data domain that was just added to the workbook. This ID is defined by Office Add-ins. + This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + id?: string; + /** + * Gets the service ID of the linked entity data domain that was just added to the workbook. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + serviceId: number; + /** + * Gets the source of the event. See `Excel.EventSource` for details. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + source: Excel.EventSource | "Local" | "Remote"; + /** + * Gets the type of the event. See `Excel.EventType` for details. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + type: "LinkedEntityDataDomainLinkedEntityDataDomainAdded"; + } + /** + * Represents a collection of `LinkedEntityDataDomain` objects. + The collection can contain linked entity data domains such as stocks, geography, or currencies defined by service data providers, such as Bing or Power BI, or linked entity data domains defined by Office Add-ins. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + export class LinkedEntityDataDomainCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.LinkedEntityDataDomain[]; + /** + * Adds a linked entity data domain object defined by the Office Add-in to the collection. + Once the linked entity data domain is added, it can be used to create `LinkedEntityCellValue` objects. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * @param options - Options that are used to create the linked entity data domain to be added. + */ + add(options: Excel.LinkedEntityDataDomainCreateOptions): void; + /** + * Gets the number of linked entity data domains in the collection. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a linked entity data domain by its `id`. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * @param id - The `id` of the `LinkedEntityDataDomain` object to be retrieved. + * @returns The linked entity data domain with the given `id`. If there are multiple linked entity data domains with the same `id`, the one defined by this Office Add-in will be returned. + */ + getItem(id: string): Excel.LinkedEntityDataDomain; + /** + * Gets a linked entity data domain by its index in the collection. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * @param index - The index of the linked entity data domain in the collection. + * @returns The linked entity data domain at the given index. + */ + getItemAt(index: number): Excel.LinkedEntityDataDomain; + /** + * Gets a linked entity data domain by its `name`. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * @param name - The `name` of the `LinkedEntityDataDomain` object to be retrieved. + * @returns The linked entity data domain with the given `name`. If there are multiple linked entity data domains with the same `name`, the one defined by this Office Add-in will be returned. + */ + getItemByName(name: string): Excel.LinkedEntityDataDomain; + /** + * Gets a linked entity data domain by its `name`. + If the linked entity data domain does not exist, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * @param name - The `name` of the `LinkedEntityDataDomain` object to be retrieved. + * @returns The linked entity data domain with the given `name`. If there are multiple linked entity data domains with the same `name`, the one defined by this Office Add-in will be returned. + */ + getItemByNameOrNullObject(name: string): Excel.LinkedEntityDataDomain; + /** + * Gets a linked entity data domain by its `id`. + If the linked entity data domain does not exist, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * @param id - The `id` of the `LinkedEntityDataDomain` object to be retrieved. + * @returns The linked entity data domain with the given `id`. If there are multiple linked entity data domains with the same `id`, the one defined by this Office Add-in will be returned. + */ + getItemOrNullObject(id: string): Excel.LinkedEntityDataDomain; + /** + * Refreshes all `LinkedEntityCellValue` objects of all linked entity data domains in this collection. + The refresh request can fail if the data providers are busy or temporarily inaccessible. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + refreshAll(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.LinkedEntityDataDomainCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.LinkedEntityDataDomainCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.LinkedEntityDataDomainCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.LinkedEntityDataDomainCollection; + /** + * Occurs when a new linked entity data domain is added to the workbook. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * @eventproperty + */ + readonly onLinkedEntityDataDomainAdded: OfficeExtension.EventHandlers; + /** + * Occurs when the request to refresh `LinkedEntityCellValue` objects of a linked entity data domain is completed. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * @eventproperty + */ + readonly onRefreshCompleted: OfficeExtension.EventHandlers; + /** + * Occurs when the `refreshMode` of a linked entity data domain is changed. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * @eventproperty + */ + readonly onRefreshModeChanged: OfficeExtension.EventHandlers; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.LinkedEntityDataDomainCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.LinkedEntityDataDomainCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.LinkedEntityDataDomainCollectionData; + } + /** + * Represents options that are used to create the `LinkedEntityDataDomain` object being added to the `LinkedEntityDataDomainCollection`. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This interface isn't supported in Excel on the web. + */ + export interface LinkedEntityDataDomainCreateOptions { + /** + * Specifies the name of the data provider for the linked entity data domain. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + dataProvider: string; + /** + * Specifies the ID of the linked entity data domain. + This ID must be unique across all linked entity data domains defined by this Office Add-in. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + id: string; + /** + * Specifies the ID of the custom function that will be called on demand to resolve or refresh the `LinkedEntityCellValue` objects of this linked entity data domain. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/excel/custom-functions-json-autogeneration#id | Autogenerate JSON metadata for custom functions: ID}. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + loadFunctionId: string; + /** + * Specifies the name of the linked entity data domain. + This name must be unique across all linked entity data domains defined by this Office Add-in. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + name: string; + /** + * Specifies the frequency, in seconds, at which `LinkedEntityCellValue` objects of this linked entity data domain are refreshed automatically. The minimum valid value is 300. + This property is required if the `supportedRefreshModes` array contains the value "Periodic". + This property only applies if the `refreshMode` of the linked entity data domain is set to "Periodic". + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + periodicRefreshInterval?: number; + /** + * Specifies all the refresh modes supported by the linked entity data domain. + The default value is `["Manual"]`, which is always supported even if not specified. + The refresh mode saved in the workbook is loaded as the default refresh mode of the linked entity data domain on the next workbook open. + If the refresh mode was not saved in the workbook, the first value in the array is set as the default refresh mode of the linked entity data domain. + If the array has the value "Periodic", the `periodicRefreshInterval` property must also be set for the linked entity data domain. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + supportedRefreshModes?: Excel.LinkedEntityDataDomainRefreshMode[]; + } + /** + * Provides information about the linked entity data domain whose `LinkedEntityCellValue` objects were refreshed. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This interface isn't supported in Excel on the web. + */ + export interface LinkedEntityDataDomainRefreshCompletedEventArgs { + /** + * Gets any errors encountered during the request to refresh `LinkedEntityCellValue` objects of the linked entity data domain. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + errors?: string[]; + /** + * Gets the ID of the linked entity data domain whose `LinkedEntityCellValue` objects were refreshed. This ID is defined by Office Add-ins. + This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + id?: string; + /** + * Returns `true` if the `LinkedEntityCellValue` objects of the linked entity data domain were refreshed successfully, otherwise returns `false`. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + refreshed: boolean; + /** + * Gets the service ID of the linked entity data domain whose `LinkedEntityCellValue` objects were refreshed. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + serviceId: number; + /** + * Gets the source of the event. See `Excel.EventSource` for details. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + source: Excel.EventSource | "Local" | "Remote"; + /** + * Gets the type of the event. See `Excel.EventType` for details. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + type: "LinkedEntityDataDomainRefreshCompleted"; + } + /** + * Represents the refresh mode setting for the `LinkedEntityCellValue` objects of a `LinkedEntityDataDomain`. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + enum LinkedEntityDataDomainRefreshMode { + /** + * Refresh mode is unknown or unsupported. + * @remarks + * [Api set: ExcelApi 1.19] + */ + unknown = "Unknown", + /** + * Manual refresh by the user. + Refresh is not triggered automatically. + * @remarks + * [Api set: ExcelApi 1.19] + */ + manual = "Manual", + /** + * Refresh on workbook load, applicable to linked entity data domains defined by service data providers, such as Bing or Power BI. + Refresh on add-in load, applicable to linked entity data domains defined by Office Add-ins. + * @remarks + * [Api set: ExcelApi 1.19] + */ + onLoad = "OnLoad", + /** + * Refresh automatically based on the frequency, in seconds, specified by `periodicRefreshInterval`. + For linked entity data domains defined by service data providers, such as Bing or Power BI, this value also initiates a refresh each time the workbook is opened. + For linked entity data domains defined by Office Add-ins, this value also initiates a refresh each time the add-in loads. + * @remarks + * [Api set: ExcelApi 1.19] + */ + periodic = "Periodic" + } + /** + * Provides information about the linked entity data domain whose refresh mode was changed. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This interface isn't supported in Excel on the web. + */ + export interface LinkedEntityDataDomainRefreshModeChangedEventArgs { + /** + * Gets the ID of the linked entity data domain whose refresh mode was changed. This ID is defined by Office Add-ins. + This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + id?: string; + /** + * Gets the new refresh mode of the linked entity data domain. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + refreshMode: Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic"; + /** + * Gets the service ID of the linked entity data domain whose refresh mode was changed. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + serviceId: number; + /** + * Gets the source of the event. See `Excel.EventSource` for details. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + source: Excel.EventSource | "Local" | "Remote"; + /** + * Gets the type of the event. See `Excel.EventType` for details. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + type: "LinkedEntityDataDomainRefreshModeChanged"; + } + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + enum ChartAxisType { + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + invalid = "Invalid", + /** + * Axis displays categories. + * @remarks + * [Api set: ExcelApi 1.7] + */ + category = "Category", + /** + * Axis displays values. + * @remarks + * [Api set: ExcelApi 1.7] + */ + value = "Value", + /** + * Axis displays data series. + * @remarks + * [Api set: ExcelApi 1.7] + */ + series = "Series" + } + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + enum ChartAxisGroup { + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + primary = "Primary", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + secondary = "Secondary" + } + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + enum ChartAxisScaleType { + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + linear = "Linear", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + logarithmic = "Logarithmic" + } + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + enum ChartAxisPosition { + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + automatic = "Automatic", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + maximum = "Maximum", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + minimum = "Minimum", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + custom = "Custom" + } + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + enum ChartAxisTickMark { + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + none = "None", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + cross = "Cross", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + inside = "Inside", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + outside = "Outside" + } + /** + * Represents the state of calculation across the entire Excel application. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum CalculationState { + /** + * Calculations complete. + * @remarks + * [Api set: ExcelApi 1.9] + */ + done = "Done", + /** + * Calculations in progress. + * @remarks + * [Api set: ExcelApi 1.9] + */ + calculating = "Calculating", + /** + * Changes that trigger calculation have been made, but a recalculation has not yet been performed. + * @remarks + * [Api set: ExcelApi 1.9] + */ + pending = "Pending" + } + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + enum ChartAxisTickLabelPosition { + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + nextToAxis = "NextToAxis", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + high = "High", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + low = "Low", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + none = "None" + } + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + enum ChartAxisDisplayUnit { + /** + * Default option. This will reset display unit to the axis, and set unit label invisible. + * @remarks + * [Api set: ExcelApi 1.7] + */ + none = "None", + /** + * This will set the axis in units of hundreds. + * @remarks + * [Api set: ExcelApi 1.7] + */ + hundreds = "Hundreds", + /** + * This will set the axis in units of thousands. + * @remarks + * [Api set: ExcelApi 1.7] + */ + thousands = "Thousands", + /** + * This will set the axis in units of tens of thousands. + * @remarks + * [Api set: ExcelApi 1.7] + */ + tenThousands = "TenThousands", + /** + * This will set the axis in units of hundreds of thousands. + * @remarks + * [Api set: ExcelApi 1.7] + */ + hundredThousands = "HundredThousands", + /** + * This will set the axis in units of millions. + * @remarks + * [Api set: ExcelApi 1.7] + */ + millions = "Millions", + /** + * This will set the axis in units of tens of millions. + * @remarks + * [Api set: ExcelApi 1.7] + */ + tenMillions = "TenMillions", + /** + * This will set the axis in units of hundreds of millions. + * @remarks + * [Api set: ExcelApi 1.7] + */ + hundredMillions = "HundredMillions", + /** + * This will set the axis in units of billions. + * @remarks + * [Api set: ExcelApi 1.7] + */ + billions = "Billions", + /** + * This will set the axis in units of trillions. + * @remarks + * [Api set: ExcelApi 1.7] + */ + trillions = "Trillions", + /** + * This will set the axis in units of custom value. + * @remarks + * [Api set: ExcelApi 1.7] + */ + custom = "Custom" + } + /** + * Specifies the unit of time for chart axes and data series. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + enum ChartAxisTimeUnit { + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + days = "Days", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + months = "Months", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + years = "Years" + } + /** + * Represents the quartile calculation type of chart series layout. Only applies to a box and whisker chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum ChartBoxQuartileCalculation { + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + inclusive = "Inclusive", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + exclusive = "Exclusive" + } + /** + * Specifies the type of the category axis. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + enum ChartAxisCategoryType { + /** + * Excel controls the axis type. + * @remarks + * [Api set: ExcelApi 1.7] + */ + automatic = "Automatic", + /** + * Axis groups data by an arbitrary set of categories. + * @remarks + * [Api set: ExcelApi 1.7] + */ + textAxis = "TextAxis", + /** + * Axis groups data on a time scale. + * @remarks + * [Api set: ExcelApi 1.7] + */ + dateAxis = "DateAxis" + } + /** + * Specifies the bin type of a histogram chart or pareto chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum ChartBinType { + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + category = "Category", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + auto = "Auto", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + binWidth = "BinWidth", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + binCount = "BinCount" + } + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + enum ChartLineStyle { + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + none = "None", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + continuous = "Continuous", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + dash = "Dash", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + dashDot = "DashDot", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + dashDotDot = "DashDotDot", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + dot = "Dot", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + grey25 = "Grey25", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + grey50 = "Grey50", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + grey75 = "Grey75", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + automatic = "Automatic", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + roundDot = "RoundDot" + } + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + enum ChartDataLabelPosition { + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + invalid = "Invalid", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + none = "None", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + center = "Center", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + insideEnd = "InsideEnd", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + insideBase = "InsideBase", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + outsideEnd = "OutsideEnd", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + left = "Left", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + right = "Right", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + top = "Top", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + bottom = "Bottom", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + bestFit = "BestFit", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + callout = "Callout" + } + /** + * Represents which parts of the error bar to include. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum ChartErrorBarsInclude { + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + both = "Both", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + minusValues = "MinusValues", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + plusValues = "PlusValues" + } + /** + * Represents the range type for error bars. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum ChartErrorBarsType { + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + fixedValue = "FixedValue", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + percent = "Percent", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + stDev = "StDev", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + stError = "StError", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + custom = "Custom" + } + /** + * Represents the mapping level of a chart series. This only applies to region map charts. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum ChartMapAreaLevel { + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + automatic = "Automatic", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + dataOnly = "DataOnly", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + city = "City", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + county = "County", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + state = "State", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + country = "Country", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + continent = "Continent", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + world = "World" + } + /** + * Represents the gradient style of a chart series. This is only applicable for region map charts. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum ChartGradientStyle { + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + twoPhaseColor = "TwoPhaseColor", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + threePhaseColor = "ThreePhaseColor" + } + /** + * Represents the gradient style type of a chart series. This is only applicable for region map charts. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum ChartGradientStyleType { + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + extremeValue = "ExtremeValue", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + number = "Number", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + percent = "Percent" + } + /** + * Represents the position of the chart title. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + enum ChartTitlePosition { + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + automatic = "Automatic", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + top = "Top", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + bottom = "Bottom", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + left = "Left", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + right = "Right" + } + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + enum ChartLegendPosition { + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + invalid = "Invalid", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + top = "Top", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + bottom = "Bottom", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + left = "Left", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + right = "Right", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + corner = "Corner", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + custom = "Custom" + } + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + enum ChartMarkerStyle { + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + invalid = "Invalid", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + automatic = "Automatic", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + none = "None", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + square = "Square", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + diamond = "Diamond", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + triangle = "Triangle", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + x = "X", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + star = "Star", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + dot = "Dot", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + dash = "Dash", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + circle = "Circle", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + plus = "Plus", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + picture = "Picture" + } + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + enum ChartPlotAreaPosition { + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + automatic = "Automatic", + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + custom = "Custom" + } + /** + * Represents the region level of a chart series layout. This only applies to region map charts. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum ChartMapLabelStrategy { + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + none = "None", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + bestFit = "BestFit", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + showAll = "ShowAll" + } + /** + * Represents the region projection type of a chart series layout. This only applies to region map charts. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum ChartMapProjectionType { + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + automatic = "Automatic", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + mercator = "Mercator", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + miller = "Miller", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + robinson = "Robinson", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + albers = "Albers" + } + /** + * Represents the parent label strategy of the chart series layout. This only applies to treemap charts + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum ChartParentLabelStrategy { + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + none = "None", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + banner = "Banner", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + overlapping = "Overlapping" + } + /** + * Specifies whether the series are by rows or by columns. In Excel on desktop, the "auto" option will inspect the source data shape to automatically guess whether the data is by rows or columns. In Excel on the web, "auto" will simply default to "columns". + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + enum ChartSeriesBy { + /** + * In Excel on desktop, the "auto" option will inspect the source data shape to automatically guess whether the data is by rows or columns. In Excel on the web, "auto" will simply default to "columns". + * @remarks + * [Api set: ExcelApi 1.1] + */ + auto = "Auto", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + columns = "Columns", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + rows = "Rows" + } + /** + * Specifies the data source type of the chart series. + * + * @remarks + * [Api set: ExcelApi 1.15] + */ + enum ChartDataSourceType { + /** + * The data source type of the chart series is a local range. + * @remarks + * [Api set: ExcelApi 1.15] + */ + localRange = "LocalRange", + /** + * The data source type of the chart series is an external range. + * @remarks + * [Api set: ExcelApi 1.15] + */ + externalRange = "ExternalRange", + /** + * The data source type of the chart series is a list. + * @remarks + * [Api set: ExcelApi 1.15] + */ + list = "List", + /** + * The data source type of the chart series is unknown or unsupported. + * @remarks + * [Api set: ExcelApi 1.15] + */ + unknown = "Unknown" + } + /** + * Represents the horizontal alignment for the specified object. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + enum ChartTextHorizontalAlignment { + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + center = "Center", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + left = "Left", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + right = "Right", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + justify = "Justify", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + distributed = "Distributed" + } + /** + * Represents the vertical alignment for the specified object. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + enum ChartTextVerticalAlignment { + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + center = "Center", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + bottom = "Bottom", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + top = "Top", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + justify = "Justify", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + distributed = "Distributed" + } + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + enum ChartTickLabelAlignment { + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + center = "Center", + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + left = "Left", + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + right = "Right" + } + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + enum ChartType { + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + invalid = "Invalid", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + columnClustered = "ColumnClustered", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + columnStacked = "ColumnStacked", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + columnStacked100 = "ColumnStacked100", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + _3DColumnClustered = "3DColumnClustered", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + _3DColumnStacked = "3DColumnStacked", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + _3DColumnStacked100 = "3DColumnStacked100", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + barClustered = "BarClustered", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + barStacked = "BarStacked", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + barStacked100 = "BarStacked100", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + _3DBarClustered = "3DBarClustered", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + _3DBarStacked = "3DBarStacked", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + _3DBarStacked100 = "3DBarStacked100", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + lineStacked = "LineStacked", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + lineStacked100 = "LineStacked100", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + lineMarkers = "LineMarkers", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + lineMarkersStacked = "LineMarkersStacked", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + lineMarkersStacked100 = "LineMarkersStacked100", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + pieOfPie = "PieOfPie", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + pieExploded = "PieExploded", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + _3DPieExploded = "3DPieExploded", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + barOfPie = "BarOfPie", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + xyscatterSmooth = "XYScatterSmooth", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + xyscatterSmoothNoMarkers = "XYScatterSmoothNoMarkers", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + xyscatterLines = "XYScatterLines", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + xyscatterLinesNoMarkers = "XYScatterLinesNoMarkers", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + areaStacked = "AreaStacked", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + areaStacked100 = "AreaStacked100", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + _3DAreaStacked = "3DAreaStacked", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + _3DAreaStacked100 = "3DAreaStacked100", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + doughnutExploded = "DoughnutExploded", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + radarMarkers = "RadarMarkers", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + radarFilled = "RadarFilled", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + surface = "Surface", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + surfaceWireframe = "SurfaceWireframe", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + surfaceTopView = "SurfaceTopView", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + surfaceTopViewWireframe = "SurfaceTopViewWireframe", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + bubble = "Bubble", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + bubble3DEffect = "Bubble3DEffect", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + stockHLC = "StockHLC", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + stockOHLC = "StockOHLC", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + stockVHLC = "StockVHLC", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + stockVOHLC = "StockVOHLC", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + cylinderColClustered = "CylinderColClustered", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + cylinderColStacked = "CylinderColStacked", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + cylinderColStacked100 = "CylinderColStacked100", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + cylinderBarClustered = "CylinderBarClustered", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + cylinderBarStacked = "CylinderBarStacked", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + cylinderBarStacked100 = "CylinderBarStacked100", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + cylinderCol = "CylinderCol", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + coneColClustered = "ConeColClustered", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + coneColStacked = "ConeColStacked", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + coneColStacked100 = "ConeColStacked100", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + coneBarClustered = "ConeBarClustered", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + coneBarStacked = "ConeBarStacked", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + coneBarStacked100 = "ConeBarStacked100", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + coneCol = "ConeCol", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + pyramidColClustered = "PyramidColClustered", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + pyramidColStacked = "PyramidColStacked", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + pyramidColStacked100 = "PyramidColStacked100", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + pyramidBarClustered = "PyramidBarClustered", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + pyramidBarStacked = "PyramidBarStacked", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + pyramidBarStacked100 = "PyramidBarStacked100", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + pyramidCol = "PyramidCol", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + _3DColumn = "3DColumn", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + line = "Line", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + _3DLine = "3DLine", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + _3DPie = "3DPie", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + pie = "Pie", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + xyscatter = "XYScatter", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + _3DArea = "3DArea", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + area = "Area", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + doughnut = "Doughnut", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + radar = "Radar", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + histogram = "Histogram", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + boxwhisker = "Boxwhisker", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + pareto = "Pareto", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + regionMap = "RegionMap", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + treemap = "Treemap", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + waterfall = "Waterfall", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + sunburst = "Sunburst", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + funnel = "Funnel" + } + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + enum ChartUnderlineStyle { + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + none = "None", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + single = "Single" + } + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + enum ChartDisplayBlanksAs { + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + notPlotted = "NotPlotted", + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + zero = "Zero", + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + interplotted = "Interplotted" + } + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + enum ChartPlotBy { + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + rows = "Rows", + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + columns = "Columns" + } + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + enum ChartSplitType { + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + splitByPosition = "SplitByPosition", + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + splitByValue = "SplitByValue", + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + splitByPercentValue = "SplitByPercentValue", + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + splitByCustomSplit = "SplitByCustomSplit" + } + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + enum ChartColorScheme { + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + colorfulPalette1 = "ColorfulPalette1", + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + colorfulPalette2 = "ColorfulPalette2", + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + colorfulPalette3 = "ColorfulPalette3", + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + colorfulPalette4 = "ColorfulPalette4", + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + monochromaticPalette1 = "MonochromaticPalette1", + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + monochromaticPalette2 = "MonochromaticPalette2", + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + monochromaticPalette3 = "MonochromaticPalette3", + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + monochromaticPalette4 = "MonochromaticPalette4", + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + monochromaticPalette5 = "MonochromaticPalette5", + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + monochromaticPalette6 = "MonochromaticPalette6", + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + monochromaticPalette7 = "MonochromaticPalette7", + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + monochromaticPalette8 = "MonochromaticPalette8", + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + monochromaticPalette9 = "MonochromaticPalette9", + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + monochromaticPalette10 = "MonochromaticPalette10", + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + monochromaticPalette11 = "MonochromaticPalette11", + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + monochromaticPalette12 = "MonochromaticPalette12", + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + monochromaticPalette13 = "MonochromaticPalette13" + } + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + enum ChartTrendlineType { + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + linear = "Linear", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + exponential = "Exponential", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + logarithmic = "Logarithmic", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + movingAverage = "MovingAverage", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + polynomial = "Polynomial", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + power = "Power" + } + /** + * Specifies where in the z-order a shape should be moved relative to other shapes. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum ShapeZOrder { + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + bringToFront = "BringToFront", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + bringForward = "BringForward", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + sendToBack = "SendToBack", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + sendBackward = "SendBackward" + } + /** + * Specifies the type of a shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum ShapeType { + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + unsupported = "Unsupported", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + image = "Image", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + geometricShape = "GeometricShape", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + group = "Group", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + line = "Line" + } + /** + * Specifies whether the shape is scaled relative to its original or current size. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum ShapeScaleType { + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + currentSize = "CurrentSize", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + originalSize = "OriginalSize" + } + /** + * Specifies which part of the shape retains its position when the shape is scaled. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum ShapeScaleFrom { + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + scaleFromTopLeft = "ScaleFromTopLeft", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + scaleFromMiddle = "ScaleFromMiddle", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + scaleFromBottomRight = "ScaleFromBottomRight" + } + /** + * Specifies a shape's fill type. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum ShapeFillType { + /** + * No fill. + * @remarks + * [Api set: ExcelApi 1.9] + */ + noFill = "NoFill", + /** + * Solid fill. + * @remarks + * [Api set: ExcelApi 1.9] + */ + solid = "Solid", + /** + * Gradient fill. + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradient = "Gradient", + /** + * Pattern fill. + * @remarks + * [Api set: ExcelApi 1.9] + */ + pattern = "Pattern", + /** + * Picture and texture fill. + * @remarks + * [Api set: ExcelApi 1.9] + */ + pictureAndTexture = "PictureAndTexture", + /** + * Mixed fill. + * @remarks + * [Api set: ExcelApi 1.9] + */ + mixed = "Mixed" + } + /** + * The type of underline applied to a font. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum ShapeFontUnderlineStyle { + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + none = "None", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + single = "Single", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + double = "Double", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + heavy = "Heavy", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + dotted = "Dotted", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + dottedHeavy = "DottedHeavy", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + dash = "Dash", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + dashHeavy = "DashHeavy", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + dashLong = "DashLong", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + dashLongHeavy = "DashLongHeavy", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + dotDash = "DotDash", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + dotDashHeavy = "DotDashHeavy", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + dotDotDash = "DotDotDash", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + dotDotDashHeavy = "DotDotDashHeavy", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + wavy = "Wavy", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + wavyHeavy = "WavyHeavy", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + wavyDouble = "WavyDouble" + } + /** + * The format of the image. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum PictureFormat { + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + unknown = "UNKNOWN", + /** + * Bitmap image. + * @remarks + * [Api set: ExcelApi 1.9] + */ + bmp = "BMP", + /** + * Joint Photographic Experts Group. + * @remarks + * [Api set: ExcelApi 1.9] + */ + jpeg = "JPEG", + /** + * Graphics Interchange Format. + * @remarks + * [Api set: ExcelApi 1.9] + */ + gif = "GIF", + /** + * Portable Network Graphics. + * @remarks + * [Api set: ExcelApi 1.9] + */ + png = "PNG", + /** + * Scalable Vector Graphic. + * @remarks + * [Api set: ExcelApi 1.9] + */ + svg = "SVG" + } + /** + * The style for a line. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum ShapeLineStyle { + /** + * Single line. + * @remarks + * [Api set: ExcelApi 1.9] + */ + single = "Single", + /** + * Thick line with a thin line on each side. + * @remarks + * [Api set: ExcelApi 1.9] + */ + thickBetweenThin = "ThickBetweenThin", + /** + * Thick line next to thin line. For horizontal lines, the thick line is above the thin line. For vertical lines, the thick line is to the left of the thin line. + * @remarks + * [Api set: ExcelApi 1.9] + */ + thickThin = "ThickThin", + /** + * Thick line next to thin line. For horizontal lines, the thick line is below the thin line. For vertical lines, the thick line is to the right of the thin line. + * @remarks + * [Api set: ExcelApi 1.9] + */ + thinThick = "ThinThick", + /** + * Two thin lines. + * @remarks + * [Api set: ExcelApi 1.9] + */ + thinThin = "ThinThin" + } + /** + * The dash style for a line. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum ShapeLineDashStyle { + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + dash = "Dash", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + dashDot = "DashDot", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + dashDotDot = "DashDotDot", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + longDash = "LongDash", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + longDashDot = "LongDashDot", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + roundDot = "RoundDot", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + solid = "Solid", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + squareDot = "SquareDot", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + longDashDotDot = "LongDashDotDot", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + systemDash = "SystemDash", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + systemDot = "SystemDot", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + systemDashDot = "SystemDashDot" + } + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum ArrowheadLength { + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + short = "Short", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + medium = "Medium", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + long = "Long" + } + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum ArrowheadStyle { + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + none = "None", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + triangle = "Triangle", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + stealth = "Stealth", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + diamond = "Diamond", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + oval = "Oval", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + open = "Open" + } + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum ArrowheadWidth { + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + narrow = "Narrow", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + medium = "Medium", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + wide = "Wide" + } + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + enum BindingType { + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + range = "Range", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + table = "Table", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + text = "Text" + } + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + enum BorderIndex { + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + edgeTop = "EdgeTop", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + edgeBottom = "EdgeBottom", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + edgeLeft = "EdgeLeft", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + edgeRight = "EdgeRight", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + insideVertical = "InsideVertical", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + insideHorizontal = "InsideHorizontal", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + diagonalDown = "DiagonalDown", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + diagonalUp = "DiagonalUp" + } + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + enum BorderLineStyle { + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + none = "None", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + continuous = "Continuous", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + dash = "Dash", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + dashDot = "DashDot", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + dashDotDot = "DashDotDot", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + dot = "Dot", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + double = "Double", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + slantDashDot = "SlantDashDot" + } + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + enum BorderWeight { + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + hairline = "Hairline", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + thin = "Thin", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + medium = "Medium", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + thick = "Thick" + } + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + enum CalculationMode { + /** + * The default recalculation behavior where Excel calculates new formula results every time the relevant data is changed. + * @remarks + * [Api set: ExcelApi 1.1] + */ + automatic = "Automatic", + /** + * Calculates new formula results every time the relevant data is changed, unless the formula is in a data table. + * @remarks + * [Api set: ExcelApi 1.1] + */ + automaticExceptTables = "AutomaticExceptTables", + /** + * Calculations only occur when the user or add-in requests them. + * @remarks + * [Api set: ExcelApi 1.1] + */ + manual = "Manual" + } + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + enum CalculationType { + /** + * Recalculates all cells that Excel has marked as dirty, that is, dependents of volatile or changed data, and cells programmatically marked as dirty. + * @remarks + * [Api set: ExcelApi 1.1] + */ + recalculate = "Recalculate", + /** + * This will mark all cells as dirty and then recalculate them. + * @remarks + * [Api set: ExcelApi 1.1] + */ + full = "Full", + /** + * This will rebuild the full dependency chain, mark all cells as dirty and then recalculate them. + * @remarks + * [Api set: ExcelApi 1.1] + */ + fullRebuild = "FullRebuild" + } + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + enum ClearApplyTo { + /** + * Clears everything in the range. + * @remarks + * [Api set: ExcelApi 1.1] + */ + all = "All", + /** + * Clears all formatting for the range, leaving values intact. + * @remarks + * [Api set: ExcelApi 1.1] + */ + formats = "Formats", + /** + * Clears the contents of the range, leaving formatting intact. + * @remarks + * [Api set: ExcelApi 1.1] + */ + contents = "Contents", + /** + * Clears all hyperlinks, but leaves all content and formatting intact. + * @remarks + * [Api set: ExcelApi 1.7] + */ + hyperlinks = "Hyperlinks", + /** + * Removes hyperlinks and formatting for the cell but leaves content, conditional formats, and data validation intact. + * @remarks + * [Api set: ExcelApi 1.7] + */ + removeHyperlinks = "RemoveHyperlinks", + /** + * Sets all cells in the range to their default state. + Cells with cell controls are set to the default value defined by each control. + Cells without cell controls are set to blank. + * @remarks + * [Api set: ExcelApi 1.18] + */ + resetContents = "ResetContents" + } + /** + * Represents the format options for a data bar axis. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + enum ConditionalDataBarAxisFormat { + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + automatic = "Automatic", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + none = "None", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + cellMidPoint = "CellMidPoint" + } + /** + * Represents the data bar direction within a cell. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + enum ConditionalDataBarDirection { + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + context = "Context", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + leftToRight = "LeftToRight", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + rightToLeft = "RightToLeft" + } + /** + * Represents the direction for a selection. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + enum ConditionalFormatDirection { + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + top = "Top", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + bottom = "Bottom" + } + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + enum ConditionalFormatType { + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + custom = "Custom", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + dataBar = "DataBar", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + colorScale = "ColorScale", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + iconSet = "IconSet", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + topBottom = "TopBottom", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + presetCriteria = "PresetCriteria", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + containsText = "ContainsText", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + cellValue = "CellValue" + } + /** + * Represents the types of conditional format values. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + enum ConditionalFormatRuleType { + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + invalid = "Invalid", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + automatic = "Automatic", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + lowestValue = "LowestValue", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + highestValue = "HighestValue", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + number = "Number", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + percent = "Percent", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + formula = "Formula", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + percentile = "Percentile" + } + /** + * Represents the types of icon conditional format. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + enum ConditionalFormatIconRuleType { + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + invalid = "Invalid", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + number = "Number", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + percent = "Percent", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + formula = "Formula", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + percentile = "Percentile" + } + /** + * Represents the types of color criterion for conditional formatting. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + enum ConditionalFormatColorCriterionType { + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + invalid = "Invalid", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + lowestValue = "LowestValue", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + highestValue = "HighestValue", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + number = "Number", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + percent = "Percent", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + formula = "Formula", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + percentile = "Percentile" + } + /** + * Represents the criteria for the above/below average conditional format type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + enum ConditionalTopBottomCriterionType { + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + invalid = "Invalid", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + topItems = "TopItems", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + topPercent = "TopPercent", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + bottomItems = "BottomItems", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + bottomPercent = "BottomPercent" + } + /** + * Represents the criteria of the preset criteria conditional format type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + enum ConditionalFormatPresetCriterion { + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + invalid = "Invalid", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + blanks = "Blanks", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + nonBlanks = "NonBlanks", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + errors = "Errors", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + nonErrors = "NonErrors", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + yesterday = "Yesterday", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + today = "Today", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + tomorrow = "Tomorrow", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + lastSevenDays = "LastSevenDays", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + lastWeek = "LastWeek", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + thisWeek = "ThisWeek", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + nextWeek = "NextWeek", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + lastMonth = "LastMonth", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + thisMonth = "ThisMonth", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + nextMonth = "NextMonth", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + aboveAverage = "AboveAverage", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + belowAverage = "BelowAverage", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + equalOrAboveAverage = "EqualOrAboveAverage", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + equalOrBelowAverage = "EqualOrBelowAverage", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + oneStdDevAboveAverage = "OneStdDevAboveAverage", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + oneStdDevBelowAverage = "OneStdDevBelowAverage", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + twoStdDevAboveAverage = "TwoStdDevAboveAverage", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + twoStdDevBelowAverage = "TwoStdDevBelowAverage", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + threeStdDevAboveAverage = "ThreeStdDevAboveAverage", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + threeStdDevBelowAverage = "ThreeStdDevBelowAverage", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + uniqueValues = "UniqueValues", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + duplicateValues = "DuplicateValues" + } + /** + * Represents the operator of the text conditional format type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + enum ConditionalTextOperator { + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + invalid = "Invalid", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + contains = "Contains", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + notContains = "NotContains", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + beginsWith = "BeginsWith", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + endsWith = "EndsWith" + } + /** + * Represents the operator of the text conditional format type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + enum ConditionalCellValueOperator { + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + invalid = "Invalid", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + between = "Between", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + notBetween = "NotBetween", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + equalTo = "EqualTo", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + notEqualTo = "NotEqualTo", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + greaterThan = "GreaterThan", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + lessThan = "LessThan", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + greaterThanOrEqual = "GreaterThanOrEqual", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + lessThanOrEqual = "LessThanOrEqual" + } + /** + * Represents the operator for each icon criteria. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + enum ConditionalIconCriterionOperator { + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + invalid = "Invalid", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + greaterThan = "GreaterThan", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + greaterThanOrEqual = "GreaterThanOrEqual" + } + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + enum ConditionalRangeBorderIndex { + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + edgeTop = "EdgeTop", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + edgeBottom = "EdgeBottom", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + edgeLeft = "EdgeLeft", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + edgeRight = "EdgeRight" + } + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + enum ConditionalRangeBorderLineStyle { + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + none = "None", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + continuous = "Continuous", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + dash = "Dash", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + dashDot = "DashDot", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + dashDotDot = "DashDotDot", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + dot = "Dot" + } + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + enum ConditionalRangeFontUnderlineStyle { + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + none = "None", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + single = "Single", + /** + * @remarks + * [Api set: ExcelApi 1.6] + */ + double = "Double" + } + /** + * Represents the data validation type enum. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + enum DataValidationType { + /** + * None means allow any value, indicating that there is no data validation in the range. + * @remarks + * [Api set: ExcelApi 1.8] + */ + none = "None", + /** + * The whole number data validation type. + * @remarks + * [Api set: ExcelApi 1.8] + */ + wholeNumber = "WholeNumber", + /** + * The decimal data validation type. + * @remarks + * [Api set: ExcelApi 1.8] + */ + decimal = "Decimal", + /** + * The list data validation type. + * @remarks + * [Api set: ExcelApi 1.8] + */ + list = "List", + /** + * The date data validation type. + * @remarks + * [Api set: ExcelApi 1.8] + */ + date = "Date", + /** + * The time data validation type. + * @remarks + * [Api set: ExcelApi 1.8] + */ + time = "Time", + /** + * The text length data validation type. + * @remarks + * [Api set: ExcelApi 1.8] + */ + textLength = "TextLength", + /** + * The custom data validation type. + * @remarks + * [Api set: ExcelApi 1.8] + */ + custom = "Custom", + /** + * Inconsistent means that the range has inconsistent data validation, indicating that there are different rules on different cells. + * @remarks + * [Api set: ExcelApi 1.8] + */ + inconsistent = "Inconsistent", + /** + * Mixed criteria means that the range has data validation present on some but not all cells. + * @remarks + * [Api set: ExcelApi 1.8] + */ + mixedCriteria = "MixedCriteria" + } + /** + * Represents the data validation operator enum. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + enum DataValidationOperator { + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + between = "Between", + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + notBetween = "NotBetween", + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + equalTo = "EqualTo", + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + notEqualTo = "NotEqualTo", + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + greaterThan = "GreaterThan", + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + lessThan = "LessThan", + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + greaterThanOrEqualTo = "GreaterThanOrEqualTo", + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + lessThanOrEqualTo = "LessThanOrEqualTo" + } + /** + * Represents the data validation error alert style. The default is `Stop`. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + enum DataValidationAlertStyle { + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + stop = "Stop", + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + warning = "Warning", + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + information = "Information" + } + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + enum DeleteShiftDirection { + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + up = "Up", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + left = "Left" + } + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + enum DynamicFilterCriteria { + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + unknown = "Unknown", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + aboveAverage = "AboveAverage", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + allDatesInPeriodApril = "AllDatesInPeriodApril", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + allDatesInPeriodAugust = "AllDatesInPeriodAugust", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + allDatesInPeriodDecember = "AllDatesInPeriodDecember", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + allDatesInPeriodFebruray = "AllDatesInPeriodFebruray", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + allDatesInPeriodJanuary = "AllDatesInPeriodJanuary", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + allDatesInPeriodJuly = "AllDatesInPeriodJuly", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + allDatesInPeriodJune = "AllDatesInPeriodJune", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + allDatesInPeriodMarch = "AllDatesInPeriodMarch", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + allDatesInPeriodMay = "AllDatesInPeriodMay", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + allDatesInPeriodNovember = "AllDatesInPeriodNovember", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + allDatesInPeriodOctober = "AllDatesInPeriodOctober", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + allDatesInPeriodQuarter1 = "AllDatesInPeriodQuarter1", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + allDatesInPeriodQuarter2 = "AllDatesInPeriodQuarter2", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + allDatesInPeriodQuarter3 = "AllDatesInPeriodQuarter3", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + allDatesInPeriodQuarter4 = "AllDatesInPeriodQuarter4", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + allDatesInPeriodSeptember = "AllDatesInPeriodSeptember", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + belowAverage = "BelowAverage", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + lastMonth = "LastMonth", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + lastQuarter = "LastQuarter", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + lastWeek = "LastWeek", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + lastYear = "LastYear", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + nextMonth = "NextMonth", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + nextQuarter = "NextQuarter", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + nextWeek = "NextWeek", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + nextYear = "NextYear", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + thisMonth = "ThisMonth", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + thisQuarter = "ThisQuarter", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + thisWeek = "ThisWeek", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + thisYear = "ThisYear", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + today = "Today", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + tomorrow = "Tomorrow", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + yearToDate = "YearToDate", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + yesterday = "Yesterday" + } + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + enum FilterDatetimeSpecificity { + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + year = "Year", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + month = "Month", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + day = "Day", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + hour = "Hour", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + minute = "Minute", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + second = "Second" + } + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + enum FilterOn { + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + bottomItems = "BottomItems", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + bottomPercent = "BottomPercent", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + cellColor = "CellColor", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + dynamic = "Dynamic", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + fontColor = "FontColor", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + values = "Values", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + topItems = "TopItems", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + topPercent = "TopPercent", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + icon = "Icon", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + custom = "Custom" + } + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + enum FilterOperator { + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + and = "And", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + or = "Or" + } + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + enum HorizontalAlignment { + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + general = "General", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + left = "Left", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + center = "Center", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + right = "Right", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + fill = "Fill", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + justify = "Justify", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + centerAcrossSelection = "CenterAcrossSelection", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + distributed = "Distributed" + } + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + enum IconSet { + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + invalid = "Invalid", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + threeArrows = "ThreeArrows", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + threeArrowsGray = "ThreeArrowsGray", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + threeFlags = "ThreeFlags", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + threeTrafficLights1 = "ThreeTrafficLights1", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + threeTrafficLights2 = "ThreeTrafficLights2", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + threeSigns = "ThreeSigns", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + threeSymbols = "ThreeSymbols", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + threeSymbols2 = "ThreeSymbols2", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + fourArrows = "FourArrows", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + fourArrowsGray = "FourArrowsGray", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + fourRedToBlack = "FourRedToBlack", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + fourRating = "FourRating", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + fourTrafficLights = "FourTrafficLights", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + fiveArrows = "FiveArrows", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + fiveArrowsGray = "FiveArrowsGray", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + fiveRating = "FiveRating", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + fiveQuarters = "FiveQuarters", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + threeStars = "ThreeStars", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + threeTriangles = "ThreeTriangles", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + fiveBoxes = "FiveBoxes" + } + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + enum ImageFittingMode { + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + fit = "Fit", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + fitAndCenter = "FitAndCenter", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + fill = "Fill" + } + /** + * Determines the direction in which existing cells will be shifted to accommodate what is being inserted. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + enum InsertShiftDirection { + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + down = "Down", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + right = "Right" + } + /** + * @remarks + * [Api set: ExcelApi 1.4] + */ + enum NamedItemScope { + /** + * @remarks + * [Api set: ExcelApi 1.4] + */ + worksheet = "Worksheet", + /** + * @remarks + * [Api set: ExcelApi 1.4] + */ + workbook = "Workbook" + } + /** + * @remarks + * [Api set: ExcelApi 1.1 for String,Integer,Double,Boolean,Range,Error; 1.7 for Array] + */ + enum NamedItemType { + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + string = "String", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + integer = "Integer", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + double = "Double", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + boolean = "Boolean", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + range = "Range", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + error = "Error", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + array = "Array" + } + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + enum RangeUnderlineStyle { + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + none = "None", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + single = "Single", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + double = "Double", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + singleAccountant = "SingleAccountant", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + doubleAccountant = "DoubleAccountant" + } + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + enum SheetVisibility { + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + visible = "Visible", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + hidden = "Hidden", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + veryHidden = "VeryHidden" + } + /** + * @remarks + * [Api set: ExcelApi 1.14] + */ + enum EventTriggerSource { + /** + * The event trigger source is unknown or currently unsupported. + * @remarks + * [Api set: ExcelApi 1.14] + */ + unknown = "Unknown", + /** + * The event is triggered by the Office JS API of the current add-in. + * @remarks + * [Api set: ExcelApi 1.14] + */ + thisLocalAddin = "ThisLocalAddin" + } + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + enum RangeValueType { + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + unknown = "Unknown", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + empty = "Empty", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + string = "String", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + integer = "Integer", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + double = "Double", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + boolean = "Boolean", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + error = "Error", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + richValue = "RichValue" + } + /** + * @remarks + * [Api set: ExcelApi 1.13] + */ + enum KeyboardDirection { + /** + * @remarks + * [Api set: ExcelApi 1.13] + */ + left = "Left", + /** + * @remarks + * [Api set: ExcelApi 1.13] + */ + right = "Right", + /** + * @remarks + * [Api set: ExcelApi 1.13] + */ + up = "Up", + /** + * @remarks + * [Api set: ExcelApi 1.13] + */ + down = "Down" + } + /** + * Specifies the search direction. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum SearchDirection { + /** + * Search in forward order. + * @remarks + * [Api set: ExcelApi 1.9] + */ + forward = "Forward", + /** + * Search in reverse order. + * @remarks + * [Api set: ExcelApi 1.9] + */ + backwards = "Backwards" + } + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + enum SortOrientation { + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + rows = "Rows", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + columns = "Columns" + } + /** + * Represents the part of the cell used as the sorting criteria. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + enum SortOn { + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + value = "Value", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + cellColor = "CellColor", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + fontColor = "FontColor", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + icon = "Icon" + } + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + enum SortDataOption { + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + normal = "Normal", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + textAsNumber = "TextAsNumber" + } + /** + * Represents the ordering method to be used when sorting Chinese characters. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + enum SortMethod { + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + pinYin = "PinYin", + /** + * @remarks + * [Api set: ExcelApi 1.2] + */ + strokeCount = "StrokeCount" + } + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + enum VerticalAlignment { + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + top = "Top", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + center = "Center", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + bottom = "Bottom", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + justify = "Justify", + /** + * @remarks + * [Api set: ExcelApi 1.1] + */ + distributed = "Distributed" + } + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + enum DocumentPropertyType { + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + number = "Number", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + boolean = "Boolean", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + date = "Date", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + string = "String", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + float = "Float" + } + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + enum EventSource { + /** + * Local means the event comes from a local user session. + * @remarks + * [Api set: ExcelApi 1.7] + */ + local = "Local", + /** + * Remote means the event comes from a remote user session. + * @remarks + * [Api set: ExcelApi 1.7] + */ + remote = "Remote" + } + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + enum DataChangeType { + /** + * `Unknown` indicates that the type of data change is not one of the listed types. + * @remarks + * [Api set: ExcelApi 1.8. The name of this value was 'Others' in ExcelApi 1.7] + */ + unknown = "Unknown", + /** + * `RangeEdited` indicates that the data change event is triggered by a range being edited. + * @remarks + * [Api set: ExcelApi 1.7] + */ + rangeEdited = "RangeEdited", + /** + * `RowInserted` indicates that the data change event is triggered by inserting new rows. + * @remarks + * [Api set: ExcelApi 1.7] + */ + rowInserted = "RowInserted", + /** + * `RowDeleted` indicates that the data change event is triggered by deleting rows. + * @remarks + * [Api set: ExcelApi 1.7] + */ + rowDeleted = "RowDeleted", + /** + * `ColumnInserted` indicates that the data change event is triggered by inserting new columns. + * @remarks + * [Api set: ExcelApi 1.7] + */ + columnInserted = "ColumnInserted", + /** + * `ColumnDeleted` indicates that the data change event is triggered by deleting columns. + * @remarks + * [Api set: ExcelApi 1.7] + */ + columnDeleted = "ColumnDeleted", + /** + * `CellInserted` indicates that the data change event is triggered by inserting new cells. + * @remarks + * [Api set: ExcelApi 1.7] + */ + cellInserted = "CellInserted", + /** + * `CellDeleted` indicates that the data change event is triggered by deleting cells. + * @remarks + * [Api set: ExcelApi 1.7] + */ + cellDeleted = "CellDeleted" + } + /** + * @remarks + * [Api set: ExcelApi 1.11] + */ + enum RowHiddenChangeType { + /** + * `Unhidden` indicates that the row is not hidden. + * @remarks + * [Api set: ExcelApi 1.11] + */ + unhidden = "Unhidden", + /** + * `Hidden` indicates that the row is hidden. + * @remarks + * [Api set: ExcelApi 1.11] + */ + hidden = "Hidden" + } + /** + * Represents how the comments in the event were changed. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + enum CommentChangeType { + /** + * Comments were edited. + * @remarks + * [Api set: ExcelApi 1.12] + */ + commentEdited = "CommentEdited", + /** + * Comments were resolved. + * @remarks + * [Api set: ExcelApi 1.12] + */ + commentResolved = "CommentResolved", + /** + * Comments were reopened. + * @remarks + * [Api set: ExcelApi 1.12] + */ + commentReopened = "CommentReopened", + /** + * Replies were added. + * @remarks + * [Api set: ExcelApi 1.12] + */ + replyAdded = "ReplyAdded", + /** + * Replies were deleted. + * @remarks + * [Api set: ExcelApi 1.12] + */ + replyDeleted = "ReplyDeleted", + /** + * Replies were edited. + * @remarks + * [Api set: ExcelApi 1.12] + */ + replyEdited = "ReplyEdited" + } + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + enum EventType { + /** + * `WorksheetChanged` represents the type of event registered on a `Worksheet` or `WorksheetCollection` and occurs when data changes. + * @remarks + * [Api set: ExcelApi 1.7] + */ + worksheetChanged = "WorksheetChanged", + /** + * `WorksheetSelectionChanged` represents the type of event registered on a `Worksheet` and occurs when the selection changes. + * @remarks + * [Api set: ExcelApi 1.7] + */ + worksheetSelectionChanged = "WorksheetSelectionChanged", + /** + * `WorksheetAdded` represents the type of event registered on a `WorksheetCollection` and occurs when a new worksheet is added to the workbook. + * @remarks + * [Api set: ExcelApi 1.7] + */ + worksheetAdded = "WorksheetAdded", + /** + * `WorksheetActivated` represents the type of event registered on a `Worksheet` or `WorksheetCollection` and occurs when a worksheet activates. + * @remarks + * [Api set: ExcelApi 1.7] + */ + worksheetActivated = "WorksheetActivated", + /** + * `WorksheetDeactivated` represents the type of event registered on a `Worksheet` or `WorksheetCollection` and occurs when a worksheet deactivates. + * @remarks + * [Api set: ExcelApi 1.7] + */ + worksheetDeactivated = "WorksheetDeactivated", + /** + * `TableChanged` represents the type of event registered on a `Table` and occurs when data changes. + * @remarks + * [Api set: ExcelApi 1.7] + */ + tableChanged = "TableChanged", + /** + * `TableSelectionChanged` represents the type of event registered on a `Table` and occurs when the selection changes. + * @remarks + * [Api set: ExcelApi 1.7] + */ + tableSelectionChanged = "TableSelectionChanged", + /** + * `WorksheetDeleted` represents the type of event registered on a `WorksheetCollection` and occurs when a worksheet is deleted from the workbook. + * @remarks + * [Api set: ExcelApi 1.7] + */ + worksheetDeleted = "WorksheetDeleted", + /** + * `ChartAdded` represents the type of event registered on a `ChartCollection` and occurs when a new chart is added to the worksheet. + * @remarks + * [Api set: ExcelApi 1.7] + */ + chartAdded = "ChartAdded", + /** + * `ChartActivated` represents the type of event registered on a `Chart` or `ChartCollection` and occurs when a chart activates. + * @remarks + * [Api set: ExcelApi 1.7] + */ + chartActivated = "ChartActivated", + /** + * `ChartDeactivated` represents the type of event registered on a `Chart` or `ChartCollection` and occurs when a chart deactivates. + * @remarks + * [Api set: ExcelApi 1.7] + */ + chartDeactivated = "ChartDeactivated", + /** + * `ChartDeleted` represents the type of event registered on a `ChartCollection` and occurs when a chart is deleted from the worksheet. + * @remarks + * [Api set: ExcelApi 1.7] + */ + chartDeleted = "ChartDeleted", + /** + * `WorksheetCalculated` represents the type of event registered on a `Worksheet` or `WorksheetCollection` and occurs when a worksheet is calculated. + * @remarks + * [Api set: ExcelApi 1.7] + */ + worksheetCalculated = "WorksheetCalculated", + /** + * `VisualSelectionChanged` represents the type of event registered on a `VisualCollection` and occurs when the visual selection changes. + * @remarks + * [Api set: ExcelApi 1.7] + */ + visualSelectionChanged = "VisualSelectionChanged", + /** + * `TableAdded` represents the type of event registered on a `TableCollection` and occurs when a table is added. + * @remarks + * [Api set: ExcelApi 1.7] + */ + tableAdded = "TableAdded", + /** + * `TableDeleted` represents the type of event that is registered on a `TableCollection` and occurs when a table is deleted. + * @remarks + * [Api set: ExcelApi 1.7] + */ + tableDeleted = "TableDeleted", + /** + * `TableFiltered` represents the type of event registered on a table or `TableCollection` and occurs when the data of a table is filtered. + * @remarks + * [Api set: ExcelApi 1.7] + */ + tableFiltered = "TableFiltered", + /** + * `WorksheetFiltered` represents the type of event registered on a worksheet or `WorksheetCollection` and occurs when the data of an AutoFilter in the worksheet is filtered. + * @remarks + * [Api set: ExcelApi 1.7] + */ + worksheetFiltered = "WorksheetFiltered", + /** + * `ShapeActivated` represents the type of event that is registered on a `Shape` and occurs when the shape activates. + * @remarks + * [Api set: ExcelApi 1.7] + */ + shapeActivated = "ShapeActivated", + /** + * `ShapeDeactivated` represents the type of event that is registered on a `Shape` and occurs when the shape deactivates. + * @remarks + * [Api set: ExcelApi 1.7] + */ + shapeDeactivated = "ShapeDeactivated", + /** + * `VisualChange` represents the type of event registered on a `Visual` and occurs when there is a visual change. + * @remarks + * [Api set: ExcelApi 1.7] + */ + visualChange = "VisualChange", + /** + * `WorkbookAutoSaveSettingChanged` represents the type of event registered on a workbook and occurs when there is an auto save setting change. + * @remarks + * [Api set: ExcelApi 1.7] + */ + workbookAutoSaveSettingChanged = "WorkbookAutoSaveSettingChanged", + /** + * `WorksheetFormatChanged` represents the type of event registered on a worksheet and occurs when a format is changed. + * @remarks + * [Api set: ExcelApi 1.7] + */ + worksheetFormatChanged = "WorksheetFormatChanged", + /** + * `RibbonCommandExecuted` represents the type of event registered on the ribbon and occurs when a user clicks on the ribbon + * @remarks + * [Api set: ExcelApi 1.7] + */ + ribbonCommandExecuted = "RibbonCommandExecuted", + /** + * `WorksheetRowSorted` represents the type of event registered on a worksheet and occurs when rows are sorted. + * @remarks + * [Api set: ExcelApi 1.7] + */ + worksheetRowSorted = "WorksheetRowSorted", + /** + * `WorksheetColumnSorted` represents the type of event registered on a worksheet and occurs columns are sorted. + * @remarks + * [Api set: ExcelApi 1.7] + */ + worksheetColumnSorted = "WorksheetColumnSorted", + /** + * `WorksheetSingleClicked` represents the type of event registered on a worksheet and occurs when a cell is left-clicked or tapped. + * @remarks + * [Api set: ExcelApi 1.7] + */ + worksheetSingleClicked = "WorksheetSingleClicked", + /** + * `WorksheetRowHiddenChanged` represents the type of event registered on a worksheet and occurs when a row's hidden state is changed. + * @remarks + * [Api set: ExcelApi 1.7] + */ + worksheetRowHiddenChanged = "WorksheetRowHiddenChanged", + /** + * `CommentAdded` represents the type of event that is registered on a comment collection and occurs when comments are added. + * @remarks + * [Api set: ExcelApi 1.7] + */ + commentAdded = "CommentAdded", + /** + * `CommentDeleted` represents the type of event that is registered on a comment collection and occurs when comments are deleted. + * @remarks + * [Api set: ExcelApi 1.7] + */ + commentDeleted = "CommentDeleted", + /** + * `CommentChanged` represents the type of event that is registered on a comment collection and occurs when comments are changed. + * @remarks + * [Api set: ExcelApi 1.7] + */ + commentChanged = "CommentChanged", + /** + * `RefreshRequestCompleted` represents the type of event registered on a `LinkedDataType` and occurs when a request to refresh a data source is completed. + * @remarks + * [Api set: ExcelApi 1.7] + */ + linkedDataTypeRefreshRequestCompleted = "LinkedDataTypeRefreshRequestCompleted", + /** + * `RefreshModeChanged` represents the type of event registered on a `LinkedDataType` and occurs when the linked data type refresh mode is changed. + * @remarks + * [Api set: ExcelApi 1.7] + */ + linkedDataTypeRefreshModeChanged = "LinkedDataTypeRefreshModeChanged", + /** + * `LinkedDataTypeAdded` represents the type of event registered on a `LinkedDataType` and occurs when a new linked data type is added to the workbook. + * @remarks + * [Api set: ExcelApi 1.7] + */ + linkedDataTypeLinkedDataTypeAdded = "LinkedDataTypeLinkedDataTypeAdded", + /** + * `WorksheetFormulaChanged` represents the type of event registered on a worksheet and occurs when a formula is changed. + * @remarks + * [Api set: ExcelApi 1.7] + */ + worksheetFormulaChanged = "WorksheetFormulaChanged", + /** + * `WorkbookActivated` represents the type of event which is fired when a workbook is activated. + * @remarks + * [Api set: ExcelApi 1.7] + */ + workbookActivated = "WorkbookActivated", + /** + * `WorkbookLinksChanged` represents the type of event which is fired when a workbook link is changed. + * @remarks + * [Api set: ExcelApi 1.7] + */ + linkedWorkbookWorkbookLinksChanged = "LinkedWorkbookWorkbookLinksChanged", + /** + * `WorkbookLinksRefreshCompleted` represents the type of event registered on a linked Workbook and occurs when a linked workbook completes a refresh. + * @remarks + * [Api set: ExcelApi 1.7] + */ + linkedWorkbookRefreshCompleted = "LinkedWorkbookRefreshCompleted", + /** + * WorksheetProtectionChanged represents the type of event registered on worksheet, and occurs when protection status is changed. + * @remarks + * [Api set: ExcelApi 1.7] + */ + worksheetProtectionChanged = "WorksheetProtectionChanged", + /** + * WorksheetNameChanged represents the type of event registered on a worksheet that occurs when its name changes. + * @remarks + * [Api set: ExcelApi 1.7] + */ + worksheetNameChanged = "WorksheetNameChanged", + /** + * WorksheetVisibilityChanged represents the type of event registered on a worksheet that occurs when its visibility changes. + * @remarks + * [Api set: ExcelApi 1.7] + */ + worksheetVisibilityChanged = "WorksheetVisibilityChanged", + /** + * WorksheetMoved represents the type of event registered on a worksheet that occurs when it is moved within a workbook. + * @remarks + * [Api set: ExcelApi 1.7] + */ + worksheetMoved = "WorksheetMoved", + /** + * LinkedEntityDataDomainAdded represents the type of event registered when a new linked entity data domain is added to the workbook. + * @remarks + * [Api set: ExcelApi 1.19] + */ + linkedEntityDataDomainLinkedEntityDataDomainAdded = "LinkedEntityDataDomainLinkedEntityDataDomainAdded", + /** + * LinkedEntityDataDomainRefreshCompleted represents the type of event registered when the request to refresh `LinkedEntityCellValue` objects of a linked entity data domain is completed. + * @remarks + * [Api set: ExcelApi 1.19] + */ + linkedEntityDataDomainRefreshCompleted = "LinkedEntityDataDomainRefreshCompleted", + /** + * LinkedEntityDataDomainRefreshModeChanged represents the type of event registered when the `refreshMode` of a linked entity data domain is changed. + * @remarks + * [Api set: ExcelApi 1.19] + */ + linkedEntityDataDomainRefreshModeChanged = "LinkedEntityDataDomainRefreshModeChanged" + } + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + enum DocumentPropertyItem { + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + title = "Title", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + subject = "Subject", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + author = "Author", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + keywords = "Keywords", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + comments = "Comments", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + template = "Template", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + lastAuth = "LastAuth", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + revision = "Revision", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + appName = "AppName", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + lastPrint = "LastPrint", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + creation = "Creation", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + lastSave = "LastSave", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + category = "Category", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + format = "Format", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + manager = "Manager", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + company = "Company" + } + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + enum SubtotalLocationType { + /** + * Subtotals are at the top. + * @remarks + * [Api set: ExcelApi 1.8] + */ + atTop = "AtTop", + /** + * Subtotals are at the bottom. + * @remarks + * [Api set: ExcelApi 1.8] + */ + atBottom = "AtBottom", + /** + * Subtotals are off. + * @remarks + * [Api set: ExcelApi 1.8] + */ + off = "Off" + } + /** + * @remarks + * [Api set: ExcelApi 1.8] + */ + enum PivotLayoutType { + /** + * A horizontally compressed form with labels from the next field in the same column. + * @remarks + * [Api set: ExcelApi 1.8] + */ + compact = "Compact", + /** + * Inner fields' items are always on a new line relative to the outer fields' items. + * @remarks + * [Api set: ExcelApi 1.8] + */ + tabular = "Tabular", + /** + * Inner fields' items are on same row as outer fields' items and subtotals are always on the bottom. + * @remarks + * [Api set: ExcelApi 1.8] + */ + outline = "Outline" + } + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + enum ProtectionSelectionMode { + /** + * Selection is allowed for all cells. + * @remarks + * [Api set: ExcelApi 1.7] + */ + normal = "Normal", + /** + * Selection is allowed only for cells that are not locked. + * @remarks + * [Api set: ExcelApi 1.7] + */ + unlocked = "Unlocked", + /** + * Selection is not allowed for any cells. + * @remarks + * [Api set: ExcelApi 1.7] + */ + none = "None" + } + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + enum PageOrientation { + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + portrait = "Portrait", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + landscape = "Landscape" + } + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum PaperType { + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + letter = "Letter", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + letterSmall = "LetterSmall", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + tabloid = "Tabloid", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + ledger = "Ledger", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + legal = "Legal", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + statement = "Statement", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + executive = "Executive", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + a3 = "A3", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + a4 = "A4", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + a4Small = "A4Small", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + a5 = "A5", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + b4 = "B4", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + b5 = "B5", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + folio = "Folio", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + quatro = "Quatro", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + paper10x14 = "Paper10x14", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + paper11x17 = "Paper11x17", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + note = "Note", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + envelope9 = "Envelope9", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + envelope10 = "Envelope10", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + envelope11 = "Envelope11", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + envelope12 = "Envelope12", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + envelope14 = "Envelope14", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + csheet = "Csheet", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + dsheet = "Dsheet", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + esheet = "Esheet", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + envelopeDL = "EnvelopeDL", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + envelopeC5 = "EnvelopeC5", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + envelopeC3 = "EnvelopeC3", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + envelopeC4 = "EnvelopeC4", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + envelopeC6 = "EnvelopeC6", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + envelopeC65 = "EnvelopeC65", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + envelopeB4 = "EnvelopeB4", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + envelopeB5 = "EnvelopeB5", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + envelopeB6 = "EnvelopeB6", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + envelopeItaly = "EnvelopeItaly", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + envelopeMonarch = "EnvelopeMonarch", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + envelopePersonal = "EnvelopePersonal", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + fanfoldUS = "FanfoldUS", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + fanfoldStdGerman = "FanfoldStdGerman", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + fanfoldLegalGerman = "FanfoldLegalGerman" + } + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + enum ReadingOrder { + /** + * Reading order is determined by the language of the first character entered. + If a right-to-left language character is entered first, reading order is right to left. + If a left-to-right language character is entered first, reading order is left to right. + * @remarks + * [Api set: ExcelApi 1.7] + */ + context = "Context", + /** + * Left to right reading order + * @remarks + * [Api set: ExcelApi 1.7] + */ + leftToRight = "LeftToRight", + /** + * Right to left reading order + * @remarks + * [Api set: ExcelApi 1.7] + */ + rightToLeft = "RightToLeft" + } + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + enum BuiltInStyle { + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + normal = "Normal", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + comma = "Comma", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + currency = "Currency", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + percent = "Percent", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + wholeComma = "WholeComma", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + wholeDollar = "WholeDollar", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + hlink = "Hlink", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + hlinkTrav = "HlinkTrav", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + note = "Note", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + warningText = "WarningText", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + emphasis1 = "Emphasis1", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + emphasis2 = "Emphasis2", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + emphasis3 = "Emphasis3", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + sheetTitle = "SheetTitle", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + heading1 = "Heading1", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + heading2 = "Heading2", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + heading3 = "Heading3", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + heading4 = "Heading4", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + input = "Input", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + output = "Output", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + calculation = "Calculation", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + checkCell = "CheckCell", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + linkedCell = "LinkedCell", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + total = "Total", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + good = "Good", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + bad = "Bad", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + neutral = "Neutral", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + accent1 = "Accent1", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + accent1_20 = "Accent1_20", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + accent1_40 = "Accent1_40", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + accent1_60 = "Accent1_60", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + accent2 = "Accent2", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + accent2_20 = "Accent2_20", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + accent2_40 = "Accent2_40", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + accent2_60 = "Accent2_60", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + accent3 = "Accent3", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + accent3_20 = "Accent3_20", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + accent3_40 = "Accent3_40", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + accent3_60 = "Accent3_60", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + accent4 = "Accent4", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + accent4_20 = "Accent4_20", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + accent4_40 = "Accent4_40", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + accent4_60 = "Accent4_60", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + accent5 = "Accent5", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + accent5_20 = "Accent5_20", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + accent5_40 = "Accent5_40", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + accent5_60 = "Accent5_60", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + accent6 = "Accent6", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + accent6_20 = "Accent6_20", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + accent6_40 = "Accent6_40", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + accent6_60 = "Accent6_60", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + explanatoryText = "ExplanatoryText" + } + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum PrintErrorType { + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + asDisplayed = "AsDisplayed", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + blank = "Blank", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + dash = "Dash", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + notAvailable = "NotAvailable" + } + /** + * The position of a worksheet relative to another worksheet or the entire worksheet collection. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + enum WorksheetPositionType { + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + none = "None", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + before = "Before", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + after = "After", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + beginning = "Beginning", + /** + * @remarks + * [Api set: ExcelApi 1.7] + */ + end = "End" + } + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum PrintComments { + /** + * Comments will not be printed. + * @remarks + * [Api set: ExcelApi 1.9] + */ + noComments = "NoComments", + /** + * Comments will be printed as end notes at the end of the worksheet. + * @remarks + * [Api set: ExcelApi 1.9] + */ + endSheet = "EndSheet", + /** + * Comments will be printed where they were inserted in the worksheet. + * @remarks + * [Api set: ExcelApi 1.9] + */ + inPlace = "InPlace" + } + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum PrintOrder { + /** + * Process down the rows before processing across pages or page fields to the right. + * @remarks + * [Api set: ExcelApi 1.9] + */ + downThenOver = "DownThenOver", + /** + * Process across pages or page fields to the right before moving down the rows. + * @remarks + * [Api set: ExcelApi 1.9] + */ + overThenDown = "OverThenDown" + } + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum PrintMarginUnit { + /** + * Assign the page margins in points. A point is 1/72 of an inch. + * @remarks + * [Api set: ExcelApi 1.9] + */ + points = "Points", + /** + * Assign the page margins in inches. + * @remarks + * [Api set: ExcelApi 1.9] + */ + inches = "Inches", + /** + * Assign the page margins in centimeters. + * @remarks + * [Api set: ExcelApi 1.9] + */ + centimeters = "Centimeters" + } + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum HeaderFooterState { + /** + * Only one general header/footer is used for all pages printed. + * @remarks + * [Api set: ExcelApi 1.9] + */ + default = "Default", + /** + * There is a separate first page header/footer, and a general header/footer used for all other pages. + * @remarks + * [Api set: ExcelApi 1.9] + */ + firstAndDefault = "FirstAndDefault", + /** + * There is a different header/footer for odd and even pages. + * @remarks + * [Api set: ExcelApi 1.9] + */ + oddAndEven = "OddAndEven", + /** + * There is a separate first page header/footer, then there is a separate header/footer for odd and even pages. + * @remarks + * [Api set: ExcelApi 1.9] + */ + firstOddAndEven = "FirstOddAndEven" + } + /** + * The behavior types when AutoFill is used on a range in the workbook. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum AutoFillType { + /** + * Populates the adjacent cells based on the surrounding data (the standard AutoFill behavior). + * @remarks + * [Api set: ExcelApi 1.9] + */ + fillDefault = "FillDefault", + /** + * Populates the adjacent cells with data based on the selected data. + * @remarks + * [Api set: ExcelApi 1.9] + */ + fillCopy = "FillCopy", + /** + * Populates the adjacent cells with data that follows a pattern in the copied cells. + * @remarks + * [Api set: ExcelApi 1.9] + */ + fillSeries = "FillSeries", + /** + * Populates the adjacent cells with the selected formats. + * @remarks + * [Api set: ExcelApi 1.9] + */ + fillFormats = "FillFormats", + /** + * Populates the adjacent cells with the selected values. + * @remarks + * [Api set: ExcelApi 1.9] + */ + fillValues = "FillValues", + /** + * A version of "FillSeries" for dates that bases the pattern on either the day of the month or the day of the week, depending on the context. + * @remarks + * [Api set: ExcelApi 1.9] + */ + fillDays = "FillDays", + /** + * A version of "FillSeries" for dates that bases the pattern on the day of the week and only includes weekdays. + * @remarks + * [Api set: ExcelApi 1.9] + */ + fillWeekdays = "FillWeekdays", + /** + * A version of "FillSeries" for dates that bases the pattern on the month. + * @remarks + * [Api set: ExcelApi 1.9] + */ + fillMonths = "FillMonths", + /** + * A version of "FillSeries" for dates that bases the pattern on the year. + * @remarks + * [Api set: ExcelApi 1.9] + */ + fillYears = "FillYears", + /** + * A version of "FillSeries" for numbers that fills out the values in the adjacent cells according to a linear trend model. + * @remarks + * [Api set: ExcelApi 1.9] + */ + linearTrend = "LinearTrend", + /** + * A version of "FillSeries" for numbers that fills out the values in the adjacent cells according to a growth trend model. + * @remarks + * [Api set: ExcelApi 1.9] + */ + growthTrend = "GrowthTrend", + /** + * Populates the adjacent cells by using Excel's Flash Fill feature. + * @remarks + * [Api set: ExcelApi 1.9] + */ + flashFill = "FlashFill" + } + /** + * @remarks + * [Api set: ExcelApi 1.10] + */ + enum GroupOption { + /** + * Group by rows. + * @remarks + * [Api set: ExcelApi 1.10] + */ + byRows = "ByRows", + /** + * Group by columns. + * @remarks + * [Api set: ExcelApi 1.10] + */ + byColumns = "ByColumns" + } + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum RangeCopyType { + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + all = "All", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + formulas = "Formulas", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + values = "Values", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + formats = "Formats", + } + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum LinkedDataTypeState { + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + none = "None", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + validLinkedData = "ValidLinkedData", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + disambiguationNeeded = "DisambiguationNeeded", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + brokenLinkedData = "BrokenLinkedData", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + fetchingData = "FetchingData" + } + /** + * Specifies the shape type for a `GeometricShape` object. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum GeometricShapeType { + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + lineInverse = "LineInverse", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + triangle = "Triangle", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + rightTriangle = "RightTriangle", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + rectangle = "Rectangle", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + diamond = "Diamond", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + parallelogram = "Parallelogram", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + trapezoid = "Trapezoid", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + nonIsoscelesTrapezoid = "NonIsoscelesTrapezoid", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + pentagon = "Pentagon", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + hexagon = "Hexagon", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + heptagon = "Heptagon", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + octagon = "Octagon", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + decagon = "Decagon", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + dodecagon = "Dodecagon", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + star4 = "Star4", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + star5 = "Star5", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + star6 = "Star6", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + star7 = "Star7", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + star8 = "Star8", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + star10 = "Star10", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + star12 = "Star12", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + star16 = "Star16", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + star24 = "Star24", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + star32 = "Star32", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + roundRectangle = "RoundRectangle", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + round1Rectangle = "Round1Rectangle", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + round2SameRectangle = "Round2SameRectangle", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + round2DiagonalRectangle = "Round2DiagonalRectangle", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + snipRoundRectangle = "SnipRoundRectangle", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + snip1Rectangle = "Snip1Rectangle", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + snip2SameRectangle = "Snip2SameRectangle", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + snip2DiagonalRectangle = "Snip2DiagonalRectangle", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + plaque = "Plaque", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + ellipse = "Ellipse", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + teardrop = "Teardrop", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + homePlate = "HomePlate", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + chevron = "Chevron", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + pieWedge = "PieWedge", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + pie = "Pie", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + blockArc = "BlockArc", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + donut = "Donut", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + noSmoking = "NoSmoking", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + rightArrow = "RightArrow", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + leftArrow = "LeftArrow", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + upArrow = "UpArrow", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + downArrow = "DownArrow", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + stripedRightArrow = "StripedRightArrow", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + notchedRightArrow = "NotchedRightArrow", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + bentUpArrow = "BentUpArrow", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + leftRightArrow = "LeftRightArrow", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + upDownArrow = "UpDownArrow", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + leftUpArrow = "LeftUpArrow", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + leftRightUpArrow = "LeftRightUpArrow", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + quadArrow = "QuadArrow", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + leftArrowCallout = "LeftArrowCallout", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + rightArrowCallout = "RightArrowCallout", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + upArrowCallout = "UpArrowCallout", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + downArrowCallout = "DownArrowCallout", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + leftRightArrowCallout = "LeftRightArrowCallout", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + upDownArrowCallout = "UpDownArrowCallout", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + quadArrowCallout = "QuadArrowCallout", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + bentArrow = "BentArrow", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + uturnArrow = "UturnArrow", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + circularArrow = "CircularArrow", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + leftCircularArrow = "LeftCircularArrow", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + leftRightCircularArrow = "LeftRightCircularArrow", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + curvedRightArrow = "CurvedRightArrow", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + curvedLeftArrow = "CurvedLeftArrow", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + curvedUpArrow = "CurvedUpArrow", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + curvedDownArrow = "CurvedDownArrow", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + swooshArrow = "SwooshArrow", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + cube = "Cube", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + can = "Can", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + lightningBolt = "LightningBolt", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + heart = "Heart", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + sun = "Sun", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + moon = "Moon", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + smileyFace = "SmileyFace", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + irregularSeal1 = "IrregularSeal1", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + irregularSeal2 = "IrregularSeal2", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + foldedCorner = "FoldedCorner", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + bevel = "Bevel", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + frame = "Frame", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + halfFrame = "HalfFrame", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + corner = "Corner", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + diagonalStripe = "DiagonalStripe", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + chord = "Chord", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + arc = "Arc", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + leftBracket = "LeftBracket", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + rightBracket = "RightBracket", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + leftBrace = "LeftBrace", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + rightBrace = "RightBrace", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + bracketPair = "BracketPair", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + bracePair = "BracePair", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + callout1 = "Callout1", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + callout2 = "Callout2", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + callout3 = "Callout3", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + accentCallout1 = "AccentCallout1", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + accentCallout2 = "AccentCallout2", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + accentCallout3 = "AccentCallout3", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + borderCallout1 = "BorderCallout1", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + borderCallout2 = "BorderCallout2", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + borderCallout3 = "BorderCallout3", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + accentBorderCallout1 = "AccentBorderCallout1", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + accentBorderCallout2 = "AccentBorderCallout2", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + accentBorderCallout3 = "AccentBorderCallout3", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + wedgeRectCallout = "WedgeRectCallout", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + wedgeRRectCallout = "WedgeRRectCallout", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + wedgeEllipseCallout = "WedgeEllipseCallout", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + cloudCallout = "CloudCallout", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + cloud = "Cloud", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + ribbon = "Ribbon", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + ribbon2 = "Ribbon2", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + ellipseRibbon = "EllipseRibbon", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + ellipseRibbon2 = "EllipseRibbon2", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + leftRightRibbon = "LeftRightRibbon", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + verticalScroll = "VerticalScroll", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + horizontalScroll = "HorizontalScroll", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + wave = "Wave", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + doubleWave = "DoubleWave", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + plus = "Plus", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + flowChartProcess = "FlowChartProcess", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + flowChartDecision = "FlowChartDecision", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + flowChartInputOutput = "FlowChartInputOutput", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + flowChartPredefinedProcess = "FlowChartPredefinedProcess", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + flowChartInternalStorage = "FlowChartInternalStorage", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + flowChartDocument = "FlowChartDocument", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + flowChartMultidocument = "FlowChartMultidocument", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + flowChartTerminator = "FlowChartTerminator", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + flowChartPreparation = "FlowChartPreparation", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + flowChartManualInput = "FlowChartManualInput", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + flowChartManualOperation = "FlowChartManualOperation", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + flowChartConnector = "FlowChartConnector", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + flowChartPunchedCard = "FlowChartPunchedCard", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + flowChartPunchedTape = "FlowChartPunchedTape", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + flowChartSummingJunction = "FlowChartSummingJunction", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + flowChartOr = "FlowChartOr", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + flowChartCollate = "FlowChartCollate", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + flowChartSort = "FlowChartSort", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + flowChartExtract = "FlowChartExtract", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + flowChartMerge = "FlowChartMerge", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + flowChartOfflineStorage = "FlowChartOfflineStorage", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + flowChartOnlineStorage = "FlowChartOnlineStorage", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + flowChartMagneticTape = "FlowChartMagneticTape", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + flowChartMagneticDisk = "FlowChartMagneticDisk", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + flowChartMagneticDrum = "FlowChartMagneticDrum", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + flowChartDisplay = "FlowChartDisplay", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + flowChartDelay = "FlowChartDelay", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + flowChartAlternateProcess = "FlowChartAlternateProcess", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + flowChartOffpageConnector = "FlowChartOffpageConnector", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + actionButtonBlank = "ActionButtonBlank", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + actionButtonHome = "ActionButtonHome", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + actionButtonHelp = "ActionButtonHelp", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + actionButtonInformation = "ActionButtonInformation", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + actionButtonForwardNext = "ActionButtonForwardNext", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + actionButtonBackPrevious = "ActionButtonBackPrevious", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + actionButtonEnd = "ActionButtonEnd", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + actionButtonBeginning = "ActionButtonBeginning", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + actionButtonReturn = "ActionButtonReturn", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + actionButtonDocument = "ActionButtonDocument", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + actionButtonSound = "ActionButtonSound", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + actionButtonMovie = "ActionButtonMovie", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + gear6 = "Gear6", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + gear9 = "Gear9", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + funnel = "Funnel", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + mathPlus = "MathPlus", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + mathMinus = "MathMinus", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + mathMultiply = "MathMultiply", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + mathDivide = "MathDivide", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + mathEqual = "MathEqual", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + mathNotEqual = "MathNotEqual", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + cornerTabs = "CornerTabs", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + squareTabs = "SquareTabs", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + plaqueTabs = "PlaqueTabs", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + chartX = "ChartX", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + chartStar = "ChartStar", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + chartPlus = "ChartPlus" + } + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum ConnectorType { + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + straight = "Straight", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + elbow = "Elbow", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + curve = "Curve" + } + /** + * @remarks + * [Api set: ExcelApi 1.10] + */ + enum ContentType { + /** + * Indicates a plain format type for the comment content. + * @remarks + * [Api set: ExcelApi 1.10] + */ + plain = "Plain", + /** + * Comment content containing mentions. + * @remarks + * [Api set: ExcelApi 1.10] + */ + mention = "Mention" + } + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum SpecialCellType { + /** + * All cells with conditional formats. + * @remarks + * [Api set: ExcelApi 1.9] + */ + conditionalFormats = "ConditionalFormats", + /** + * Cells with validation criteria. + * @remarks + * [Api set: ExcelApi 1.9] + */ + dataValidations = "DataValidations", + /** + * Cells with no content. + * @remarks + * [Api set: ExcelApi 1.9] + */ + blanks = "Blanks", + /** + * Cells containing constants. + * @remarks + * [Api set: ExcelApi 1.9] + */ + constants = "Constants", + /** + * Cells containing formulas. + * @remarks + * [Api set: ExcelApi 1.9] + */ + formulas = "Formulas", + /** + * Cells with the same conditional format as the first cell in the range. + * @remarks + * [Api set: ExcelApi 1.9] + */ + sameConditionalFormat = "SameConditionalFormat", + /** + * Cells with the same data validation criteria as the first cell in the range. + * @remarks + * [Api set: ExcelApi 1.9] + */ + sameDataValidation = "SameDataValidation", + /** + * Cells that are visible. + * @remarks + * [Api set: ExcelApi 1.9] + */ + visible = "Visible" + } + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum SpecialCellValueType { + /** + * Cells that have errors, boolean, numeric, or string values. + * @remarks + * [Api set: ExcelApi 1.9] + */ + all = "All", + /** + * Cells that have errors. + * @remarks + * [Api set: ExcelApi 1.9] + */ + errors = "Errors", + /** + * Cells that have errors or boolean values. + * @remarks + * [Api set: ExcelApi 1.9] + */ + errorsLogical = "ErrorsLogical", + /** + * Cells that have errors or numeric values. + * @remarks + * [Api set: ExcelApi 1.9] + */ + errorsNumbers = "ErrorsNumbers", + /** + * Cells that have errors or string values. + * @remarks + * [Api set: ExcelApi 1.9] + */ + errorsText = "ErrorsText", + /** + * Cells that have errors, boolean, or numeric values. + * @remarks + * [Api set: ExcelApi 1.9] + */ + errorsLogicalNumber = "ErrorsLogicalNumber", + /** + * Cells that have errors, boolean, or string values. + * @remarks + * [Api set: ExcelApi 1.9] + */ + errorsLogicalText = "ErrorsLogicalText", + /** + * Cells that have errors, numeric, or string values. + * @remarks + * [Api set: ExcelApi 1.9] + */ + errorsNumberText = "ErrorsNumberText", + /** + * Cells that have a boolean value. + * @remarks + * [Api set: ExcelApi 1.9] + */ + logical = "Logical", + /** + * Cells that have a boolean or numeric value. + * @remarks + * [Api set: ExcelApi 1.9] + */ + logicalNumbers = "LogicalNumbers", + /** + * Cells that have a boolean or string value. + * @remarks + * [Api set: ExcelApi 1.9] + */ + logicalText = "LogicalText", + /** + * Cells that have a boolean, numeric, or string value. + * @remarks + * [Api set: ExcelApi 1.9] + */ + logicalNumbersText = "LogicalNumbersText", + /** + * Cells that have a numeric value. + * @remarks + * [Api set: ExcelApi 1.9] + */ + numbers = "Numbers", + /** + * Cells that have a numeric or string value. + * @remarks + * [Api set: ExcelApi 1.9] + */ + numbersText = "NumbersText", + /** + * Cells that have a string value. + * @remarks + * [Api set: ExcelApi 1.9] + */ + text = "Text" + } + /** + * Specifies the way that an object is attached to its underlying cells. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum Placement { + /** + * The object is moved and sized with the cells. + * @remarks + * [Api set: ExcelApi 1.9] + */ + twoCell = "TwoCell", + /** + * The object is moved with the cells. + * @remarks + * [Api set: ExcelApi 1.9] + */ + oneCell = "OneCell", + /** + * The object is free floating. + * @remarks + * [Api set: ExcelApi 1.9] + */ + absolute = "Absolute" + } + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum FillPattern { + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + none = "None", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + solid = "Solid", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + gray50 = "Gray50", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + gray75 = "Gray75", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + gray25 = "Gray25", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + horizontal = "Horizontal", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + vertical = "Vertical", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + down = "Down", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + up = "Up", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + checker = "Checker", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + semiGray75 = "SemiGray75", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + lightHorizontal = "LightHorizontal", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + lightVertical = "LightVertical", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + lightDown = "LightDown", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + lightUp = "LightUp", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + grid = "Grid", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + crissCross = "CrissCross", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + gray16 = "Gray16", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + gray8 = "Gray8", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + linearGradient = "LinearGradient", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + rectangularGradient = "RectangularGradient" + } + /** + * Specifies the horizontal alignment for the text frame in a shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum ShapeTextHorizontalAlignment { + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + left = "Left", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + center = "Center", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + right = "Right", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + justify = "Justify", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + justifyLow = "JustifyLow", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + distributed = "Distributed", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + thaiDistributed = "ThaiDistributed" + } + /** + * Specifies the vertical alignment for the text frame in a shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum ShapeTextVerticalAlignment { + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + top = "Top", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + middle = "Middle", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + bottom = "Bottom", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + justified = "Justified", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + distributed = "Distributed" + } + /** + * Specifies the vertical overflow for the text frame in a shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum ShapeTextVerticalOverflow { + /** + * Allow text to overflow the text frame vertically (can be from the top, bottom, or both depending on the text alignment). + * @remarks + * [Api set: ExcelApi 1.9] + */ + overflow = "Overflow", + /** + * Hide text that does not fit vertically within the text frame, and add an ellipsis (...) at the end of the visible text. + * @remarks + * [Api set: ExcelApi 1.9] + */ + ellipsis = "Ellipsis", + /** + * Hide text that does not fit vertically within the text frame. + * @remarks + * [Api set: ExcelApi 1.9] + */ + clip = "Clip" + } + /** + * Specifies the horizontal overflow for the text frame in a shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum ShapeTextHorizontalOverflow { + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + overflow = "Overflow", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + clip = "Clip" + } + /** + * Specifies the reading order for the text frame in a shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum ShapeTextReadingOrder { + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + leftToRight = "LeftToRight", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + rightToLeft = "RightToLeft" + } + /** + * Specifies the orientation for the text frame in a shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum ShapeTextOrientation { + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + horizontal = "Horizontal", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + vertical = "Vertical", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + vertical270 = "Vertical270", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + wordArtVertical = "WordArtVertical", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + eastAsianVertical = "EastAsianVertical", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + mongolianVertical = "MongolianVertical", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + wordArtVerticalRTL = "WordArtVerticalRTL" + } + /** + * Determines the type of automatic sizing allowed. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum ShapeAutoSize { + /** + * No autosizing. + * @remarks + * [Api set: ExcelApi 1.9] + */ + autoSizeNone = "AutoSizeNone", + /** + * The text is adjusted to fit the shape. + * @remarks + * [Api set: ExcelApi 1.9] + */ + autoSizeTextToFitShape = "AutoSizeTextToFitShape", + /** + * The shape is adjusted to fit the text. + * @remarks + * [Api set: ExcelApi 1.9] + */ + autoSizeShapeToFitText = "AutoSizeShapeToFitText", + /** + * A combination of automatic sizing schemes are used. + * @remarks + * [Api set: ExcelApi 1.9] + */ + autoSizeMixed = "AutoSizeMixed" + } + /** + * Specifies the close behavior for `Workbook.close`. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum CloseBehavior { + /** + * Save the possible changes before closing the workbook. + * @remarks + * [Api set: ExcelApi 1.9] + */ + save = "Save", + /** + * Discard the possible changes when closing the workbook. + * @remarks + * [Api set: ExcelApi 1.9] + */ + skipSave = "SkipSave" + } + /** + * Specifies the save behavior for `Workbook.save`. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum SaveBehavior { + /** + * Save the workbook without prompting the user. If file is not saved, + it will save it with default name in the default location. + * @remarks + * [Api set: ExcelApi 1.9] + */ + save = "Save", + /** + * Prompts the "Save As" experience to the user if the workbook has not been saved, + Ignored if the workbook was previously saved. + * @remarks + * [Api set: ExcelApi 1.9] + */ + prompt = "Prompt" + } + /** + * Specifies the slicer sort behavior for `Slicer.sortBy`. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + enum SlicerSortType { + /** + * Sort slicer items in the order provided by the data source. + * @remarks + * [Api set: ExcelApi 1.10] + */ + dataSourceOrder = "DataSourceOrder", + /** + * Sort slicer items in ascending order by item captions. + * @remarks + * [Api set: ExcelApi 1.10] + */ + ascending = "Ascending", + /** + * Sort slicer items in descending order by item captions. + * @remarks + * [Api set: ExcelApi 1.10] + */ + descending = "Descending" + } + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + enum RibbonTab { + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + others = "Others", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + home = "Home", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + insert = "Insert", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + draw = "Draw", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + pageLayout = "PageLayout", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + formulas = "Formulas", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + data = "Data", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + review = "Review", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + view = "View", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + developer = "Developer", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + addIns = "AddIns", + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + help = "Help" + } + /** + * Represents a category of number formats. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + enum NumberFormatCategory { + /** + * General format cells have no specific number format. + * @remarks + * [Api set: ExcelApi 1.12] + */ + general = "General", + /** + * Number is used for general display of numbers. Currency and Accounting offer specialized formatting for monetary value. + * @remarks + * [Api set: ExcelApi 1.12] + */ + number = "Number", + /** + * Currency formats are used for general monetary values. Use Accounting formats to align decimal points in a column. + * @remarks + * [Api set: ExcelApi 1.12] + */ + currency = "Currency", + /** + * Accounting formats line up the currency symbols and decimal points in a column. + * @remarks + * [Api set: ExcelApi 1.12] + */ + accounting = "Accounting", + /** + * Date formats display date and time serial numbers as date values. Date formats that begin with an asterisk (*) respond to changes in regional date and time settings that are specified for the operating system. Formats without an asterisk are not affected by operating system settings. + * @remarks + * [Api set: ExcelApi 1.12] + */ + date = "Date", + /** + * Time formats display date and time serial numbers as date values. Time formats that begin with an asterisk (*) respond to changes in regional date and time settings that are specified for the operating system. Formats without an asterisk are not affected by operating system settings. + * @remarks + * [Api set: ExcelApi 1.12] + */ + time = "Time", + /** + * Percentage formats multiply the cell value by 100 and displays the result with a percent symbol. + * @remarks + * [Api set: ExcelApi 1.12] + */ + percentage = "Percentage", + /** + * Fraction formats display the cell value as a whole number with the remainder rounded to the nearest fraction value. + * @remarks + * [Api set: ExcelApi 1.12] + */ + fraction = "Fraction", + /** + * Scientific formats display the cell value as a number between 1 and 10 multiplied by a power of 10. + * @remarks + * [Api set: ExcelApi 1.12] + */ + scientific = "Scientific", + /** + * Text format cells are treated as text even when a number is in the cell. The cell is displayed exactly as entered. + * @remarks + * [Api set: ExcelApi 1.12] + */ + text = "Text", + /** + * Special formats are useful for tracking list and database values. + * @remarks + * [Api set: ExcelApi 1.12] + */ + special = "Special", + /** + * A custom format that is not a part of any category. + * @remarks + * [Api set: ExcelApi 1.12] + */ + custom = "Custom" + } + + + /** + * Represents a collection of note objects that are part of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + export class NoteCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.Note[]; + /** + * Adds a new note with the given content on the given cell. + * + * @remarks + * [Api set: ExcelApi 1.18] + * + * @param cellAddress - The cell to which the note is added. This can be a `Range` object or a string such as "A1". If the string is invalid, or the range is not a single cell, an `InvalidCellAddress` error is thrown. + * @param content - The text of the note. + */ + add(cellAddress: Range | string, content: any): Excel.Note; + /** + * Gets the number of notes in the collection. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a note by its cell address. + * + * @remarks + * [Api set: ExcelApi 1.18] + * + * @param key - The cell address of the note. + * @returns The note with the given cell address. If there is no note with the given cell address, then the `ItemNotFound` error is thrown. + */ + getItem(key: string): Excel.Note; + /** + * Gets a note from the collection based on its position. + * + * @remarks + * [Api set: ExcelApi 1.18] + * + * @param index - The index value of the note to be retrieved. Zero-indexed. + */ + getItemAt(index: number): Excel.Note; + /** + * Gets a note by its cell address. + If the note object does not exist, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.18] + * + * @param key - The cell address of the note. + * @returns The note with the given cell address or null object. + */ + getItemOrNullObject(key: string): Excel.Note; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.NoteCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.NoteCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.NoteCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.NoteCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.NoteCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.NoteCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.NoteCollectionData; + } + /** + * Represents a note in the workbook or worksheet. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + export class Note extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Gets the author of the note. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + readonly authorName: string; + /** + * Specifies the text of the note. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + content: string; + /** + * Specifies the height of the note. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + height: number; + /** + * Specifies the visibility of the note. A value of `true` means the note is shown. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + visible: boolean; + /** + * Specifies the width of the note. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + width: number; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.NoteUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.Note): void; + /** + * Deletes the note. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + delete(): void; + /** + * Gets the cell where this note is located. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + getLocation(): Excel.Range; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.NoteLoadOptions): Excel.Note; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Note; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.Note; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.Note` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.NoteData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.NoteData; + } + /** + * An object containing the result of a function-evaluation operation + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + export class FunctionResult extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Error value (such as "#DIV/0") representing the error. If the error string is not set, then the function succeeded, and its result is written to the Value field. The error is always in the English locale. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + readonly error: string; + /** + * The value of function evaluation. The value field will be populated only if no error has occurred (i.e., the Error property is not set). + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + readonly value: T; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.FunctionResultLoadOptions): FunctionResult; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): FunctionResult; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): FunctionResult; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `FunctionResult` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Interfaces.FunctionResultData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Interfaces.FunctionResultData; + } + /** + * An object for evaluating Excel functions. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + export class Functions extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns the absolute value of a number, a number without its sign. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the real number for which you want the absolute value. + */ + abs(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the accrued interest for a security that pays periodic interest. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param issue - Is the security's issue date, expressed as a serial date number. + * @param firstInterest - Is the security's first interest date, expressed as a serial date number. + * @param settlement - Is the security's settlement date, expressed as a serial date number. + * @param rate - Is the security's annual coupon rate. + * @param par - Is the security's par value. + * @param frequency - Is the number of coupon payments per year. + * @param basis - Is the type of day count basis to use. + * @param calcMethod - Is a logical value: to accrued interest from issue date = TRUE or omitted; to calculate from last coupon payment date = FALSE. + */ + accrInt(issue: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, firstInterest: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, rate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, par: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, frequency: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, calcMethod?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the accrued interest for a security that pays interest at maturity. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param issue - Is the security's issue date, expressed as a serial date number. + * @param settlement - Is the security's maturity date, expressed as a serial date number. + * @param rate - Is the security's annual coupon rate. + * @param par - Is the security's par value. + * @param basis - Is the type of day count basis to use. + */ + accrIntM(issue: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, rate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, par: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the arccosine of a number, in radians in the range 0 to Pi. The arccosine is the angle whose cosine is Number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the cosine of the angle you want and must be from -1 to 1. + */ + acos(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the inverse hyperbolic cosine of a number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is any real number equal to or greater than 1. + */ + acosh(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the arccotangent of a number, in radians in the range 0 to Pi. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the cotangent of the angle you want. + */ + acot(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the inverse hyperbolic cotangent of a number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the hyperbolic cotangent of the angle that you want. + */ + acoth(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the prorated linear depreciation of an asset for each accounting period. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param cost - Is the cost of the asset. + * @param datePurchased - Is the date the asset is purchased. + * @param firstPeriod - Is the date of the end of the first period. + * @param salvage - Is the salvage value at the end of life of the asset. + * @param period - Is the period. + * @param rate - Is the rate of depreciation. + * @param basis - Year_basis : 0 for year of 360 days, 1 for actual, 3 for year of 365 days. + */ + amorDegrc(cost: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, datePurchased: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, firstPeriod: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, salvage: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, period: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, rate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the prorated linear depreciation of an asset for each accounting period. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param cost - Is the cost of the asset. + * @param datePurchased - Is the date the asset is purchased. + * @param firstPeriod - Is the date of the end of the first period. + * @param salvage - Is the salvage value at the end of life of the asset. + * @param period - Is the period. + * @param rate - Is the rate of depreciation. + * @param basis - Year_basis : 0 for year of 360 days, 1 for actual, 3 for year of 365 days. + */ + amorLinc(cost: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, datePurchased: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, firstPeriod: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, salvage: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, period: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, rate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Checks whether all arguments are TRUE, and returns TRUE if all arguments are TRUE. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - List of parameters, whose elements are 1 to 255 conditions you want to test that can be either TRUE or FALSE and can be logical values, arrays, or references. + */ + and(...values: Array>): FunctionResult; + /** + * Converts a Roman numeral to Arabic. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param text - Is the Roman numeral you want to convert. + */ + arabic(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the number of areas in a reference. An area is a range of contiguous cells or a single cell. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param reference - Is a reference to a cell or range of cells and can refer to multiple areas. + */ + areas(reference: Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Changes full-width (double-byte) characters to half-width (single-byte) characters. Use with double-byte character sets (DBCS). + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param text - Is a text, or a reference to a cell containing a text. + */ + asc(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the arcsine of a number in radians, in the range -Pi/2 to Pi/2. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the sine of the angle you want and must be from -1 to 1. + */ + asin(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the inverse hyperbolic sine of a number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is any real number equal to or greater than 1. + */ + asinh(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the arctangent of a number in radians, in the range -Pi/2 to Pi/2. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the tangent of the angle you want. + */ + atan(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the arctangent of the specified x- and y- coordinates, in radians between -Pi and Pi, excluding -Pi. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param xNum - Is the x-coordinate of the point. + * @param yNum - Is the y-coordinate of the point. + */ + atan2(xNum: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, yNum: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the inverse hyperbolic tangent of a number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is any real number between -1 and 1 excluding -1 and 1. + */ + atanh(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the average of the absolute deviations of data points from their mean. Arguments can be numbers or names, arrays, or references that contain numbers. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - List of parameters, whose elements are 1 to 255 arguments for which you want the average of the absolute deviations. + */ + aveDev(...values: Array>): FunctionResult; + /** + * Returns the average (arithmetic mean) of its arguments, which can be numbers or names, arrays, or references that contain numbers. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - List of parameters, whose elements are 1 to 255 numeric arguments for which you want the average. + */ + average(...values: Array>): FunctionResult; + /** + * Returns the average (arithmetic mean) of its arguments, evaluating text and FALSE in arguments as 0; TRUE evaluates as 1. Arguments can be numbers, names, arrays, or references. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - List of parameters, whose elements are 1 to 255 arguments for which you want the average. + */ + averageA(...values: Array>): FunctionResult; + /** + * Finds average(arithmetic mean) for the cells specified by a given condition or criteria. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param range - Is the range of cells you want evaluated. + * @param criteria - Is the condition or criteria in the form of a number, expression, or text that defines which cells will be used to find the average. + * @param averageRange - Are the actual cells to be used to find the average. If omitted, the cells in range are used. + */ + averageIf(range: Excel.Range | Excel.RangeReference | Excel.FunctionResult, criteria: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, averageRange?: Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Finds average(arithmetic mean) for the cells specified by a given set of conditions or criteria. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param averageRange - Are the actual cells to be used to find the average. + * @param values - List of parameters, where the first element of each pair is the Is the range of cells you want evaluated for the particular condition , and the second element is is the condition or criteria in the form of a number, expression, or text that defines which cells will be used to find the average. + */ + averageIfs(averageRange: Excel.Range | Excel.RangeReference | Excel.FunctionResult, ...values: Array | number | string | boolean>): FunctionResult; + /** + * Converts a number to text (baht). + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is a number that you want to convert. + */ + bahtText(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Converts a number into a text representation with the given radix (base). + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the number that you want to convert. + * @param radix - Is the base Radix that you want to convert the number into. + * @param minLength - Is the minimum length of the returned string. If omitted leading zeros are not added. + */ + base(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, radix: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, minLength?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the modified Bessel function In(x). + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param x - Is the value at which to evaluate the function. + * @param n - Is the order of the Bessel function. + */ + besselI(x: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, n: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the Bessel function Jn(x). + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param x - Is the value at which to evaluate the function. + * @param n - Is the order of the Bessel function. + */ + besselJ(x: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, n: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the modified Bessel function Kn(x). + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param x - Is the value at which to evaluate the function. + * @param n - Is the order of the function. + */ + besselK(x: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, n: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the Bessel function Yn(x). + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param x - Is the value at which to evaluate the function. + * @param n - Is the order of the function. + */ + besselY(x: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, n: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the beta probability distribution function. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param x - Is the value between A and B at which to evaluate the function. + * @param alpha - Is a parameter to the distribution and must be greater than 0. + * @param beta - Is a parameter to the distribution and must be greater than 0. + * @param cumulative - Is a logical value: for the cumulative distribution function, use TRUE; for the probability density function, use FALSE. + * @param A - Is an optional lower bound to the interval of x. If omitted, A = 0. + * @param B - Is an optional upper bound to the interval of x. If omitted, B = 1. + */ + beta_Dist(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, alpha: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, beta: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, cumulative: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, A?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, B?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the inverse of the cumulative beta probability density function (BETA.DIST). + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param probability - Is a probability associated with the beta distribution. + * @param alpha - Is a parameter to the distribution and must be greater than 0. + * @param beta - Is a parameter to the distribution and must be greater than 0. + * @param A - Is an optional lower bound to the interval of x. If omitted, A = 0. + * @param B - Is an optional upper bound to the interval of x. If omitted, B = 1. + */ + beta_Inv(probability: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, alpha: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, beta: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, A?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, B?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Converts a binary number to decimal. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the binary number you want to convert. + */ + bin2Dec(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Converts a binary number to hexadecimal. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the binary number you want to convert. + * @param places - Is the number of characters to use. + */ + bin2Hex(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, places?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Converts a binary number to octal. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the binary number you want to convert. + * @param places - Is the number of characters to use. + */ + bin2Oct(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, places?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the individual term binomial distribution probability. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param numberS - Is the number of successes in trials. + * @param trials - Is the number of independent trials. + * @param probabilityS - Is the probability of success on each trial. + * @param cumulative - Is a logical value: for the cumulative distribution function, use TRUE; for the probability mass function, use FALSE. + */ + binom_Dist(numberS: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, trials: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, probabilityS: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, cumulative: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the probability of a trial result using a binomial distribution. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param trials - Is the number of independent trials. + * @param probabilityS - Is the probability of success on each trial. + * @param numberS - Is the number of successes in trials. + * @param numberS2 - If provided this function returns the probability that the number of successful trials shall lie between numberS and numberS2. + */ + binom_Dist_Range(trials: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, probabilityS: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, numberS: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, numberS2?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the smallest value for which the cumulative binomial distribution is greater than or equal to a criterion value. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param trials - Is the number of Bernoulli trials. + * @param probabilityS - Is the probability of success on each trial, a number between 0 and 1 inclusive. + * @param alpha - Is the criterion value, a number between 0 and 1 inclusive. + */ + binom_Inv(trials: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, probabilityS: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, alpha: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns a bitwise 'And' of two numbers. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number1 - Is the decimal representation of the binary number you want to evaluate. + * @param number2 - Is the decimal representation of the binary number you want to evaluate. + */ + bitand(number1: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, number2: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns a number shifted left by shift_amount bits. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the decimal representation of the binary number you want to evaluate. + * @param shiftAmount - Is the number of bits that you want to shift Number left by. + */ + bitlshift(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, shiftAmount: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns a bitwise 'Or' of two numbers. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number1 - Is the decimal representation of the binary number you want to evaluate. + * @param number2 - Is the decimal representation of the binary number you want to evaluate. + */ + bitor(number1: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, number2: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns a number shifted right by shift_amount bits. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the decimal representation of the binary number you want to evaluate. + * @param shiftAmount - Is the number of bits that you want to shift Number right by. + */ + bitrshift(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, shiftAmount: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns a bitwise 'Exclusive Or' of two numbers. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number1 - Is the decimal representation of the binary number you want to evaluate. + * @param number2 - Is the decimal representation of the binary number you want to evaluate. + */ + bitxor(number1: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, number2: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Rounds a number up, to the nearest integer or to the nearest multiple of significance. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the value you want to round. + * @param significance - Is the multiple to which you want to round. + * @param mode - When given and nonzero this function will round away from zero. + */ + ceiling_Math(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, significance?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, mode?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Rounds a number up, to the nearest integer or to the nearest multiple of significance. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the value you want to round. + * @param significance - Is the multiple to which you want to round. + */ + ceiling_Precise(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, significance?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the character specified by the code number from the character set for your computer. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is a number between 1 and 255 specifying which character you want. + */ + char(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the left-tailed probability of the chi-squared distribution. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param x - Is the value at which you want to evaluate the distribution, a nonnegative number. + * @param degFreedom - Is the number of degrees of freedom, a number between 1 and 10^10, excluding 10^10. + * @param cumulative - Is a logical value for the function to return: the cumulative distribution function = TRUE; the probability density function = FALSE. + */ + chiSq_Dist(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, degFreedom: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, cumulative: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the right-tailed probability of the chi-squared distribution. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param x - Is the value at which you want to evaluate the distribution, a nonnegative number. + * @param degFreedom - Is the number of degrees of freedom, a number between 1 and 10^10, excluding 10^10. + */ + chiSq_Dist_RT(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, degFreedom: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the inverse of the left-tailed probability of the chi-squared distribution. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param probability - Is a probability associated with the chi-squared distribution, a value between 0 and 1 inclusive. + * @param degFreedom - Is the number of degrees of freedom, a number between 1 and 10^10, excluding 10^10. + */ + chiSq_Inv(probability: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, degFreedom: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the inverse of the right-tailed probability of the chi-squared distribution. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param probability - Is a probability associated with the chi-squared distribution, a value between 0 and 1 inclusive. + * @param degFreedom - Is the number of degrees of freedom, a number between 1 and 10^10, excluding 10^10. + */ + chiSq_Inv_RT(probability: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, degFreedom: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Chooses a value or action to perform from a list of values, based on an index number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param indexNum - Specifies which value argument is selected. indexNum must be between 1 and 254, or a formula or a reference to a number between 1 and 254. + * @param values - List of parameters, whose elements are 1 to 254 numbers, cell references, defined names, formulas, functions, or text arguments from which CHOOSE selects. + */ + choose(indexNum: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, ...values: Array>): FunctionResult; + /** + * Removes all nonprintable characters from text. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param text - Is any worksheet information from which you want to remove nonprintable characters. + */ + clean(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns a numeric code for the first character in a text string, in the character set used by your computer. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param text - Is the text for which you want the code of the first character. + */ + code(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the number of columns in an array or reference. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param array - Is an array or array formula, or a reference to a range of cells for which you want the number of columns. + */ + columns(array: Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the number of combinations for a given number of items. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the total number of items. + * @param numberChosen - Is the number of items in each combination. + */ + combin(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, numberChosen: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the number of combinations with repetitions for a given number of items. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the total number of items. + * @param numberChosen - Is the number of items in each combination. + */ + combina(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, numberChosen: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Converts real and imaginary coefficients into a complex number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param realNum - Is the real coefficient of the complex number. + * @param iNum - Is the imaginary coefficient of the complex number. + * @param suffix - Is the suffix for the imaginary component of the complex number. + */ + complex(realNum: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, iNum: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, suffix?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Joins several text strings into one text string. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - List of parameters, whose elements are 1 to 255 text strings to be joined into a single text string and can be text strings, numbers, or single-cell references. + */ + concatenate(...values: Array>): FunctionResult; + /** + * Returns the confidence interval for a population mean, using a normal distribution. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param alpha - Is the significance level used to compute the confidence level, a number greater than 0 and less than 1. + * @param standardDev - Is the population standard deviation for the data range and is assumed to be known. standardDev must be greater than 0. + * @param size - Is the sample size. + */ + confidence_Norm(alpha: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, standardDev: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, size: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the confidence interval for a population mean, using a Student's T distribution. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param alpha - Is the significance level used to compute the confidence level, a number greater than 0 and less than 1. + * @param standardDev - Is the population standard deviation for the data range and is assumed to be known. standardDev must be greater than 0. + * @param size - Is the sample size. + */ + confidence_T(alpha: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, standardDev: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, size: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Converts a number from one measurement system to another. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the value in from_units to convert. + * @param fromUnit - Is the units for number. + * @param toUnit - Is the units for the result. + */ + convert(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, fromUnit: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, toUnit: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the cosine of an angle. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the angle in radians for which you want the cosine. + */ + cos(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the hyperbolic cosine of a number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is any real number. + */ + cosh(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the cotangent of an angle. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the angle in radians for which you want the cotangent. + */ + cot(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the hyperbolic cotangent of a number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the angle in radians for which you want the hyperbolic cotangent. + */ + coth(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Counts the number of cells in a range that contain numbers. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - List of parameters, whose elements are 1 to 255 arguments that can contain or refer to a variety of different types of data, but only numbers are counted. + */ + count(...values: Array>): FunctionResult; + /** + * Counts the number of cells in a range that are not empty. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - List of parameters, whose elements are 1 to 255 arguments representing the values and cells you want to count. Values can be any type of information. + */ + countA(...values: Array>): FunctionResult; + /** + * Counts the number of empty cells in a specified range of cells. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param range - Is the range from which you want to count the empty cells. + */ + countBlank(range: Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Counts the number of cells within a range that meet the given condition. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param range - Is the range of cells from which you want to count nonblank cells. + * @param criteria - Is the condition in the form of a number, expression, or text that defines which cells will be counted. + */ + countIf(range: Excel.Range | Excel.RangeReference | Excel.FunctionResult, criteria: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Counts the number of cells specified by a given set of conditions or criteria. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - List of parameters, where the first element of each pair is the Is the range of cells you want evaluated for the particular condition , and the second element is is the condition in the form of a number, expression, or text that defines which cells will be counted. + */ + countIfs(...values: Array | number | string | boolean>): FunctionResult; + /** + * Returns the number of days from the beginning of the coupon period to the settlement date. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param settlement - Is the security's settlement date, expressed as a serial date number. + * @param maturity - Is the security's maturity date, expressed as a serial date number. + * @param frequency - Is the number of coupon payments per year. + * @param basis - Is the type of day count basis to use. + */ + coupDayBs(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, frequency: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the number of days in the coupon period that contains the settlement date. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param settlement - Is the security's settlement date, expressed as a serial date number. + * @param maturity - Is the security's maturity date, expressed as a serial date number. + * @param frequency - Is the number of coupon payments per year. + * @param basis - Is the type of day count basis to use. + */ + coupDays(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, frequency: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the number of days from the settlement date to the next coupon date. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param settlement - Is the security's settlement date, expressed as a serial date number. + * @param maturity - Is the security's maturity date, expressed as a serial date number. + * @param frequency - Is the number of coupon payments per year. + * @param basis - Is the type of day count basis to use. + */ + coupDaysNc(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, frequency: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the next coupon date after the settlement date. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param settlement - Is the security's settlement date, expressed as a serial date number. + * @param maturity - Is the security's maturity date, expressed as a serial date number. + * @param frequency - Is the number of coupon payments per year. + * @param basis - Is the type of day count basis to use. + */ + coupNcd(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, frequency: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the number of coupons payable between the settlement date and maturity date. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param settlement - Is the security's settlement date, expressed as a serial date number. + * @param maturity - Is the security's maturity date, expressed as a serial date number. + * @param frequency - Is the number of coupon payments per year. + * @param basis - Is the type of day count basis to use. + */ + coupNum(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, frequency: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the previous coupon date before the settlement date. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param settlement - Is the security's settlement date, expressed as a serial date number. + * @param maturity - Is the security's maturity date, expressed as a serial date number. + * @param frequency - Is the number of coupon payments per year. + * @param basis - Is the type of day count basis to use. + */ + coupPcd(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, frequency: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the cosecant of an angle. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the angle in radians for which you want the cosecant. + */ + csc(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the hyperbolic cosecant of an angle. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the angle in radians for which you want the hyperbolic cosecant. + */ + csch(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the cumulative interest paid between two periods. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param rate - Is the interest rate. + * @param nper - Is the total number of payment periods. + * @param pv - Is the present value. + * @param startPeriod - Is the first period in the calculation. + * @param endPeriod - Is the last period in the calculation. + * @param type - Is the timing of the payment. + */ + cumIPmt(rate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, nper: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, pv: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, startPeriod: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, endPeriod: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, type: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the cumulative principal paid on a loan between two periods. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param rate - Is the interest rate. + * @param nper - Is the total number of payment periods. + * @param pv - Is the present value. + * @param startPeriod - Is the first period in the calculation. + * @param endPeriod - Is the last period in the calculation. + * @param type - Is the timing of the payment. + */ + cumPrinc(rate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, nper: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, pv: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, startPeriod: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, endPeriod: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, type: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Averages the values in a column in a list or database that match conditions you specify. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param database - Is the range of cells that makes up the list or database. A database is a list of related data. + * @param field - Is either the label of the column in double quotation marks or a number that represents the column's position in the list. + * @param criteria - Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition. + */ + daverage(database: Excel.Range | Excel.RangeReference | Excel.FunctionResult, field: number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult, criteria: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Counts the cells containing numbers in the field (column) of records in the database that match the conditions you specify. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param database - Is the range of cells that makes up the list or database. A database is a list of related data. + * @param field - Is either the label of the column in double quotation marks or a number that represents the column's position in the list. + * @param criteria - Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition. + */ + dcount(database: Excel.Range | Excel.RangeReference | Excel.FunctionResult, field: number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult, criteria: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Counts nonblank cells in the field (column) of records in the database that match the conditions you specify. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param database - Is the range of cells that makes up the list or database. A database is a list of related data. + * @param field - Is either the label of the column in double quotation marks or a number that represents the column's position in the list. + * @param criteria - Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition. + */ + dcountA(database: Excel.Range | Excel.RangeReference | Excel.FunctionResult, field: number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult, criteria: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Extracts from a database a single record that matches the conditions you specify. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param database - Is the range of cells that makes up the list or database. A database is a list of related data. + * @param field - Is either the label of the column in double quotation marks or a number that represents the column's position in the list. + * @param criteria - Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition. + */ + dget(database: Excel.Range | Excel.RangeReference | Excel.FunctionResult, field: number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult, criteria: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the largest number in the field (column) of records in the database that match the conditions you specify. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param database - Is the range of cells that makes up the list or database. A database is a list of related data. + * @param field - Is either the label of the column in double quotation marks or a number that represents the column's position in the list. + * @param criteria - Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition. + */ + dmax(database: Excel.Range | Excel.RangeReference | Excel.FunctionResult, field: number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult, criteria: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the smallest number in the field (column) of records in the database that match the conditions you specify. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param database - Is the range of cells that makes up the list or database. A database is a list of related data. + * @param field - Is either the label of the column in double quotation marks or a number that represents the column's position in the list. + * @param criteria - Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition. + */ + dmin(database: Excel.Range | Excel.RangeReference | Excel.FunctionResult, field: number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult, criteria: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Multiplies the values in the field (column) of records in the database that match the conditions you specify. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param database - Is the range of cells that makes up the list or database. A database is a list of related data. + * @param field - Is either the label of the column in double quotation marks or a number that represents the column's position in the list. + * @param criteria - Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition. + */ + dproduct(database: Excel.Range | Excel.RangeReference | Excel.FunctionResult, field: number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult, criteria: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Estimates the standard deviation based on a sample from selected database entries. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param database - Is the range of cells that makes up the list or database. A database is a list of related data. + * @param field - Is either the label of the column in double quotation marks or a number that represents the column's position in the list. + * @param criteria - Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition. + */ + dstDev(database: Excel.Range | Excel.RangeReference | Excel.FunctionResult, field: number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult, criteria: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Calculates the standard deviation based on the entire population of selected database entries. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param database - Is the range of cells that makes up the list or database. A database is a list of related data. + * @param field - Is either the label of the column in double quotation marks or a number that represents the column's position in the list. + * @param criteria - Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition. + */ + dstDevP(database: Excel.Range | Excel.RangeReference | Excel.FunctionResult, field: number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult, criteria: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Adds the numbers in the field (column) of records in the database that match the conditions you specify. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param database - Is the range of cells that makes up the list or database. A database is a list of related data. + * @param field - Is either the label of the column in double quotation marks or a number that represents the column's position in the list. + * @param criteria - Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition. + */ + dsum(database: Excel.Range | Excel.RangeReference | Excel.FunctionResult, field: number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult, criteria: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Estimates variance based on a sample from selected database entries. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param database - Is the range of cells that makes up the list or database. A database is a list of related data. + * @param field - Is either the label of the column in double quotation marks or a number that represents the column's position in the list. + * @param criteria - Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition. + */ + dvar(database: Excel.Range | Excel.RangeReference | Excel.FunctionResult, field: number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult, criteria: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Calculates variance based on the entire population of selected database entries. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param database - Is the range of cells that makes up the list or database. A database is a list of related data. + * @param field - Is either the label of the column in double quotation marks or a number that represents the column's position in the list. + * @param criteria - Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition. + */ + dvarP(database: Excel.Range | Excel.RangeReference | Excel.FunctionResult, field: number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult, criteria: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the number that represents the date in Microsoft Excel date-time code. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param year - Is a number from 1900 or 1904 (depending on the workbook's date system) to 9999. + * @param month - Is a number from 1 to 12 representing the month of the year. + * @param day - Is a number from 1 to 31 representing the day of the month. + */ + date(year: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, month: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, day: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Converts a date in the form of text to a number that represents the date in Microsoft Excel date-time code. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param dateText - Is text that represents a date in a Microsoft Excel date format, between 1/1/1900 or 1/1/1904 (depending on the workbook's date system) and 12/31/9999. + */ + datevalue(dateText: string | number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the day of the month, a number from 1 to 31. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param serialNumber - Is a number in the date-time code used by Microsoft Excel. + */ + day(serialNumber: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the number of days between the two dates. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param endDate - startDate and endDate are the two dates between which you want to know the number of days. + * @param startDate - startDate and endDate are the two dates between which you want to know the number of days. + */ + days(endDate: string | number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, startDate: string | number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the number of days between two dates based on a 360-day year (twelve 30-day months). + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param startDate - startDate and endDate are the two dates between which you want to know the number of days. + * @param endDate - startDate and endDate are the two dates between which you want to know the number of days. + * @param method - Is a logical value specifying the calculation method: U.S. (NASD) = FALSE or omitted; European = TRUE. + */ + days360(startDate: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, endDate: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, method?: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the depreciation of an asset for a specified period using the fixed-declining balance method. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param cost - Is the initial cost of the asset. + * @param salvage - Is the salvage value at the end of the life of the asset. + * @param life - Is the number of periods over which the asset is being depreciated (sometimes called the useful life of the asset). + * @param period - Is the period for which you want to calculate the depreciation. Period must use the same units as Life. + * @param month - Is the number of months in the first year. If month is omitted, it is assumed to be 12. + */ + db(cost: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, salvage: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, life: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, period: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, month?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Changes half-width (single-byte) characters within a character string to full-width (double-byte) characters. Use with double-byte character sets (DBCS). + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param text - Is a text, or a reference to a cell containing a text. + */ + dbcs(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the depreciation of an asset for a specified period using the double-declining balance method or some other method you specify. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param cost - Is the initial cost of the asset. + * @param salvage - Is the salvage value at the end of the life of the asset. + * @param life - Is the number of periods over which the asset is being depreciated (sometimes called the useful life of the asset). + * @param period - Is the period for which you want to calculate the depreciation. Period must use the same units as Life. + * @param factor - Is the rate at which the balance declines. If Factor is omitted, it is assumed to be 2 (the double-declining balance method). + */ + ddb(cost: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, salvage: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, life: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, period: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, factor?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Converts a decimal number to binary. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the decimal integer you want to convert. + * @param places - Is the number of characters to use. + */ + dec2Bin(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, places?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Converts a decimal number to hexadecimal. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the decimal integer you want to convert. + * @param places - Is the number of characters to use. + */ + dec2Hex(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, places?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Converts a decimal number to octal. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the decimal integer you want to convert. + * @param places - Is the number of characters to use. + */ + dec2Oct(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, places?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Converts a text representation of a number in a given base into a decimal number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the number that you want to convert. + * @param radix - Is the base Radix of the number you are converting. + */ + decimal(number: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult, radix: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Converts radians to degrees. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param angle - Is the angle in radians that you want to convert. + */ + degrees(angle: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Tests whether two numbers are equal. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number1 - Is the first number. + * @param number2 - Is the second number. + */ + delta(number1: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, number2?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the sum of squares of deviations of data points from their sample mean. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - List of parameters, whose elements are 1 to 255 arguments, or an array or array reference, on which you want DEVSQ to calculate. + */ + devSq(...values: Array>): FunctionResult; + /** + * Returns the discount rate for a security. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param settlement - Is the security's settlement date, expressed as a serial date number. + * @param maturity - Is the security's maturity date, expressed as a serial date number. + * @param pr - Is the security's price per $100 face value. + * @param redemption - Is the security's redemption value per $100 face value. + * @param basis - Is the type of day count basis to use. + */ + disc(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, pr: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, redemption: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Converts a number to text, using currency format. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is a number, a reference to a cell containing a number, or a formula that evaluates to a number. + * @param decimals - Is the number of digits to the right of the decimal point. The number is rounded as necessary; if omitted, Decimals = 2. + */ + dollar(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, decimals?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Converts a dollar price, expressed as a fraction, into a dollar price, expressed as a decimal number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param fractionalDollar - Is a number expressed as a fraction. + * @param fraction - Is the integer to use in the denominator of the fraction. + */ + dollarDe(fractionalDollar: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, fraction: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Converts a dollar price, expressed as a decimal number, into a dollar price, expressed as a fraction. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param decimalDollar - Is a decimal number. + * @param fraction - Is the integer to use in the denominator of a fraction. + */ + dollarFr(decimalDollar: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, fraction: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the annual duration of a security with periodic interest payments. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param settlement - Is the security's settlement date, expressed as a serial date number. + * @param maturity - Is the security's maturity date, expressed as a serial date number. + * @param coupon - Is the security's annual coupon rate. + * @param yld - Is the security's annual yield. + * @param frequency - Is the number of coupon payments per year. + * @param basis - Is the type of day count basis to use. + */ + duration(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, coupon: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, yld: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, frequency: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Rounds a number up, to the nearest integer or to the nearest multiple of significance. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the value you want to round. + * @param significance - Is the multiple to which you want to round. + */ + ecma_Ceiling(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, significance: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the serial number of the date that is the indicated number of months before or after the start date. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param startDate - Is a serial date number that represents the start date. + * @param months - Is the number of months before or after startDate. + */ + edate(startDate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, months: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the effective annual interest rate. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param nominalRate - Is the nominal interest rate. + * @param npery - Is the number of compounding periods per year. + */ + effect(nominalRate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, npery: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the serial number of the last day of the month before or after a specified number of months. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param startDate - Is a serial date number that represents the start date. + * @param months - Is the number of months before or after the startDate. + */ + eoMonth(startDate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, months: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the error function. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param lowerLimit - Is the lower bound for integrating ERF. + * @param upperLimit - Is the upper bound for integrating ERF. + */ + erf(lowerLimit: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, upperLimit?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the complementary error function. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param x - Is the lower bound for integrating ERF. + */ + erfC(x: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the complementary error function. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param X - Is the lower bound for integrating ERFC.PRECISE. + */ + erfC_Precise(X: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the error function. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param X - Is the lower bound for integrating ERF.PRECISE. + */ + erf_Precise(X: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns a number matching an error value. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param errorVal - Is the error value for which you want the identifying number, and can be an actual error value or a reference to a cell containing an error value. + */ + error_Type(errorVal: string | number | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Rounds a positive number up and negative number down to the nearest even integer. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the value to round. + */ + even(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Checks whether two text strings are exactly the same, and returns TRUE or FALSE. EXACT is case-sensitive. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param text1 - Is the first text string. + * @param text2 - Is the second text string. + */ + exact(text1: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult, text2: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns e raised to the power of a given number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the exponent applied to the base e. The constant e equals 2.71828182845904, the base of the natural logarithm. + */ + exp(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the exponential distribution. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param x - Is the value of the function, a nonnegative number. + * @param lambda - Is the parameter value, a positive number. + * @param cumulative - Is a logical value for the function to return: the cumulative distribution function = TRUE; the probability density function = FALSE. + */ + expon_Dist(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, lambda: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, cumulative: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the future value of an initial principal after applying a series of compound interest rates. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param principal - Is the present value. + * @param schedule - Is an array of interest rates to apply. + */ + fvschedule(principal: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, schedule: number | string | Excel.Range | boolean | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the (left-tailed) F probability distribution (degree of diversity) for two data sets. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param x - Is the value at which to evaluate the function, a nonnegative number. + * @param degFreedom1 - Is the numerator degrees of freedom, a number between 1 and 10^10, excluding 10^10. + * @param degFreedom2 - Is the denominator degrees of freedom, a number between 1 and 10^10, excluding 10^10. + * @param cumulative - Is a logical value for the function to return: the cumulative distribution function = TRUE; the probability density function = FALSE. + */ + f_Dist(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, degFreedom1: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, degFreedom2: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, cumulative: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the (right-tailed) F probability distribution (degree of diversity) for two data sets. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param x - Is the value at which to evaluate the function, a nonnegative number. + * @param degFreedom1 - Is the numerator degrees of freedom, a number between 1 and 10^10, excluding 10^10. + * @param degFreedom2 - Is the denominator degrees of freedom, a number between 1 and 10^10, excluding 10^10. + */ + f_Dist_RT(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, degFreedom1: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, degFreedom2: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the inverse of the (left-tailed) F probability distribution: if p = F.DIST(x,...), then F.INV(p,...) = x. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param probability - Is a probability associated with the F cumulative distribution, a number between 0 and 1 inclusive. + * @param degFreedom1 - Is the numerator degrees of freedom, a number between 1 and 10^10, excluding 10^10. + * @param degFreedom2 - Is the denominator degrees of freedom, a number between 1 and 10^10, excluding 10^10. + */ + f_Inv(probability: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, degFreedom1: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, degFreedom2: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the inverse of the (right-tailed) F probability distribution: if p = F.DIST.RT(x,...), then F.INV.RT(p,...) = x. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param probability - Is a probability associated with the F cumulative distribution, a number between 0 and 1 inclusive. + * @param degFreedom1 - Is the numerator degrees of freedom, a number between 1 and 10^10, excluding 10^10. + * @param degFreedom2 - Is the denominator degrees of freedom, a number between 1 and 10^10, excluding 10^10. + */ + f_Inv_RT(probability: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, degFreedom1: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, degFreedom2: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the factorial of a number, equal to 1*2*3*...* Number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the nonnegative number you want the factorial of. + */ + fact(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the double factorial of a number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the value for which to return the double factorial. + */ + factDouble(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the logical value FALSE. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + false(): FunctionResult; + /** + * Returns the starting position of one text string within another text string. FIND is case-sensitive. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param findText - Is the text you want to find. Use double quotes (empty text) to match the first character in withinText; wildcard characters not allowed. + * @param withinText - Is the text containing the text you want to find. + * @param startNum - Specifies the character at which to start the search. The first character in withinText is character number 1. If omitted, startNum = 1. + */ + find(findText: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult, withinText: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult, startNum?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Finds the starting position of one text string within another text string. FINDB is case-sensitive. Use with double-byte character sets (DBCS). + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param findText - Is the text you want to find. + * @param withinText - Is the text containing the text you want to find. + * @param startNum - Specifies the character at which to start the search. + */ + findB(findText: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult, withinText: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult, startNum?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the Fisher transformation. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param x - Is the value for which you want the transformation, a number between -1 and 1, excluding -1 and 1. + */ + fisher(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the inverse of the Fisher transformation: if y = FISHER(x), then FISHERINV(y) = x. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param y - Is the value for which you want to perform the inverse of the transformation. + */ + fisherInv(y: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Rounds a number to the specified number of decimals and returns the result as text with or without commas. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the number you want to round and convert to text. + * @param decimals - Is the number of digits to the right of the decimal point. If omitted, Decimals = 2. + * @param noCommas - Is a logical value: do not display commas in the returned text = TRUE; do display commas in the returned text = FALSE or omitted. + */ + fixed(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, decimals?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, noCommas?: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Rounds a number down, to the nearest integer or to the nearest multiple of significance. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the value you want to round. + * @param significance - Is the multiple to which you want to round. + * @param mode - When given and nonzero this function will round towards zero. + */ + floor_Math(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, significance?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, mode?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Rounds a number down, to the nearest integer or to the nearest multiple of significance. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the numeric value you want to round. + * @param significance - Is the multiple to which you want to round. + */ + floor_Precise(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, significance?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the future value of an investment based on periodic, constant payments and a constant interest rate. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param rate - Is the interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR. + * @param nper - Is the total number of payment periods in the investment. + * @param pmt - Is the payment made each period; it cannot change over the life of the investment. + * @param pv - Is the present value, or the lump-sum amount that a series of future payments is worth now. If omitted, Pv = 0. + * @param type - Is a value representing the timing of payment: payment at the beginning of the period = 1; payment at the end of the period = 0 or omitted. + */ + fv(rate: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, nper: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, pmt: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, pv?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, type?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the Gamma function value. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param x - Is the value for which you want to calculate Gamma. + */ + gamma(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the natural logarithm of the gamma function. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param x - Is the value for which you want to calculate GAMMALN, a positive number. + */ + gammaLn(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the natural logarithm of the gamma function. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param x - Is the value for which you want to calculate GAMMALN.PRECISE, a positive number. + */ + gammaLn_Precise(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the gamma distribution. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param x - Is the value at which you want to evaluate the distribution, a nonnegative number. + * @param alpha - Is a parameter to the distribution, a positive number. + * @param beta - Is a parameter to the distribution, a positive number. If beta = 1, GAMMA.DIST returns the standard gamma distribution. + * @param cumulative - Is a logical value: return the cumulative distribution function = TRUE; return the probability mass function = FALSE or omitted. + */ + gamma_Dist(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, alpha: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, beta: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, cumulative: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the inverse of the gamma cumulative distribution: if p = GAMMA.DIST(x,...), then GAMMA.INV(p,...) = x. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param probability - Is the probability associated with the gamma distribution, a number between 0 and 1, inclusive. + * @param alpha - Is a parameter to the distribution, a positive number. + * @param beta - Is a parameter to the distribution, a positive number. If beta = 1, GAMMA.INV returns the inverse of the standard gamma distribution. + */ + gamma_Inv(probability: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, alpha: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, beta: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns 0.5 less than the standard normal cumulative distribution. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param x - Is the value for which you want the distribution. + */ + gauss(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the greatest common divisor. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - List of parameters, whose elements are 1 to 255 values. + */ + gcd(...values: Array>): FunctionResult; + /** + * Tests whether a number is greater than a threshold value. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the value to test against step. + * @param step - Is the threshold value. + */ + geStep(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, step?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the geometric mean of an array or range of positive numeric data. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - List of parameters, whose elements are 1 to 255 numbers or names, arrays, or references that contain numbers for which you want the mean. + */ + geoMean(...values: Array>): FunctionResult; + /** + * Looks for a value in the top row of a table or array of values and returns the value in the same column from a row you specify. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param lookupValue - Is the value to be found in the first row of the table and can be a value, a reference, or a text string. + * @param tableArray - Is a table of text, numbers, or logical values in which data is looked up. tableArray can be a reference to a range or a range name. + * @param rowIndexNum - Is the row number in tableArray from which the matching value should be returned. The first row of values in the table is row 1. + * @param rangeLookup - Is a logical value: to find the closest match in the top row (sorted in ascending order) = TRUE or omitted; find an exact match = FALSE. + */ + hlookup(lookupValue: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, tableArray: Excel.Range | number | Excel.RangeReference | Excel.FunctionResult, rowIndexNum: Excel.Range | number | Excel.RangeReference | Excel.FunctionResult, rangeLookup?: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the harmonic mean of a data set of positive numbers: the reciprocal of the arithmetic mean of reciprocals. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - List of parameters, whose elements are 1 to 255 numbers or names, arrays, or references that contain numbers for which you want the harmonic mean. + */ + harMean(...values: Array>): FunctionResult; + /** + * Converts a Hexadecimal number to binary. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the hexadecimal number you want to convert. + * @param places - Is the number of characters to use. + */ + hex2Bin(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, places?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Converts a hexadecimal number to decimal. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the hexadecimal number you want to convert. + */ + hex2Dec(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Converts a hexadecimal number to octal. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the hexadecimal number you want to convert. + * @param places - Is the number of characters to use. + */ + hex2Oct(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, places?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the hour as a number from 0 (12:00 A.M.) to 23 (11:00 P.M.). + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param serialNumber - Is a number in the date-time code used by Microsoft Excel, or text in time format, such as 16:48:00 or 4:48:00 PM. + */ + hour(serialNumber: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the hypergeometric distribution. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param sampleS - Is the number of successes in the sample. + * @param numberSample - Is the size of the sample. + * @param populationS - Is the number of successes in the population. + * @param numberPop - Is the population size. + * @param cumulative - Is a logical value: for the cumulative distribution function, use TRUE; for the probability density function, use FALSE. + */ + hypGeom_Dist(sampleS: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, numberSample: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, populationS: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, numberPop: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, cumulative: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Creates a shortcut or jump that opens a document stored on your hard drive, a network server, or on the Internet. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param linkLocation - Is the text giving the path and file name to the document to be opened, a hard drive location, UNC address, or URL path. + * @param friendlyName - Is text or a number that is displayed in the cell. If omitted, the cell displays the linkLocation text. + */ + hyperlink(linkLocation: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult, friendlyName?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Rounds a number up, to the nearest integer or to the nearest multiple of significance. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the value you want to round. + * @param significance - Is the optional multiple to which you want to round. + */ + iso_Ceiling(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, significance?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Checks whether a condition is met, and returns one value if TRUE, and another value if FALSE. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param logicalTest - Is any value or expression that can be evaluated to TRUE or FALSE. + * @param valueIfTrue - Is the value that is returned if logicalTest is TRUE. If omitted, TRUE is returned. You can nest up to seven IF functions. + * @param valueIfFalse - Is the value that is returned if logicalTest is FALSE. If omitted, FALSE is returned. + */ + if(logicalTest: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, valueIfTrue?: Excel.Range | number | string | boolean | Excel.RangeReference | Excel.FunctionResult, valueIfFalse?: Excel.Range | number | string | boolean | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the absolute value (modulus) of a complex number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param inumber - Is a complex number for which you want the absolute value. + */ + imAbs(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the argument q, an angle expressed in radians. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param inumber - Is a complex number for which you want the argument. + */ + imArgument(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the complex conjugate of a complex number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param inumber - Is a complex number for which you want the conjugate. + */ + imConjugate(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the cosine of a complex number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param inumber - Is a complex number for which you want the cosine. + */ + imCos(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the hyperbolic cosine of a complex number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param inumber - Is a complex number for which you want the hyperbolic cosine. + */ + imCosh(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the cotangent of a complex number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param inumber - Is a complex number for which you want the cotangent. + */ + imCot(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the cosecant of a complex number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param inumber - Is a complex number for which you want the cosecant. + */ + imCsc(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the hyperbolic cosecant of a complex number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param inumber - Is a complex number for which you want the hyperbolic cosecant. + */ + imCsch(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the quotient of two complex numbers. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param inumber1 - Is the complex numerator or dividend. + * @param inumber2 - Is the complex denominator or divisor. + */ + imDiv(inumber1: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, inumber2: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the exponential of a complex number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param inumber - Is a complex number for which you want the exponential. + */ + imExp(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the natural logarithm of a complex number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param inumber - Is a complex number for which you want the natural logarithm. + */ + imLn(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the base-10 logarithm of a complex number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param inumber - Is a complex number for which you want the common logarithm. + */ + imLog10(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the base-2 logarithm of a complex number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param inumber - Is a complex number for which you want the base-2 logarithm. + */ + imLog2(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns a complex number raised to an integer power. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param inumber - Is a complex number you want to raise to a power. + * @param number - Is the power to which you want to raise the complex number. + */ + imPower(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the product of 1 to 255 complex numbers. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - Inumber1, Inumber2,... are from 1 to 255 complex numbers to multiply. + */ + imProduct(...values: Array>): FunctionResult; + /** + * Returns the real coefficient of a complex number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param inumber - Is a complex number for which you want the real coefficient. + */ + imReal(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the secant of a complex number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param inumber - Is a complex number for which you want the secant. + */ + imSec(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the hyperbolic secant of a complex number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param inumber - Is a complex number for which you want the hyperbolic secant. + */ + imSech(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the sine of a complex number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param inumber - Is a complex number for which you want the sine. + */ + imSin(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the hyperbolic sine of a complex number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param inumber - Is a complex number for which you want the hyperbolic sine. + */ + imSinh(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the square root of a complex number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param inumber - Is a complex number for which you want the square root. + */ + imSqrt(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the difference of two complex numbers. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param inumber1 - Is the complex number from which to subtract inumber2. + * @param inumber2 - Is the complex number to subtract from inumber1. + */ + imSub(inumber1: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, inumber2: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the sum of complex numbers. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - List of parameters, whose elements are from 1 to 255 complex numbers to add. + */ + imSum(...values: Array>): FunctionResult; + /** + * Returns the tangent of a complex number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param inumber - Is a complex number for which you want the tangent. + */ + imTan(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the imaginary coefficient of a complex number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param inumber - Is a complex number for which you want the imaginary coefficient. + */ + imaginary(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Rounds a number down to the nearest integer. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the real number you want to round down to an integer. + */ + int(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the interest rate for a fully invested security. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param settlement - Is the security's settlement date, expressed as a serial date number. + * @param maturity - Is the security's maturity date, expressed as a serial date number. + * @param investment - Is the amount invested in the security. + * @param redemption - Is the amount to be received at maturity. + * @param basis - Is the type of day count basis to use. + */ + intRate(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, investment: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, redemption: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the interest payment for a given period for an investment, based on periodic, constant payments and a constant interest rate. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param rate - Is the interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR. + * @param per - Is the period for which you want to find the interest and must be in the range 1 to Nper. + * @param nper - Is the total number of payment periods in an investment. + * @param pv - Is the present value, or the lump-sum amount that a series of future payments is worth now. + * @param fv - Is the future value, or a cash balance you want to attain after the last payment is made. If omitted, Fv = 0. + * @param type - Is a logical value representing the timing of payment: at the end of the period = 0 or omitted, at the beginning of the period = 1. + */ + ipmt(rate: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, per: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, nper: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, pv: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, fv?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, type?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the internal rate of return for a series of cash flows. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - Is an array or a reference to cells that contain numbers for which you want to calculate the internal rate of return. + * @param guess - Is a number that you guess is close to the result of IRR; 0.1 (10 percent) if omitted. + */ + irr(values: Excel.Range | Excel.RangeReference | Excel.FunctionResult, guess?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Checks whether a value is an error other than #N/A, and returns TRUE or FALSE. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param value - Is the value you want to test. Value can refer to a cell, a formula, or a name that refers to a cell, formula, or value. + */ + isErr(value: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Checks whether a value is an error, and returns TRUE or FALSE. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param value - Is the value you want to test. Value can refer to a cell, a formula, or a name that refers to a cell, formula, or value. + */ + isError(value: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns TRUE if the number is even. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the value to test. + */ + isEven(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Checks whether a reference is to a cell containing a formula, and returns TRUE or FALSE. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param reference - Is a reference to the cell you want to test. Reference can be a cell reference, a formula, or name that refers to a cell. + */ + isFormula(reference: Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Checks whether a value is a logical value (TRUE or FALSE), and returns TRUE or FALSE. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param value - Is the value you want to test. Value can refer to a cell, a formula, or a name that refers to a cell, formula, or value. + */ + isLogical(value: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Checks whether a value is #N/A, and returns TRUE or FALSE. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param value - Is the value you want to test. Value can refer to a cell, a formula, or a name that refers to a cell, formula, or value. + */ + isNA(value: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Checks whether a value is not text (blank cells are not text), and returns TRUE or FALSE. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param value - Is the value you want tested: a cell; a formula; or a name referring to a cell, formula, or value. + */ + isNonText(value: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Checks whether a value is a number, and returns TRUE or FALSE. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param value - Is the value you want to test. Value can refer to a cell, a formula, or a name that refers to a cell, formula, or value. + */ + isNumber(value: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns TRUE if the number is odd. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the value to test. + */ + isOdd(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Checks whether a value is text, and returns TRUE or FALSE. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param value - Is the value you want to test. Value can refer to a cell, a formula, or a name that refers to a cell, formula, or value. + */ + isText(value: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the ISO week number in the year for a given date. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param date - Is the date-time code used by Microsoft Excel for date and time calculation. + */ + isoWeekNum(date: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the interest paid during a specific period of an investment. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param rate - Interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR. + * @param per - Period for which you want to find the interest. + * @param nper - Number of payment periods in an investment. + * @param pv - Lump sum amount that a series of future payments is right now. + */ + ispmt(rate: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, per: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, nper: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, pv: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Checks whether a value is a reference, and returns TRUE or FALSE. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param value - Is the value you want to test. Value can refer to a cell, a formula, or a name that refers to a cell, formula, or value. + */ + isref(value: Excel.Range | number | string | boolean | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the kurtosis of a data set. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - List of parameters, whose elements are 1 to 255 numbers or names, arrays, or references that contain numbers for which you want the kurtosis. + */ + kurt(...values: Array>): FunctionResult; + /** + * Returns the k-th largest value in a data set. For example, the fifth largest number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param array - Is the array or range of data for which you want to determine the k-th largest value. + * @param k - Is the position (from the largest) in the array or cell range of the value to return. + */ + large(array: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, k: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the least common multiple. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - List of parameters, whose elements are 1 to 255 values for which you want the least common multiple. + */ + lcm(...values: Array>): FunctionResult; + /** + * Returns the specified number of characters from the start of a text string. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param text - Is the text string containing the characters you want to extract. + * @param numChars - Specifies how many characters you want LEFT to extract; 1 if omitted. + */ + left(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult, numChars?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the specified number of characters from the start of a text string. Use with double-byte character sets (DBCS). + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param text - Is the text string containing the characters you want to extract. + * @param numBytes - Specifies how many characters you want LEFT to return. + */ + leftb(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult, numBytes?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the number of characters in a text string. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param text - Is the text whose length you want to find. Spaces count as characters. + */ + len(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the number of characters in a text string. Use with double-byte character sets (DBCS). + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param text - Is the text whose length you want to find. + */ + lenb(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the natural logarithm of a number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the positive real number for which you want the natural logarithm. + */ + ln(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the logarithm of a number to the base you specify. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the positive real number for which you want the logarithm. + * @param base - Is the base of the logarithm; 10 if omitted. + */ + log(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, base?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the base-10 logarithm of a number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the positive real number for which you want the base-10 logarithm. + */ + log10(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the lognormal distribution of x, where ln(x) is normally distributed with parameters Mean and Standard_dev. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param x - Is the value at which to evaluate the function, a positive number. + * @param mean - Is the mean of ln(x). + * @param standardDev - Is the standard deviation of ln(x), a positive number. + * @param cumulative - Is a logical value: for the cumulative distribution function, use TRUE; for the probability density function, use FALSE. + */ + logNorm_Dist(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, mean: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, standardDev: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, cumulative: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the inverse of the lognormal cumulative distribution function of x, where ln(x) is normally distributed with parameters Mean and Standard_dev. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param probability - Is a probability associated with the lognormal distribution, a number between 0 and 1, inclusive. + * @param mean - Is the mean of ln(x). + * @param standardDev - Is the standard deviation of ln(x), a positive number. + */ + logNorm_Inv(probability: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, mean: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, standardDev: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Looks up a value either from a one-row or one-column range or from an array. Provided for backward compatibility. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param lookupValue - Is a value that LOOKUP searches for in lookupVector and can be a number, text, a logical value, or a name or reference to a value. + * @param lookupVector - Is a range that contains only one row or one column of text, numbers, or logical values, placed in ascending order. + * @param resultVector - Is a range that contains only one row or column, the same size as lookupVector. + */ + lookup(lookupValue: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, lookupVector: Excel.Range | Excel.RangeReference | Excel.FunctionResult, resultVector?: Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Converts all letters in a text string to lowercase. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param text - Is the text you want to convert to lowercase. Characters in Text that are not letters are not changed. + */ + lower(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the Macauley modified duration for a security with an assumed par value of $100. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param settlement - Is the security's settlement date, expressed as a serial date number. + * @param maturity - Is the security's maturity date, expressed as a serial date number. + * @param coupon - Is the security's annual coupon rate. + * @param yld - Is the security's annual yield. + * @param frequency - Is the number of coupon payments per year. + * @param basis - Is the type of day count basis to use. + */ + mduration(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, coupon: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, yld: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, frequency: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the internal rate of return for a series of periodic cash flows, considering both cost of investment and interest on reinvestment of cash. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - Is an array or a reference to cells that contain numbers that represent a series of payments (negative) and income (positive) at regular periods. + * @param financeRate - Is the interest rate you pay on the money used in the cash flows. + * @param reinvestRate - Is the interest rate you receive on the cash flows as you reinvest them. + */ + mirr(values: Excel.Range | Excel.RangeReference | Excel.FunctionResult, financeRate: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, reinvestRate: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns a number rounded to the desired multiple. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the value to round. + * @param multiple - Is the multiple to which you want to round number. + */ + mround(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, multiple: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the relative position of an item in an array that matches a specified value in a specified order. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param lookupValue - Is the value you use to find the value you want in the array, a number, text, or logical value, or a reference to one of these. + * @param lookupArray - Is a contiguous range of cells containing possible lookup values, an array of values, or a reference to an array. + * @param matchType - Is a number 1, 0, or -1 indicating which value to return. + */ + match(lookupValue: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, lookupArray: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, matchType?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the largest value in a set of values. Ignores logical values and text. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - List of parameters, whose elements are 1 to 255 numbers, empty cells, logical values, or text numbers for which you want the maximum. + */ + max(...values: Array>): FunctionResult; + /** + * Returns the largest value in a set of values. Does not ignore logical values and text. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - List of parameters, whose elements are 1 to 255 numbers, empty cells, logical values, or text numbers for which you want the maximum. + */ + maxA(...values: Array>): FunctionResult; + /** + * Returns the median, or the number in the middle of the set of given numbers. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - List of parameters, whose elements are 1 to 255 numbers or names, arrays, or references that contain numbers for which you want the median. + */ + median(...values: Array>): FunctionResult; + /** + * Returns the characters from the middle of a text string, given a starting position and length. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param text - Is the text string from which you want to extract the characters. + * @param startNum - Is the position of the first character you want to extract. The first character in Text is 1. + * @param numChars - Specifies how many characters to return from Text. + */ + mid(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult, startNum: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, numChars: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns characters from the middle of a text string, given a starting position and length. Use with double-byte character sets (DBCS). + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param text - Is the text string containing the characters you want to extract. + * @param startNum - Is the position of the first character you want to extract in text. + * @param numBytes - Specifies how many characters to return from text. + */ + midb(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult, startNum: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, numBytes: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the smallest number in a set of values. Ignores logical values and text. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - List of parameters, whose elements are 1 to 255 numbers, empty cells, logical values, or text numbers for which you want the minimum. + */ + min(...values: Array>): FunctionResult; + /** + * Returns the smallest value in a set of values. Does not ignore logical values and text. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - List of parameters, whose elements are 1 to 255 numbers, empty cells, logical values, or text numbers for which you want the minimum. + */ + minA(...values: Array>): FunctionResult; + /** + * Returns the minute, a number from 0 to 59. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param serialNumber - Is a number in the date-time code used by Microsoft Excel or text in time format, such as 16:48:00 or 4:48:00 PM. + */ + minute(serialNumber: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the remainder after a number is divided by a divisor. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the number for which you want to find the remainder after the division is performed. + * @param divisor - Is the number by which you want to divide Number. + */ + mod(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, divisor: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the month, a number from 1 (January) to 12 (December). + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param serialNumber - Is a number in the date-time code used by Microsoft Excel. + */ + month(serialNumber: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the multinomial of a set of numbers. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - List of parameters, whose elements are 1 to 255 values for which you want the multinomial. + */ + multiNomial(...values: Array>): FunctionResult; + /** + * Converts non-number value to a number, dates to serial numbers, TRUE to 1, anything else to 0 (zero). + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param value - Is the value you want converted. + */ + n(value: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the number of periods for an investment based on periodic, constant payments and a constant interest rate. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param rate - Is the interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR. + * @param pmt - Is the payment made each period; it cannot change over the life of the investment. + * @param pv - Is the present value, or the lump-sum amount that a series of future payments is worth now. + * @param fv - Is the future value, or a cash balance you want to attain after the last payment is made. If omitted, zero is used. + * @param type - Is a logical value: payment at the beginning of the period = 1; payment at the end of the period = 0 or omitted. + */ + nper(rate: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, pmt: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, pv: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, fv?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, type?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the error value #N/A (value not available). + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + na(): FunctionResult; + /** + * Returns the negative binomial distribution, the probability that there will be Number_f failures before the Number_s-th success, with Probability_s probability of a success. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param numberF - Is the number of failures. + * @param numberS - Is the threshold number of successes. + * @param probabilityS - Is the probability of a success; a number between 0 and 1. + * @param cumulative - Is a logical value: for the cumulative distribution function, use TRUE; for the probability mass function, use FALSE. + */ + negBinom_Dist(numberF: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, numberS: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, probabilityS: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, cumulative: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the number of whole workdays between two dates. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param startDate - Is a serial date number that represents the start date. + * @param endDate - Is a serial date number that represents the end date. + * @param holidays - Is an optional set of one or more serial date numbers to exclude from the working calendar, such as state and federal holidays and floating holidays. + */ + networkDays(startDate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, endDate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, holidays?: number | string | Excel.Range | boolean | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the number of whole workdays between two dates with custom weekend parameters. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param startDate - Is a serial date number that represents the start date. + * @param endDate - Is a serial date number that represents the end date. + * @param weekend - Is a number or string specifying when weekends occur. + * @param holidays - Is an optional set of one or more serial date numbers to exclude from the working calendar, such as state and federal holidays and floating holidays. + */ + networkDays_Intl(startDate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, endDate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, weekend?: number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult, holidays?: number | string | Excel.Range | boolean | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the annual nominal interest rate. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param effectRate - Is the effective interest rate. + * @param npery - Is the number of compounding periods per year. + */ + nominal(effectRate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, npery: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the normal distribution for the specified mean and standard deviation. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param x - Is the value for which you want the distribution. + * @param mean - Is the arithmetic mean of the distribution. + * @param standardDev - Is the standard deviation of the distribution, a positive number. + * @param cumulative - Is a logical value: for the cumulative distribution function, use TRUE; for the probability density function, use FALSE. + */ + norm_Dist(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, mean: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, standardDev: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, cumulative: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the inverse of the normal cumulative distribution for the specified mean and standard deviation. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param probability - Is a probability corresponding to the normal distribution, a number between 0 and 1 inclusive. + * @param mean - Is the arithmetic mean of the distribution. + * @param standardDev - Is the standard deviation of the distribution, a positive number. + */ + norm_Inv(probability: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, mean: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, standardDev: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the standard normal distribution (has a mean of zero and a standard deviation of one). + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param z - Is the value for which you want the distribution. + * @param cumulative - Is a logical value for the function to return: the cumulative distribution function = TRUE; the probability density function = FALSE. + */ + norm_S_Dist(z: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, cumulative: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the inverse of the standard normal cumulative distribution (has a mean of zero and a standard deviation of one). + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param probability - Is a probability corresponding to the normal distribution, a number between 0 and 1 inclusive. + */ + norm_S_Inv(probability: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Changes FALSE to TRUE, or TRUE to FALSE. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param logical - Is a value or expression that can be evaluated to TRUE or FALSE. + */ + not(logical: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the current date and time formatted as a date and time. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + now(): FunctionResult; + /** + * Returns the net present value of an investment based on a discount rate and a series of future payments (negative values) and income (positive values). + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param rate - Is the rate of discount over the length of one period. + * @param values - List of parameters, whose elements are 1 to 254 payments and income, equally spaced in time and occurring at the end of each period. + */ + npv(rate: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, ...values: Array>): FunctionResult; + /** + * Converts text to number in a locale-independent manner. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param text - Is the string representing the number you want to convert. + * @param decimalSeparator - Is the character used as the decimal separator in the string. + * @param groupSeparator - Is the character used as the group separator in the string. + */ + numberValue(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult, decimalSeparator?: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult, groupSeparator?: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Converts an octal number to binary. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the octal number you want to convert. + * @param places - Is the number of characters to use. + */ + oct2Bin(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, places?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Converts an octal number to decimal. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the octal number you want to convert. + */ + oct2Dec(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Converts an octal number to hexadecimal. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the octal number you want to convert. + * @param places - Is the number of characters to use. + */ + oct2Hex(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, places?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Rounds a positive number up and negative number down to the nearest odd integer. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the value to round. + */ + odd(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the price per $100 face value of a security with an odd first period. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param settlement - Is the security's settlement date, expressed as a serial date number. + * @param maturity - Is the security's maturity date, expressed as a serial date number. + * @param issue - Is the security's issue date, expressed as a serial date number. + * @param firstCoupon - Is the security's first coupon date, expressed as a serial date number. + * @param rate - Is the security's interest rate. + * @param yld - Is the security's annual yield. + * @param redemption - Is the security's redemption value per $100 face value. + * @param frequency - Is the number of coupon payments per year. + * @param basis - Is the type of day count basis to use. + */ + oddFPrice(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, issue: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, firstCoupon: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, rate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, yld: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, redemption: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, frequency: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the yield of a security with an odd first period. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param settlement - Is the security's settlement date, expressed as a serial date number. + * @param maturity - Is the security's maturity date, expressed as a serial date number. + * @param issue - Is the security's issue date, expressed as a serial date number. + * @param firstCoupon - Is the security's first coupon date, expressed as a serial date number. + * @param rate - Is the security's interest rate. + * @param pr - Is the security's price. + * @param redemption - Is the security's redemption value per $100 face value. + * @param frequency - Is the number of coupon payments per year. + * @param basis - Is the type of day count basis to use. + */ + oddFYield(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, issue: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, firstCoupon: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, rate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, pr: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, redemption: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, frequency: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the price per $100 face value of a security with an odd last period. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param settlement - Is the security's settlement date, expressed as a serial date number. + * @param maturity - Is the security's maturity date, expressed as a serial date number. + * @param lastInterest - Is the security's last coupon date, expressed as a serial date number. + * @param rate - Is the security's interest rate. + * @param yld - Is the security's annual yield. + * @param redemption - Is the security's redemption value per $100 face value. + * @param frequency - Is the number of coupon payments per year. + * @param basis - Is the type of day count basis to use. + */ + oddLPrice(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, lastInterest: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, rate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, yld: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, redemption: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, frequency: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the yield of a security with an odd last period. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param settlement - Is the security's settlement date, expressed as a serial date number. + * @param maturity - Is the security's maturity date, expressed as a serial date number. + * @param lastInterest - Is the security's last coupon date, expressed as a serial date number. + * @param rate - Is the security's interest rate. + * @param pr - Is the security's price. + * @param redemption - Is the security's redemption value per $100 face value. + * @param frequency - Is the number of coupon payments per year. + * @param basis - Is the type of day count basis to use. + */ + oddLYield(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, lastInterest: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, rate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, pr: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, redemption: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, frequency: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Checks whether any of the arguments are TRUE, and returns TRUE or FALSE. Returns FALSE only if all arguments are FALSE. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - List of parameters, whose elements are 1 to 255 conditions that you want to test that can be either TRUE or FALSE. + */ + or(...values: Array>): FunctionResult; + /** + * Returns the number of periods required by an investment to reach a specified value. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param rate - Is the interest rate per period. + * @param pv - Is the present value of the investment. + * @param fv - Is the desired future value of the investment. + */ + pduration(rate: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, pv: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, fv: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the rank of a value in a data set as a percentage (0..1, exclusive) of the data set. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param array - Is the array or range of data with numeric values that defines relative standing. + * @param x - Is the value for which you want to know the rank. + * @param significance - Is an optional value that identifies the number of significant digits for the returned percentage, three digits if omitted (0.xxx%). + */ + percentRank_Exc(array: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, significance?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the rank of a value in a data set as a percentage (0..1, inclusive) of the data set. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param array - Is the array or range of data with numeric values that defines relative standing. + * @param x - Is the value for which you want to know the rank. + * @param significance - Is an optional value that identifies the number of significant digits for the returned percentage, three digits if omitted (0.xxx%). + */ + percentRank_Inc(array: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, significance?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the k-th percentile of values in a range, where k is in the range 0..1, exclusive. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param array - Is the array or range of data that defines relative standing. + * @param k - Is the percentile value that is between 0 through 1, inclusive. + */ + percentile_Exc(array: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, k: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the k-th percentile of values in a range, where k is in the range 0..1, inclusive. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param array - Is the array or range of data that defines relative standing. + * @param k - Is the percentile value that is between 0 through 1, inclusive. + */ + percentile_Inc(array: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, k: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the number of permutations for a given number of objects that can be selected from the total objects. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the total number of objects. + * @param numberChosen - Is the number of objects in each permutation. + */ + permut(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, numberChosen: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the number of permutations for a given number of objects (with repetitions) that can be selected from the total objects. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the total number of objects. + * @param numberChosen - Is the number of objects in each permutation. + */ + permutationa(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, numberChosen: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the value of the density function for a standard normal distribution. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param x - Is the number for which you want the density of the standard normal distribution. + */ + phi(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the value of Pi, 3.14159265358979, accurate to 15 digits. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + pi(): FunctionResult; + /** + * Calculates the payment for a loan based on constant payments and a constant interest rate. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param rate - Is the interest rate per period for the loan. For example, use 6%/4 for quarterly payments at 6% APR. + * @param nper - Is the total number of payments for the loan. + * @param pv - Is the present value: the total amount that a series of future payments is worth now. + * @param fv - Is the future value, or a cash balance you want to attain after the last payment is made, 0 (zero) if omitted. + * @param type - Is a logical value: payment at the beginning of the period = 1; payment at the end of the period = 0 or omitted. + */ + pmt(rate: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, nper: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, pv: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, fv?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, type?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the Poisson distribution. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param x - Is the number of events. + * @param mean - Is the expected numeric value, a positive number. + * @param cumulative - Is a logical value: for the cumulative Poisson probability, use TRUE; for the Poisson probability mass function, use FALSE. + */ + poisson_Dist(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, mean: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, cumulative: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the result of a number raised to a power. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the base number, any real number. + * @param power - Is the exponent, to which the base number is raised. + */ + power(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, power: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the payment on the principal for a given investment based on periodic, constant payments and a constant interest rate. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param rate - Is the interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR. + * @param per - Specifies the period and must be in the range 1 to nper. + * @param nper - Is the total number of payment periods in an investment. + * @param pv - Is the present value: the total amount that a series of future payments is worth now. + * @param fv - Is the future value, or cash balance you want to attain after the last payment is made. + * @param type - Is a logical value: payment at the beginning of the period = 1; payment at the end of the period = 0 or omitted. + */ + ppmt(rate: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, per: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, nper: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, pv: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, fv?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, type?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the price per $100 face value of a security that pays periodic interest. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param settlement - Is the security's settlement date, expressed as a serial date number. + * @param maturity - Is the security's maturity date, expressed as a serial date number. + * @param rate - Is the security's annual coupon rate. + * @param yld - Is the security's annual yield. + * @param redemption - Is the security's redemption value per $100 face value. + * @param frequency - Is the number of coupon payments per year. + * @param basis - Is the type of day count basis to use. + */ + price(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, rate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, yld: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, redemption: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, frequency: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the price per $100 face value of a discounted security. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param settlement - Is the security's settlement date, expressed as a serial date number. + * @param maturity - Is the security's maturity date, expressed as a serial date number. + * @param discount - Is the security's discount rate. + * @param redemption - Is the security's redemption value per $100 face value. + * @param basis - Is the type of day count basis to use. + */ + priceDisc(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, discount: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, redemption: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the price per $100 face value of a security that pays interest at maturity. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param settlement - Is the security's settlement date, expressed as a serial date number. + * @param maturity - Is the security's maturity date, expressed as a serial date number. + * @param issue - Is the security's issue date, expressed as a serial date number. + * @param rate - Is the security's interest rate at date of issue. + * @param yld - Is the security's annual yield. + * @param basis - Is the type of day count basis to use. + */ + priceMat(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, issue: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, rate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, yld: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Multiplies all the numbers given as arguments. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - List of parameters, whose elements are 1 to 255 numbers, logical values, or text representations of numbers that you want to multiply. + */ + product(...values: Array>): FunctionResult; + /** + * Converts a text string to proper case; the first letter in each word to uppercase, and all other letters to lowercase. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param text - Is text enclosed in quotation marks, a formula that returns text, or a reference to a cell containing text to partially capitalize. + */ + proper(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the present value of an investment: the total amount that a series of future payments is worth now. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param rate - Is the interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR. + * @param nper - Is the total number of payment periods in an investment. + * @param pmt - Is the payment made each period and cannot change over the life of the investment. + * @param fv - Is the future value, or a cash balance you want to attain after the last payment is made. + * @param type - Is a logical value: payment at the beginning of the period = 1; payment at the end of the period = 0 or omitted. + */ + pv(rate: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, nper: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, pmt: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, fv?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, type?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the quartile of a data set, based on percentile values from 0..1, exclusive. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param array - Is the array or cell range of numeric values for which you want the quartile value. + * @param quart - Is a number: minimum value = 0; 1st quartile = 1; median value = 2; 3rd quartile = 3; maximum value = 4. + */ + quartile_Exc(array: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, quart: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the quartile of a data set, based on percentile values from 0..1, inclusive. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param array - Is the array or cell range of numeric values for which you want the quartile value. + * @param quart - Is a number: minimum value = 0; 1st quartile = 1; median value = 2; 3rd quartile = 3; maximum value = 4. + */ + quartile_Inc(array: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, quart: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the integer portion of a division. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param numerator - Is the dividend. + * @param denominator - Is the divisor. + */ + quotient(numerator: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, denominator: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Converts degrees to radians. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param angle - Is an angle in degrees that you want to convert. + */ + radians(angle: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns a random number greater than or equal to 0 and less than 1, evenly distributed (changes on recalculation). + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + rand(): FunctionResult; + /** + * Returns a random number between the numbers you specify. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param bottom - Is the smallest integer RANDBETWEEN will return. + * @param top - Is the largest integer RANDBETWEEN will return. + */ + randBetween(bottom: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, top: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the rank of a number in a list of numbers: its size relative to other values in the list; if more than one value has the same rank, the average rank is returned. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the number for which you want to find the rank. + * @param ref - Is an array of, or a reference to, a list of numbers. Nonnumeric values are ignored. + * @param order - Is a number: rank in the list sorted descending = 0 or omitted; rank in the list sorted ascending = any nonzero value. + */ + rank_Avg(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, ref: Excel.Range | Excel.RangeReference | Excel.FunctionResult, order?: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the rank of a number in a list of numbers: its size relative to other values in the list; if more than one value has the same rank, the top rank of that set of values is returned. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the number for which you want to find the rank. + * @param ref - Is an array of, or a reference to, a list of numbers. Nonnumeric values are ignored. + * @param order - Is a number: rank in the list sorted descending = 0 or omitted; rank in the list sorted ascending = any nonzero value. + */ + rank_Eq(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, ref: Excel.Range | Excel.RangeReference | Excel.FunctionResult, order?: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the interest rate per period of a loan or an investment. For example, use 6%/4 for quarterly payments at 6% APR. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param nper - Is the total number of payment periods for the loan or investment. + * @param pmt - Is the payment made each period and cannot change over the life of the loan or investment. + * @param pv - Is the present value: the total amount that a series of future payments is worth now. + * @param fv - Is the future value, or a cash balance you want to attain after the last payment is made. If omitted, uses Fv = 0. + * @param type - Is a logical value: payment at the beginning of the period = 1; payment at the end of the period = 0 or omitted. + * @param guess - Is your guess for what the rate will be; if omitted, Guess = 0.1 (10 percent). + */ + rate(nper: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, pmt: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, pv: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, fv?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, type?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, guess?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the amount received at maturity for a fully invested security. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param settlement - Is the security's settlement date, expressed as a serial date number. + * @param maturity - Is the security's maturity date, expressed as a serial date number. + * @param investment - Is the amount invested in the security. + * @param discount - Is the security's discount rate. + * @param basis - Is the type of day count basis to use. + */ + received(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, investment: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, discount: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Replaces part of a text string with a different text string. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param oldText - Is text in which you want to replace some characters. + * @param startNum - Is the position of the character in oldText that you want to replace with newText. + * @param numChars - Is the number of characters in oldText that you want to replace. + * @param newText - Is the text that will replace characters in oldText. + */ + replace(oldText: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult, startNum: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, numChars: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, newText: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Replaces part of a text string with a different text string. Use with double-byte character sets (DBCS). + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param oldText - Is text in which you want to replace some characters. + * @param startNum - Is the position of the character in oldText that you want to replace with newText. + * @param numBytes - Is the number of characters in oldText that you want to replace with newText. + * @param newText - Is the text that will replace characters in oldText. + */ + replaceB(oldText: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult, startNum: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, numBytes: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, newText: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Repeats text a given number of times. Use REPT to fill a cell with a number of instances of a text string. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param text - Is the text you want to repeat. + * @param numberTimes - Is a positive number specifying the number of times to repeat text. + */ + rept(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult, numberTimes: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the specified number of characters from the end of a text string. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param text - Is the text string that contains the characters you want to extract. + * @param numChars - Specifies how many characters you want to extract, 1 if omitted. + */ + right(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult, numChars?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the specified number of characters from the end of a text string. Use with double-byte character sets (DBCS). + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param text - Is the text string containing the characters you want to extract. + * @param numBytes - Specifies how many characters you want to extract. + */ + rightb(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult, numBytes?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Converts an Arabic numeral to Roman, as text. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the Arabic numeral you want to convert. + * @param form - Is the number specifying the type of Roman numeral you want. + */ + roman(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, form?: boolean | number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Rounds a number to a specified number of digits. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the number you want to round. + * @param numDigits - Is the number of digits to which you want to round. Negative rounds to the left of the decimal point; zero to the nearest integer. + */ + round(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, numDigits: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Rounds a number down, toward zero. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is any real number that you want rounded down. + * @param numDigits - Is the number of digits to which you want to round. Negative rounds to the left of the decimal point; zero or omitted, to the nearest integer. + */ + roundDown(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, numDigits: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Rounds a number up, away from zero. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is any real number that you want rounded up. + * @param numDigits - Is the number of digits to which you want to round. Negative rounds to the left of the decimal point; zero or omitted, to the nearest integer. + */ + roundUp(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, numDigits: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the number of rows in a reference or array. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param array - Is an array, an array formula, or a reference to a range of cells for which you want the number of rows. + */ + rows(array: Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns an equivalent interest rate for the growth of an investment. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param nper - Is the number of periods for the investment. + * @param pv - Is the present value of the investment. + * @param fv - Is the future value of the investment. + */ + rri(nper: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, pv: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, fv: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the secant of an angle. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the angle in radians for which you want the secant. + */ + sec(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the hyperbolic secant of an angle. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the angle in radians for which you want the hyperbolic secant. + */ + sech(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the second, a number from 0 to 59. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param serialNumber - Is a number in the date-time code used by Microsoft Excel or text in time format, such as 16:48:23 or 4:48:47 PM. + */ + second(serialNumber: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the sum of a power series based on the formula. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param x - Is the input value to the power series. + * @param n - Is the initial power to which you want to raise x. + * @param m - Is the step by which to increase n for each term in the series. + * @param coefficients - Is a set of coefficients by which each successive power of x is multiplied. + */ + seriesSum(x: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, n: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, m: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, coefficients: Excel.Range | string | number | boolean | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the sheet number of the referenced sheet. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param value - Is the name of a sheet or a reference that you want the sheet number of. If omitted the number of the sheet containing the function is returned. + */ + sheet(value?: Excel.Range | string | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the number of sheets in a reference. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param reference - Is a reference for which you want to know the number of sheets it contains. If omitted the number of sheets in the workbook containing the function is returned. + */ + sheets(reference?: Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the sign of a number: 1 if the number is positive, zero if the number is zero, or -1 if the number is negative. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is any real number. + */ + sign(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the sine of an angle. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the angle in radians for which you want the sine. Degrees * PI()/180 = radians. + */ + sin(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the hyperbolic sine of a number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is any real number. + */ + sinh(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the skewness of a distribution: a characterization of the degree of asymmetry of a distribution around its mean. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - List of parameters, whose elements are 1 to 255 numbers or names, arrays, or references that contain numbers for which you want the skewness. + */ + skew(...values: Array>): FunctionResult; + /** + * Returns the skewness of a distribution based on a population: a characterization of the degree of asymmetry of a distribution around its mean. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - List of parameters, whose elements are 1 to 254 numbers or names, arrays, or references that contain numbers for which you want the population skewness. + */ + skew_p(...values: Array>): FunctionResult; + /** + * Returns the straight-line depreciation of an asset for one period. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param cost - Is the initial cost of the asset. + * @param salvage - Is the salvage value at the end of the life of the asset. + * @param life - Is the number of periods over which the asset is being depreciated (sometimes called the useful life of the asset). + */ + sln(cost: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, salvage: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, life: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the k-th smallest value in a data set. For example, the fifth smallest number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param array - Is an array or range of numerical data for which you want to determine the k-th smallest value. + * @param k - Is the position (from the smallest) in the array or range of the value to return. + */ + small(array: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, k: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the square root of a number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the number for which you want the square root. + */ + sqrt(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the square root of (number * Pi). + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the number by which p is multiplied. + */ + sqrtPi(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Estimates standard deviation based on a sample, including logical values and text. Text and the logical value FALSE have the value 0; the logical value TRUE has the value 1. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - List of parameters, whose elements are 1 to 255 values corresponding to a sample of a population and can be values or names or references to values. + */ + stDevA(...values: Array>): FunctionResult; + /** + * Calculates standard deviation based on an entire population, including logical values and text. Text and the logical value FALSE have the value 0; the logical value TRUE has the value 1. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - List of parameters, whose elements are 1 to 255 values corresponding to a population and can be values, names, arrays, or references that contain values. + */ + stDevPA(...values: Array>): FunctionResult; + /** + * Calculates standard deviation based on the entire population given as arguments (ignores logical values and text). + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - List of parameters, whose elements are 1 to 255 numbers corresponding to a population and can be numbers or references that contain numbers. + */ + stDev_P(...values: Array>): FunctionResult; + /** + * Estimates standard deviation based on a sample (ignores logical values and text in the sample). + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - List of parameters, whose elements are 1 to 255 numbers corresponding to a sample of a population and can be numbers or references that contain numbers. + */ + stDev_S(...values: Array>): FunctionResult; + /** + * Returns a normalized value from a distribution characterized by a mean and standard deviation. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param x - Is the value you want to normalize. + * @param mean - Is the arithmetic mean of the distribution. + * @param standardDev - Is the standard deviation of the distribution, a positive number. + */ + standardize(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, mean: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, standardDev: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Replaces existing text with new text in a text string. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param text - Is the text or the reference to a cell containing text in which you want to substitute characters. + * @param oldText - Is the existing text you want to replace. If the case of oldText does not match the case of text, SUBSTITUTE will not replace the text. + * @param newText - Is the text you want to replace oldText with. + * @param instanceNum - Specifies which occurrence of oldText you want to replace. If omitted, every instance of oldText is replaced. + */ + substitute(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult, oldText: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult, newText: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult, instanceNum?: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns a subtotal in a list or database. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param functionNum - Is the number 1 to 11 that specifies the summary function for the subtotal. + * @param values - List of parameters, whose elements are 1 to 254 ranges or references for which you want the subtotal. + */ + subtotal(functionNum: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, ...values: Array>): FunctionResult; + /** + * Adds all the numbers in a range of cells. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - List of parameters, whose elements are 1 to 255 numbers to sum. Logical values and text are ignored in cells, included if typed as arguments. + */ + sum(...values: Array>): FunctionResult; + /** + * Adds the cells specified by a given condition or criteria. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param range - Is the range of cells you want evaluated. + * @param criteria - Is the condition or criteria in the form of a number, expression, or text that defines which cells will be added. + * @param sumRange - Are the actual cells to sum. If omitted, the cells in range are used. + */ + sumIf(range: Excel.Range | Excel.RangeReference | Excel.FunctionResult, criteria: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, sumRange?: Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Adds the cells specified by a given set of conditions or criteria. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param sumRange - Are the actual cells to sum. + * @param values - List of parameters, where the first element of each pair is the Is the range of cells you want evaluated for the particular condition , and the second element is is the condition or criteria in the form of a number, expression, or text that defines which cells will be added. + */ + sumIfs(sumRange: Excel.Range | Excel.RangeReference | Excel.FunctionResult, ...values: Array | number | string | boolean>): FunctionResult; + /** + * Returns the sum of the squares of the arguments. The arguments can be numbers, arrays, names, or references to cells that contain numbers. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - List of parameters, whose elements are 1 to 255 numbers, arrays, names, or references to arrays for which you want the sum of the squares. + */ + sumSq(...values: Array>): FunctionResult; + /** + * Returns the sum-of-years' digits depreciation of an asset for a specified period. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param cost - Is the initial cost of the asset. + * @param salvage - Is the salvage value at the end of the life of the asset. + * @param life - Is the number of periods over which the asset is being depreciated (sometimes called the useful life of the asset). + * @param per - Is the period and must use the same units as Life. + */ + syd(cost: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, salvage: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, life: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, per: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Checks whether a value is text, and returns the text if it is, or returns double quotes (empty text) if it is not. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param value - Is the value to test. + */ + t(value: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the bond-equivalent yield for a treasury bill. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param settlement - Is the Treasury bill's settlement date, expressed as a serial date number. + * @param maturity - Is the Treasury bill's maturity date, expressed as a serial date number. + * @param discount - Is the Treasury bill's discount rate. + */ + tbillEq(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, discount: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the price per $100 face value for a treasury bill. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param settlement - Is the Treasury bill's settlement date, expressed as a serial date number. + * @param maturity - Is the Treasury bill's maturity date, expressed as a serial date number. + * @param discount - Is the Treasury bill's discount rate. + */ + tbillPrice(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, discount: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the yield for a treasury bill. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param settlement - Is the Treasury bill's settlement date, expressed as a serial date number. + * @param maturity - Is the Treasury bill's maturity date, expressed as a serial date number. + * @param pr - Is the Treasury Bill's price per $100 face value. + */ + tbillYield(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, pr: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the left-tailed Student's t-distribution. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param x - Is the numeric value at which to evaluate the distribution. + * @param degFreedom - Is an integer indicating the number of degrees of freedom that characterize the distribution. + * @param cumulative - Is a logical value: for the cumulative distribution function, use TRUE; for the probability density function, use FALSE. + */ + t_Dist(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, degFreedom: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, cumulative: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the two-tailed Student's t-distribution. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param x - Is the numeric value at which to evaluate the distribution. + * @param degFreedom - Is an integer indicating the number of degrees of freedom that characterize the distribution. + */ + t_Dist_2T(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, degFreedom: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the right-tailed Student's t-distribution. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param x - Is the numeric value at which to evaluate the distribution. + * @param degFreedom - Is an integer indicating the number of degrees of freedom that characterize the distribution. + */ + t_Dist_RT(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, degFreedom: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the left-tailed inverse of the Student's t-distribution. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param probability - Is the probability associated with the two-tailed Student's t-distribution, a number between 0 and 1 inclusive. + * @param degFreedom - Is a positive integer indicating the number of degrees of freedom to characterize the distribution. + */ + t_Inv(probability: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, degFreedom: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the two-tailed inverse of the Student's t-distribution. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param probability - Is the probability associated with the two-tailed Student's t-distribution, a number between 0 and 1 inclusive. + * @param degFreedom - Is a positive integer indicating the number of degrees of freedom to characterize the distribution. + */ + t_Inv_2T(probability: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, degFreedom: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the tangent of an angle. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the angle in radians for which you want the tangent. Degrees * PI()/180 = radians. + */ + tan(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the hyperbolic tangent of a number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is any real number. + */ + tanh(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Converts a value to text in a specific number format. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param value - Is a number, a formula that evaluates to a numeric value, or a reference to a cell containing a numeric value. + * @param formatText - Is a number format in text form from the Category box on the Number tab in the Format Cells dialog box. + */ + text(value: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, formatText: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Converts hours, minutes, and seconds given as numbers to an Excel serial number, formatted with a time format. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param hour - Is a number from 0 to 23 representing the hour. + * @param minute - Is a number from 0 to 59 representing the minute. + * @param second - Is a number from 0 to 59 representing the second. + */ + time(hour: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, minute: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, second: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Converts a text time to an Excel serial number for a time, a number from 0 (12:00:00 AM) to 0.999988426 (11:59:59 PM). Format the number with a time format after entering the formula. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param timeText - Is a text string that gives a time in any one of the Microsoft Excel time formats (date information in the string is ignored). + */ + timevalue(timeText: string | number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the current date formatted as a date. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + today(): FunctionResult; + /** + * Removes all spaces from a text string except for single spaces between words. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param text - Is the text from which you want spaces removed. + */ + trim(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the mean of the interior portion of a set of data values. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param array - Is the range or array of values to trim and average. + * @param percent - Is the fractional number of data points to exclude from the top and bottom of the data set. + */ + trimMean(array: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, percent: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the logical value TRUE. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + true(): FunctionResult; + /** + * Truncates a number to an integer by removing the decimal, or fractional, part of the number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the number you want to truncate. + * @param numDigits - Is a number specifying the precision of the truncation, 0 (zero) if omitted. + */ + trunc(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, numDigits?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns an integer representing the data type of a value: number = 1; text = 2; logical value = 4; error value = 16; array = 64; compound data = 128. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param value - Can be any value. + */ + type(value: boolean | string | number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Converts a number to text, using currency format. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is a number, a reference to a cell containing a number, or a formula that evaluates to a number. + * @param decimals - Is the number of digits to the right of the decimal point. + */ + usdollar(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, decimals?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the Unicode character referenced by the given numeric value. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param number - Is the Unicode number representing a character. + */ + unichar(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the number (code point) corresponding to the first character of the text. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param text - Is the character that you want the Unicode value of. + */ + unicode(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Converts a text string to all uppercase letters. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param text - Is the text you want converted to uppercase, a reference or a text string. + */ + upper(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Looks for a value in the leftmost column of a table, and then returns a value in the same row from a column you specify. By default, the table must be sorted in an ascending order. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param lookupValue - Is the value to be found in the first column of the table, and can be a value, a reference, or a text string. + * @param tableArray - Is a table of text, numbers, or logical values, in which data is retrieved. tableArray can be a reference to a range or a range name. + * @param colIndexNum - Is the column number in tableArray from which the matching value should be returned. The first column of values in the table is column 1. + * @param rangeLookup - Is a logical value: to find the closest match in the first column (sorted in ascending order) = TRUE or omitted; find an exact match = FALSE. + */ + vlookup(lookupValue: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, tableArray: Excel.Range | number | Excel.RangeReference | Excel.FunctionResult, colIndexNum: Excel.Range | number | Excel.RangeReference | Excel.FunctionResult, rangeLookup?: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Converts a text string that represents a number to a number. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param text - Is the text enclosed in quotation marks or a reference to a cell containing the text you want to convert. + */ + value(text: string | boolean | number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Estimates variance based on a sample, including logical values and text. Text and the logical value FALSE have the value 0; the logical value TRUE has the value 1. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - List of parameters, whose elements are 1 to 255 value arguments corresponding to a sample of a population. + */ + varA(...values: Array>): FunctionResult; + /** + * Calculates variance based on the entire population, including logical values and text. Text and the logical value FALSE have the value 0; the logical value TRUE has the value 1. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - List of parameters, whose elements are 1 to 255 value arguments corresponding to a population. + */ + varPA(...values: Array>): FunctionResult; + /** + * Calculates variance based on the entire population (ignores logical values and text in the population). + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - List of parameters, whose elements are 1 to 255 numeric arguments corresponding to a population. + */ + var_P(...values: Array>): FunctionResult; + /** + * Estimates variance based on a sample (ignores logical values and text in the sample). + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - List of parameters, whose elements are 1 to 255 numeric arguments corresponding to a sample of a population. + */ + var_S(...values: Array>): FunctionResult; + /** + * Returns the depreciation of an asset for any period you specify, including partial periods, using the double-declining balance method or some other method you specify. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param cost - Is the initial cost of the asset. + * @param salvage - Is the salvage value at the end of the life of the asset. + * @param life - Is the number of periods over which the asset is being depreciated (sometimes called the useful life of the asset). + * @param startPeriod - Is the starting period for which you want to calculate the depreciation, in the same units as Life. + * @param endPeriod - Is the ending period for which you want to calculate the depreciation, in the same units as Life. + * @param factor - Is the rate at which the balance declines, 2 (double-declining balance) if omitted. + * @param noSwitch - Switch to straight-line depreciation when depreciation is greater than the declining balance = FALSE or omitted; do not switch = TRUE. + */ + vdb(cost: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, salvage: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, life: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, startPeriod: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, endPeriod: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, factor?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, noSwitch?: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the week number in the year. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param serialNumber - Is the date-time code used by Microsoft Excel for date and time calculation. + * @param returnType - Is a number (1 or 2) that determines the type of the return value. + */ + weekNum(serialNumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, returnType?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns a number from 1 to 7 identifying the day of the week of a date. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param serialNumber - Is a number that represents a date. + * @param returnType - Is a number: for Sunday=1 through Saturday=7, use 1; for Monday=1 through Sunday=7, use 2; for Monday=0 through Sunday=6, use 3. + */ + weekday(serialNumber: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, returnType?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the Weibull distribution. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param x - Is the value at which to evaluate the function, a nonnegative number. + * @param alpha - Is a parameter to the distribution, a positive number. + * @param beta - Is a parameter to the distribution, a positive number. + * @param cumulative - Is a logical value: for the cumulative distribution function, use TRUE; for the probability mass function, use FALSE. + */ + weibull_Dist(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, alpha: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, beta: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, cumulative: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the serial number of the date before or after a specified number of workdays. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param startDate - Is a serial date number that represents the start date. + * @param days - Is the number of nonweekend and non-holiday days before or after startDate. + * @param holidays - Is an optional array of one or more serial date numbers to exclude from the working calendar, such as state and federal holidays and floating holidays. + */ + workDay(startDate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, days: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, holidays?: number | string | Excel.Range | boolean | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the serial number of the date before or after a specified number of workdays with custom weekend parameters. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param startDate - Is a serial date number that represents the start date. + * @param days - Is the number of nonweekend and non-holiday days before or after startDate. + * @param weekend - Is a number or string specifying when weekends occur. + * @param holidays - Is an optional array of one or more serial date numbers to exclude from the working calendar, such as state and federal holidays and floating holidays. + */ + workDay_Intl(startDate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, days: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, weekend?: number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult, holidays?: number | string | Excel.Range | boolean | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the internal rate of return for a schedule of cash flows. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - Is a series of cash flows that correspond to a schedule of payments in dates. + * @param dates - Is a schedule of payment dates that corresponds to the cash flow payments. + * @param guess - Is a number that you guess is close to the result of XIRR. + */ + xirr(values: number | string | Excel.Range | boolean | Excel.RangeReference | Excel.FunctionResult, dates: number | string | Excel.Range | boolean | Excel.RangeReference | Excel.FunctionResult, guess?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the net present value for a schedule of cash flows. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param rate - Is the discount rate to apply to the cash flows. + * @param values - Is a series of cash flows that correspond to a schedule of payments in dates. + * @param dates - Is a schedule of payment dates that corresponds to the cash flow payments. + */ + xnpv(rate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, values: number | string | Excel.Range | boolean | Excel.RangeReference | Excel.FunctionResult, dates: number | string | Excel.Range | boolean | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns a logical 'Exclusive Or' of all arguments. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param values - List of parameters, whose elements are 1 to 254 conditions you want to test that can be either TRUE or FALSE and can be logical values, arrays, or references. + */ + xor(...values: Array>): FunctionResult; + /** + * Returns the year of a date, an integer in the range 1900 - 9999. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param serialNumber - Is a number in the date-time code used by Microsoft Excel. + */ + year(serialNumber: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the year fraction representing the number of whole days between start_date and end_date. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param startDate - Is a serial date number that represents the start date. + * @param endDate - Is a serial date number that represents the end date. + * @param basis - Is the type of day count basis to use. + */ + yearFrac(startDate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, endDate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the yield on a security that pays periodic interest. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param settlement - Is the security's settlement date, expressed as a serial date number. + * @param maturity - Is the security's maturity date, expressed as a serial date number. + * @param rate - Is the security's annual coupon rate. + * @param pr - Is the security's price per $100 face value. + * @param redemption - Is the security's redemption value per $100 face value. + * @param frequency - Is the number of coupon payments per year. + * @param basis - Is the type of day count basis to use. + */ + yield(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, rate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, pr: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, redemption: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, frequency: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the annual yield for a discounted security. For example, a treasury bill. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param settlement - Is the security's settlement date, expressed as a serial date number. + * @param maturity - Is the security's maturity date, expressed as a serial date number. + * @param pr - Is the security's price per $100 face value. + * @param redemption - Is the security's redemption value per $100 face value. + * @param basis - Is the type of day count basis to use. + */ + yieldDisc(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, pr: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, redemption: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the annual yield of a security that pays interest at maturity. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param settlement - Is the security's settlement date, expressed as a serial date number. + * @param maturity - Is the security's maturity date, expressed as a serial date number. + * @param issue - Is the security's issue date, expressed as a serial date number. + * @param rate - Is the security's interest rate at date of issue. + * @param pr - Is the security's price per $100 face value. + * @param basis - Is the type of day count basis to use. + */ + yieldMat(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, issue: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, rate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, pr: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Returns the one-tailed P-value of a z-test. + * + * @remarks + * [Api set: ExcelApi 1.2] + * + * @param array - Is the array or range of data against which to test X. + * @param x - Is the value to test. + * @param sigma - Is the population (known) standard deviation. If omitted, the sample standard deviation is used. + */ + z_Test(array: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult, sigma?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult): FunctionResult; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.Functions` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.FunctionsData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): { + [key: string]: string; + }; + } + enum ErrorCodes { + accessDenied = "AccessDenied", + apiNotFound = "ApiNotFound", + conflict = "Conflict", + emptyChartSeries = "EmptyChartSeries", + filteredRangeConflict = "FilteredRangeConflict", + formulaLengthExceedsLimit = "FormulaLengthExceedsLimit", + generalException = "GeneralException", + inactiveWorkbook = "InactiveWorkbook", + insertDeleteConflict = "InsertDeleteConflict", + invalidArgument = "InvalidArgument", + invalidBinding = "InvalidBinding", + invalidOperation = "InvalidOperation", + invalidReference = "InvalidReference", + invalidSelection = "InvalidSelection", + itemAlreadyExists = "ItemAlreadyExists", + itemNotFound = "ItemNotFound", + mergedRangeConflict = "MergedRangeConflict", + nonBlankCellOffSheet = "NonBlankCellOffSheet", + notImplemented = "NotImplemented", + openWorkbookLinksBlocked = "OpenWorkbookLinksBlocked", + operationCellsExceedLimit = "OperationCellsExceedLimit", + pivotTableRangeConflict = "PivotTableRangeConflict", + powerQueryRefreshResourceChallenge = "PowerQueryRefreshResourceChallenge", + rangeExceedsLimit = "RangeExceedsLimit", + rangeImageExceedsLimit = "RangeImageExceedsLimit", + refreshWorkbookLinksBlocked = "RefreshWorkbookLinksBlocked", + requestAborted = "RequestAborted", + responsePayloadSizeLimitExceeded = "ResponsePayloadSizeLimitExceeded", + unsupportedFeature = "UnsupportedFeature", + unsupportedFillType = "UnsupportedFillType", + unsupportedOperation = "UnsupportedOperation", + unsupportedSheet = "UnsupportedSheet", + invalidOperationInCellEditMode = "InvalidOperationInCellEditMode" + } + export namespace Interfaces { + /** + * Provides ways to load properties of only a subset of members of a collection. + */ + export interface CollectionLoadOptions { + /** + * Specify the number of items in the queried collection to be included in the result. + */ + $top?: number; + /** + * Specify the number of items in the collection that are to be skipped and not included in the result. If top is specified, the selection of result will start after skipping the specified number of items. + */ + $skip?: number; + } + /** An interface for updating data on the `AllowEditRange` object, for use in `allowEditRange.set({ ... })`. */ + export interface AllowEditRangeUpdateData { + + + } + /** An interface for updating data on the `AllowEditRangeCollection` object, for use in `allowEditRangeCollection.set({ ... })`. */ + export interface AllowEditRangeCollectionUpdateData { + items?: Excel.Interfaces.AllowEditRangeData[]; + } + /** An interface for updating data on the `QueryCollection` object, for use in `queryCollection.set({ ... })`. */ + export interface QueryCollectionUpdateData { + items?: Excel.Interfaces.QueryData[]; + } + /** An interface for updating data on the `LinkedWorkbookCollection` object, for use in `linkedWorkbookCollection.set({ ... })`. */ + export interface LinkedWorkbookCollectionUpdateData { + + items?: Excel.Interfaces.LinkedWorkbookData[]; + } + /** An interface for updating data on the `Runtime` object, for use in `runtime.set({ ... })`. */ + export interface RuntimeUpdateData { + /** + * Toggle JavaScript events in the current task pane or content add-in. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + enableEvents?: boolean; + } + /** An interface for updating data on the `Application` object, for use in `application.set({ ... })`. */ + export interface ApplicationUpdateData { + /** + * Returns the iterative calculation settings. + In Excel on Windows and Mac, the settings will apply to the Excel Application. + In Excel on the web and other platforms, the settings will apply to the active workbook. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + iterativeCalculation?: Excel.Interfaces.IterativeCalculationUpdateData; + /** + * Returns the calculation mode used in the workbook, as defined by the constants in `Excel.CalculationMode`. Possible values are: `Automatic`, where Excel controls recalculation; `AutomaticExceptTables`, where Excel controls recalculation but ignores changes in tables; `Manual`, where calculation is done when the user requests it. + * + * @remarks + * [Api set: ExcelApi 1.1 for get, 1.8 for set] + */ + calculationMode?: Excel.CalculationMode | "Automatic" | "AutomaticExceptTables" | "Manual"; + } + /** An interface for updating data on the `IterativeCalculation` object, for use in `iterativeCalculation.set({ ... })`. */ + export interface IterativeCalculationUpdateData { + /** + * True if Excel will use iteration to resolve circular references. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enabled?: boolean; + /** + * Specifies the maximum amount of change between each iteration as Excel resolves circular references. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + maxChange?: number; + /** + * Specifies the maximum number of iterations that Excel can use to resolve a circular reference. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + maxIteration?: number; + } + /** An interface for updating data on the `Workbook` object, for use in `workbook.set({ ... })`. */ + export interface WorkbookUpdateData { + /** + * Gets the workbook properties. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + properties?: Excel.Interfaces.DocumentPropertiesUpdateData; + /** + * True if all charts in the workbook are tracking the actual data points to which they are attached. + False if the charts track the index of the data points. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + chartDataPointTrack?: boolean; + /** + * Specifies if changes have been made since the workbook was last saved. + You can set this property to `true` if you want to close a modified workbook without either saving it or being prompted to save it. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + isDirty?: boolean; + /** + * True if calculations in this workbook will be done using only the precision of the numbers as they're displayed. + Data will permanently lose accuracy when switching this property from `false` to `true`. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + usePrecisionAsDisplayed?: boolean; + } + /** An interface for updating data on the `Worksheet` object, for use in `worksheet.set({ ... })`. */ + export interface WorksheetUpdateData { + /** + * Gets the `PageLayout` object of the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + pageLayout?: Excel.Interfaces.PageLayoutUpdateData; + /** + * Determines if Excel should recalculate the worksheet when necessary. + True if Excel recalculates the worksheet when necessary. False if Excel doesn't recalculate the sheet. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enableCalculation?: boolean; + /** + * The display name of the worksheet. The name must be fewer than 32 characters. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + name?: string; + /** + * The zero-based position of the worksheet within the workbook. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + position?: number; + /** + * Specifies if data type icons are visible on the worksheet. By default, data type icons are visible. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + showDataTypeIcons?: boolean; + /** + * Specifies if gridlines are visible to the user. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showGridlines?: boolean; + /** + * Specifies if headings are visible to the user. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showHeadings?: boolean; + /** + * Specifies the standard (default) width of all the columns in the worksheet. + One unit of column width is equal to the width of one character in the Normal style. For proportional fonts, the width of the character 0 (zero) is used. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + standardWidth?: number; + /** + * The tab color of the worksheet. + When retrieving the tab color, if the worksheet is invisible, the value will be `null`. If the worksheet is visible but the tab color is set to auto, an empty string will be returned. Otherwise, the property will be set to a color, in the form #RRGGBB (e.g., "FFA500"). + When setting the color, use an empty-string to set an "auto" color, or a real color otherwise. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + tabColor?: string; + /** + * The visibility of the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.1 for reading visibility; 1.2 for setting it.] + */ + visibility?: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden"; + } + /** An interface for updating data on the `WorksheetCollection` object, for use in `worksheetCollection.set({ ... })`. */ + export interface WorksheetCollectionUpdateData { + items?: Excel.Interfaces.WorksheetData[]; + } + /** An interface for updating data on the `Range` object, for use in `range.set({ ... })`. */ + export interface RangeUpdateData { + /** + * Returns a data validation object. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + dataValidation?: Excel.Interfaces.DataValidationUpdateData; + /** + * Returns a format object, encapsulating the range's font, fill, borders, alignment, and other properties. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + format?: Excel.Interfaces.RangeFormatUpdateData; + /** + * Represents if all columns in the current range are hidden. Value is `true` when all columns in a range are hidden. Value is `false` when no columns in the range are hidden. Value is `null` when some columns in a range are hidden and other columns in the same range are not hidden. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + columnHidden?: boolean; + /** + * Accesses the cell control applied to this range. + If the range has multiple cell controls, this returns `EmptyCellControl`. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + control?: CellControl; + /** + * Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + formulas?: any[][]; + /** + * Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. If a cell has no formula, its value is returned instead. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + formulasLocal?: any[][]; + /** + * Represents the formula in R1C1-style notation. If a cell has no formula, its value is returned instead. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + formulasR1C1?: any[][]; + /** + * Represents the hyperlink for the current range. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + hyperlink?: Excel.RangeHyperlink; + /** + * Represents Excel's number format code for the given range. For more information about Excel number formatting, see {@link https://support.microsoft.com/office/5026bbd6-04bc-48cd-bf33-80f18b4eae68 | Number format codes}. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + numberFormat?: any[][]; + /** + * Represents Excel's number format code for the given range, based on the language settings of the user. + Excel does not perform any language or format coercion when getting or setting the `numberFormatLocal` property. + Any returned text uses the locally-formatted strings based on the language specified in the system settings. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + numberFormatLocal?: any[][]; + /** + * Represents if all rows in the current range are hidden. Value is `true` when all rows in a range are hidden. Value is `false` when no rows in the range are hidden. Value is `null` when some rows in a range are hidden and other rows in the same range are not hidden. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + rowHidden?: boolean; + /** + * Represents the style of the current range. + If the styles of the cells are inconsistent, `null` will be returned. + For custom styles, the style name will be returned. For built-in styles, a string representing a value in the `BuiltInStyle` enum will be returned. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + style?: string; + /** + * Represents the raw values of the specified range. The data returned could be a string, number, or boolean. Cells that contain an error will return the error string. + If the returned value starts with a plus ("+"), minus ("-"), or equal sign ("="), Excel interprets this value as a formula. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + values?: any[][]; + /** + * A JSON representation of the values in the cells in this range. + Unlike `Range.values`, `Range.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `Range.valuesAsJsonLocal`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJson?: CellValue[][]; + /** + * A JSON representation of the values in the cells in this range. + Unlike `Range.values`, `Range.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `Range.valuesAsJson`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJsonLocal?: CellValue[][]; + } + /** An interface for updating data on the `RangeAreas` object, for use in `rangeAreas.set({ ... })`. */ + export interface RangeAreasUpdateData { + /** + * Returns a data validation object for all ranges in the `RangeAreas`. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + dataValidation?: Excel.Interfaces.DataValidationUpdateData; + /** + * Returns a `RangeFormat` object, encapsulating the font, fill, borders, alignment, and other properties for all ranges in the `RangeAreas` object. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + format?: Excel.Interfaces.RangeFormatUpdateData; + /** + * Represents the style for all ranges in this `RangeAreas` object. + If the styles of the cells are inconsistent, `null` will be returned. + For custom styles, the style name will be returned. For built-in styles, a string representing a value in the `BuiltInStyle` enum will be returned. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + style?: string; + } + /** An interface for updating data on the `RangeView` object, for use in `rangeView.set({ ... })`. */ + export interface RangeViewUpdateData { + /** + * Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + formulas?: any[][]; + /** + * Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. If a cell has no formula, its value is returned instead. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + formulasLocal?: any[][]; + /** + * Represents the formula in R1C1-style notation. If a cell has no formula, its value is returned instead. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + formulasR1C1?: any[][]; + /** + * Represents Excel's number format code for the given cell. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + numberFormat?: any[][]; + /** + * Represents the raw values of the specified range view. The data returned could be of type string, number, or a boolean. Cells that contain an error will return the error string. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + values?: any[][]; + /** + * A JSON representation of the values in the cells in this range. + Unlike `RangeView.values`, `RangeView.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `RangeView.valuesAsJsonLocal`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJson?: CellValue[][]; + /** + * A JSON representation of the values in the cells in this range. + Unlike `RangeView.values`, `RangeView.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `RangeView.valuesAsJson`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJsonLocal?: CellValue[][]; + } + /** An interface for updating data on the `RangeViewCollection` object, for use in `rangeViewCollection.set({ ... })`. */ + export interface RangeViewCollectionUpdateData { + items?: Excel.Interfaces.RangeViewData[]; + } + /** An interface for updating data on the `SettingCollection` object, for use in `settingCollection.set({ ... })`. */ + export interface SettingCollectionUpdateData { + items?: Excel.Interfaces.SettingData[]; + } + /** An interface for updating data on the `Setting` object, for use in `setting.set({ ... })`. */ + export interface SettingUpdateData { + /** + * Represents the value stored for this setting. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + value?: any; + } + /** An interface for updating data on the `NamedItemCollection` object, for use in `namedItemCollection.set({ ... })`. */ + export interface NamedItemCollectionUpdateData { + items?: Excel.Interfaces.NamedItemData[]; + } + /** An interface for updating data on the `NamedItem` object, for use in `namedItem.set({ ... })`. */ + export interface NamedItemUpdateData { + /** + * Specifies the comment associated with this name. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + comment?: string; + /** + * The formula of the named item. Formulas always start with an equal sign ("="). + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + formula?: any; + /** + * Specifies if the object is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + visible?: boolean; + } + /** An interface for updating data on the `BindingCollection` object, for use in `bindingCollection.set({ ... })`. */ + export interface BindingCollectionUpdateData { + items?: Excel.Interfaces.BindingData[]; + } + /** An interface for updating data on the `TableCollection` object, for use in `tableCollection.set({ ... })`. */ + export interface TableCollectionUpdateData { + items?: Excel.Interfaces.TableData[]; + } + /** An interface for updating data on the `TableScopedCollection` object, for use in `tableScopedCollection.set({ ... })`. */ + export interface TableScopedCollectionUpdateData { + items?: Excel.Interfaces.TableData[]; + } + /** An interface for updating data on the `Table` object, for use in `table.set({ ... })`. */ + export interface TableUpdateData { + /** + * Specifies if the first column contains special formatting. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + highlightFirstColumn?: boolean; + /** + * Specifies if the last column contains special formatting. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + highlightLastColumn?: boolean; + /** + * Name of the table. + + The set name of the table must follow the guidelines specified in the {@link https://support.microsoft.com/office/fbf49a4f-82a3-43eb-8ba2-44d21233b114 | Rename an Excel table} article. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + name?: string; + /** + * Specifies if the columns show banded formatting in which odd columns are highlighted differently from even ones, to make reading the table easier. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + showBandedColumns?: boolean; + /** + * Specifies if the rows show banded formatting in which odd rows are highlighted differently from even ones, to make reading the table easier. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + showBandedRows?: boolean; + /** + * Specifies if the filter buttons are visible at the top of each column header. Setting this is only allowed if the table contains a header row. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + showFilterButton?: boolean; + /** + * Specifies if the header row is visible. This value can be set to show or remove the header row. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + showHeaders?: boolean; + /** + * Specifies if the total row is visible. This value can be set to show or remove the total row. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + showTotals?: boolean; + /** + * Constant value that represents the table style. Possible values are: "TableStyleLight1" through "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", "TableStyleDark1" through "TableStyleDark11". A custom user-defined style present in the workbook can also be specified. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + style?: string; + } + /** An interface for updating data on the `TableColumnCollection` object, for use in `tableColumnCollection.set({ ... })`. */ + export interface TableColumnCollectionUpdateData { + items?: Excel.Interfaces.TableColumnData[]; + } + /** An interface for updating data on the `TableColumn` object, for use in `tableColumn.set({ ... })`. */ + export interface TableColumnUpdateData { + /** + * Specifies the name of the table column. + * + * @remarks + * [Api set: ExcelApi 1.1 for getting the name; 1.4 for setting it.] + */ + name?: string; + /** + * Represents the raw values of the specified range. The data returned could be a string, number, or boolean. Cells that contain an error will return the error string. + If the returned value starts with a plus ("+"), minus ("-"), or equal sign ("="), Excel interprets this value as a formula. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + values?: any[][]; + /** + * A JSON representation of the values in the cells in this table column. + Unlike `TableColumn.values`, `TableColumn.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `TableColumn.valuesAsJsonLocal`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJson?: CellValue[][]; + /** + * A JSON representation of the values in the cells in this table column. + Unlike `TableColumn.values`, `TableColumn.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `TableColumn.valuesAsJson`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJsonLocal?: CellValue[][]; + } + /** An interface for updating data on the `TableRowCollection` object, for use in `tableRowCollection.set({ ... })`. */ + export interface TableRowCollectionUpdateData { + items?: Excel.Interfaces.TableRowData[]; + } + /** An interface for updating data on the `TableRow` object, for use in `tableRow.set({ ... })`. */ + export interface TableRowUpdateData { + /** + * Represents the raw values of the specified range. The data returned could be a string, number, or boolean. Cells that contain an error will return the error string. + If the returned value starts with a plus ("+"), minus ("-"), or equal sign ("="), Excel interprets this value as a formula. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + values?: any[][]; + /** + * A JSON representation of the values in the cells in this table row. + Unlike `TableRow.values`, `TableRow.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `TableRow.valuesAsJsonLocal`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJson?: CellValue[][]; + /** + * A JSON representation of the values in the cells in this table row. + Unlike `TableRow.values`, `TableRow.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `TableRow.valuesAsJson`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJsonLocal?: CellValue[][]; + } + /** An interface for updating data on the `DataValidation` object, for use in `dataValidation.set({ ... })`. */ + export interface DataValidationUpdateData { + /** + * Error alert when user enters invalid data. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + errorAlert?: Excel.DataValidationErrorAlert; + /** + * Specifies if data validation will be performed on blank cells. Default is `true`. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + ignoreBlanks?: boolean; + /** + * Prompt when users select a cell. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + prompt?: Excel.DataValidationPrompt; + /** + * Data validation rule that contains different type of data validation criteria. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + rule?: Excel.DataValidationRule; + } + /** An interface for updating data on the `RangeFormat` object, for use in `rangeFormat.set({ ... })`. */ + export interface RangeFormatUpdateData { + /** + * Collection of border objects that apply to the overall range. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + borders?: Excel.Interfaces.RangeBorderCollectionUpdateData; + /** + * Returns the fill object defined on the overall range. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + fill?: Excel.Interfaces.RangeFillUpdateData; + /** + * Returns the font object defined on the overall range. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + font?: Excel.Interfaces.RangeFontUpdateData; + /** + * Returns the format protection object for a range. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + protection?: Excel.Interfaces.FormatProtectionUpdateData; + /** + * Specifies if text is automatically indented when text alignment is set to equal distribution. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + autoIndent?: boolean; + /** + * Specifies the width of all columns within the range. If the column widths are not uniform, `null` will be returned. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + columnWidth?: number; + /** + * Represents the horizontal alignment for the specified object. See `Excel.HorizontalAlignment` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + horizontalAlignment?: Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed"; + /** + * An integer from 0 to 250 that indicates the indent level. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + indentLevel?: number; + /** + * The reading order for the range. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readingOrder?: Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft"; + /** + * The height of all rows in the range. If the row heights are not uniform, `null` will be returned. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + rowHeight?: number; + /** + * Specifies if text automatically shrinks to fit in the available column width. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + shrinkToFit?: boolean; + /** + * The text orientation of all the cells within the range. + The text orientation should be an integer either from -90 to 90, or 180 for vertically-oriented text. + If the orientation within a range are not uniform, then `null` will be returned. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + textOrientation?: number; + /** + * Determines if the row height of the `Range` object equals the standard height of the sheet. + Returns `true` if the row height of the `Range` object equals the standard height of the sheet. + Returns `null` if the range contains more than one row and the rows aren't all the same height. + Returns `false` otherwise. + Note: This property is only intended to be set to `true`. Setting it to `false` has no effect. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + useStandardHeight?: boolean; + /** + * Specifies if the column width of the `Range` object equals the standard width of the sheet. + Returns `true` if the column width of the `Range` object equals the standard width of the sheet. + Returns `null` if the range contains more than one column and the columns aren't all the same height. + Returns `false` otherwise. + Note: This property is only intended to be set to `true`. Setting it to `false` has no effect. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + useStandardWidth?: boolean; + /** + * Represents the vertical alignment for the specified object. See `Excel.VerticalAlignment` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + verticalAlignment?: Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed"; + /** + * Specifies if Excel wraps the text in the object. A `null` value indicates that the entire range doesn't have a uniform wrap setting + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + wrapText?: boolean; + } + /** An interface for updating data on the `FormatProtection` object, for use in `formatProtection.set({ ... })`. */ + export interface FormatProtectionUpdateData { + /** + * Specifies if Excel hides the formula for the cells in the range. A `null` value indicates that the entire range doesn't have a uniform formula hidden setting. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + formulaHidden?: boolean; + /** + * Specifies if Excel locks the cells in the object. A `null` value indicates that the entire range doesn't have a uniform lock setting. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + locked?: boolean; + } + /** An interface for updating data on the `RangeFill` object, for use in `rangeFill.set({ ... })`. */ + export interface RangeFillUpdateData { + /** + * HTML color code representing the color of the background, in the form #RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange") + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + color?: string; + /** + * The pattern of a range. See `Excel.FillPattern` for details. LinearGradient and RectangularGradient are not supported. + A `null` value indicates that the entire range doesn't have a uniform pattern setting. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + pattern?: Excel.FillPattern | "None" | "Solid" | "Gray50" | "Gray75" | "Gray25" | "Horizontal" | "Vertical" | "Down" | "Up" | "Checker" | "SemiGray75" | "LightHorizontal" | "LightVertical" | "LightDown" | "LightUp" | "Grid" | "CrissCross" | "Gray16" | "Gray8" | "LinearGradient" | "RectangularGradient"; + /** + * The HTML color code representing the color of the range pattern, in the form #RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange"). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + patternColor?: string; + /** + * Specifies a double that lightens or darkens a pattern color for the range fill. The value is between -1 (darkest) and 1 (brightest), with 0 for the original color. + A `null` value indicates that the range doesn't have uniform `patternTintAndShade` settings. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + patternTintAndShade?: number; + /** + * Specifies a double that lightens or darkens a color for the range fill. The value is between -1 (darkest) and 1 (brightest), with 0 for the original color. + A `null` value indicates that the range doesn't have uniform `tintAndShade` settings. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + tintAndShade?: number; + } + /** An interface for updating data on the `RangeBorder` object, for use in `rangeBorder.set({ ... })`. */ + export interface RangeBorderUpdateData { + /** + * HTML color code representing the color of the border line, in the form #RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange"). + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + color?: string; + /** + * One of the constants of line style specifying the line style for the border. See `Excel.BorderLineStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + style?: Excel.BorderLineStyle | "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot" | "Double" | "SlantDashDot"; + /** + * Specifies a double that lightens or darkens a color for the range border, the value is between -1 (darkest) and 1 (brightest), with 0 for the original color. + A `null` value indicates that the border doesn't have a uniform `tintAndShade` setting. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + tintAndShade?: number; + /** + * Specifies the weight of the border around a range. See `Excel.BorderWeight` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + weight?: Excel.BorderWeight | "Hairline" | "Thin" | "Medium" | "Thick"; + } + /** An interface for updating data on the `RangeBorderCollection` object, for use in `rangeBorderCollection.set({ ... })`. */ + export interface RangeBorderCollectionUpdateData { + /** + * Specifies a double that lightens or darkens a color for range borders. The value is between -1 (darkest) and 1 (brightest), with 0 for the original color. + A `null` value indicates that the entire border collection doesn't have a uniform `tintAndShade` setting. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + tintAndShade?: number; + items?: Excel.Interfaces.RangeBorderData[]; + } + /** An interface for updating data on the `RangeFont` object, for use in `rangeFont.set({ ... })`. */ + export interface RangeFontUpdateData { + /** + * Represents the bold status of the font. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + bold?: boolean; + /** + * HTML color code representation of the text color (e.g., #FF0000 represents Red). + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + color?: string; + /** + * Specifies the italic status of the font. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + italic?: boolean; + /** + * Font name (e.g., "Calibri"). The name's length should not be greater than 31 characters. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + name?: string; + /** + * Font size. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + size?: number; + /** + * Specifies the strikethrough status of font. A `null` value indicates that the entire range doesn't have a uniform strikethrough setting. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + strikethrough?: boolean; + /** + * Specifies the subscript status of font. + Returns `true` if all the fonts of the range are subscript. + Returns `false` if all the fonts of the range are superscript or normal (neither superscript, nor subscript). + Returns `null` otherwise. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + subscript?: boolean; + /** + * Specifies the superscript status of font. + Returns `true` if all the fonts of the range are superscript. + Returns `false` if all the fonts of the range are subscript or normal (neither superscript, nor subscript). + Returns `null` otherwise. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + superscript?: boolean; + /** + * Specifies a double that lightens or darkens a color for the range font. The value is between -1 (darkest) and 1 (brightest), with 0 for the original color. + A `null` value indicates that the entire range doesn't have a uniform font `tintAndShade` setting. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + tintAndShade?: number; + /** + * Type of underline applied to the font. See `Excel.RangeUnderlineStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + underline?: Excel.RangeUnderlineStyle | "None" | "Single" | "Double" | "SingleAccountant" | "DoubleAccountant"; + } + /** An interface for updating data on the `ChartCollection` object, for use in `chartCollection.set({ ... })`. */ + export interface ChartCollectionUpdateData { + items?: Excel.Interfaces.ChartData[]; + } + /** An interface for updating data on the `Chart` object, for use in `chart.set({ ... })`. */ + export interface ChartUpdateData { + /** + * Represents chart axes. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + axes?: Excel.Interfaces.ChartAxesUpdateData; + /** + * Represents the data labels on the chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + dataLabels?: Excel.Interfaces.ChartDataLabelsUpdateData; + /** + * Encapsulates the format properties for the chart area. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + format?: Excel.Interfaces.ChartAreaFormatUpdateData; + /** + * Represents the legend for the chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + legend?: Excel.Interfaces.ChartLegendUpdateData; + /** + * Encapsulates the options for a pivot chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + pivotOptions?: Excel.Interfaces.ChartPivotOptionsUpdateData; + /** + * Represents the plot area for the chart. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + plotArea?: Excel.Interfaces.ChartPlotAreaUpdateData; + /** + * Represents the title of the specified chart, including the text, visibility, position, and formatting of the title. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + title?: Excel.Interfaces.ChartTitleUpdateData; + /** + * Specifies a chart category label level enumeration constant, referring to the level of the source category labels. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + categoryLabelLevel?: number; + /** + * Specifies the type of the chart. See `Excel.ChartType` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + chartType?: Excel.ChartType | "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel"; + /** + * Specifies the way that blank cells are plotted on a chart. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + displayBlanksAs?: Excel.ChartDisplayBlanksAs | "NotPlotted" | "Zero" | "Interplotted"; + /** + * Specifies the height, in points, of the chart object. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + height?: number; + /** + * The distance, in points, from the left side of the chart to the worksheet origin. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + left?: number; + /** + * Specifies the name of a chart object. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + name?: string; + /** + * Specifies the way columns or rows are used as data series on the chart. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + plotBy?: Excel.ChartPlotBy | "Rows" | "Columns"; + /** + * True if only visible cells are plotted. False if both visible and hidden cells are plotted. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + plotVisibleOnly?: boolean; + /** + * Specifies a chart series name level enumeration constant, referring to the level of the source series names. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + seriesNameLevel?: number; + /** + * Specifies whether to display all field buttons on a PivotChart. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showAllFieldButtons?: boolean; + /** + * Specifies whether to show the data labels when the value is greater than the maximum value on the value axis. + If the value axis becomes smaller than the size of the data points, you can use this property to set whether to show the data labels. + This property applies to 2-D charts only. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showDataLabelsOverMaximum?: boolean; + /** + * Specifies the chart style for the chart. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + style?: number; + /** + * Specifies the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart). + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + top?: number; + /** + * Specifies the width, in points, of the chart object. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + width?: number; + } + /** An interface for updating data on the `ChartPivotOptions` object, for use in `chartPivotOptions.set({ ... })`. */ + export interface ChartPivotOptionsUpdateData { + /** + * Specifies whether to display the axis field buttons on a PivotChart. The `showAxisFieldButtons` property corresponds to the "Show Axis Field Buttons" command on the "Field Buttons" drop-down list of the "Analyze" tab, which is available when a PivotChart is selected. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showAxisFieldButtons?: boolean; + /** + * Specifies whether to display the legend field buttons on a PivotChart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showLegendFieldButtons?: boolean; + /** + * Specifies whether to display the report filter field buttons on a PivotChart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showReportFilterFieldButtons?: boolean; + /** + * Specifies whether to display the show value field buttons on a PivotChart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showValueFieldButtons?: boolean; + } + /** An interface for updating data on the `ChartAreaFormat` object, for use in `chartAreaFormat.set({ ... })`. */ + export interface ChartAreaFormatUpdateData { + /** + * Represents the border format of chart area, which includes color, linestyle, and weight. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + border?: Excel.Interfaces.ChartBorderUpdateData; + /** + * Represents the font attributes (font name, font size, color, etc.) for the current object. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + font?: Excel.Interfaces.ChartFontUpdateData; + /** + * Specifies the color scheme of the chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + colorScheme?: Excel.ChartColorScheme | "ColorfulPalette1" | "ColorfulPalette2" | "ColorfulPalette3" | "ColorfulPalette4" | "MonochromaticPalette1" | "MonochromaticPalette2" | "MonochromaticPalette3" | "MonochromaticPalette4" | "MonochromaticPalette5" | "MonochromaticPalette6" | "MonochromaticPalette7" | "MonochromaticPalette8" | "MonochromaticPalette9" | "MonochromaticPalette10" | "MonochromaticPalette11" | "MonochromaticPalette12" | "MonochromaticPalette13"; + /** + * Specifies if the chart area of the chart has rounded corners. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + roundedCorners?: boolean; + } + /** An interface for updating data on the `ChartSeriesCollection` object, for use in `chartSeriesCollection.set({ ... })`. */ + export interface ChartSeriesCollectionUpdateData { + items?: Excel.Interfaces.ChartSeriesData[]; + } + /** An interface for updating data on the `ChartSeries` object, for use in `chartSeries.set({ ... })`. */ + export interface ChartSeriesUpdateData { + /** + * Encapsulates the bin options for histogram charts and pareto charts. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + binOptions?: Excel.Interfaces.ChartBinOptionsUpdateData; + /** + * Encapsulates the options for the box and whisker charts. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + boxwhiskerOptions?: Excel.Interfaces.ChartBoxwhiskerOptionsUpdateData; + /** + * Represents a collection of all data labels in the series. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + dataLabels?: Excel.Interfaces.ChartDataLabelsUpdateData; + /** + * Represents the formatting of a chart series, which includes fill and line formatting. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + format?: Excel.Interfaces.ChartSeriesFormatUpdateData; + /** + * Encapsulates the options for a region map chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + mapOptions?: Excel.Interfaces.ChartMapOptionsUpdateData; + /** + * Represents the error bar object of a chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + xErrorBars?: Excel.Interfaces.ChartErrorBarsUpdateData; + /** + * Represents the error bar object of a chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + yErrorBars?: Excel.Interfaces.ChartErrorBarsUpdateData; + /** + * Specifies the group for the specified series. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + axisGroup?: Excel.ChartAxisGroup | "Primary" | "Secondary"; + /** + * This can be an integer value from 0 (zero) to 300, representing the percentage of the default size. This property only applies to bubble charts. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + bubbleScale?: number; + /** + * Represents the chart type of a series. See `Excel.ChartType` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + chartType?: Excel.ChartType | "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel"; + /** + * Represents the doughnut hole size of a chart series. Only valid on doughnut and doughnut exploded charts. + Throws an `InvalidArgument` error on invalid charts. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + doughnutHoleSize?: number; + /** + * Specifies the explosion value for a pie-chart or doughnut-chart slice. Returns 0 (zero) if there's no explosion (the tip of the slice is in the center of the pie). + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + explosion?: number; + /** + * Specifies if the series is filtered. Not applicable for surface charts. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + filtered?: boolean; + /** + * Specifies the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical). Applies only to pie, 3-D pie, and doughnut charts. Can be a value from 0 through 360. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + firstSliceAngle?: number; + /** + * Represents the gap width of a chart series. Only valid on bar and column charts, as well as + specific classes of line and pie charts. Throws an invalid argument exception on invalid charts. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + gapWidth?: number; + /** + * Specifies the color for maximum value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMaximumColor?: string; + /** + * Specifies the type for maximum value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMaximumType?: Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent"; + /** + * Specifies the maximum value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMaximumValue?: number; + /** + * Specifies the color for the midpoint value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMidpointColor?: string; + /** + * Specifies the type for the midpoint value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMidpointType?: Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent"; + /** + * Specifies the midpoint value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMidpointValue?: number; + /** + * Specifies the color for the minimum value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMinimumColor?: string; + /** + * Specifies the type for the minimum value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMinimumType?: Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent"; + /** + * Specifies the minimum value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMinimumValue?: number; + /** + * Specifies the series gradient style of a region map chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientStyle?: Excel.ChartGradientStyle | "TwoPhaseColor" | "ThreePhaseColor"; + /** + * Specifies if the series has data labels. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + hasDataLabels?: boolean; + /** + * Specifies the fill color for negative data points in a series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + invertColor?: string; + /** + * True if Excel inverts the pattern in the item when it corresponds to a negative number. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + invertIfNegative?: boolean; + /** + * Specifies the marker background color of a chart series. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + markerBackgroundColor?: string; + /** + * Specifies the marker foreground color of a chart series. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + markerForegroundColor?: string; + /** + * Specifies the marker size of a chart series. + The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + markerSize?: number; + /** + * Specifies the marker style of a chart series. See `Excel.ChartMarkerStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + markerStyle?: Excel.ChartMarkerStyle | "Invalid" | "Automatic" | "None" | "Square" | "Diamond" | "Triangle" | "X" | "Star" | "Dot" | "Dash" | "Circle" | "Plus" | "Picture"; + /** + * Specifies the name of a series in a chart. The name's length should not be greater than 255 characters. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + name?: string; + /** + * Specifies how bars and columns are positioned. Can be a value between -100 and 100. Applies only to 2-D bar and 2-D column charts. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + overlap?: number; + /** + * Specifies the series parent label strategy area for a treemap chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + parentLabelStrategy?: Excel.ChartParentLabelStrategy | "None" | "Banner" | "Overlapping"; + /** + * Specifies the plot order of a chart series within the chart group. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + plotOrder?: number; + /** + * Specifies the size of the secondary section of either a pie-of-pie chart or a bar-of-pie chart, as a percentage of the size of the primary pie. Can be a value from 5 to 200. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + secondPlotSize?: number; + /** + * Specifies whether connector lines are shown in waterfall charts. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showConnectorLines?: boolean; + /** + * Specifies whether leader lines are displayed for each data label in the series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showLeaderLines?: boolean; + /** + * Specifies if the series has a shadow. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showShadow?: boolean; + /** + * Specifies if the series is smooth. Only applicable to line and scatter charts. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + smooth?: boolean; + /** + * Specifies the way the two sections of either a pie-of-pie chart or a bar-of-pie chart are split. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + splitType?: Excel.ChartSplitType | "SplitByPosition" | "SplitByValue" | "SplitByPercentValue" | "SplitByCustomSplit"; + /** + * Specifies the threshold value that separates two sections of either a pie-of-pie chart or a bar-of-pie chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + splitValue?: number; + /** + * True if Excel assigns a different color or pattern to each data marker. The chart must contain only one series. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + varyByCategories?: boolean; + } + /** An interface for updating data on the `ChartSeriesFormat` object, for use in `chartSeriesFormat.set({ ... })`. */ + export interface ChartSeriesFormatUpdateData { + /** + * Represents line formatting. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + line?: Excel.Interfaces.ChartLineFormatUpdateData; + } + /** An interface for updating data on the `ChartPointsCollection` object, for use in `chartPointsCollection.set({ ... })`. */ + export interface ChartPointsCollectionUpdateData { + items?: Excel.Interfaces.ChartPointData[]; + } + /** An interface for updating data on the `ChartPoint` object, for use in `chartPoint.set({ ... })`. */ + export interface ChartPointUpdateData { + /** + * Returns the data label of a chart point. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + dataLabel?: Excel.Interfaces.ChartDataLabelUpdateData; + /** + * Encapsulates the format properties chart point. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + format?: Excel.Interfaces.ChartPointFormatUpdateData; + /** + * Represents whether a data point has a data label. Not applicable for surface charts. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + hasDataLabel?: boolean; + /** + * HTML color code representation of the marker background color of a data point (e.g., #FF0000 represents Red). + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + markerBackgroundColor?: string; + /** + * HTML color code representation of the marker foreground color of a data point (e.g., #FF0000 represents Red). + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + markerForegroundColor?: string; + /** + * Represents marker size of a data point. + The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + markerSize?: number; + /** + * Represents marker style of a chart data point. See `Excel.ChartMarkerStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + markerStyle?: Excel.ChartMarkerStyle | "Invalid" | "Automatic" | "None" | "Square" | "Diamond" | "Triangle" | "X" | "Star" | "Dot" | "Dash" | "Circle" | "Plus" | "Picture"; + } + /** An interface for updating data on the `ChartPointFormat` object, for use in `chartPointFormat.set({ ... })`. */ + export interface ChartPointFormatUpdateData { + /** + * Represents the border format of a chart data point, which includes color, style, and weight information. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + border?: Excel.Interfaces.ChartBorderUpdateData; + } + /** An interface for updating data on the `ChartAxes` object, for use in `chartAxes.set({ ... })`. */ + export interface ChartAxesUpdateData { + /** + * Represents the category axis in a chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + categoryAxis?: Excel.Interfaces.ChartAxisUpdateData; + /** + * Represents the series axis of a 3-D chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + seriesAxis?: Excel.Interfaces.ChartAxisUpdateData; + /** + * Represents the value axis in an axis. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + valueAxis?: Excel.Interfaces.ChartAxisUpdateData; + } + /** An interface for updating data on the `ChartAxis` object, for use in `chartAxis.set({ ... })`. */ + export interface ChartAxisUpdateData { + /** + * Represents the formatting of a chart object, which includes line and font formatting. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + format?: Excel.Interfaces.ChartAxisFormatUpdateData; + /** + * Returns an object that represents the major gridlines for the specified axis. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + majorGridlines?: Excel.Interfaces.ChartGridlinesUpdateData; + /** + * Returns an object that represents the minor gridlines for the specified axis. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + minorGridlines?: Excel.Interfaces.ChartGridlinesUpdateData; + /** + * Represents the axis title. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + title?: Excel.Interfaces.ChartAxisTitleUpdateData; + /** + * Specifies the alignment for the specified axis tick label. See `Excel.ChartTextHorizontalAlignment` for detail. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + alignment?: Excel.ChartTickLabelAlignment | "Center" | "Left" | "Right"; + /** + * Specifies the base unit for the specified category axis. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + baseTimeUnit?: Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years"; + /** + * Specifies the category axis type. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + categoryType?: Excel.ChartAxisCategoryType | "Automatic" | "TextAxis" | "DateAxis"; + /** + * Represents the axis display unit. See `Excel.ChartAxisDisplayUnit` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + displayUnit?: Excel.ChartAxisDisplayUnit | "None" | "Hundreds" | "Thousands" | "TenThousands" | "HundredThousands" | "Millions" | "TenMillions" | "HundredMillions" | "Billions" | "Trillions" | "Custom"; + /** + * Specifies if the value axis crosses the category axis between categories. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + isBetweenCategories?: boolean; + /** + * Specifies if the number format is linked to the cells. If `true`, the number format will change in the labels when it changes in the cells. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + linkNumberFormat?: boolean; + /** + * Specifies the base of the logarithm when using logarithmic scales. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + logBase?: number; + /** + * Specifies the type of major tick mark for the specified axis. See `Excel.ChartAxisTickMark` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + majorTickMark?: Excel.ChartAxisTickMark | "None" | "Cross" | "Inside" | "Outside"; + /** + * Specifies the major unit scale value for the category axis when the `categoryType` property is set to `dateAxis`. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + majorTimeUnitScale?: Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years"; + /** + * Represents the interval between two major tick marks. Can be set to a numeric value or an empty string. The returned value is always a number. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + majorUnit?: any; + /** + * Represents the maximum value on the value axis. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + maximum?: any; + /** + * Represents the minimum value on the value axis. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + minimum?: any; + /** + * Specifies the type of minor tick mark for the specified axis. See `Excel.ChartAxisTickMark` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + minorTickMark?: Excel.ChartAxisTickMark | "None" | "Cross" | "Inside" | "Outside"; + /** + * Specifies the minor unit scale value for the category axis when the `categoryType` property is set to `dateAxis`. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + minorTimeUnitScale?: Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years"; + /** + * Represents the interval between two minor tick marks. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + minorUnit?: any; + /** + * Specifies if an axis is multilevel. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + multiLevel?: boolean; + /** + * Specifies the format code for the axis tick label. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + numberFormat?: string; + /** + * Specifies the distance between the levels of labels, and the distance between the first level and the axis line. The value should be an integer from 0 to 1000. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + offset?: number; + /** + * Specifies the specified axis position where the other axis crosses. See `Excel.ChartAxisPosition` for details. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + position?: Excel.ChartAxisPosition | "Automatic" | "Maximum" | "Minimum" | "Custom"; + /** + * Specifies if Excel plots data points from last to first. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + reversePlotOrder?: boolean; + /** + * Specifies the value axis scale type. See `Excel.ChartAxisScaleType` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + scaleType?: Excel.ChartAxisScaleType | "Linear" | "Logarithmic"; + /** + * Specifies if the axis display unit label is visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showDisplayUnitLabel?: boolean; + /** + * Specifies the angle to which the text is oriented for the chart axis tick label. The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + textOrientation?: any; + /** + * Specifies the position of tick-mark labels on the specified axis. See `Excel.ChartAxisTickLabelPosition` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + tickLabelPosition?: Excel.ChartAxisTickLabelPosition | "NextToAxis" | "High" | "Low" | "None"; + /** + * Specifies the number of categories or series between tick-mark labels. Can be a value from 1 through 31999 or an empty string for automatic setting. The returned value is always a number. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + tickLabelSpacing?: any; + /** + * Specifies the number of categories or series between tick marks. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + tickMarkSpacing?: number; + /** + * Specifies if the axis is visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + visible?: boolean; + } + /** An interface for updating data on the `ChartAxisFormat` object, for use in `chartAxisFormat.set({ ... })`. */ + export interface ChartAxisFormatUpdateData { + /** + * Specifies the font attributes (font name, font size, color, etc.) for a chart axis element. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + font?: Excel.Interfaces.ChartFontUpdateData; + /** + * Specifies chart line formatting. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + line?: Excel.Interfaces.ChartLineFormatUpdateData; + } + /** An interface for updating data on the `ChartAxisTitle` object, for use in `chartAxisTitle.set({ ... })`. */ + export interface ChartAxisTitleUpdateData { + /** + * Specifies the formatting of the chart axis title. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + format?: Excel.Interfaces.ChartAxisTitleFormatUpdateData; + /** + * Specifies the axis title. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + text?: string; + /** + * Specifies the angle to which the text is oriented for the chart axis title. The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + textOrientation?: number; + /** + * Specifies if the axis title is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + visible?: boolean; + } + /** An interface for updating data on the `ChartAxisTitleFormat` object, for use in `chartAxisTitleFormat.set({ ... })`. */ + export interface ChartAxisTitleFormatUpdateData { + /** + * Specifies the chart axis title's border format, which includes color, linestyle, and weight. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + border?: Excel.Interfaces.ChartBorderUpdateData; + /** + * Specifies the chart axis title's font attributes, such as font name, font size, or color, of the chart axis title object. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + font?: Excel.Interfaces.ChartFontUpdateData; + } + /** An interface for updating data on the `ChartDataLabels` object, for use in `chartDataLabels.set({ ... })`. */ + export interface ChartDataLabelsUpdateData { + /** + * Specifies the format of chart data labels, which includes fill and font formatting. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + format?: Excel.Interfaces.ChartDataLabelFormatUpdateData; + /** + * Gets an object that represents the leader lines of the data labels. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + leaderLines?: Excel.Interfaces.ChartLeaderLinesUpdateData; + /** + * Specifies if data labels automatically generate appropriate text based on context. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + autoText?: boolean; + /** + * Specifies the geometric shape type of the data labels. See `Excel.GeometricShapeType` for more details. + Value is `null` if the data labels are not geometric shapes. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + geometricShapeType?: Excel.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"; + /** + * Specifies the horizontal alignment for chart data label. See `Excel.ChartTextHorizontalAlignment` for details. + This property is valid only when the `TextOrientation` of data label is 0. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + horizontalAlignment?: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"; + /** + * Specifies if the number format is linked to the cells. If `true`, the number format will change in the labels when it changes in the cells. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + linkNumberFormat?: boolean; + /** + * Specifies the format code for data labels. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + numberFormat?: string; + /** + * Value that represents the position of the data label. See `Excel.ChartDataLabelPosition` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + position?: Excel.ChartDataLabelPosition | "Invalid" | "None" | "Center" | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" | "Right" | "Top" | "Bottom" | "BestFit" | "Callout"; + /** + * String representing the separator used for the data labels on a chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + separator?: string; + /** + * Specifies if the data label bubble size is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + showBubbleSize?: boolean; + /** + * Specifies if the data label category name is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + showCategoryName?: boolean; + /** + * Specifies if leader lines are displayed for the data labels. `true` if leader lines are shown; otherwise, `false`. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + showLeaderLines?: boolean; + /** + * Specifies if the data label legend key is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + showLegendKey?: boolean; + /** + * Specifies if the data label percentage is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + showPercentage?: boolean; + /** + * Specifies if the data label series name is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + showSeriesName?: boolean; + /** + * Specifies if the data label value is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + showValue?: boolean; + /** + * Represents the angle to which the text is oriented for data labels. The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + textOrientation?: number; + /** + * Represents the vertical alignment of chart data label. See `Excel.ChartTextVerticalAlignment` for details. + This property is valid only when `TextOrientation` of the data label is -90, 90, or 180. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + verticalAlignment?: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"; + } + /** An interface for updating data on the `ChartDataLabel` object, for use in `chartDataLabel.set({ ... })`. */ + export interface ChartDataLabelUpdateData { + /** + * Represents the format of chart data label. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + format?: Excel.Interfaces.ChartDataLabelFormatUpdateData; + /** + * Specifies if the data label automatically generates appropriate text based on context. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + autoText?: boolean; + /** + * String value that represents the formula of chart data label using A1-style notation. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + formula?: string; + /** + * Specifies the geometric shape type of the data label. See `Excel.GeometricShapeType` for more details. + Value is `null` if the data label is not a geometric shape. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + geometricShapeType?: Excel.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"; + /** + * Represents the horizontal alignment for chart data label. + See `Excel.ChartTextHorizontalAlignment` for details. + This property is valid only when `TextOrientation` of data label is -90, 90, or 180. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + horizontalAlignment?: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"; + /** + * Represents the distance, in points, from the left edge of chart data label to the left edge of chart area. Value is `null` if the chart data label is not visible. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + left?: number; + /** + * Specifies if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + linkNumberFormat?: boolean; + /** + * Specifies the format code for data label. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + numberFormat?: string; + /** + * Value that represents the position of the data label. + See `Excel.ChartDataLabelPosition` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + position?: Excel.ChartDataLabelPosition | "Invalid" | "None" | "Center" | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" | "Right" | "Top" | "Bottom" | "BestFit" | "Callout"; + /** + * String representing the separator used for the data label on a chart. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + separator?: string; + /** + * Specifies if the data label bubble size is visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showBubbleSize?: boolean; + /** + * Specifies if the data label category name is visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showCategoryName?: boolean; + /** + * Specifies if the data label legend key is visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showLegendKey?: boolean; + /** + * Specifies if the data label percentage is visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showPercentage?: boolean; + /** + * Specifies if the data label series name is visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showSeriesName?: boolean; + /** + * Specifies if the data label value is visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showValue?: boolean; + /** + * String representing the text of the data label on a chart. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + text?: string; + /** + * Represents the angle to which the text is oriented for the chart data label. + The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + textOrientation?: number; + /** + * Represents the distance, in points, from the top edge of chart data label to the top of chart area. Value is `null` if the chart data label is not visible. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + top?: number; + /** + * Represents the vertical alignment of chart data label. + See `Excel.ChartTextVerticalAlignment` for details. + This property is valid only when `TextOrientation` of data label is 0. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + verticalAlignment?: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"; + } + /** An interface for updating data on the `ChartDataLabelFormat` object, for use in `chartDataLabelFormat.set({ ... })`. */ + export interface ChartDataLabelFormatUpdateData { + /** + * Represents the border format, which includes color, linestyle, and weight. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + border?: Excel.Interfaces.ChartBorderUpdateData; + /** + * Represents the font attributes (such as font name, font size, and color) for a chart data label. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + font?: Excel.Interfaces.ChartFontUpdateData; + } + /** An interface for updating data on the `ChartDataLabelAnchor` object, for use in `chartDataLabelAnchor.set({ ... })`. */ + export interface ChartDataLabelAnchorUpdateData { + /** + * Specifies the distance, in points, from the anchor to the left edge of the chart data label. + Note that when getting the value, it may differ slightly from the set value. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + left?: number; + /** + * Specifies the distance, in points, from the anchor to the top edge of the chart data label. + Note that when getting the value, it may differ slightly from the set value. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + top?: number; + } + /** An interface for updating data on the `ChartDataTable` object, for use in `chartDataTable.set({ ... })`. */ + export interface ChartDataTableUpdateData { + /** + * Represents the format of a chart data table, which includes fill, font, and border format. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + format?: Excel.Interfaces.ChartDataTableFormatUpdateData; + /** + * Specifies whether to display the horizontal border of the data table. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + showHorizontalBorder?: boolean; + /** + * Specifies whether to show the legend key of the data table. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + showLegendKey?: boolean; + /** + * Specifies whether to display the outline border of the data table. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + showOutlineBorder?: boolean; + /** + * Specifies whether to display the vertical border of the data table. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + showVerticalBorder?: boolean; + /** + * Specifies whether to show the data table of the chart. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + visible?: boolean; + } + /** An interface for updating data on the `ChartDataTableFormat` object, for use in `chartDataTableFormat.set({ ... })`. */ + export interface ChartDataTableFormatUpdateData { + /** + * Represents the border format of chart data table, which includes color, line style, and weight. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + border?: Excel.Interfaces.ChartBorderUpdateData; + /** + * Represents the font attributes (such as font name, font size, and color) for the current object. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + font?: Excel.Interfaces.ChartFontUpdateData; + } + /** An interface for updating data on the `ChartErrorBars` object, for use in `chartErrorBars.set({ ... })`. */ + export interface ChartErrorBarsUpdateData { + /** + * Specifies the formatting type of the error bars. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + format?: Excel.Interfaces.ChartErrorBarsFormatUpdateData; + /** + * Specifies if error bars have an end style cap. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + endStyleCap?: boolean; + /** + * Specifies which parts of the error bars to include. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + include?: Excel.ChartErrorBarsInclude | "Both" | "MinusValues" | "PlusValues"; + /** + * The type of range marked by the error bars. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + type?: Excel.ChartErrorBarsType | "FixedValue" | "Percent" | "StDev" | "StError" | "Custom"; + /** + * Specifies whether the error bars are displayed. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + visible?: boolean; + } + /** An interface for updating data on the `ChartErrorBarsFormat` object, for use in `chartErrorBarsFormat.set({ ... })`. */ + export interface ChartErrorBarsFormatUpdateData { + /** + * Represents the chart line formatting. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + line?: Excel.Interfaces.ChartLineFormatUpdateData; + } + /** An interface for updating data on the `ChartGridlines` object, for use in `chartGridlines.set({ ... })`. */ + export interface ChartGridlinesUpdateData { + /** + * Represents the formatting of chart gridlines. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + format?: Excel.Interfaces.ChartGridlinesFormatUpdateData; + /** + * Specifies if the axis gridlines are visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + visible?: boolean; + } + /** An interface for updating data on the `ChartGridlinesFormat` object, for use in `chartGridlinesFormat.set({ ... })`. */ + export interface ChartGridlinesFormatUpdateData { + /** + * Represents chart line formatting. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + line?: Excel.Interfaces.ChartLineFormatUpdateData; + } + /** An interface for updating data on the `ChartLegend` object, for use in `chartLegend.set({ ... })`. */ + export interface ChartLegendUpdateData { + /** + * Represents the formatting of a chart legend, which includes fill and font formatting. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + format?: Excel.Interfaces.ChartLegendFormatUpdateData; + /** + * Specifies the height, in points, of the legend on the chart. Value is `null` if the legend is not visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + height?: number; + /** + * Specifies the left value, in points, of the legend on the chart. Value is `null` if the legend is not visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + left?: number; + /** + * Specifies if the chart legend should overlap with the main body of the chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + overlay?: boolean; + /** + * Specifies the position of the legend on the chart. See `Excel.ChartLegendPosition` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + position?: Excel.ChartLegendPosition | "Invalid" | "Top" | "Bottom" | "Left" | "Right" | "Corner" | "Custom"; + /** + * Specifies if the legend has a shadow on the chart. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showShadow?: boolean; + /** + * Specifies the top of a chart legend. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + top?: number; + /** + * Specifies if the chart legend is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + visible?: boolean; + /** + * Specifies the width, in points, of the legend on the chart. Value is `null` if the legend is not visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + width?: number; + } + /** An interface for updating data on the `ChartLegendEntry` object, for use in `chartLegendEntry.set({ ... })`. */ + export interface ChartLegendEntryUpdateData { + /** + * Represents the visibility of a chart legend entry. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + visible?: boolean; + } + /** An interface for updating data on the `ChartLegendEntryCollection` object, for use in `chartLegendEntryCollection.set({ ... })`. */ + export interface ChartLegendEntryCollectionUpdateData { + items?: Excel.Interfaces.ChartLegendEntryData[]; + } + /** An interface for updating data on the `ChartLegendFormat` object, for use in `chartLegendFormat.set({ ... })`. */ + export interface ChartLegendFormatUpdateData { + /** + * Represents the border format, which includes color, linestyle, and weight. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + border?: Excel.Interfaces.ChartBorderUpdateData; + /** + * Represents the font attributes such as font name, font size, and color of a chart legend. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + font?: Excel.Interfaces.ChartFontUpdateData; + } + /** An interface for updating data on the `ChartMapOptions` object, for use in `chartMapOptions.set({ ... })`. */ + export interface ChartMapOptionsUpdateData { + /** + * Specifies the series map labels strategy of a region map chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + labelStrategy?: Excel.ChartMapLabelStrategy | "None" | "BestFit" | "ShowAll"; + /** + * Specifies the series mapping level of a region map chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + level?: Excel.ChartMapAreaLevel | "Automatic" | "DataOnly" | "City" | "County" | "State" | "Country" | "Continent" | "World"; + /** + * Specifies the series projection type of a region map chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + projectionType?: Excel.ChartMapProjectionType | "Automatic" | "Mercator" | "Miller" | "Robinson" | "Albers"; + } + /** An interface for updating data on the `ChartTitle` object, for use in `chartTitle.set({ ... })`. */ + export interface ChartTitleUpdateData { + /** + * Represents the formatting of a chart title, which includes fill and font formatting. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + format?: Excel.Interfaces.ChartTitleFormatUpdateData; + /** + * Specifies the horizontal alignment for chart title. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + horizontalAlignment?: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"; + /** + * Specifies the distance, in points, from the left edge of chart title to the left edge of chart area. Value is `null` if the chart title is not visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + left?: number; + /** + * Specifies if the chart title will overlay the chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + overlay?: boolean; + /** + * Represents the position of chart title. See `Excel.ChartTitlePosition` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + position?: Excel.ChartTitlePosition | "Automatic" | "Top" | "Bottom" | "Left" | "Right"; + /** + * Represents a boolean value that determines if the chart title has a shadow. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showShadow?: boolean; + /** + * Specifies the chart's title text. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + text?: string; + /** + * Specifies the angle to which the text is oriented for the chart title. The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + textOrientation?: number; + /** + * Specifies the distance, in points, from the top edge of chart title to the top of chart area. Value is `null` if the chart title is not visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + top?: number; + /** + * Specifies the vertical alignment of chart title. See `Excel.ChartTextVerticalAlignment` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + verticalAlignment?: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"; + /** + * Specifies if the chart title is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + visible?: boolean; + } + /** An interface for updating data on the `ChartFormatString` object, for use in `chartFormatString.set({ ... })`. */ + export interface ChartFormatStringUpdateData { + /** + * Represents the font attributes, such as font name, font size, and color of a chart characters object. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + font?: Excel.Interfaces.ChartFontUpdateData; + } + /** An interface for updating data on the `ChartTitleFormat` object, for use in `chartTitleFormat.set({ ... })`. */ + export interface ChartTitleFormatUpdateData { + /** + * Represents the border format of chart title, which includes color, linestyle, and weight. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + border?: Excel.Interfaces.ChartBorderUpdateData; + /** + * Represents the font attributes (such as font name, font size, and color) for an object. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + font?: Excel.Interfaces.ChartFontUpdateData; + } + /** An interface for updating data on the `ChartBorder` object, for use in `chartBorder.set({ ... })`. */ + export interface ChartBorderUpdateData { + /** + * HTML color code representing the color of borders in the chart. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + color?: string; + /** + * Represents the line style of the border. See `Excel.ChartLineStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + lineStyle?: Excel.ChartLineStyle | "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot" | "Grey25" | "Grey50" | "Grey75" | "Automatic" | "RoundDot"; + /** + * Represents weight of the border, in points. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + weight?: number; + } + /** An interface for updating data on the `ChartBinOptions` object, for use in `chartBinOptions.set({ ... })`. */ + export interface ChartBinOptionsUpdateData { + /** + * Specifies if bin overflow is enabled in a histogram chart or pareto chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + allowOverflow?: boolean; + /** + * Specifies if bin underflow is enabled in a histogram chart or pareto chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + allowUnderflow?: boolean; + /** + * Specifies the bin count of a histogram chart or pareto chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + count?: number; + /** + * Specifies the bin overflow value of a histogram chart or pareto chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + overflowValue?: number; + /** + * Specifies the bin's type for a histogram chart or pareto chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + type?: Excel.ChartBinType | "Category" | "Auto" | "BinWidth" | "BinCount"; + /** + * Specifies the bin underflow value of a histogram chart or pareto chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + underflowValue?: number; + /** + * Specifies the bin width value of a histogram chart or pareto chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + width?: number; + } + /** An interface for updating data on the `ChartBoxwhiskerOptions` object, for use in `chartBoxwhiskerOptions.set({ ... })`. */ + export interface ChartBoxwhiskerOptionsUpdateData { + /** + * Specifies if the quartile calculation type of a box and whisker chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + quartileCalculation?: Excel.ChartBoxQuartileCalculation | "Inclusive" | "Exclusive"; + /** + * Specifies if inner points are shown in a box and whisker chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showInnerPoints?: boolean; + /** + * Specifies if the mean line is shown in a box and whisker chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showMeanLine?: boolean; + /** + * Specifies if the mean marker is shown in a box and whisker chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showMeanMarker?: boolean; + /** + * Specifies if outlier points are shown in a box and whisker chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showOutlierPoints?: boolean; + } + /** An interface for updating data on the `ChartLineFormat` object, for use in `chartLineFormat.set({ ... })`. */ + export interface ChartLineFormatUpdateData { + /** + * HTML color code representing the color of lines in the chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + color?: string; + /** + * Represents the line style. See `Excel.ChartLineStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + lineStyle?: Excel.ChartLineStyle | "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot" | "Grey25" | "Grey50" | "Grey75" | "Automatic" | "RoundDot"; + /** + * Represents weight of the line, in points. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + weight?: number; + } + /** An interface for updating data on the `ChartFont` object, for use in `chartFont.set({ ... })`. */ + export interface ChartFontUpdateData { + /** + * Represents the bold status of font. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + bold?: boolean; + /** + * HTML color code representation of the text color (e.g., #FF0000 represents Red). + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + color?: string; + /** + * Represents the italic status of the font. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + italic?: boolean; + /** + * Font name (e.g., "Calibri") + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + name?: string; + /** + * Size of the font (e.g., 11) + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + size?: number; + /** + * Type of underline applied to the font. See `Excel.ChartUnderlineStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + underline?: Excel.ChartUnderlineStyle | "None" | "Single"; + } + /** An interface for updating data on the `ChartTrendline` object, for use in `chartTrendline.set({ ... })`. */ + export interface ChartTrendlineUpdateData { + /** + * Represents the formatting of a chart trendline. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + format?: Excel.Interfaces.ChartTrendlineFormatUpdateData; + /** + * Represents the label of a chart trendline. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + label?: Excel.Interfaces.ChartTrendlineLabelUpdateData; + /** + * Represents the number of periods that the trendline extends backward. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + backwardPeriod?: number; + /** + * Represents the number of periods that the trendline extends forward. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + forwardPeriod?: number; + /** + * Represents the intercept value of the trendline. Can be set to a numeric value or an empty string (for automatic values). The returned value is always a number. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + intercept?: any; + /** + * Represents the period of a chart trendline. Only applicable to trendlines with the type `MovingAverage`. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + movingAveragePeriod?: number; + /** + * Represents the name of the trendline. Can be set to a string value, a `null` value represents automatic values. The returned value is always a string + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + name?: string; + /** + * Represents the order of a chart trendline. Only applicable to trendlines with the type `Polynomial`. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + polynomialOrder?: number; + /** + * True if the equation for the trendline is displayed on the chart. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showEquation?: boolean; + /** + * True if the r-squared value for the trendline is displayed on the chart. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showRSquared?: boolean; + /** + * Represents the type of a chart trendline. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + type?: Excel.ChartTrendlineType | "Linear" | "Exponential" | "Logarithmic" | "MovingAverage" | "Polynomial" | "Power"; + } + /** An interface for updating data on the `ChartTrendlineCollection` object, for use in `chartTrendlineCollection.set({ ... })`. */ + export interface ChartTrendlineCollectionUpdateData { + items?: Excel.Interfaces.ChartTrendlineData[]; + } + /** An interface for updating data on the `ChartTrendlineFormat` object, for use in `chartTrendlineFormat.set({ ... })`. */ + export interface ChartTrendlineFormatUpdateData { + /** + * Represents chart line formatting. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + line?: Excel.Interfaces.ChartLineFormatUpdateData; + } + /** An interface for updating data on the `ChartTrendlineLabel` object, for use in `chartTrendlineLabel.set({ ... })`. */ + export interface ChartTrendlineLabelUpdateData { + /** + * The format of the chart trendline label. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + format?: Excel.Interfaces.ChartTrendlineLabelFormatUpdateData; + /** + * Specifies if the trendline label automatically generates appropriate text based on context. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + autoText?: boolean; + /** + * String value that represents the formula of the chart trendline label using A1-style notation. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + formula?: string; + /** + * Represents the horizontal alignment of the chart trendline label. See `Excel.ChartTextHorizontalAlignment` for details. + This property is valid only when `TextOrientation` of a trendline label is -90, 90, or 180. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + horizontalAlignment?: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"; + /** + * Represents the distance, in points, from the left edge of the chart trendline label to the left edge of the chart area. Value is `null` if the chart trendline label is not visible. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + left?: number; + /** + * Specifies if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + linkNumberFormat?: boolean; + /** + * String value that represents the format code for the trendline label. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + numberFormat?: string; + /** + * String representing the text of the trendline label on a chart. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + text?: string; + /** + * Represents the angle to which the text is oriented for the chart trendline label. The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + textOrientation?: number; + /** + * Represents the distance, in points, from the top edge of the chart trendline label to the top of the chart area. Value is `null` if the chart trendline label is not visible. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + top?: number; + /** + * Represents the vertical alignment of the chart trendline label. See `Excel.ChartTextVerticalAlignment` for details. + This property is valid only when `TextOrientation` of a trendline label is 0. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + verticalAlignment?: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"; + } + /** An interface for updating data on the `ChartTrendlineLabelFormat` object, for use in `chartTrendlineLabelFormat.set({ ... })`. */ + export interface ChartTrendlineLabelFormatUpdateData { + /** + * Specifies the border format, which includes color, linestyle, and weight. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + border?: Excel.Interfaces.ChartBorderUpdateData; + /** + * Specifies the font attributes (such as font name, font size, and color) for a chart trendline label. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + font?: Excel.Interfaces.ChartFontUpdateData; + } + /** An interface for updating data on the `ChartPlotArea` object, for use in `chartPlotArea.set({ ... })`. */ + export interface ChartPlotAreaUpdateData { + /** + * Specifies the formatting of a chart plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + format?: Excel.Interfaces.ChartPlotAreaFormatUpdateData; + /** + * Specifies the height value of a plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + height?: number; + /** + * Specifies the inside height value of a plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + insideHeight?: number; + /** + * Specifies the inside left value of a plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + insideLeft?: number; + /** + * Specifies the inside top value of a plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + insideTop?: number; + /** + * Specifies the inside width value of a plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + insideWidth?: number; + /** + * Specifies the left value of a plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + left?: number; + /** + * Specifies the position of a plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + position?: Excel.ChartPlotAreaPosition | "Automatic" | "Custom"; + /** + * Specifies the top value of a plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + top?: number; + /** + * Specifies the width value of a plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + width?: number; + } + /** An interface for updating data on the `ChartPlotAreaFormat` object, for use in `chartPlotAreaFormat.set({ ... })`. */ + export interface ChartPlotAreaFormatUpdateData { + /** + * Specifies the border attributes of a chart plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + border?: Excel.Interfaces.ChartBorderUpdateData; + } + /** An interface for updating data on the `ChartLeaderLines` object, for use in `chartLeaderLines.set({ ... })`. */ + export interface ChartLeaderLinesUpdateData { + /** + * Represents the formatting of leader lines of data labels in a series. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + format?: Excel.Interfaces.ChartLeaderLinesFormatUpdateData; + } + /** An interface for updating data on the `ChartLeaderLinesFormat` object, for use in `chartLeaderLinesFormat.set({ ... })`. */ + export interface ChartLeaderLinesFormatUpdateData { + /** + * Gets an object that represents the line formatting of chart leader lines. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + line?: Excel.Interfaces.ChartLineFormatUpdateData; + } + /** An interface for updating data on the `CustomXmlPartScopedCollection` object, for use in `customXmlPartScopedCollection.set({ ... })`. */ + export interface CustomXmlPartScopedCollectionUpdateData { + items?: Excel.Interfaces.CustomXmlPartData[]; + } + /** An interface for updating data on the `CustomXmlPartCollection` object, for use in `customXmlPartCollection.set({ ... })`. */ + export interface CustomXmlPartCollectionUpdateData { + items?: Excel.Interfaces.CustomXmlPartData[]; + } + /** An interface for updating data on the `PivotTableScopedCollection` object, for use in `pivotTableScopedCollection.set({ ... })`. */ + export interface PivotTableScopedCollectionUpdateData { + items?: Excel.Interfaces.PivotTableData[]; + } + /** An interface for updating data on the `PivotTableCollection` object, for use in `pivotTableCollection.set({ ... })`. */ + export interface PivotTableCollectionUpdateData { + items?: Excel.Interfaces.PivotTableData[]; + } + /** An interface for updating data on the `PivotTable` object, for use in `pivotTable.set({ ... })`. */ + export interface PivotTableUpdateData { + /** + * Specifies if the PivotTable allows the application of multiple PivotFilters on a given PivotField in the table. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + allowMultipleFiltersPerField?: boolean; + /** + * Specifies if the PivotTable allows values in the data body to be edited by the user. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enableDataValueEditing?: boolean; + /** + * Name of the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + name?: string; + /** + * Specifies whether the PivotTable refreshes when the workbook opens. Corresponds to "Refresh on load" setting in the UI. + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + refreshOnOpen?: boolean; + /** + * Specifies if the PivotTable uses custom lists when sorting. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + useCustomSortLists?: boolean; + } + /** An interface for updating data on the `PivotLayout` object, for use in `pivotLayout.set({ ... })`. */ + export interface PivotLayoutUpdateData { + /** + * The alt text description of the PivotTable. + + Alt text provides alternative, text-based representations of the information contained in the PivotTable. + This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table. + A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content. + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + altTextDescription?: string; + /** + * The alt text title of the PivotTable. + + Alt text provides alternative, text-based representations of the information contained in the PivotTable. + This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table. + A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content. + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + altTextTitle?: string; + /** + * Specifies if formatting will be automatically formatted when it's refreshed or when fields are moved. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + autoFormat?: boolean; + /** + * The text that is automatically filled into any empty cell in the PivotTable if `fillEmptyCells == true`. + Note that this value persists if `fillEmptyCells` is set to `false`, and that setting this value does not set that property to `true`. + By default, this is an empty string. + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + emptyCellText?: string; + /** + * Specifies if the field list can be shown in the UI. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + enableFieldList?: boolean; + /** + * Specifies whether empty cells in the PivotTable should be populated with the `emptyCellText`. Default is `false`. + Note that the value of `emptyCellText` persists when this property is set to `false`. + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + fillEmptyCells?: boolean; + /** + * This property indicates the PivotLayoutType of all fields on the PivotTable. + If fields have different states, this will be null. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + layoutType?: Excel.PivotLayoutType | "Compact" | "Tabular" | "Outline"; + /** + * Specifies if formatting is preserved when the report is refreshed or recalculated by operations such as pivoting, sorting, or changing page field items. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + preserveFormatting?: boolean; + /** + * Specifies if the PivotTable report shows grand totals for columns. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showColumnGrandTotals?: boolean; + /** + * Specifies whether the PivotTable displays field headers (field captions and filter drop-downs). + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + showFieldHeaders?: boolean; + /** + * Specifies if the PivotTable report shows grand totals for rows. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showRowGrandTotals?: boolean; + /** + * This property indicates the `SubtotalLocationType` of all fields on the PivotTable. + If fields have different states, this will be `null`. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + subtotalLocation?: Excel.SubtotalLocationType | "AtTop" | "AtBottom" | "Off"; + } + /** An interface for updating data on the `PivotHierarchyCollection` object, for use in `pivotHierarchyCollection.set({ ... })`. */ + export interface PivotHierarchyCollectionUpdateData { + items?: Excel.Interfaces.PivotHierarchyData[]; + } + /** An interface for updating data on the `PivotHierarchy` object, for use in `pivotHierarchy.set({ ... })`. */ + export interface PivotHierarchyUpdateData { + /** + * Name of the PivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + name?: string; + } + /** An interface for updating data on the `RowColumnPivotHierarchyCollection` object, for use in `rowColumnPivotHierarchyCollection.set({ ... })`. */ + export interface RowColumnPivotHierarchyCollectionUpdateData { + items?: Excel.Interfaces.RowColumnPivotHierarchyData[]; + } + /** An interface for updating data on the `RowColumnPivotHierarchy` object, for use in `rowColumnPivotHierarchy.set({ ... })`. */ + export interface RowColumnPivotHierarchyUpdateData { + /** + * Name of the RowColumnPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + name?: string; + /** + * Position of the RowColumnPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + position?: number; + } + /** An interface for updating data on the `FilterPivotHierarchyCollection` object, for use in `filterPivotHierarchyCollection.set({ ... })`. */ + export interface FilterPivotHierarchyCollectionUpdateData { + items?: Excel.Interfaces.FilterPivotHierarchyData[]; + } + /** An interface for updating data on the `FilterPivotHierarchy` object, for use in `filterPivotHierarchy.set({ ... })`. */ + export interface FilterPivotHierarchyUpdateData { + /** + * Determines whether to allow multiple filter items. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + enableMultipleFilterItems?: boolean; + /** + * Name of the FilterPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + name?: string; + /** + * Position of the FilterPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + position?: number; + } + /** An interface for updating data on the `DataPivotHierarchyCollection` object, for use in `dataPivotHierarchyCollection.set({ ... })`. */ + export interface DataPivotHierarchyCollectionUpdateData { + items?: Excel.Interfaces.DataPivotHierarchyData[]; + } + /** An interface for updating data on the `DataPivotHierarchy` object, for use in `dataPivotHierarchy.set({ ... })`. */ + export interface DataPivotHierarchyUpdateData { + /** + * Returns the PivotFields associated with the DataPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + field?: Excel.Interfaces.PivotFieldUpdateData; + /** + * Name of the DataPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + name?: string; + /** + * Number format of the DataPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + numberFormat?: string; + /** + * Position of the DataPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + position?: number; + /** + * Specifies if the data should be shown as a specific summary calculation. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showAs?: Excel.ShowAsRule; + /** + * Specifies if all items of the DataPivotHierarchy are shown. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + summarizeBy?: Excel.AggregationFunction | "Unknown" | "Automatic" | "Sum" | "Count" | "Average" | "Max" | "Min" | "Product" | "CountNumbers" | "StandardDeviation" | "StandardDeviationP" | "Variance" | "VarianceP"; + } + /** An interface for updating data on the `PivotFieldCollection` object, for use in `pivotFieldCollection.set({ ... })`. */ + export interface PivotFieldCollectionUpdateData { + items?: Excel.Interfaces.PivotFieldData[]; + } + /** An interface for updating data on the `PivotField` object, for use in `pivotField.set({ ... })`. */ + export interface PivotFieldUpdateData { + /** + * Name of the PivotField. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + name?: string; + /** + * Determines whether to show all items of the PivotField. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showAllItems?: boolean; + /** + * Subtotals of the PivotField. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + subtotals?: Excel.Subtotals; + } + /** An interface for updating data on the `PivotItemCollection` object, for use in `pivotItemCollection.set({ ... })`. */ + export interface PivotItemCollectionUpdateData { + items?: Excel.Interfaces.PivotItemData[]; + } + /** An interface for updating data on the `PivotItem` object, for use in `pivotItem.set({ ... })`. */ + export interface PivotItemUpdateData { + /** + * Determines whether the item is expanded to show child items or if it's collapsed and child items are hidden. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + isExpanded?: boolean; + /** + * Name of the PivotItem. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + name?: string; + /** + * Specifies if the PivotItem is visible. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + visible?: boolean; + } + /** An interface for updating data on the `WorksheetCustomProperty` object, for use in `worksheetCustomProperty.set({ ... })`. */ + export interface WorksheetCustomPropertyUpdateData { + /** + * Gets or sets the value of the custom property. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + value?: string; + } + /** An interface for updating data on the `WorksheetCustomPropertyCollection` object, for use in `worksheetCustomPropertyCollection.set({ ... })`. */ + export interface WorksheetCustomPropertyCollectionUpdateData { + items?: Excel.Interfaces.WorksheetCustomPropertyData[]; + } + /** An interface for updating data on the `DocumentProperties` object, for use in `documentProperties.set({ ... })`. */ + export interface DocumentPropertiesUpdateData { + /** + * The author of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + author?: string; + /** + * The category of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + category?: string; + /** + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + comments?: string; + /** + * The company of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + company?: string; + /** + * The keywords of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + keywords?: string; + /** + * The manager of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + manager?: string; + /** + * Gets the revision number of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + revisionNumber?: number; + /** + * The subject of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + subject?: string; + /** + * The title of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + title?: string; + } + /** An interface for updating data on the `CustomProperty` object, for use in `customProperty.set({ ... })`. */ + export interface CustomPropertyUpdateData { + /** + * The value of the custom property. The value is limited to 255 characters outside of Excel on the web (larger values are automatically trimmed to 255 characters on other platforms). + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + value?: any; + } + /** An interface for updating data on the `CustomPropertyCollection` object, for use in `customPropertyCollection.set({ ... })`. */ + export interface CustomPropertyCollectionUpdateData { + items?: Excel.Interfaces.CustomPropertyData[]; + } + /** An interface for updating data on the `ConditionalFormatCollection` object, for use in `conditionalFormatCollection.set({ ... })`. */ + export interface ConditionalFormatCollectionUpdateData { + items?: Excel.Interfaces.ConditionalFormatData[]; + } + /** An interface for updating data on the `ConditionalFormat` object, for use in `conditionalFormat.set({ ... })`. */ + export interface ConditionalFormatUpdateData { + /** + * Returns the cell value conditional format properties if the current conditional format is a `CellValue` type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + cellValue?: Excel.Interfaces.CellValueConditionalFormatUpdateData; + /** + * Returns the cell value conditional format properties if the current conditional format is a `CellValue` type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + cellValueOrNullObject?: Excel.Interfaces.CellValueConditionalFormatUpdateData; + /** + * Returns the color scale conditional format properties if the current conditional format is a `ColorScale` type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + colorScale?: Excel.Interfaces.ColorScaleConditionalFormatUpdateData; + /** + * Returns the color scale conditional format properties if the current conditional format is a `ColorScale` type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + colorScaleOrNullObject?: Excel.Interfaces.ColorScaleConditionalFormatUpdateData; + /** + * Returns the custom conditional format properties if the current conditional format is a custom type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + custom?: Excel.Interfaces.CustomConditionalFormatUpdateData; + /** + * Returns the custom conditional format properties if the current conditional format is a custom type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + customOrNullObject?: Excel.Interfaces.CustomConditionalFormatUpdateData; + /** + * Returns the data bar properties if the current conditional format is a data bar. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + dataBar?: Excel.Interfaces.DataBarConditionalFormatUpdateData; + /** + * Returns the data bar properties if the current conditional format is a data bar. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + dataBarOrNullObject?: Excel.Interfaces.DataBarConditionalFormatUpdateData; + /** + * Returns the icon set conditional format properties if the current conditional format is an `IconSet` type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + iconSet?: Excel.Interfaces.IconSetConditionalFormatUpdateData; + /** + * Returns the icon set conditional format properties if the current conditional format is an `IconSet` type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + iconSetOrNullObject?: Excel.Interfaces.IconSetConditionalFormatUpdateData; + /** + * Returns the preset criteria conditional format. See `Excel.PresetCriteriaConditionalFormat` for more details. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + preset?: Excel.Interfaces.PresetCriteriaConditionalFormatUpdateData; + /** + * Returns the preset criteria conditional format. See `Excel.PresetCriteriaConditionalFormat` for more details. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + presetOrNullObject?: Excel.Interfaces.PresetCriteriaConditionalFormatUpdateData; + /** + * Returns the specific text conditional format properties if the current conditional format is a text type. + For example, to format cells matching the word "Text". + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + textComparison?: Excel.Interfaces.TextConditionalFormatUpdateData; + /** + * Returns the specific text conditional format properties if the current conditional format is a text type. + For example, to format cells matching the word "Text". + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + textComparisonOrNullObject?: Excel.Interfaces.TextConditionalFormatUpdateData; + /** + * Returns the top/bottom conditional format properties if the current conditional format is a `TopBottom` type. + For example, to format the top 10% or bottom 10 items. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + topBottom?: Excel.Interfaces.TopBottomConditionalFormatUpdateData; + /** + * Returns the top/bottom conditional format properties if the current conditional format is a `TopBottom` type. + For example, to format the top 10% or bottom 10 items. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + topBottomOrNullObject?: Excel.Interfaces.TopBottomConditionalFormatUpdateData; + /** + * The priority (or index) within the conditional format collection that this conditional format currently exists in. Changing this also + changes other conditional formats' priorities, to allow for a contiguous priority order. + Use a negative priority to begin from the back. + Priorities greater than the bounds will get and set to the maximum (or minimum if negative) priority. + Also note that if you change the priority, you have to re-fetch a new copy of the object at that new priority location if you want to make further changes to it. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + priority?: number; + /** + * If the conditions of this conditional format are met, no lower-priority formats shall take effect on that cell. + Value is `null` on data bars, icon sets, and color scales as there's no concept of `StopIfTrue` for these. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + stopIfTrue?: boolean; + } + /** An interface for updating data on the `DataBarConditionalFormat` object, for use in `dataBarConditionalFormat.set({ ... })`. */ + export interface DataBarConditionalFormatUpdateData { + /** + * Representation of all values to the left of the axis in an Excel data bar. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + negativeFormat?: Excel.Interfaces.ConditionalDataBarNegativeFormatUpdateData; + /** + * Representation of all values to the right of the axis in an Excel data bar. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + positiveFormat?: Excel.Interfaces.ConditionalDataBarPositiveFormatUpdateData; + /** + * HTML color code representing the color of the Axis line, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + Value is "" (an empty string) if no axis is present or set. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + axisColor?: string; + /** + * Representation of how the axis is determined for an Excel data bar. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + axisFormat?: Excel.ConditionalDataBarAxisFormat | "Automatic" | "None" | "CellMidPoint"; + /** + * Specifies the direction that the data bar graphic should be based on. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + barDirection?: Excel.ConditionalDataBarDirection | "Context" | "LeftToRight" | "RightToLeft"; + /** + * The rule for what constitutes the lower bound (and how to calculate it, if applicable) for a data bar. + The `ConditionalDataBarRule` object must be set as a JSON object (use `x.lowerBoundRule = {...}` instead of `x.lowerBoundRule.formula = ...`). + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + lowerBoundRule?: Excel.ConditionalDataBarRule; + /** + * If `true`, hides the values from the cells where the data bar is applied. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + showDataBarOnly?: boolean; + /** + * The rule for what constitutes the upper bound (and how to calculate it, if applicable) for a data bar. + The `ConditionalDataBarRule` object must be set as a JSON object (use `x.upperBoundRule = {...}` instead of `x.upperBoundRule.formula = ...`). + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + upperBoundRule?: Excel.ConditionalDataBarRule; + } + /** An interface for updating data on the `ConditionalDataBarPositiveFormat` object, for use in `conditionalDataBarPositiveFormat.set({ ... })`. */ + export interface ConditionalDataBarPositiveFormatUpdateData { + /** + * HTML color code representing the color of the border line, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + Value is "" (an empty string) if no border is present or set. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + borderColor?: string; + /** + * HTML color code representing the fill color, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + fillColor?: string; + /** + * Specifies if the data bar has a gradient. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + gradientFill?: boolean; + } + /** An interface for updating data on the `ConditionalDataBarNegativeFormat` object, for use in `conditionalDataBarNegativeFormat.set({ ... })`. */ + export interface ConditionalDataBarNegativeFormatUpdateData { + /** + * HTML color code representing the color of the border line, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + Value is "" (an empty string) if no border is present or set. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + borderColor?: string; + /** + * HTML color code representing the fill color, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + fillColor?: string; + /** + * Specifies if the negative data bar has the same border color as the positive data bar. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + matchPositiveBorderColor?: boolean; + /** + * Specifies if the negative data bar has the same fill color as the positive data bar. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + matchPositiveFillColor?: boolean; + } + /** An interface for updating data on the `CustomConditionalFormat` object, for use in `customConditionalFormat.set({ ... })`. */ + export interface CustomConditionalFormatUpdateData { + /** + * Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + format?: Excel.Interfaces.ConditionalRangeFormatUpdateData; + /** + * Specifies the `Rule` object on this conditional format. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + rule?: Excel.Interfaces.ConditionalFormatRuleUpdateData; + } + /** An interface for updating data on the `ConditionalFormatRule` object, for use in `conditionalFormatRule.set({ ... })`. */ + export interface ConditionalFormatRuleUpdateData { + /** + * The formula, if required, on which to evaluate the conditional format rule. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + formula?: string; + /** + * The formula, if required, on which to evaluate the conditional format rule in the user's language. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + formulaLocal?: string; + /** + * The formula, if required, on which to evaluate the conditional format rule in R1C1-style notation. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + formulaR1C1?: string; + } + /** An interface for updating data on the `IconSetConditionalFormat` object, for use in `iconSetConditionalFormat.set({ ... })`. */ + export interface IconSetConditionalFormatUpdateData { + /** + * An array of criteria and icon sets for the rules and potential custom icons for conditional icons. Note that for the first criterion only the custom icon can be modified, while type, formula, and operator will be ignored when set. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + criteria?: Excel.ConditionalIconCriterion[]; + /** + * If `true`, reverses the icon orders for the icon set. Note that this cannot be set if custom icons are used. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + reverseIconOrder?: boolean; + /** + * If `true`, hides the values and only shows icons. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + showIconOnly?: boolean; + /** + * If set, displays the icon set option for the conditional format. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + style?: Excel.IconSet | "Invalid" | "ThreeArrows" | "ThreeArrowsGray" | "ThreeFlags" | "ThreeTrafficLights1" | "ThreeTrafficLights2" | "ThreeSigns" | "ThreeSymbols" | "ThreeSymbols2" | "FourArrows" | "FourArrowsGray" | "FourRedToBlack" | "FourRating" | "FourTrafficLights" | "FiveArrows" | "FiveArrowsGray" | "FiveRating" | "FiveQuarters" | "ThreeStars" | "ThreeTriangles" | "FiveBoxes"; + } + /** An interface for updating data on the `ColorScaleConditionalFormat` object, for use in `colorScaleConditionalFormat.set({ ... })`. */ + export interface ColorScaleConditionalFormatUpdateData { + /** + * The criteria of the color scale. Midpoint is optional when using a two point color scale. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + criteria?: Excel.ConditionalColorScaleCriteria; + } + /** An interface for updating data on the `TopBottomConditionalFormat` object, for use in `topBottomConditionalFormat.set({ ... })`. */ + export interface TopBottomConditionalFormatUpdateData { + /** + * Returns a format object, encapsulating the conditional format's font, fill, borders, and other properties. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + format?: Excel.Interfaces.ConditionalRangeFormatUpdateData; + /** + * The criteria of the top/bottom conditional format. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + rule?: Excel.ConditionalTopBottomRule; + } + /** An interface for updating data on the `PresetCriteriaConditionalFormat` object, for use in `presetCriteriaConditionalFormat.set({ ... })`. */ + export interface PresetCriteriaConditionalFormatUpdateData { + /** + * Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + format?: Excel.Interfaces.ConditionalRangeFormatUpdateData; + /** + * The rule of the conditional format. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + rule?: Excel.ConditionalPresetCriteriaRule; + } + /** An interface for updating data on the `TextConditionalFormat` object, for use in `textConditionalFormat.set({ ... })`. */ + export interface TextConditionalFormatUpdateData { + /** + * Returns a format object, encapsulating the conditional format's font, fill, borders, and other properties. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + format?: Excel.Interfaces.ConditionalRangeFormatUpdateData; + /** + * The rule of the conditional format. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + rule?: Excel.ConditionalTextComparisonRule; + } + /** An interface for updating data on the `CellValueConditionalFormat` object, for use in `cellValueConditionalFormat.set({ ... })`. */ + export interface CellValueConditionalFormatUpdateData { + /** + * Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + format?: Excel.Interfaces.ConditionalRangeFormatUpdateData; + /** + * Specifies the rule object on this conditional format. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + rule?: Excel.ConditionalCellValueRule; + } + /** An interface for updating data on the `ConditionalRangeFormat` object, for use in `conditionalRangeFormat.set({ ... })`. */ + export interface ConditionalRangeFormatUpdateData { + /** + * Collection of border objects that apply to the overall conditional format range. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + borders?: Excel.Interfaces.ConditionalRangeBorderCollectionUpdateData; + /** + * Returns the fill object defined on the overall conditional format range. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + fill?: Excel.Interfaces.ConditionalRangeFillUpdateData; + /** + * Returns the font object defined on the overall conditional format range. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + font?: Excel.Interfaces.ConditionalRangeFontUpdateData; + /** + * Represents Excel's number format code for the given range. For more information about Excel number formatting, see {@link https://support.microsoft.com/office/5026bbd6-04bc-48cd-bf33-80f18b4eae68 | Number format codes}. + Cleared if `null` is passed in. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + numberFormat?: any; + } + /** An interface for updating data on the `ConditionalRangeFont` object, for use in `conditionalRangeFont.set({ ... })`. */ + export interface ConditionalRangeFontUpdateData { + /** + * Specifies if the font is bold. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + bold?: boolean; + /** + * HTML color code representation of the text color (e.g., #FF0000 represents Red). + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + color?: string; + /** + * Specifies if the font is italic. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + italic?: boolean; + /** + * Specifies the strikethrough status of the font. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + strikethrough?: boolean; + /** + * The type of underline applied to the font. See `Excel.ConditionalRangeFontUnderlineStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + underline?: Excel.ConditionalRangeFontUnderlineStyle | "None" | "Single" | "Double"; + } + /** An interface for updating data on the `ConditionalRangeFill` object, for use in `conditionalRangeFill.set({ ... })`. */ + export interface ConditionalRangeFillUpdateData { + /** + * HTML color code representing the color of the fill, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + color?: string; + } + /** An interface for updating data on the `ConditionalRangeBorder` object, for use in `conditionalRangeBorder.set({ ... })`. */ + export interface ConditionalRangeBorderUpdateData { + /** + * HTML color code representing the color of the border line, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + color?: string; + /** + * One of the constants of line style specifying the line style for the border. See `Excel.BorderLineStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + style?: Excel.ConditionalRangeBorderLineStyle | "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot"; + } + /** An interface for updating data on the `ConditionalRangeBorderCollection` object, for use in `conditionalRangeBorderCollection.set({ ... })`. */ + export interface ConditionalRangeBorderCollectionUpdateData { + /** + * Gets the bottom border. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + bottom?: Excel.Interfaces.ConditionalRangeBorderUpdateData; + /** + * Gets the left border. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + left?: Excel.Interfaces.ConditionalRangeBorderUpdateData; + /** + * Gets the right border. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + right?: Excel.Interfaces.ConditionalRangeBorderUpdateData; + /** + * Gets the top border. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + top?: Excel.Interfaces.ConditionalRangeBorderUpdateData; + items?: Excel.Interfaces.ConditionalRangeBorderData[]; + } + /** An interface for updating data on the `Style` object, for use in `style.set({ ... })`. */ + export interface StyleUpdateData { + /** + * A collection of four border objects that represent the style of the four borders. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + borders?: Excel.Interfaces.RangeBorderCollectionUpdateData; + /** + * The fill of the style. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + fill?: Excel.Interfaces.RangeFillUpdateData; + /** + * A `Font` object that represents the font of the style. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + font?: Excel.Interfaces.RangeFontUpdateData; + /** + * Specifies if text is automatically indented when the text alignment in a cell is set to equal distribution. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + autoIndent?: boolean; + /** + * Specifies if the formula will be hidden when the worksheet is protected. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + formulaHidden?: boolean; + /** + * Represents the horizontal alignment for the style. See `Excel.HorizontalAlignment` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + horizontalAlignment?: Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed"; + /** + * Specifies if the style includes the auto indent, horizontal alignment, vertical alignment, wrap text, indent level, and text orientation properties. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + includeAlignment?: boolean; + /** + * Specifies if the style includes the color, color index, line style, and weight border properties. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + includeBorder?: boolean; + /** + * Specifies if the style includes the background, bold, color, color index, font style, italic, name, size, strikethrough, subscript, superscript, and underline font properties. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + includeFont?: boolean; + /** + * Specifies if the style includes the number format property. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + includeNumber?: boolean; + /** + * Specifies if the style includes the color, color index, invert if negative, pattern, pattern color, and pattern color index interior properties. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + includePatterns?: boolean; + /** + * Specifies if the style includes the formula hidden and locked protection properties. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + includeProtection?: boolean; + /** + * An integer from 0 to 250 that indicates the indent level for the style. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + indentLevel?: number; + /** + * Specifies if the object is locked when the worksheet is protected. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + locked?: boolean; + /** + * The format code of the number format for the style. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + numberFormat?: string; + /** + * The localized format code of the number format for the style. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + numberFormatLocal?: string; + /** + * The reading order for the style. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readingOrder?: Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft"; + /** + * Specifies if text automatically shrinks to fit in the available column width. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + shrinkToFit?: boolean; + /** + * The text orientation for the style. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + textOrientation?: number; + /** + * Specifies the vertical alignment for the style. See `Excel.VerticalAlignment` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + verticalAlignment?: Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed"; + /** + * Specifies if Excel wraps the text in the object. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + wrapText?: boolean; + } + /** An interface for updating data on the `StyleCollection` object, for use in `styleCollection.set({ ... })`. */ + export interface StyleCollectionUpdateData { + items?: Excel.Interfaces.StyleData[]; + } + /** An interface for updating data on the `TableStyleCollection` object, for use in `tableStyleCollection.set({ ... })`. */ + export interface TableStyleCollectionUpdateData { + items?: Excel.Interfaces.TableStyleData[]; + } + /** An interface for updating data on the `TableStyle` object, for use in `tableStyle.set({ ... })`. */ + export interface TableStyleUpdateData { + /** + * Specifies the name of the table style. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + name?: string; + } + /** An interface for updating data on the `PivotTableStyleCollection` object, for use in `pivotTableStyleCollection.set({ ... })`. */ + export interface PivotTableStyleCollectionUpdateData { + items?: Excel.Interfaces.PivotTableStyleData[]; + } + /** An interface for updating data on the `PivotTableStyle` object, for use in `pivotTableStyle.set({ ... })`. */ + export interface PivotTableStyleUpdateData { + /** + * Specifies the name of the PivotTable style. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + name?: string; + } + /** An interface for updating data on the `SlicerStyleCollection` object, for use in `slicerStyleCollection.set({ ... })`. */ + export interface SlicerStyleCollectionUpdateData { + items?: Excel.Interfaces.SlicerStyleData[]; + } + /** An interface for updating data on the `SlicerStyle` object, for use in `slicerStyle.set({ ... })`. */ + export interface SlicerStyleUpdateData { + /** + * Specifies the name of the slicer style. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + name?: string; + } + /** An interface for updating data on the `TimelineStyleCollection` object, for use in `timelineStyleCollection.set({ ... })`. */ + export interface TimelineStyleCollectionUpdateData { + items?: Excel.Interfaces.TimelineStyleData[]; + } + /** An interface for updating data on the `TimelineStyle` object, for use in `timelineStyle.set({ ... })`. */ + export interface TimelineStyleUpdateData { + /** + * Specifies the name of the timeline style. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + name?: string; + } + /** An interface for updating data on the `PageLayout` object, for use in `pageLayout.set({ ... })`. */ + export interface PageLayoutUpdateData { + /** + * Header and footer configuration for the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + headersFooters?: Excel.Interfaces.HeaderFooterGroupUpdateData; + /** + * The worksheet's black and white print option. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + blackAndWhite?: boolean; + /** + * The worksheet's bottom page margin to use for printing in points. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + bottomMargin?: number; + /** + * The worksheet's center horizontally flag. This flag determines whether the worksheet will be centered horizontally when it's printed. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + centerHorizontally?: boolean; + /** + * The worksheet's center vertically flag. This flag determines whether the worksheet will be centered vertically when it's printed. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + centerVertically?: boolean; + /** + * The worksheet's draft mode option. If `true`, the sheet will be printed without graphics. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + draftMode?: boolean; + /** + * The worksheet's first page number to print. A `null` value represents "auto" page numbering. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + firstPageNumber?: number | ""; + /** + * The worksheet's footer margin, in points, for use when printing. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + footerMargin?: number; + /** + * The worksheet's header margin, in points, for use when printing. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + headerMargin?: number; + /** + * The worksheet's left margin, in points, for use when printing. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + leftMargin?: number; + /** + * The worksheet's orientation of the page. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + orientation?: Excel.PageOrientation | "Portrait" | "Landscape"; + /** + * The worksheet's paper size of the page. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + paperSize?: Excel.PaperType | "Letter" | "LetterSmall" | "Tabloid" | "Ledger" | "Legal" | "Statement" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "Folio" | "Quatro" | "Paper10x14" | "Paper11x17" | "Note" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "Csheet" | "Dsheet" | "Esheet" | "EnvelopeDL" | "EnvelopeC5" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "FanfoldUS" | "FanfoldStdGerman" | "FanfoldLegalGerman"; + /** + * Specifies if the worksheet's comments should be displayed when printing. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + printComments?: Excel.PrintComments | "NoComments" | "EndSheet" | "InPlace"; + /** + * The worksheet's print errors option. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + printErrors?: Excel.PrintErrorType | "AsDisplayed" | "Blank" | "Dash" | "NotAvailable"; + /** + * Specifies if the worksheet's gridlines will be printed. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + printGridlines?: boolean; + /** + * Specifies if the worksheet's headings will be printed. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + printHeadings?: boolean; + /** + * The worksheet's page print order option. This specifies the order to use for processing the page number printed. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + printOrder?: Excel.PrintOrder | "DownThenOver" | "OverThenDown"; + /** + * The worksheet's right margin, in points, for use when printing. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + rightMargin?: number; + /** + * The worksheet's top margin, in points, for use when printing. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + topMargin?: number; + /** + * The worksheet's print zoom options. + The `PageLayoutZoomOptions` object must be set as a JSON object (use `x.zoom = {...}` instead of `x.zoom.scale = ...`). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + zoom?: Excel.PageLayoutZoomOptions; + } + /** An interface for updating data on the `HeaderFooter` object, for use in `headerFooter.set({ ... })`. */ + export interface HeaderFooterUpdateData { + /** + * The center footer of the worksheet. + To apply font formatting or insert a variable value, use format codes specified here: https://msdn.microsoft.com/library/bb225426.aspx. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + centerFooter?: string; + /** + * The center header of the worksheet. + To apply font formatting or insert a variable value, use format codes specified here: https://msdn.microsoft.com/library/bb225426.aspx. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + centerHeader?: string; + /** + * The left footer of the worksheet. + To apply font formatting or insert a variable value, use format codes specified here: https://msdn.microsoft.com/library/bb225426.aspx. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + leftFooter?: string; + /** + * The left header of the worksheet. + To apply font formatting or insert a variable value, use format codes specified here: https://msdn.microsoft.com/library/bb225426.aspx. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + leftHeader?: string; + /** + * The right footer of the worksheet. + To apply font formatting or insert a variable value, use format codes specified here: https://msdn.microsoft.com/library/bb225426.aspx. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + rightFooter?: string; + /** + * The right header of the worksheet. + To apply font formatting or insert a variable value, use format codes specified here: https://msdn.microsoft.com/library/bb225426.aspx. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + rightHeader?: string; + } + /** An interface for updating data on the `HeaderFooterGroup` object, for use in `headerFooterGroup.set({ ... })`. */ + export interface HeaderFooterGroupUpdateData { + /** + * The general header/footer, used for all pages unless even/odd or first page is specified. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + defaultForAllPages?: Excel.Interfaces.HeaderFooterUpdateData; + /** + * The header/footer to use for even pages, odd header/footer needs to be specified for odd pages. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + evenPages?: Excel.Interfaces.HeaderFooterUpdateData; + /** + * The first page header/footer, for all other pages general or even/odd is used. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + firstPage?: Excel.Interfaces.HeaderFooterUpdateData; + /** + * The header/footer to use for odd pages, even header/footer needs to be specified for even pages. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + oddPages?: Excel.Interfaces.HeaderFooterUpdateData; + /** + * The state by which headers/footers are set. See `Excel.HeaderFooterState` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + state?: Excel.HeaderFooterState | "Default" | "FirstAndDefault" | "OddAndEven" | "FirstOddAndEven"; + /** + * Gets or sets a flag indicating if headers/footers are aligned with the page margins set in the page layout options for the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + useSheetMargins?: boolean; + /** + * Gets or sets a flag indicating if headers/footers should be scaled by the page percentage scale set in the page layout options for the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + useSheetScale?: boolean; + } + /** An interface for updating data on the `PageBreakCollection` object, for use in `pageBreakCollection.set({ ... })`. */ + export interface PageBreakCollectionUpdateData { + items?: Excel.Interfaces.PageBreakData[]; + } + /** An interface for updating data on the `RangeCollection` object, for use in `rangeCollection.set({ ... })`. */ + export interface RangeCollectionUpdateData { + items?: Excel.Interfaces.RangeData[]; + } + /** An interface for updating data on the `RangeAreasCollection` object, for use in `rangeAreasCollection.set({ ... })`. */ + export interface RangeAreasCollectionUpdateData { + items?: Excel.Interfaces.RangeAreasData[]; + } + /** An interface for updating data on the `CommentCollection` object, for use in `commentCollection.set({ ... })`. */ + export interface CommentCollectionUpdateData { + items?: Excel.Interfaces.CommentData[]; + } + /** An interface for updating data on the `Comment` object, for use in `comment.set({ ... })`. */ + export interface CommentUpdateData { + /** + * The comment's content. The string is plain text. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + content?: string; + /** + * The comment thread status. A value of `true` means that the comment thread is resolved. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + resolved?: boolean; + } + /** An interface for updating data on the `CommentReplyCollection` object, for use in `commentReplyCollection.set({ ... })`. */ + export interface CommentReplyCollectionUpdateData { + items?: Excel.Interfaces.CommentReplyData[]; + } + /** An interface for updating data on the `CommentReply` object, for use in `commentReply.set({ ... })`. */ + export interface CommentReplyUpdateData { + /** + * The comment reply's content. The string is plain text. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + content?: string; + } + /** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */ + export interface ShapeCollectionUpdateData { + items?: Excel.Interfaces.ShapeData[]; + } + /** An interface for updating data on the `Shape` object, for use in `shape.set({ ... })`. */ + export interface ShapeUpdateData { + /** + * Returns the fill formatting of this shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + fill?: Excel.Interfaces.ShapeFillUpdateData; + /** + * Returns the line formatting of this shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + lineFormat?: Excel.Interfaces.ShapeLineFormatUpdateData; + /** + * Specifies the alternative description text for a `Shape` object. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + altTextDescription?: string; + /** + * Specifies the alternative title text for a `Shape` object. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + altTextTitle?: string; + /** + * Specifies the geometric shape type of this geometric shape. See `Excel.GeometricShapeType` for details. Returns `null` if the shape type is not "GeometricShape". + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + geometricShapeType?: Excel.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"; + /** + * Specifies the height, in points, of the shape. + Throws an `InvalidArgument` exception when set with a negative value or zero as an input. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + height?: number; + /** + * The distance, in points, from the left side of the shape to the left side of the worksheet. + Throws an `InvalidArgument` exception when set with a negative value as an input. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + left?: number; + /** + * Specifies if the aspect ratio of this shape is locked. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + lockAspectRatio?: boolean; + /** + * Specifies the name of the shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + name?: string; + /** + * Represents how the object is attached to the cells below it. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + placement?: Excel.Placement | "TwoCell" | "OneCell" | "Absolute"; + /** + * Specifies the rotation, in degrees, of the shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + rotation?: number; + /** + * The distance, in points, from the top edge of the shape to the top edge of the worksheet. + Throws an `InvalidArgument` exception when set with a negative value as an input. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + top?: number; + /** + * Specifies if the shape is visible. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + visible?: boolean; + /** + * Specifies the width, in points, of the shape. + Throws an `InvalidArgument` exception when set with a negative value or zero as an input. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + width?: number; + } + /** An interface for updating data on the `GroupShapeCollection` object, for use in `groupShapeCollection.set({ ... })`. */ + export interface GroupShapeCollectionUpdateData { + items?: Excel.Interfaces.ShapeData[]; + } + /** An interface for updating data on the `Line` object, for use in `line.set({ ... })`. */ + export interface LineUpdateData { + /** + * Represents the length of the arrowhead at the beginning of the specified line. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + beginArrowheadLength?: Excel.ArrowheadLength | "Short" | "Medium" | "Long"; + /** + * Represents the style of the arrowhead at the beginning of the specified line. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + beginArrowheadStyle?: Excel.ArrowheadStyle | "None" | "Triangle" | "Stealth" | "Diamond" | "Oval" | "Open"; + /** + * Represents the width of the arrowhead at the beginning of the specified line. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + beginArrowheadWidth?: Excel.ArrowheadWidth | "Narrow" | "Medium" | "Wide"; + /** + * Represents the length of the arrowhead at the end of the specified line. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + endArrowheadLength?: Excel.ArrowheadLength | "Short" | "Medium" | "Long"; + /** + * Represents the style of the arrowhead at the end of the specified line. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + endArrowheadStyle?: Excel.ArrowheadStyle | "None" | "Triangle" | "Stealth" | "Diamond" | "Oval" | "Open"; + /** + * Represents the width of the arrowhead at the end of the specified line. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + endArrowheadWidth?: Excel.ArrowheadWidth | "Narrow" | "Medium" | "Wide"; + /** + * Represents the connector type for the line. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + connectorType?: Excel.ConnectorType | "Straight" | "Elbow" | "Curve"; + } + /** An interface for updating data on the `ShapeFill` object, for use in `shapeFill.set({ ... })`. */ + export interface ShapeFillUpdateData { + /** + * Represents the shape fill foreground color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange") + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + foregroundColor?: string; + /** + * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + transparency?: number; + } + /** An interface for updating data on the `ShapeLineFormat` object, for use in `shapeLineFormat.set({ ... })`. */ + export interface ShapeLineFormatUpdateData { + /** + * Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + color?: string; + /** + * Represents the line style of the shape. Returns `null` when the line is not visible or there are inconsistent dash styles. See `Excel.ShapeLineDashStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + dashStyle?: Excel.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot"; + /** + * Represents the line style of the shape. Returns `null` when the line is not visible or there are inconsistent styles. See `Excel.ShapeLineStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + style?: Excel.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin"; + /** + * Represents the degree of transparency of the specified line as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` when the shape has inconsistent transparencies. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + transparency?: number; + /** + * Specifies if the line formatting of a shape element is visible. Returns `null` when the shape has inconsistent visibilities. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + visible?: boolean; + /** + * Represents the weight of the line, in points. Returns `null` when the line is not visible or there are inconsistent line weights. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + weight?: number; + } + /** An interface for updating data on the `TextFrame` object, for use in `textFrame.set({ ... })`. */ + export interface TextFrameUpdateData { + /** + * The automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + autoSizeSetting?: Excel.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed"; + /** + * Represents the bottom margin, in points, of the text frame. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + bottomMargin?: number; + /** + * Represents the horizontal alignment of the text frame. See `Excel.ShapeTextHorizontalAlignment` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + horizontalAlignment?: Excel.ShapeTextHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed"; + /** + * Represents the horizontal overflow behavior of the text frame. See `Excel.ShapeTextHorizontalOverflow` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + horizontalOverflow?: Excel.ShapeTextHorizontalOverflow | "Overflow" | "Clip"; + /** + * Represents the left margin, in points, of the text frame. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + leftMargin?: number; + /** + * Represents the angle to which the text is oriented for the text frame. See `Excel.ShapeTextOrientation` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + orientation?: Excel.ShapeTextOrientation | "Horizontal" | "Vertical" | "Vertical270" | "WordArtVertical" | "EastAsianVertical" | "MongolianVertical" | "WordArtVerticalRTL"; + /** + * Represents the reading order of the text frame, either left-to-right or right-to-left. See `Excel.ShapeTextReadingOrder` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readingOrder?: Excel.ShapeTextReadingOrder | "LeftToRight" | "RightToLeft"; + /** + * Represents the right margin, in points, of the text frame. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + rightMargin?: number; + /** + * Represents the top margin, in points, of the text frame. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + topMargin?: number; + /** + * Represents the vertical alignment of the text frame. See `Excel.ShapeTextVerticalAlignment` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + verticalAlignment?: Excel.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom" | "Justified" | "Distributed"; + /** + * Represents the vertical overflow behavior of the text frame. See `Excel.ShapeTextVerticalOverflow` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + verticalOverflow?: Excel.ShapeTextVerticalOverflow | "Overflow" | "Ellipsis" | "Clip"; + } + /** An interface for updating data on the `TextRange` object, for use in `textRange.set({ ... })`. */ + export interface TextRangeUpdateData { + /** + * Returns a `ShapeFont` object that represents the font attributes for the text range. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + font?: Excel.Interfaces.ShapeFontUpdateData; + /** + * Represents the plain text content of the text range. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + text?: string; + } + /** An interface for updating data on the `ShapeFont` object, for use in `shapeFont.set({ ... })`. */ + export interface ShapeFontUpdateData { + /** + * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + bold?: boolean; + /** + * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + color?: string; + /** + * Represents the italic status of font. Returns `null` if the `TextRange` includes both italic and non-italic text fragments. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + italic?: boolean; + /** + * Represents font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + name?: string; + /** + * Represents font size in points (e.g., 11). Returns `null` if the `TextRange` includes text fragments with different font sizes. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + size?: number; + /** + * Type of underline applied to the font. Returns `null` if the `TextRange` includes text fragments with different underline styles. See `Excel.ShapeFontUnderlineStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + underline?: Excel.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble"; + } + /** An interface for updating data on the `Slicer` object, for use in `slicer.set({ ... })`. */ + export interface SlicerUpdateData { + /** + * Represents the worksheet containing the slicer. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + worksheet?: Excel.Interfaces.WorksheetUpdateData; + /** + * Represents the caption of the slicer. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + caption?: string; + /** + * Specifies the height, in points, of the slicer. + Throws an `InvalidArgument` exception when set with a negative value or zero as an input. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + height?: number; + /** + * Represents the distance, in points, from the left side of the slicer to the left of the worksheet. + Throws an `InvalidArgument` error when set with a negative value as an input. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + left?: number; + /** + * Represents the name of the slicer. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + name?: string; + /** + * Specifies the sort order of the items in the slicer. + Possible values are: "DataSourceOrder", "Ascending", "Descending". + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + sortBy?: Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | "Descending"; + /** + * Constant value that represents the slicer style. + Possible values are: "SlicerStyleLight1" through "SlicerStyleLight6", "TableStyleOther1" through "TableStyleOther2", "SlicerStyleDark1" through "SlicerStyleDark6". A custom user-defined style present in the workbook can also be specified. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + style?: string; + /** + * Represents the distance, in points, from the top edge of the slicer to the top of the worksheet. + Throws an `InvalidArgument` error when set with a negative value as an input. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + top?: number; + /** + * Represents the width, in points, of the slicer. + Throws an `InvalidArgument` error when set with a negative value or zero as an input. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + width?: number; + } + /** An interface for updating data on the `SlicerCollection` object, for use in `slicerCollection.set({ ... })`. */ + export interface SlicerCollectionUpdateData { + items?: Excel.Interfaces.SlicerData[]; + } + /** An interface for updating data on the `SlicerItem` object, for use in `slicerItem.set({ ... })`. */ + export interface SlicerItemUpdateData { + /** + * Value is `true` if the slicer item is selected. + Setting this value will not clear the selected state of other slicer items. + By default, if the slicer item is the only one selected, when it is deselected, all items will be selected. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + isSelected?: boolean; + } + /** An interface for updating data on the `SlicerItemCollection` object, for use in `slicerItemCollection.set({ ... })`. */ + export interface SlicerItemCollectionUpdateData { + items?: Excel.Interfaces.SlicerItemData[]; + } + /** An interface for updating data on the `LinkedEntityDataDomain` object, for use in `linkedEntityDataDomain.set({ ... })`. */ + export interface LinkedEntityDataDomainUpdateData { + /** + * Specifies the refresh mode that defines how and when the `LinkedEntityCellValue` objects of this linked entity data domain are refreshed. + If the refresh mode being set is not supported by this linked entity data domain, then the current refresh mode is not changed. + If the refresh mode is set to "Periodic", the refresh interval is set to the `periodicRefreshInterval` of this linked entity data domain. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + refreshMode?: Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic"; + } + /** An interface for updating data on the `LinkedEntityDataDomainCollection` object, for use in `linkedEntityDataDomainCollection.set({ ... })`. */ + export interface LinkedEntityDataDomainCollectionUpdateData { + items?: Excel.Interfaces.LinkedEntityDataDomainData[]; + } + /** An interface for updating data on the `NamedSheetView` object, for use in `namedSheetView.set({ ... })`. */ + export interface NamedSheetViewUpdateData { + + } + /** An interface for updating data on the `NamedSheetViewCollection` object, for use in `namedSheetViewCollection.set({ ... })`. */ + export interface NamedSheetViewCollectionUpdateData { + items?: Excel.Interfaces.NamedSheetViewData[]; + } + /** An interface for updating data on the `NoteCollection` object, for use in `noteCollection.set({ ... })`. */ + export interface NoteCollectionUpdateData { + items?: Excel.Interfaces.NoteData[]; + } + /** An interface for updating data on the `Note` object, for use in `note.set({ ... })`. */ + export interface NoteUpdateData { + /** + * Specifies the text of the note. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + content?: string; + /** + * Specifies the height of the note. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + height?: number; + /** + * Specifies the visibility of the note. A value of `true` means the note is shown. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + visible?: boolean; + /** + * Specifies the width of the note. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + width?: number; + } + /** An interface describing the data returned by calling `allowEditRange.toJSON()`. */ + export interface AllowEditRangeData { + + + + } + /** An interface describing the data returned by calling `allowEditRangeCollection.toJSON()`. */ + export interface AllowEditRangeCollectionData { + items?: Excel.Interfaces.AllowEditRangeData[]; + } + /** An interface describing the data returned by calling `query.toJSON()`. */ + export interface QueryData { + /** + * Gets the query error message from when the query was last refreshed. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + error?: Excel.QueryError | "Unknown" | "None" | "FailedLoadToWorksheet" | "FailedLoadToDataModel" | "FailedDownload" | "FailedToCompleteDownload"; + /** + * Gets the query loaded to object type. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + loadedTo?: Excel.LoadToType | "ConnectionOnly" | "Table" | "PivotTable" | "PivotChart"; + /** + * Specifies if the query loaded to the data model. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + loadedToDataModel?: boolean; + /** + * Gets the name of the query. + Query names cannot contain periods or quotation marks. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + name?: string; + /** + * Gets the date and time when the query was last refreshed. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + refreshDate?: Date; + /** + * Gets the number of rows that were loaded when the query was last refreshed. + If last refresh has errors the value will be -1. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + rowsLoadedCount?: number; + } + /** An interface describing the data returned by calling `queryCollection.toJSON()`. */ + export interface QueryCollectionData { + items?: Excel.Interfaces.QueryData[]; + } + /** An interface describing the data returned by calling `linkedWorkbook.toJSON()`. */ + export interface LinkedWorkbookData { + + } + /** An interface describing the data returned by calling `linkedWorkbookCollection.toJSON()`. */ + export interface LinkedWorkbookCollectionData { + items?: Excel.Interfaces.LinkedWorkbookData[]; + } + /** An interface describing the data returned by calling `runtime.toJSON()`. */ + export interface RuntimeData { + /** + * Toggle JavaScript events in the current task pane or content add-in. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + enableEvents?: boolean; + } + /** An interface describing the data returned by calling `application.toJSON()`. */ + export interface ApplicationData { + /** + * Provides information based on current system culture settings. This includes the culture names, number formatting, and other culturally dependent settings. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + cultureInfo?: Excel.Interfaces.CultureInfoData; + /** + * Returns the iterative calculation settings. + In Excel on Windows and Mac, the settings will apply to the Excel Application. + In Excel on the web and other platforms, the settings will apply to the active workbook. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + iterativeCalculation?: Excel.Interfaces.IterativeCalculationData; + /** + * Returns the Excel calculation engine version used for the last full recalculation. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + calculationEngineVersion?: number; + /** + * Returns the calculation mode used in the workbook, as defined by the constants in `Excel.CalculationMode`. Possible values are: `Automatic`, where Excel controls recalculation; `AutomaticExceptTables`, where Excel controls recalculation but ignores changes in tables; `Manual`, where calculation is done when the user requests it. + * + * @remarks + * [Api set: ExcelApi 1.1 for get, 1.8 for set] + */ + calculationMode?: Excel.CalculationMode | "Automatic" | "AutomaticExceptTables" | "Manual"; + /** + * Returns the calculation state of the application. See `Excel.CalculationState` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + calculationState?: Excel.CalculationState | "Done" | "Calculating" | "Pending"; + /** + * Gets the string used as the decimal separator for numeric values. This is based on the local Excel settings. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + decimalSeparator?: string; + /** + * Gets the string used to separate groups of digits to the left of the decimal for numeric values. This is based on the local Excel settings. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + thousandsSeparator?: string; + /** + * Specifies if the system separators of Excel are enabled. + System separators include the decimal separator and thousands separator. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + useSystemSeparators?: boolean; + } + /** An interface describing the data returned by calling `iterativeCalculation.toJSON()`. */ + export interface IterativeCalculationData { + /** + * True if Excel will use iteration to resolve circular references. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enabled?: boolean; + /** + * Specifies the maximum amount of change between each iteration as Excel resolves circular references. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + maxChange?: number; + /** + * Specifies the maximum number of iterations that Excel can use to resolve a circular reference. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + maxIteration?: number; + } + /** An interface describing the data returned by calling `workbook.toJSON()`. */ + export interface WorkbookData { + /** + * Represents a collection of bindings that are part of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + bindings?: Excel.Interfaces.BindingData[]; + /** + * Represents a collection of comments associated with the workbook. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + comments?: Excel.Interfaces.CommentData[]; + /** + * Represents the collection of custom XML parts contained by this workbook. + * + * @remarks + * [Api set: ExcelApi 1.5] + */ + customXmlParts?: Excel.Interfaces.CustomXmlPartData[]; + /** + * Represents a collection of workbook-scoped named items (named ranges and constants). + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + names?: Excel.Interfaces.NamedItemData[]; + /** + * Returns a collection of all the notes objects in the workbook. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + notes?: Excel.Interfaces.NoteData[]; + /** + * Represents a collection of PivotTableStyles associated with the workbook. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + pivotTableStyles?: Excel.Interfaces.PivotTableStyleData[]; + /** + * Represents a collection of PivotTables associated with the workbook. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + pivotTables?: Excel.Interfaces.PivotTableData[]; + /** + * Gets the workbook properties. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + properties?: Excel.Interfaces.DocumentPropertiesData; + /** + * Returns the protection object for a workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + protection?: Excel.Interfaces.WorkbookProtectionData; + /** + * Represents a collection of settings associated with the workbook. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + settings?: Excel.Interfaces.SettingData[]; + /** + * Represents a collection of SlicerStyles associated with the workbook. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + slicerStyles?: Excel.Interfaces.SlicerStyleData[]; + /** + * Represents a collection of slicers associated with the workbook. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + slicers?: Excel.Interfaces.SlicerData[]; + /** + * Represents a collection of styles associated with the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + styles?: Excel.Interfaces.StyleData[]; + /** + * Represents a collection of TableStyles associated with the workbook. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + tableStyles?: Excel.Interfaces.TableStyleData[]; + /** + * Represents a collection of tables associated with the workbook. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + tables?: Excel.Interfaces.TableData[]; + /** + * Represents a collection of TimelineStyles associated with the workbook. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + timelineStyles?: Excel.Interfaces.TimelineStyleData[]; + /** + * Represents a collection of worksheets associated with the workbook. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + worksheets?: Excel.Interfaces.WorksheetData[]; + /** + * Specifies if the workbook is in AutoSave mode. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + autoSave?: boolean; + /** + * Returns a number about the version of Excel Calculation Engine. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + calculationEngineVersion?: number; + /** + * True if all charts in the workbook are tracking the actual data points to which they are attached. + False if the charts track the index of the data points. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + chartDataPointTrack?: boolean; + /** + * Specifies if changes have been made since the workbook was last saved. + You can set this property to `true` if you want to close a modified workbook without either saving it or being prompted to save it. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + isDirty?: boolean; + /** + * Gets the workbook name. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + name?: string; + /** + * Specifies if the workbook has ever been saved locally or online. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + previouslySaved?: boolean; + /** + * Returns `true` if the workbook is open in read-only mode. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readOnly?: boolean; + /** + * True if calculations in this workbook will be done using only the precision of the numbers as they're displayed. + Data will permanently lose accuracy when switching this property from `false` to `true`. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + usePrecisionAsDisplayed?: boolean; + } + /** An interface describing the data returned by calling `workbookProtection.toJSON()`. */ + export interface WorkbookProtectionData { + /** + * Specifies if the workbook is protected. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + protected?: boolean; + } + /** An interface describing the data returned by calling `workbookCreated.toJSON()`. */ + export interface WorkbookCreatedData { + } + /** An interface describing the data returned by calling `worksheet.toJSON()`. */ + export interface WorksheetData { + /** + * Represents the `AutoFilter` object of the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + autoFilter?: Excel.Interfaces.AutoFilterData; + /** + * Returns a collection of charts that are part of the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + charts?: Excel.Interfaces.ChartData[]; + /** + * Returns a collection of all the Comments objects on the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + comments?: Excel.Interfaces.CommentData[]; + /** + * Gets a collection of worksheet-level custom properties. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + customProperties?: Excel.Interfaces.WorksheetCustomPropertyData[]; + /** + * Gets the horizontal page break collection for the worksheet. This collection only contains manual page breaks. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + horizontalPageBreaks?: Excel.Interfaces.PageBreakData[]; + /** + * Collection of names scoped to the current worksheet. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + names?: Excel.Interfaces.NamedItemData[]; + /** + * Returns a collection of all the notes objects in the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + notes?: Excel.Interfaces.NoteData[]; + /** + * Gets the `PageLayout` object of the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + pageLayout?: Excel.Interfaces.PageLayoutData; + /** + * Collection of PivotTables that are part of the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + pivotTables?: Excel.Interfaces.PivotTableData[]; + /** + * Returns the sheet protection object for a worksheet. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + protection?: Excel.Interfaces.WorksheetProtectionData; + /** + * Returns the collection of all the Shape objects on the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + shapes?: Excel.Interfaces.ShapeData[]; + /** + * Returns a collection of slicers that are part of the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + slicers?: Excel.Interfaces.SlicerData[]; + /** + * Collection of tables that are part of the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + tables?: Excel.Interfaces.TableData[]; + /** + * Gets the vertical page break collection for the worksheet. This collection only contains manual page breaks. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + verticalPageBreaks?: Excel.Interfaces.PageBreakData[]; + /** + * Determines if Excel should recalculate the worksheet when necessary. + True if Excel recalculates the worksheet when necessary. False if Excel doesn't recalculate the sheet. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enableCalculation?: boolean; + /** + * Returns a value that uniquely identifies the worksheet in a given workbook. The value of the identifier remains the same even when the worksheet is renamed or moved. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + id?: string; + /** + * The display name of the worksheet. The name must be fewer than 32 characters. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + name?: string; + /** + * The zero-based position of the worksheet within the workbook. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + position?: number; + /** + * Specifies if data type icons are visible on the worksheet. By default, data type icons are visible. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + showDataTypeIcons?: boolean; + /** + * Specifies if gridlines are visible to the user. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showGridlines?: boolean; + /** + * Specifies if headings are visible to the user. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showHeadings?: boolean; + /** + * Returns the standard (default) height of all the rows in the worksheet, in points. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + standardHeight?: number; + /** + * Specifies the standard (default) width of all the columns in the worksheet. + One unit of column width is equal to the width of one character in the Normal style. For proportional fonts, the width of the character 0 (zero) is used. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + standardWidth?: number; + /** + * The tab color of the worksheet. + When retrieving the tab color, if the worksheet is invisible, the value will be `null`. If the worksheet is visible but the tab color is set to auto, an empty string will be returned. Otherwise, the property will be set to a color, in the form #RRGGBB (e.g., "FFA500"). + When setting the color, use an empty-string to set an "auto" color, or a real color otherwise. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + tabColor?: string; + /** + * Returns a value representing this worksheet that can be read by Open Office XML. This is an integer value, which is different from `worksheet.id` (which returns a globally unique identifier) and `worksheet.name` (which returns a value such as "Sheet1"). + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + tabId?: number; + /** + * The visibility of the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.1 for reading visibility; 1.2 for setting it.] + */ + visibility?: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden"; + } + /** An interface describing the data returned by calling `worksheetCollection.toJSON()`. */ + export interface WorksheetCollectionData { + items?: Excel.Interfaces.WorksheetData[]; + } + /** An interface describing the data returned by calling `worksheetProtection.toJSON()`. */ + export interface WorksheetProtectionData { + + + + + /** + * Specifies the protection options for the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + options?: Excel.WorksheetProtectionOptions; + /** + * Specifies if the worksheet is protected. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + protected?: boolean; + + } + /** An interface describing the data returned by calling `range.toJSON()`. */ + export interface RangeData { + /** + * The collection of `ConditionalFormats` that intersect the range. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + conditionalFormats?: Excel.Interfaces.ConditionalFormatData[]; + /** + * Returns a data validation object. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + dataValidation?: Excel.Interfaces.DataValidationData; + /** + * Returns a format object, encapsulating the range's font, fill, borders, alignment, and other properties. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + format?: Excel.Interfaces.RangeFormatData; + /** + * Specifies the range reference in A1-style. Address value contains the sheet reference (e.g., "Sheet1!A1:B4"). + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + address?: string; + /** + * Represents the range reference for the specified range in the language of the user. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + addressLocal?: string; + /** + * Specifies the number of cells in the range. This API will return -1 if the cell count exceeds 2^31-1 (2,147,483,647). + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + cellCount?: number; + /** + * Specifies the total number of columns in the range. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + columnCount?: number; + /** + * Represents if all columns in the current range are hidden. Value is `true` when all columns in a range are hidden. Value is `false` when no columns in the range are hidden. Value is `null` when some columns in a range are hidden and other columns in the same range are not hidden. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + columnHidden?: boolean; + /** + * Specifies the column number of the first cell in the range. Zero-indexed. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + columnIndex?: number; + /** + * Accesses the cell control applied to this range. + If the range has multiple cell controls, this returns `EmptyCellControl`. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + control?: CellControl; + /** + * Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + formulas?: any[][]; + /** + * Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. If a cell has no formula, its value is returned instead. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + formulasLocal?: any[][]; + /** + * Represents the formula in R1C1-style notation. If a cell has no formula, its value is returned instead. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + formulasR1C1?: any[][]; + /** + * Represents if all cells have a spill border. + Returns `true` if all cells have a spill border, or `false` if all cells do not have a spill border. + Returns `null` if there are cells both with and without spill borders within the range. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + hasSpill?: boolean; + /** + * Returns the distance in points, for 100% zoom, from the top edge of the range to the bottom edge of the range. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + height?: number; + /** + * Represents if all cells in the current range are hidden. Value is `true` when all cells in a range are hidden. Value is `false` when no cells in the range are hidden. Value is `null` when some cells in a range are hidden and other cells in the same range are not hidden. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + hidden?: boolean; + /** + * Represents the hyperlink for the current range. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + hyperlink?: Excel.RangeHyperlink; + /** + * Represents if the current range is an entire column. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + isEntireColumn?: boolean; + /** + * Represents if the current range is an entire row. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + isEntireRow?: boolean; + /** + * Returns the distance in points, for 100% zoom, from the left edge of the worksheet to the left edge of the range. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + left?: number; + /** + * Represents the data type state of each cell. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + linkedDataTypeState?: Excel.LinkedDataTypeState[][]; + /** + * Represents Excel's number format code for the given range. For more information about Excel number formatting, see {@link https://support.microsoft.com/office/5026bbd6-04bc-48cd-bf33-80f18b4eae68 | Number format codes}. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + numberFormat?: any[][]; + /** + * Represents the category of number format of each cell. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + numberFormatCategories?: Excel.NumberFormatCategory[][]; + /** + * Represents Excel's number format code for the given range, based on the language settings of the user. + Excel does not perform any language or format coercion when getting or setting the `numberFormatLocal` property. + Any returned text uses the locally-formatted strings based on the language specified in the system settings. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + numberFormatLocal?: any[][]; + /** + * Returns the total number of rows in the range. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + rowCount?: number; + /** + * Represents if all rows in the current range are hidden. Value is `true` when all rows in a range are hidden. Value is `false` when no rows in the range are hidden. Value is `null` when some rows in a range are hidden and other rows in the same range are not hidden. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + rowHidden?: boolean; + /** + * Returns the row number of the first cell in the range. Zero-indexed. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + rowIndex?: number; + /** + * Represents if all the cells would be saved as an array formula. + Returns `true` if all cells would be saved as an array formula, or `false` if all cells would not be saved as an array formula. + Returns `null` if some cells would be saved as an array formula and some would not be. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + savedAsArray?: boolean; + /** + * Represents the style of the current range. + If the styles of the cells are inconsistent, `null` will be returned. + For custom styles, the style name will be returned. For built-in styles, a string representing a value in the `BuiltInStyle` enum will be returned. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + style?: string; + /** + * Text values of the specified range. The text value will not depend on the cell width. The number sign (#) substitution that happens in the Excel UI will not affect the text value returned by the API. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + text?: string[][]; + /** + * Returns the distance in points, for 100% zoom, from the top edge of the worksheet to the top edge of the range. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + top?: number; + /** + * Specifies the type of data in each cell. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + valueTypes?: Excel.RangeValueType[][]; + /** + * Represents the raw values of the specified range. The data returned could be a string, number, or boolean. Cells that contain an error will return the error string. + If the returned value starts with a plus ("+"), minus ("-"), or equal sign ("="), Excel interprets this value as a formula. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + values?: any[][]; + /** + * A JSON representation of the values in the cells in this range. + Unlike `Range.values`, `Range.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `Range.valuesAsJsonLocal`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJson?: CellValue[][]; + /** + * A JSON representation of the values in the cells in this range. + Unlike `Range.values`, `Range.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `Range.valuesAsJson`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJsonLocal?: CellValue[][]; + /** + * Returns the distance in points, for 100% zoom, from the left edge of the range to the right edge of the range. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + width?: number; + } + /** An interface describing the data returned by calling `rangeAreas.toJSON()`. */ + export interface RangeAreasData { + /** + * Returns a collection of rectangular ranges that comprise this `RangeAreas` object. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + areas?: Excel.Interfaces.RangeData[]; + /** + * Returns a collection of conditional formats that intersect with any cells in this `RangeAreas` object. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + conditionalFormats?: Excel.Interfaces.ConditionalFormatData[]; + /** + * Returns a data validation object for all ranges in the `RangeAreas`. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + dataValidation?: Excel.Interfaces.DataValidationData; + /** + * Returns a `RangeFormat` object, encapsulating the font, fill, borders, alignment, and other properties for all ranges in the `RangeAreas` object. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + format?: Excel.Interfaces.RangeFormatData; + /** + * Returns the `RangeAreas` reference in A1-style. Address value will contain the worksheet name for each rectangular block of cells (e.g., "Sheet1!A1:B4, Sheet1!D1:D4"). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + address?: string; + /** + * Returns the `RangeAreas` reference in the user locale. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + addressLocal?: string; + /** + * Returns the number of rectangular ranges that comprise this `RangeAreas` object. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + areaCount?: number; + /** + * Returns the number of cells in the `RangeAreas` object, summing up the cell counts of all of the individual rectangular ranges. Returns -1 if the cell count exceeds 2^31-1 (2,147,483,647). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + cellCount?: number; + /** + * Specifies if all the ranges on this `RangeAreas` object represent entire columns (e.g., "A:C, Q:Z"). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + isEntireColumn?: boolean; + /** + * Specifies if all the ranges on this `RangeAreas` object represent entire rows (e.g., "1:3, 5:7"). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + isEntireRow?: boolean; + /** + * Represents the style for all ranges in this `RangeAreas` object. + If the styles of the cells are inconsistent, `null` will be returned. + For custom styles, the style name will be returned. For built-in styles, a string representing a value in the `BuiltInStyle` enum will be returned. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + style?: string; + } + /** An interface describing the data returned by calling `workbookRangeAreas.toJSON()`. */ + export interface WorkbookRangeAreasData { + /** + * Returns the `RangeAreasCollection` object. Each `RangeAreas` in the collection represent one or more rectangle ranges in one worksheet. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + areas?: Excel.Interfaces.RangeAreasData[]; + /** + * Returns ranges that comprise this object in a `RangeCollection` object. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + ranges?: Excel.Interfaces.RangeData[]; + /** + * Returns an array of addresses in A1-style. Address values contain the worksheet name for each rectangular block of cells (e.g., "Sheet1!A1:B4, Sheet1!D1:D4"). Read-only. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + addresses?: string[]; + } + /** An interface describing the data returned by calling `rangeView.toJSON()`. */ + export interface RangeViewData { + /** + * Represents a collection of range views associated with the range. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + rows?: Excel.Interfaces.RangeViewData[]; + /** + * Represents the cell addresses of the `RangeView`. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + cellAddresses?: any[][]; + /** + * The number of visible columns. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + columnCount?: number; + /** + * Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + formulas?: any[][]; + /** + * Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. If a cell has no formula, its value is returned instead. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + formulasLocal?: any[][]; + /** + * Represents the formula in R1C1-style notation. If a cell has no formula, its value is returned instead. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + formulasR1C1?: any[][]; + /** + * Returns a value that represents the index of the `RangeView`. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + index?: number; + /** + * Represents Excel's number format code for the given cell. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + numberFormat?: any[][]; + /** + * The number of visible rows. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + rowCount?: number; + /** + * Text values of the specified range. The text value will not depend on the cell width. The # sign substitution that happens in Excel UI will not affect the text value returned by the API. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + text?: string[][]; + /** + * Represents the type of data of each cell. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + valueTypes?: Excel.RangeValueType[][]; + /** + * Represents the raw values of the specified range view. The data returned could be of type string, number, or a boolean. Cells that contain an error will return the error string. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + values?: any[][]; + /** + * A JSON representation of the values in the cells in this range. + Unlike `RangeView.values`, `RangeView.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `RangeView.valuesAsJsonLocal`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJson?: CellValue[][]; + /** + * A JSON representation of the values in the cells in this range. + Unlike `RangeView.values`, `RangeView.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `RangeView.valuesAsJson`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJsonLocal?: CellValue[][]; + } + /** An interface describing the data returned by calling `rangeViewCollection.toJSON()`. */ + export interface RangeViewCollectionData { + items?: Excel.Interfaces.RangeViewData[]; + } + /** An interface describing the data returned by calling `settingCollection.toJSON()`. */ + export interface SettingCollectionData { + items?: Excel.Interfaces.SettingData[]; + } + /** An interface describing the data returned by calling `setting.toJSON()`. */ + export interface SettingData { + /** + * The key that represents the ID of the setting. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + key?: string; + /** + * Represents the value stored for this setting. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + value?: any; + } + /** An interface describing the data returned by calling `namedItemCollection.toJSON()`. */ + export interface NamedItemCollectionData { + items?: Excel.Interfaces.NamedItemData[]; + } + /** An interface describing the data returned by calling `namedItem.toJSON()`. */ + export interface NamedItemData { + /** + * Returns an object containing values and types of the named item. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + arrayValues?: Excel.Interfaces.NamedItemArrayValuesData; + /** + * Specifies the comment associated with this name. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + comment?: string; + /** + * The formula of the named item. Formulas always start with an equal sign ("="). + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + formula?: any; + /** + * The name of the object. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + name?: string; + /** + * Specifies if the name is scoped to the workbook or to a specific worksheet. Possible values are: Worksheet, Workbook. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + scope?: Excel.NamedItemScope | "Worksheet" | "Workbook"; + /** + * Specifies the type of the value returned by the name's formula. See `Excel.NamedItemType` for details. + * + * @remarks + * [Api set: ExcelApi 1.1 for String,Integer,Double,Boolean,Range,Error; 1.7 for Array] + */ + type?: Excel.NamedItemType | "String" | "Integer" | "Double" | "Boolean" | "Range" | "Error" | "Array"; + /** + * 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 + * [Api set: ExcelApi 1.1] + */ + value?: any; + /** + * A JSON representation of the values in this named item. + Unlike `NamedItem.value`, `NamedItem.valueAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `NamedItem.valueAsJsonLocal`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valueAsJson?: CellValue | string; + /** + * A JSON representation of the values in this named item. + Unlike `NamedItem.value`, `NamedItem.valueAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `NamedItem.valueAsJson`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valueAsJsonLocal?: CellValue | string; + /** + * Specifies if the object is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + visible?: boolean; + } + /** An interface describing the data returned by calling `namedItemArrayValues.toJSON()`. */ + export interface NamedItemArrayValuesData { + /** + * Represents the types for each item in the named item array + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + types?: Excel.RangeValueType[][]; + /** + * Represents the values of each item in the named item array. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + values?: any[][]; + /** + * A JSON representation of the values in this named item array. + Unlike `NamedItemArrayValues.values`, `NamedItemArrayValues.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `NamedItemArrayValues.valuesAsJsonLocal`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJson?: CellValue[][]; + /** + * A JSON representation of the values in this named item array. + Unlike `NamedItemArrayValues.values`, `NamedItemArrayValues.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `NamedItemArrayValues.valuesAsJson`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJsonLocal?: CellValue[][]; + } + /** An interface describing the data returned by calling `binding.toJSON()`. */ + export interface BindingData { + /** + * Represents the binding identifier. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + id?: string; + /** + * Returns the type of the binding. See `Excel.BindingType` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + type?: Excel.BindingType | "Range" | "Table" | "Text"; + } + /** An interface describing the data returned by calling `bindingCollection.toJSON()`. */ + export interface BindingCollectionData { + items?: Excel.Interfaces.BindingData[]; + } + /** An interface describing the data returned by calling `tableCollection.toJSON()`. */ + export interface TableCollectionData { + items?: Excel.Interfaces.TableData[]; + } + /** An interface describing the data returned by calling `tableScopedCollection.toJSON()`. */ + export interface TableScopedCollectionData { + items?: Excel.Interfaces.TableData[]; + } + /** An interface describing the data returned by calling `table.toJSON()`. */ + export interface TableData { + /** + * Represents the `AutoFilter` object of the table. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + autoFilter?: Excel.Interfaces.AutoFilterData; + /** + * Represents a collection of all the columns in the table. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + columns?: Excel.Interfaces.TableColumnData[]; + /** + * Represents a collection of all the rows in the table. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + rows?: Excel.Interfaces.TableRowData[]; + /** + * Represents the sorting for the table. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + sort?: Excel.Interfaces.TableSortData; + /** + * Specifies if the first column contains special formatting. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + highlightFirstColumn?: boolean; + /** + * Specifies if the last column contains special formatting. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + highlightLastColumn?: boolean; + /** + * Returns a value that uniquely identifies the table in a given workbook. The value of the identifier remains the same even when the table is renamed. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + id?: string; + /** + * Returns a numeric ID. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + legacyId?: string; + /** + * Name of the table. + + The set name of the table must follow the guidelines specified in the {@link https://support.microsoft.com/office/fbf49a4f-82a3-43eb-8ba2-44d21233b114 | Rename an Excel table} article. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + name?: string; + /** + * Specifies if the columns show banded formatting in which odd columns are highlighted differently from even ones, to make reading the table easier. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + showBandedColumns?: boolean; + /** + * Specifies if the rows show banded formatting in which odd rows are highlighted differently from even ones, to make reading the table easier. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + showBandedRows?: boolean; + /** + * Specifies if the filter buttons are visible at the top of each column header. Setting this is only allowed if the table contains a header row. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + showFilterButton?: boolean; + /** + * Specifies if the header row is visible. This value can be set to show or remove the header row. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + showHeaders?: boolean; + /** + * Specifies if the total row is visible. This value can be set to show or remove the total row. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + showTotals?: boolean; + /** + * Constant value that represents the table style. Possible values are: "TableStyleLight1" through "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", "TableStyleDark1" through "TableStyleDark11". A custom user-defined style present in the workbook can also be specified. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + style?: string; + } + /** An interface describing the data returned by calling `tableColumnCollection.toJSON()`. */ + export interface TableColumnCollectionData { + items?: Excel.Interfaces.TableColumnData[]; + } + /** An interface describing the data returned by calling `tableColumn.toJSON()`. */ + export interface TableColumnData { + /** + * Retrieves the filter applied to the column. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + filter?: Excel.Interfaces.FilterData; + /** + * Returns a unique key that identifies the column within the table. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + id?: number; + /** + * Returns the index number of the column within the columns collection of the table. Zero-indexed. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + index?: number; + /** + * Specifies the name of the table column. + * + * @remarks + * [Api set: ExcelApi 1.1 for getting the name; 1.4 for setting it.] + */ + name?: string; + /** + * Represents the raw values of the specified range. The data returned could be a string, number, or boolean. Cells that contain an error will return the error string. + If the returned value starts with a plus ("+"), minus ("-"), or equal sign ("="), Excel interprets this value as a formula. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + values?: any[][]; + /** + * A JSON representation of the values in the cells in this table column. + Unlike `TableColumn.values`, `TableColumn.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `TableColumn.valuesAsJsonLocal`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJson?: CellValue[][]; + /** + * A JSON representation of the values in the cells in this table column. + Unlike `TableColumn.values`, `TableColumn.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `TableColumn.valuesAsJson`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJsonLocal?: CellValue[][]; + } + /** An interface describing the data returned by calling `tableRowCollection.toJSON()`. */ + export interface TableRowCollectionData { + items?: Excel.Interfaces.TableRowData[]; + } + /** An interface describing the data returned by calling `tableRow.toJSON()`. */ + export interface TableRowData { + /** + * Returns the index number of the row within the rows collection of the table. Zero-indexed. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + index?: number; + /** + * Represents the raw values of the specified range. The data returned could be a string, number, or boolean. Cells that contain an error will return the error string. + If the returned value starts with a plus ("+"), minus ("-"), or equal sign ("="), Excel interprets this value as a formula. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + values?: any[][]; + /** + * A JSON representation of the values in the cells in this table row. + Unlike `TableRow.values`, `TableRow.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `TableRow.valuesAsJsonLocal`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJson?: CellValue[][]; + /** + * A JSON representation of the values in the cells in this table row. + Unlike `TableRow.values`, `TableRow.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `TableRow.valuesAsJson`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJsonLocal?: CellValue[][]; + } + /** An interface describing the data returned by calling `dataValidation.toJSON()`. */ + export interface DataValidationData { + /** + * Error alert when user enters invalid data. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + errorAlert?: Excel.DataValidationErrorAlert; + /** + * Specifies if data validation will be performed on blank cells. Default is `true`. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + ignoreBlanks?: boolean; + /** + * Prompt when users select a cell. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + prompt?: Excel.DataValidationPrompt; + /** + * Data validation rule that contains different type of data validation criteria. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + rule?: Excel.DataValidationRule; + /** + * Type of the data validation, see `Excel.DataValidationType` for details. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + type?: Excel.DataValidationType | "None" | "WholeNumber" | "Decimal" | "List" | "Date" | "Time" | "TextLength" | "Custom" | "Inconsistent" | "MixedCriteria"; + /** + * Represents if all cell values are valid according to the data validation rules. + Returns `true` if all cell values are valid, or `false` if all cell values are invalid. + Returns `null` if there are both valid and invalid cell values within the range. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + valid?: boolean; + } + /** An interface describing the data returned by calling `removeDuplicatesResult.toJSON()`. */ + export interface RemoveDuplicatesResultData { + /** + * Number of duplicated rows removed by the operation. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + removed?: number; + /** + * Number of remaining unique rows present in the resulting range. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + uniqueRemaining?: number; + } + /** An interface describing the data returned by calling `rangeFormat.toJSON()`. */ + export interface RangeFormatData { + /** + * Collection of border objects that apply to the overall range. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + borders?: Excel.Interfaces.RangeBorderData[]; + /** + * Returns the fill object defined on the overall range. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + fill?: Excel.Interfaces.RangeFillData; + /** + * Returns the font object defined on the overall range. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + font?: Excel.Interfaces.RangeFontData; + /** + * Returns the format protection object for a range. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + protection?: Excel.Interfaces.FormatProtectionData; + /** + * Specifies if text is automatically indented when text alignment is set to equal distribution. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + autoIndent?: boolean; + /** + * Specifies the width of all columns within the range. If the column widths are not uniform, `null` will be returned. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + columnWidth?: number; + /** + * Represents the horizontal alignment for the specified object. See `Excel.HorizontalAlignment` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + horizontalAlignment?: Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed"; + /** + * An integer from 0 to 250 that indicates the indent level. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + indentLevel?: number; + /** + * The reading order for the range. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readingOrder?: Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft"; + /** + * The height of all rows in the range. If the row heights are not uniform, `null` will be returned. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + rowHeight?: number; + /** + * Specifies if text automatically shrinks to fit in the available column width. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + shrinkToFit?: boolean; + /** + * The text orientation of all the cells within the range. + The text orientation should be an integer either from -90 to 90, or 180 for vertically-oriented text. + If the orientation within a range are not uniform, then `null` will be returned. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + textOrientation?: number; + /** + * Determines if the row height of the `Range` object equals the standard height of the sheet. + Returns `true` if the row height of the `Range` object equals the standard height of the sheet. + Returns `null` if the range contains more than one row and the rows aren't all the same height. + Returns `false` otherwise. + Note: This property is only intended to be set to `true`. Setting it to `false` has no effect. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + useStandardHeight?: boolean; + /** + * Specifies if the column width of the `Range` object equals the standard width of the sheet. + Returns `true` if the column width of the `Range` object equals the standard width of the sheet. + Returns `null` if the range contains more than one column and the columns aren't all the same height. + Returns `false` otherwise. + Note: This property is only intended to be set to `true`. Setting it to `false` has no effect. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + useStandardWidth?: boolean; + /** + * Represents the vertical alignment for the specified object. See `Excel.VerticalAlignment` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + verticalAlignment?: Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed"; + /** + * Specifies if Excel wraps the text in the object. A `null` value indicates that the entire range doesn't have a uniform wrap setting + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + wrapText?: boolean; + } + /** An interface describing the data returned by calling `formatProtection.toJSON()`. */ + export interface FormatProtectionData { + /** + * Specifies if Excel hides the formula for the cells in the range. A `null` value indicates that the entire range doesn't have a uniform formula hidden setting. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + formulaHidden?: boolean; + /** + * Specifies if Excel locks the cells in the object. A `null` value indicates that the entire range doesn't have a uniform lock setting. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + locked?: boolean; + } + /** An interface describing the data returned by calling `rangeFill.toJSON()`. */ + export interface RangeFillData { + /** + * HTML color code representing the color of the background, in the form #RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange") + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + color?: string; + /** + * The pattern of a range. See `Excel.FillPattern` for details. LinearGradient and RectangularGradient are not supported. + A `null` value indicates that the entire range doesn't have a uniform pattern setting. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + pattern?: Excel.FillPattern | "None" | "Solid" | "Gray50" | "Gray75" | "Gray25" | "Horizontal" | "Vertical" | "Down" | "Up" | "Checker" | "SemiGray75" | "LightHorizontal" | "LightVertical" | "LightDown" | "LightUp" | "Grid" | "CrissCross" | "Gray16" | "Gray8" | "LinearGradient" | "RectangularGradient"; + /** + * The HTML color code representing the color of the range pattern, in the form #RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange"). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + patternColor?: string; + /** + * Specifies a double that lightens or darkens a pattern color for the range fill. The value is between -1 (darkest) and 1 (brightest), with 0 for the original color. + A `null` value indicates that the range doesn't have uniform `patternTintAndShade` settings. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + patternTintAndShade?: number; + /** + * Specifies a double that lightens or darkens a color for the range fill. The value is between -1 (darkest) and 1 (brightest), with 0 for the original color. + A `null` value indicates that the range doesn't have uniform `tintAndShade` settings. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + tintAndShade?: number; + } + /** An interface describing the data returned by calling `rangeBorder.toJSON()`. */ + export interface RangeBorderData { + /** + * HTML color code representing the color of the border line, in the form #RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange"). + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + color?: string; + /** + * Constant value that indicates the specific side of the border. See `Excel.BorderIndex` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + sideIndex?: Excel.BorderIndex | "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight" | "InsideVertical" | "InsideHorizontal" | "DiagonalDown" | "DiagonalUp"; + /** + * One of the constants of line style specifying the line style for the border. See `Excel.BorderLineStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + style?: Excel.BorderLineStyle | "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot" | "Double" | "SlantDashDot"; + /** + * Specifies a double that lightens or darkens a color for the range border, the value is between -1 (darkest) and 1 (brightest), with 0 for the original color. + A `null` value indicates that the border doesn't have a uniform `tintAndShade` setting. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + tintAndShade?: number; + /** + * Specifies the weight of the border around a range. See `Excel.BorderWeight` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + weight?: Excel.BorderWeight | "Hairline" | "Thin" | "Medium" | "Thick"; + } + /** An interface describing the data returned by calling `rangeBorderCollection.toJSON()`. */ + export interface RangeBorderCollectionData { + items?: Excel.Interfaces.RangeBorderData[]; + } + /** An interface describing the data returned by calling `rangeFont.toJSON()`. */ + export interface RangeFontData { + /** + * Represents the bold status of the font. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + bold?: boolean; + /** + * HTML color code representation of the text color (e.g., #FF0000 represents Red). + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + color?: string; + /** + * Specifies the italic status of the font. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + italic?: boolean; + /** + * Font name (e.g., "Calibri"). The name's length should not be greater than 31 characters. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + name?: string; + /** + * Font size. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + size?: number; + /** + * Specifies the strikethrough status of font. A `null` value indicates that the entire range doesn't have a uniform strikethrough setting. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + strikethrough?: boolean; + /** + * Specifies the subscript status of font. + Returns `true` if all the fonts of the range are subscript. + Returns `false` if all the fonts of the range are superscript or normal (neither superscript, nor subscript). + Returns `null` otherwise. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + subscript?: boolean; + /** + * Specifies the superscript status of font. + Returns `true` if all the fonts of the range are superscript. + Returns `false` if all the fonts of the range are subscript or normal (neither superscript, nor subscript). + Returns `null` otherwise. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + superscript?: boolean; + /** + * Specifies a double that lightens or darkens a color for the range font. The value is between -1 (darkest) and 1 (brightest), with 0 for the original color. + A `null` value indicates that the entire range doesn't have a uniform font `tintAndShade` setting. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + tintAndShade?: number; + /** + * Type of underline applied to the font. See `Excel.RangeUnderlineStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + underline?: Excel.RangeUnderlineStyle | "None" | "Single" | "Double" | "SingleAccountant" | "DoubleAccountant"; + } + /** An interface describing the data returned by calling `chartCollection.toJSON()`. */ + export interface ChartCollectionData { + items?: Excel.Interfaces.ChartData[]; + } + /** An interface describing the data returned by calling `chart.toJSON()`. */ + export interface ChartData { + /** + * Represents chart axes. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + axes?: Excel.Interfaces.ChartAxesData; + /** + * Represents the data labels on the chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + dataLabels?: Excel.Interfaces.ChartDataLabelsData; + /** + * Encapsulates the format properties for the chart area. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + format?: Excel.Interfaces.ChartAreaFormatData; + /** + * Represents the legend for the chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + legend?: Excel.Interfaces.ChartLegendData; + /** + * Encapsulates the options for a pivot chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + pivotOptions?: Excel.Interfaces.ChartPivotOptionsData; + /** + * Represents the plot area for the chart. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + plotArea?: Excel.Interfaces.ChartPlotAreaData; + /** + * Represents either a single series or collection of series in the chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + series?: Excel.Interfaces.ChartSeriesData[]; + /** + * Represents the title of the specified chart, including the text, visibility, position, and formatting of the title. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + title?: Excel.Interfaces.ChartTitleData; + /** + * Specifies a chart category label level enumeration constant, referring to the level of the source category labels. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + categoryLabelLevel?: number; + /** + * Specifies the type of the chart. See `Excel.ChartType` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + chartType?: Excel.ChartType | "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel"; + /** + * Specifies the way that blank cells are plotted on a chart. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + displayBlanksAs?: Excel.ChartDisplayBlanksAs | "NotPlotted" | "Zero" | "Interplotted"; + /** + * Specifies the height, in points, of the chart object. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + height?: number; + /** + * The unique ID of chart. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + id?: string; + /** + * The distance, in points, from the left side of the chart to the worksheet origin. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + left?: number; + /** + * Specifies the name of a chart object. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + name?: string; + /** + * Specifies the way columns or rows are used as data series on the chart. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + plotBy?: Excel.ChartPlotBy | "Rows" | "Columns"; + /** + * True if only visible cells are plotted. False if both visible and hidden cells are plotted. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + plotVisibleOnly?: boolean; + /** + * Specifies a chart series name level enumeration constant, referring to the level of the source series names. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + seriesNameLevel?: number; + /** + * Specifies whether to display all field buttons on a PivotChart. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showAllFieldButtons?: boolean; + /** + * Specifies whether to show the data labels when the value is greater than the maximum value on the value axis. + If the value axis becomes smaller than the size of the data points, you can use this property to set whether to show the data labels. + This property applies to 2-D charts only. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showDataLabelsOverMaximum?: boolean; + /** + * Specifies the chart style for the chart. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + style?: number; + /** + * Specifies the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart). + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + top?: number; + /** + * Specifies the width, in points, of the chart object. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + width?: number; + } + /** An interface describing the data returned by calling `chartPivotOptions.toJSON()`. */ + export interface ChartPivotOptionsData { + /** + * Specifies whether to display the axis field buttons on a PivotChart. The `showAxisFieldButtons` property corresponds to the "Show Axis Field Buttons" command on the "Field Buttons" drop-down list of the "Analyze" tab, which is available when a PivotChart is selected. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showAxisFieldButtons?: boolean; + /** + * Specifies whether to display the legend field buttons on a PivotChart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showLegendFieldButtons?: boolean; + /** + * Specifies whether to display the report filter field buttons on a PivotChart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showReportFilterFieldButtons?: boolean; + /** + * Specifies whether to display the show value field buttons on a PivotChart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showValueFieldButtons?: boolean; + } + /** An interface describing the data returned by calling `chartAreaFormat.toJSON()`. */ + export interface ChartAreaFormatData { + /** + * Represents the border format of chart area, which includes color, linestyle, and weight. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + border?: Excel.Interfaces.ChartBorderData; + /** + * Represents the font attributes (font name, font size, color, etc.) for the current object. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + font?: Excel.Interfaces.ChartFontData; + /** + * Specifies the color scheme of the chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + colorScheme?: Excel.ChartColorScheme | "ColorfulPalette1" | "ColorfulPalette2" | "ColorfulPalette3" | "ColorfulPalette4" | "MonochromaticPalette1" | "MonochromaticPalette2" | "MonochromaticPalette3" | "MonochromaticPalette4" | "MonochromaticPalette5" | "MonochromaticPalette6" | "MonochromaticPalette7" | "MonochromaticPalette8" | "MonochromaticPalette9" | "MonochromaticPalette10" | "MonochromaticPalette11" | "MonochromaticPalette12" | "MonochromaticPalette13"; + /** + * Specifies if the chart area of the chart has rounded corners. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + roundedCorners?: boolean; + } + /** An interface describing the data returned by calling `chartSeriesCollection.toJSON()`. */ + export interface ChartSeriesCollectionData { + items?: Excel.Interfaces.ChartSeriesData[]; + } + /** An interface describing the data returned by calling `chartSeries.toJSON()`. */ + export interface ChartSeriesData { + /** + * Encapsulates the bin options for histogram charts and pareto charts. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + binOptions?: Excel.Interfaces.ChartBinOptionsData; + /** + * Encapsulates the options for the box and whisker charts. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + boxwhiskerOptions?: Excel.Interfaces.ChartBoxwhiskerOptionsData; + /** + * Represents a collection of all data labels in the series. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + dataLabels?: Excel.Interfaces.ChartDataLabelsData; + /** + * Represents the formatting of a chart series, which includes fill and line formatting. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + format?: Excel.Interfaces.ChartSeriesFormatData; + /** + * Encapsulates the options for a region map chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + mapOptions?: Excel.Interfaces.ChartMapOptionsData; + /** + * Returns a collection of all points in the series. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + points?: Excel.Interfaces.ChartPointData[]; + /** + * The collection of trendlines in the series. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + trendlines?: Excel.Interfaces.ChartTrendlineData[]; + /** + * Represents the error bar object of a chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + xErrorBars?: Excel.Interfaces.ChartErrorBarsData; + /** + * Represents the error bar object of a chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + yErrorBars?: Excel.Interfaces.ChartErrorBarsData; + /** + * Specifies the group for the specified series. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + axisGroup?: Excel.ChartAxisGroup | "Primary" | "Secondary"; + /** + * This can be an integer value from 0 (zero) to 300, representing the percentage of the default size. This property only applies to bubble charts. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + bubbleScale?: number; + /** + * Represents the chart type of a series. See `Excel.ChartType` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + chartType?: Excel.ChartType | "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel"; + /** + * Represents the doughnut hole size of a chart series. Only valid on doughnut and doughnut exploded charts. + Throws an `InvalidArgument` error on invalid charts. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + doughnutHoleSize?: number; + /** + * Specifies the explosion value for a pie-chart or doughnut-chart slice. Returns 0 (zero) if there's no explosion (the tip of the slice is in the center of the pie). + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + explosion?: number; + /** + * Specifies if the series is filtered. Not applicable for surface charts. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + filtered?: boolean; + /** + * Specifies the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical). Applies only to pie, 3-D pie, and doughnut charts. Can be a value from 0 through 360. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + firstSliceAngle?: number; + /** + * Represents the gap width of a chart series. Only valid on bar and column charts, as well as + specific classes of line and pie charts. Throws an invalid argument exception on invalid charts. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + gapWidth?: number; + /** + * Specifies the color for maximum value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMaximumColor?: string; + /** + * Specifies the type for maximum value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMaximumType?: Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent"; + /** + * Specifies the maximum value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMaximumValue?: number; + /** + * Specifies the color for the midpoint value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMidpointColor?: string; + /** + * Specifies the type for the midpoint value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMidpointType?: Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent"; + /** + * Specifies the midpoint value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMidpointValue?: number; + /** + * Specifies the color for the minimum value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMinimumColor?: string; + /** + * Specifies the type for the minimum value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMinimumType?: Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent"; + /** + * Specifies the minimum value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMinimumValue?: number; + /** + * Specifies the series gradient style of a region map chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientStyle?: Excel.ChartGradientStyle | "TwoPhaseColor" | "ThreePhaseColor"; + /** + * Specifies if the series has data labels. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + hasDataLabels?: boolean; + /** + * Specifies the fill color for negative data points in a series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + invertColor?: string; + /** + * True if Excel inverts the pattern in the item when it corresponds to a negative number. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + invertIfNegative?: boolean; + /** + * Specifies the marker background color of a chart series. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + markerBackgroundColor?: string; + /** + * Specifies the marker foreground color of a chart series. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + markerForegroundColor?: string; + /** + * Specifies the marker size of a chart series. + The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + markerSize?: number; + /** + * Specifies the marker style of a chart series. See `Excel.ChartMarkerStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + markerStyle?: Excel.ChartMarkerStyle | "Invalid" | "Automatic" | "None" | "Square" | "Diamond" | "Triangle" | "X" | "Star" | "Dot" | "Dash" | "Circle" | "Plus" | "Picture"; + /** + * Specifies the name of a series in a chart. The name's length should not be greater than 255 characters. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + name?: string; + /** + * Specifies how bars and columns are positioned. Can be a value between -100 and 100. Applies only to 2-D bar and 2-D column charts. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + overlap?: number; + /** + * Specifies the series parent label strategy area for a treemap chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + parentLabelStrategy?: Excel.ChartParentLabelStrategy | "None" | "Banner" | "Overlapping"; + /** + * Specifies the plot order of a chart series within the chart group. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + plotOrder?: number; + /** + * Specifies the size of the secondary section of either a pie-of-pie chart or a bar-of-pie chart, as a percentage of the size of the primary pie. Can be a value from 5 to 200. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + secondPlotSize?: number; + /** + * Specifies whether connector lines are shown in waterfall charts. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showConnectorLines?: boolean; + /** + * Specifies whether leader lines are displayed for each data label in the series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showLeaderLines?: boolean; + /** + * Specifies if the series has a shadow. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showShadow?: boolean; + /** + * Specifies if the series is smooth. Only applicable to line and scatter charts. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + smooth?: boolean; + /** + * Specifies the way the two sections of either a pie-of-pie chart or a bar-of-pie chart are split. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + splitType?: Excel.ChartSplitType | "SplitByPosition" | "SplitByValue" | "SplitByPercentValue" | "SplitByCustomSplit"; + /** + * Specifies the threshold value that separates two sections of either a pie-of-pie chart or a bar-of-pie chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + splitValue?: number; + /** + * True if Excel assigns a different color or pattern to each data marker. The chart must contain only one series. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + varyByCategories?: boolean; + } + /** An interface describing the data returned by calling `chartSeriesFormat.toJSON()`. */ + export interface ChartSeriesFormatData { + /** + * Represents line formatting. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + line?: Excel.Interfaces.ChartLineFormatData; + } + /** An interface describing the data returned by calling `chartPointsCollection.toJSON()`. */ + export interface ChartPointsCollectionData { + items?: Excel.Interfaces.ChartPointData[]; + } + /** An interface describing the data returned by calling `chartPoint.toJSON()`. */ + export interface ChartPointData { + /** + * Returns the data label of a chart point. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + dataLabel?: Excel.Interfaces.ChartDataLabelData; + /** + * Encapsulates the format properties chart point. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + format?: Excel.Interfaces.ChartPointFormatData; + /** + * Represents whether a data point has a data label. Not applicable for surface charts. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + hasDataLabel?: boolean; + /** + * HTML color code representation of the marker background color of a data point (e.g., #FF0000 represents Red). + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + markerBackgroundColor?: string; + /** + * HTML color code representation of the marker foreground color of a data point (e.g., #FF0000 represents Red). + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + markerForegroundColor?: string; + /** + * Represents marker size of a data point. + The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + markerSize?: number; + /** + * Represents marker style of a chart data point. See `Excel.ChartMarkerStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + markerStyle?: Excel.ChartMarkerStyle | "Invalid" | "Automatic" | "None" | "Square" | "Diamond" | "Triangle" | "X" | "Star" | "Dot" | "Dash" | "Circle" | "Plus" | "Picture"; + /** + * Returns the value of a chart point. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + value?: any; + } + /** An interface describing the data returned by calling `chartPointFormat.toJSON()`. */ + export interface ChartPointFormatData { + /** + * Represents the border format of a chart data point, which includes color, style, and weight information. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + border?: Excel.Interfaces.ChartBorderData; + } + /** An interface describing the data returned by calling `chartAxes.toJSON()`. */ + export interface ChartAxesData { + /** + * Represents the category axis in a chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + categoryAxis?: Excel.Interfaces.ChartAxisData; + /** + * Represents the series axis of a 3-D chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + seriesAxis?: Excel.Interfaces.ChartAxisData; + /** + * Represents the value axis in an axis. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + valueAxis?: Excel.Interfaces.ChartAxisData; + } + /** An interface describing the data returned by calling `chartAxis.toJSON()`. */ + export interface ChartAxisData { + /** + * Represents the formatting of a chart object, which includes line and font formatting. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + format?: Excel.Interfaces.ChartAxisFormatData; + /** + * Returns an object that represents the major gridlines for the specified axis. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + majorGridlines?: Excel.Interfaces.ChartGridlinesData; + /** + * Returns an object that represents the minor gridlines for the specified axis. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + minorGridlines?: Excel.Interfaces.ChartGridlinesData; + /** + * Represents the axis title. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + title?: Excel.Interfaces.ChartAxisTitleData; + /** + * Specifies the alignment for the specified axis tick label. See `Excel.ChartTextHorizontalAlignment` for detail. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + alignment?: Excel.ChartTickLabelAlignment | "Center" | "Left" | "Right"; + /** + * Specifies the group for the specified axis. See `Excel.ChartAxisGroup` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + axisGroup?: Excel.ChartAxisGroup | "Primary" | "Secondary"; + /** + * Specifies the base unit for the specified category axis. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + baseTimeUnit?: Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years"; + /** + * Specifies the category axis type. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + categoryType?: Excel.ChartAxisCategoryType | "Automatic" | "TextAxis" | "DateAxis"; + /** + * Specifies the custom axis display unit value. To set this property, please use the `SetCustomDisplayUnit(double)` method. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + customDisplayUnit?: number; + /** + * Represents the axis display unit. See `Excel.ChartAxisDisplayUnit` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + displayUnit?: Excel.ChartAxisDisplayUnit | "None" | "Hundreds" | "Thousands" | "TenThousands" | "HundredThousands" | "Millions" | "TenMillions" | "HundredMillions" | "Billions" | "Trillions" | "Custom"; + /** + * Specifies the height, in points, of the chart axis. Returns `null` if the axis is not visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + height?: number; + /** + * Specifies if the value axis crosses the category axis between categories. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + isBetweenCategories?: boolean; + /** + * Specifies the distance, in points, from the left edge of the axis to the left of chart area. Returns `null` if the axis is not visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + left?: number; + /** + * Specifies if the number format is linked to the cells. If `true`, the number format will change in the labels when it changes in the cells. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + linkNumberFormat?: boolean; + /** + * Specifies the base of the logarithm when using logarithmic scales. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + logBase?: number; + /** + * Specifies the type of major tick mark for the specified axis. See `Excel.ChartAxisTickMark` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + majorTickMark?: Excel.ChartAxisTickMark | "None" | "Cross" | "Inside" | "Outside"; + /** + * Specifies the major unit scale value for the category axis when the `categoryType` property is set to `dateAxis`. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + majorTimeUnitScale?: Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years"; + /** + * Represents the interval between two major tick marks. Can be set to a numeric value or an empty string. The returned value is always a number. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + majorUnit?: any; + /** + * Represents the maximum value on the value axis. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + maximum?: any; + /** + * Represents the minimum value on the value axis. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + minimum?: any; + /** + * Specifies the type of minor tick mark for the specified axis. See `Excel.ChartAxisTickMark` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + minorTickMark?: Excel.ChartAxisTickMark | "None" | "Cross" | "Inside" | "Outside"; + /** + * Specifies the minor unit scale value for the category axis when the `categoryType` property is set to `dateAxis`. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + minorTimeUnitScale?: Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years"; + /** + * Represents the interval between two minor tick marks. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + minorUnit?: any; + /** + * Specifies if an axis is multilevel. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + multiLevel?: boolean; + /** + * Specifies the format code for the axis tick label. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + numberFormat?: string; + /** + * Specifies the distance between the levels of labels, and the distance between the first level and the axis line. The value should be an integer from 0 to 1000. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + offset?: number; + /** + * Specifies the specified axis position where the other axis crosses. See `Excel.ChartAxisPosition` for details. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + position?: Excel.ChartAxisPosition | "Automatic" | "Maximum" | "Minimum" | "Custom"; + /** + * Specifies the axis position where the other axis crosses. You should use the `SetPositionAt(double)` method to set this property. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + positionAt?: number; + /** + * Specifies if Excel plots data points from last to first. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + reversePlotOrder?: boolean; + /** + * Specifies the value axis scale type. See `Excel.ChartAxisScaleType` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + scaleType?: Excel.ChartAxisScaleType | "Linear" | "Logarithmic"; + /** + * Specifies if the axis display unit label is visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showDisplayUnitLabel?: boolean; + /** + * Specifies the angle to which the text is oriented for the chart axis tick label. The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + textOrientation?: any; + /** + * Specifies the position of tick-mark labels on the specified axis. See `Excel.ChartAxisTickLabelPosition` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + tickLabelPosition?: Excel.ChartAxisTickLabelPosition | "NextToAxis" | "High" | "Low" | "None"; + /** + * Specifies the number of categories or series between tick-mark labels. Can be a value from 1 through 31999 or an empty string for automatic setting. The returned value is always a number. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + tickLabelSpacing?: any; + /** + * Specifies the number of categories or series between tick marks. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + tickMarkSpacing?: number; + /** + * Specifies the distance, in points, from the top edge of the axis to the top of chart area. Returns `null` if the axis is not visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + top?: number; + /** + * Specifies the axis type. See `Excel.ChartAxisType` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + type?: Excel.ChartAxisType | "Invalid" | "Category" | "Value" | "Series"; + /** + * Specifies if the axis is visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + visible?: boolean; + /** + * Specifies the width, in points, of the chart axis. Returns `null` if the axis is not visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + width?: number; + } + /** An interface describing the data returned by calling `chartAxisFormat.toJSON()`. */ + export interface ChartAxisFormatData { + /** + * Specifies the font attributes (font name, font size, color, etc.) for a chart axis element. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + font?: Excel.Interfaces.ChartFontData; + /** + * Specifies chart line formatting. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + line?: Excel.Interfaces.ChartLineFormatData; + } + /** An interface describing the data returned by calling `chartAxisTitle.toJSON()`. */ + export interface ChartAxisTitleData { + /** + * Specifies the formatting of the chart axis title. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + format?: Excel.Interfaces.ChartAxisTitleFormatData; + /** + * Specifies the axis title. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + text?: string; + /** + * Specifies the angle to which the text is oriented for the chart axis title. The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + textOrientation?: number; + /** + * Specifies if the axis title is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + visible?: boolean; + } + /** An interface describing the data returned by calling `chartAxisTitleFormat.toJSON()`. */ + export interface ChartAxisTitleFormatData { + /** + * Specifies the chart axis title's border format, which includes color, linestyle, and weight. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + border?: Excel.Interfaces.ChartBorderData; + /** + * Specifies the chart axis title's font attributes, such as font name, font size, or color, of the chart axis title object. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + font?: Excel.Interfaces.ChartFontData; + } + /** An interface describing the data returned by calling `chartDataLabels.toJSON()`. */ + export interface ChartDataLabelsData { + /** + * Specifies the format of chart data labels, which includes fill and font formatting. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + format?: Excel.Interfaces.ChartDataLabelFormatData; + /** + * Gets an object that represents the leader lines of the data labels. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + leaderLines?: Excel.Interfaces.ChartLeaderLinesData; + /** + * Specifies if data labels automatically generate appropriate text based on context. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + autoText?: boolean; + /** + * Specifies the geometric shape type of the data labels. See `Excel.GeometricShapeType` for more details. + Value is `null` if the data labels are not geometric shapes. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + geometricShapeType?: Excel.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"; + /** + * Specifies the horizontal alignment for chart data label. See `Excel.ChartTextHorizontalAlignment` for details. + This property is valid only when the `TextOrientation` of data label is 0. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + horizontalAlignment?: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"; + /** + * Specifies if the number format is linked to the cells. If `true`, the number format will change in the labels when it changes in the cells. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + linkNumberFormat?: boolean; + /** + * Specifies the format code for data labels. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + numberFormat?: string; + /** + * Value that represents the position of the data label. See `Excel.ChartDataLabelPosition` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + position?: Excel.ChartDataLabelPosition | "Invalid" | "None" | "Center" | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" | "Right" | "Top" | "Bottom" | "BestFit" | "Callout"; + /** + * String representing the separator used for the data labels on a chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + separator?: string; + /** + * Specifies if the data labels are shown as a callout with the tail anchor attached to the data point. + If `true`, the callout is one of the following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or "WedgeEllipseCallout". + See {@link Excel.GeometricShapeType | GeometricShapeType} for more details. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + showAsStickyCallout?: boolean; + /** + * Specifies if the data label bubble size is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + showBubbleSize?: boolean; + /** + * Specifies if the data label category name is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + showCategoryName?: boolean; + /** + * Specifies if leader lines are displayed for the data labels. `true` if leader lines are shown; otherwise, `false`. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + showLeaderLines?: boolean; + /** + * Specifies if the data label legend key is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + showLegendKey?: boolean; + /** + * Specifies if the data label percentage is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + showPercentage?: boolean; + /** + * Specifies if the data label series name is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + showSeriesName?: boolean; + /** + * Specifies if the data label value is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + showValue?: boolean; + /** + * Represents the angle to which the text is oriented for data labels. The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + textOrientation?: number; + /** + * Represents the vertical alignment of chart data label. See `Excel.ChartTextVerticalAlignment` for details. + This property is valid only when `TextOrientation` of the data label is -90, 90, or 180. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + verticalAlignment?: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"; + } + /** An interface describing the data returned by calling `chartDataLabel.toJSON()`. */ + export interface ChartDataLabelData { + /** + * Represents the format of chart data label. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + format?: Excel.Interfaces.ChartDataLabelFormatData; + /** + * Specifies if the data label automatically generates appropriate text based on context. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + autoText?: boolean; + /** + * String value that represents the formula of chart data label using A1-style notation. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + formula?: string; + /** + * Specifies the geometric shape type of the data label. See `Excel.GeometricShapeType` for more details. + Value is `null` if the data label is not a geometric shape. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + geometricShapeType?: Excel.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"; + /** + * Returns the height, in points, of the chart data label. + Value is `null` if the chart data label is not visible. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + height?: number; + /** + * Represents the horizontal alignment for chart data label. + See `Excel.ChartTextHorizontalAlignment` for details. + This property is valid only when `TextOrientation` of data label is -90, 90, or 180. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + horizontalAlignment?: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"; + /** + * Represents the distance, in points, from the left edge of chart data label to the left edge of chart area. Value is `null` if the chart data label is not visible. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + left?: number; + /** + * Specifies if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + linkNumberFormat?: boolean; + /** + * Specifies the format code for data label. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + numberFormat?: string; + /** + * Value that represents the position of the data label. + See `Excel.ChartDataLabelPosition` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + position?: Excel.ChartDataLabelPosition | "Invalid" | "None" | "Center" | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" | "Right" | "Top" | "Bottom" | "BestFit" | "Callout"; + /** + * String representing the separator used for the data label on a chart. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + separator?: string; + /** + * Specifies if the data label is shown as a callout with the tail anchor attached to the data point. + If `true`, the callout is one of the following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or "WedgeEllipseCallout". + See {@link Excel.GeometricShapeType | GeometricShapeType} for more details. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + showAsStickyCallout?: boolean; + /** + * Specifies if the data label bubble size is visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showBubbleSize?: boolean; + /** + * Specifies if the data label category name is visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showCategoryName?: boolean; + /** + * Specifies if the data label legend key is visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showLegendKey?: boolean; + /** + * Specifies if the data label percentage is visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showPercentage?: boolean; + /** + * Specifies if the data label series name is visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showSeriesName?: boolean; + /** + * Specifies if the data label value is visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showValue?: boolean; + /** + * String representing the text of the data label on a chart. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + text?: string; + /** + * Represents the angle to which the text is oriented for the chart data label. + The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + textOrientation?: number; + /** + * Represents the distance, in points, from the top edge of chart data label to the top of chart area. Value is `null` if the chart data label is not visible. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + top?: number; + /** + * Represents the vertical alignment of chart data label. + See `Excel.ChartTextVerticalAlignment` for details. + This property is valid only when `TextOrientation` of data label is 0. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + verticalAlignment?: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"; + /** + * Returns the width, in points, of the chart data label. + Value is `null` if the chart data label is not visible. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + width?: number; + } + /** An interface describing the data returned by calling `chartDataLabelFormat.toJSON()`. */ + export interface ChartDataLabelFormatData { + /** + * Represents the border format, which includes color, linestyle, and weight. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + border?: Excel.Interfaces.ChartBorderData; + /** + * Represents the font attributes (such as font name, font size, and color) for a chart data label. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + font?: Excel.Interfaces.ChartFontData; + } + /** An interface describing the data returned by calling `chartDataLabelAnchor.toJSON()`. */ + export interface ChartDataLabelAnchorData { + /** + * Specifies the distance, in points, from the anchor to the left edge of the chart data label. + Note that when getting the value, it may differ slightly from the set value. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + left?: number; + /** + * Specifies the distance, in points, from the anchor to the top edge of the chart data label. + Note that when getting the value, it may differ slightly from the set value. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + top?: number; + } + /** An interface describing the data returned by calling `chartDataTable.toJSON()`. */ + export interface ChartDataTableData { + /** + * Represents the format of a chart data table, which includes fill, font, and border format. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + format?: Excel.Interfaces.ChartDataTableFormatData; + /** + * Specifies whether to display the horizontal border of the data table. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + showHorizontalBorder?: boolean; + /** + * Specifies whether to show the legend key of the data table. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + showLegendKey?: boolean; + /** + * Specifies whether to display the outline border of the data table. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + showOutlineBorder?: boolean; + /** + * Specifies whether to display the vertical border of the data table. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + showVerticalBorder?: boolean; + /** + * Specifies whether to show the data table of the chart. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + visible?: boolean; + } + /** An interface describing the data returned by calling `chartDataTableFormat.toJSON()`. */ + export interface ChartDataTableFormatData { + /** + * Represents the border format of chart data table, which includes color, line style, and weight. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + border?: Excel.Interfaces.ChartBorderData; + /** + * Represents the font attributes (such as font name, font size, and color) for the current object. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + font?: Excel.Interfaces.ChartFontData; + } + /** An interface describing the data returned by calling `chartErrorBars.toJSON()`. */ + export interface ChartErrorBarsData { + /** + * Specifies the formatting type of the error bars. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + format?: Excel.Interfaces.ChartErrorBarsFormatData; + /** + * Specifies if error bars have an end style cap. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + endStyleCap?: boolean; + /** + * Specifies which parts of the error bars to include. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + include?: Excel.ChartErrorBarsInclude | "Both" | "MinusValues" | "PlusValues"; + /** + * The type of range marked by the error bars. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + type?: Excel.ChartErrorBarsType | "FixedValue" | "Percent" | "StDev" | "StError" | "Custom"; + /** + * Specifies whether the error bars are displayed. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + visible?: boolean; + } + /** An interface describing the data returned by calling `chartErrorBarsFormat.toJSON()`. */ + export interface ChartErrorBarsFormatData { + /** + * Represents the chart line formatting. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + line?: Excel.Interfaces.ChartLineFormatData; + } + /** An interface describing the data returned by calling `chartGridlines.toJSON()`. */ + export interface ChartGridlinesData { + /** + * Represents the formatting of chart gridlines. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + format?: Excel.Interfaces.ChartGridlinesFormatData; + /** + * Specifies if the axis gridlines are visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + visible?: boolean; + } + /** An interface describing the data returned by calling `chartGridlinesFormat.toJSON()`. */ + export interface ChartGridlinesFormatData { + /** + * Represents chart line formatting. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + line?: Excel.Interfaces.ChartLineFormatData; + } + /** An interface describing the data returned by calling `chartLegend.toJSON()`. */ + export interface ChartLegendData { + /** + * Represents the formatting of a chart legend, which includes fill and font formatting. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + format?: Excel.Interfaces.ChartLegendFormatData; + /** + * Represents a collection of legendEntries in the legend. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + legendEntries?: Excel.Interfaces.ChartLegendEntryData[]; + /** + * Specifies the height, in points, of the legend on the chart. Value is `null` if the legend is not visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + height?: number; + /** + * Specifies the left value, in points, of the legend on the chart. Value is `null` if the legend is not visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + left?: number; + /** + * Specifies if the chart legend should overlap with the main body of the chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + overlay?: boolean; + /** + * Specifies the position of the legend on the chart. See `Excel.ChartLegendPosition` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + position?: Excel.ChartLegendPosition | "Invalid" | "Top" | "Bottom" | "Left" | "Right" | "Corner" | "Custom"; + /** + * Specifies if the legend has a shadow on the chart. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showShadow?: boolean; + /** + * Specifies the top of a chart legend. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + top?: number; + /** + * Specifies if the chart legend is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + visible?: boolean; + /** + * Specifies the width, in points, of the legend on the chart. Value is `null` if the legend is not visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + width?: number; + } + /** An interface describing the data returned by calling `chartLegendEntry.toJSON()`. */ + export interface ChartLegendEntryData { + /** + * Specifies the height of the legend entry on the chart legend. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + height?: number; + /** + * Specifies the index of the legend entry in the chart legend. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + index?: number; + /** + * Specifies the left value of a chart legend entry. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + left?: number; + /** + * Specifies the top of a chart legend entry. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + top?: number; + /** + * Represents the visibility of a chart legend entry. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + visible?: boolean; + /** + * Represents the width of the legend entry on the chart Legend. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + width?: number; + } + /** An interface describing the data returned by calling `chartLegendEntryCollection.toJSON()`. */ + export interface ChartLegendEntryCollectionData { + items?: Excel.Interfaces.ChartLegendEntryData[]; + } + /** An interface describing the data returned by calling `chartLegendFormat.toJSON()`. */ + export interface ChartLegendFormatData { + /** + * Represents the border format, which includes color, linestyle, and weight. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + border?: Excel.Interfaces.ChartBorderData; + /** + * Represents the font attributes such as font name, font size, and color of a chart legend. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + font?: Excel.Interfaces.ChartFontData; + } + /** An interface describing the data returned by calling `chartMapOptions.toJSON()`. */ + export interface ChartMapOptionsData { + /** + * Specifies the series map labels strategy of a region map chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + labelStrategy?: Excel.ChartMapLabelStrategy | "None" | "BestFit" | "ShowAll"; + /** + * Specifies the series mapping level of a region map chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + level?: Excel.ChartMapAreaLevel | "Automatic" | "DataOnly" | "City" | "County" | "State" | "Country" | "Continent" | "World"; + /** + * Specifies the series projection type of a region map chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + projectionType?: Excel.ChartMapProjectionType | "Automatic" | "Mercator" | "Miller" | "Robinson" | "Albers"; + } + /** An interface describing the data returned by calling `chartTitle.toJSON()`. */ + export interface ChartTitleData { + /** + * Represents the formatting of a chart title, which includes fill and font formatting. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + format?: Excel.Interfaces.ChartTitleFormatData; + /** + * Returns the height, in points, of the chart title. Value is `null` if the chart title is not visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + height?: number; + /** + * Specifies the horizontal alignment for chart title. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + horizontalAlignment?: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"; + /** + * Specifies the distance, in points, from the left edge of chart title to the left edge of chart area. Value is `null` if the chart title is not visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + left?: number; + /** + * Specifies if the chart title will overlay the chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + overlay?: boolean; + /** + * Represents the position of chart title. See `Excel.ChartTitlePosition` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + position?: Excel.ChartTitlePosition | "Automatic" | "Top" | "Bottom" | "Left" | "Right"; + /** + * Represents a boolean value that determines if the chart title has a shadow. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showShadow?: boolean; + /** + * Specifies the chart's title text. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + text?: string; + /** + * Specifies the angle to which the text is oriented for the chart title. The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + textOrientation?: number; + /** + * Specifies the distance, in points, from the top edge of chart title to the top of chart area. Value is `null` if the chart title is not visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + top?: number; + /** + * Specifies the vertical alignment of chart title. See `Excel.ChartTextVerticalAlignment` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + verticalAlignment?: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"; + /** + * Specifies if the chart title is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + visible?: boolean; + /** + * Specifies the width, in points, of the chart title. Value is `null` if the chart title is not visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + width?: number; + } + /** An interface describing the data returned by calling `chartFormatString.toJSON()`. */ + export interface ChartFormatStringData { + /** + * Represents the font attributes, such as font name, font size, and color of a chart characters object. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + font?: Excel.Interfaces.ChartFontData; + } + /** An interface describing the data returned by calling `chartTitleFormat.toJSON()`. */ + export interface ChartTitleFormatData { + /** + * Represents the border format of chart title, which includes color, linestyle, and weight. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + border?: Excel.Interfaces.ChartBorderData; + /** + * Represents the font attributes (such as font name, font size, and color) for an object. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + font?: Excel.Interfaces.ChartFontData; + } + /** An interface describing the data returned by calling `chartBorder.toJSON()`. */ + export interface ChartBorderData { + /** + * HTML color code representing the color of borders in the chart. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + color?: string; + /** + * Represents the line style of the border. See `Excel.ChartLineStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + lineStyle?: Excel.ChartLineStyle | "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot" | "Grey25" | "Grey50" | "Grey75" | "Automatic" | "RoundDot"; + /** + * Represents weight of the border, in points. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + weight?: number; + } + /** An interface describing the data returned by calling `chartBinOptions.toJSON()`. */ + export interface ChartBinOptionsData { + /** + * Specifies if bin overflow is enabled in a histogram chart or pareto chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + allowOverflow?: boolean; + /** + * Specifies if bin underflow is enabled in a histogram chart or pareto chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + allowUnderflow?: boolean; + /** + * Specifies the bin count of a histogram chart or pareto chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + count?: number; + /** + * Specifies the bin overflow value of a histogram chart or pareto chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + overflowValue?: number; + /** + * Specifies the bin's type for a histogram chart or pareto chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + type?: Excel.ChartBinType | "Category" | "Auto" | "BinWidth" | "BinCount"; + /** + * Specifies the bin underflow value of a histogram chart or pareto chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + underflowValue?: number; + /** + * Specifies the bin width value of a histogram chart or pareto chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + width?: number; + } + /** An interface describing the data returned by calling `chartBoxwhiskerOptions.toJSON()`. */ + export interface ChartBoxwhiskerOptionsData { + /** + * Specifies if the quartile calculation type of a box and whisker chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + quartileCalculation?: Excel.ChartBoxQuartileCalculation | "Inclusive" | "Exclusive"; + /** + * Specifies if inner points are shown in a box and whisker chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showInnerPoints?: boolean; + /** + * Specifies if the mean line is shown in a box and whisker chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showMeanLine?: boolean; + /** + * Specifies if the mean marker is shown in a box and whisker chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showMeanMarker?: boolean; + /** + * Specifies if outlier points are shown in a box and whisker chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showOutlierPoints?: boolean; + } + /** An interface describing the data returned by calling `chartLineFormat.toJSON()`. */ + export interface ChartLineFormatData { + /** + * HTML color code representing the color of lines in the chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + color?: string; + /** + * Represents the line style. See `Excel.ChartLineStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + lineStyle?: Excel.ChartLineStyle | "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot" | "Grey25" | "Grey50" | "Grey75" | "Automatic" | "RoundDot"; + /** + * Represents weight of the line, in points. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + weight?: number; + } + /** An interface describing the data returned by calling `chartFont.toJSON()`. */ + export interface ChartFontData { + /** + * Represents the bold status of font. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + bold?: boolean; + /** + * HTML color code representation of the text color (e.g., #FF0000 represents Red). + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + color?: string; + /** + * Represents the italic status of the font. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + italic?: boolean; + /** + * Font name (e.g., "Calibri") + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + name?: string; + /** + * Size of the font (e.g., 11) + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + size?: number; + /** + * Type of underline applied to the font. See `Excel.ChartUnderlineStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + underline?: Excel.ChartUnderlineStyle | "None" | "Single"; + } + /** An interface describing the data returned by calling `chartTrendline.toJSON()`. */ + export interface ChartTrendlineData { + /** + * Represents the formatting of a chart trendline. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + format?: Excel.Interfaces.ChartTrendlineFormatData; + /** + * Represents the label of a chart trendline. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + label?: Excel.Interfaces.ChartTrendlineLabelData; + /** + * Represents the number of periods that the trendline extends backward. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + backwardPeriod?: number; + /** + * Represents the number of periods that the trendline extends forward. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + forwardPeriod?: number; + /** + * Represents the intercept value of the trendline. Can be set to a numeric value or an empty string (for automatic values). The returned value is always a number. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + intercept?: any; + /** + * Represents the period of a chart trendline. Only applicable to trendlines with the type `MovingAverage`. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + movingAveragePeriod?: number; + /** + * Represents the name of the trendline. Can be set to a string value, a `null` value represents automatic values. The returned value is always a string + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + name?: string; + /** + * Represents the order of a chart trendline. Only applicable to trendlines with the type `Polynomial`. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + polynomialOrder?: number; + /** + * True if the equation for the trendline is displayed on the chart. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showEquation?: boolean; + /** + * True if the r-squared value for the trendline is displayed on the chart. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showRSquared?: boolean; + /** + * Represents the type of a chart trendline. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + type?: Excel.ChartTrendlineType | "Linear" | "Exponential" | "Logarithmic" | "MovingAverage" | "Polynomial" | "Power"; + } + /** An interface describing the data returned by calling `chartTrendlineCollection.toJSON()`. */ + export interface ChartTrendlineCollectionData { + items?: Excel.Interfaces.ChartTrendlineData[]; + } + /** An interface describing the data returned by calling `chartTrendlineFormat.toJSON()`. */ + export interface ChartTrendlineFormatData { + /** + * Represents chart line formatting. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + line?: Excel.Interfaces.ChartLineFormatData; + } + /** An interface describing the data returned by calling `chartTrendlineLabel.toJSON()`. */ + export interface ChartTrendlineLabelData { + /** + * The format of the chart trendline label. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + format?: Excel.Interfaces.ChartTrendlineLabelFormatData; + /** + * Specifies if the trendline label automatically generates appropriate text based on context. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + autoText?: boolean; + /** + * String value that represents the formula of the chart trendline label using A1-style notation. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + formula?: string; + /** + * Returns the height, in points, of the chart trendline label. Value is `null` if the chart trendline label is not visible. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + height?: number; + /** + * Represents the horizontal alignment of the chart trendline label. See `Excel.ChartTextHorizontalAlignment` for details. + This property is valid only when `TextOrientation` of a trendline label is -90, 90, or 180. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + horizontalAlignment?: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"; + /** + * Represents the distance, in points, from the left edge of the chart trendline label to the left edge of the chart area. Value is `null` if the chart trendline label is not visible. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + left?: number; + /** + * Specifies if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + linkNumberFormat?: boolean; + /** + * String value that represents the format code for the trendline label. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + numberFormat?: string; + /** + * String representing the text of the trendline label on a chart. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + text?: string; + /** + * Represents the angle to which the text is oriented for the chart trendline label. The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + textOrientation?: number; + /** + * Represents the distance, in points, from the top edge of the chart trendline label to the top of the chart area. Value is `null` if the chart trendline label is not visible. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + top?: number; + /** + * Represents the vertical alignment of the chart trendline label. See `Excel.ChartTextVerticalAlignment` for details. + This property is valid only when `TextOrientation` of a trendline label is 0. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + verticalAlignment?: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"; + /** + * Returns the width, in points, of the chart trendline label. Value is `null` if the chart trendline label is not visible. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + width?: number; + } + /** An interface describing the data returned by calling `chartTrendlineLabelFormat.toJSON()`. */ + export interface ChartTrendlineLabelFormatData { + /** + * Specifies the border format, which includes color, linestyle, and weight. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + border?: Excel.Interfaces.ChartBorderData; + /** + * Specifies the font attributes (such as font name, font size, and color) for a chart trendline label. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + font?: Excel.Interfaces.ChartFontData; + } + /** An interface describing the data returned by calling `chartPlotArea.toJSON()`. */ + export interface ChartPlotAreaData { + /** + * Specifies the formatting of a chart plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + format?: Excel.Interfaces.ChartPlotAreaFormatData; + /** + * Specifies the height value of a plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + height?: number; + /** + * Specifies the inside height value of a plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + insideHeight?: number; + /** + * Specifies the inside left value of a plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + insideLeft?: number; + /** + * Specifies the inside top value of a plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + insideTop?: number; + /** + * Specifies the inside width value of a plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + insideWidth?: number; + /** + * Specifies the left value of a plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + left?: number; + /** + * Specifies the position of a plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + position?: Excel.ChartPlotAreaPosition | "Automatic" | "Custom"; + /** + * Specifies the top value of a plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + top?: number; + /** + * Specifies the width value of a plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + width?: number; + } + /** An interface describing the data returned by calling `chartPlotAreaFormat.toJSON()`. */ + export interface ChartPlotAreaFormatData { + /** + * Specifies the border attributes of a chart plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + border?: Excel.Interfaces.ChartBorderData; + } + /** An interface describing the data returned by calling `chartLeaderLines.toJSON()`. */ + export interface ChartLeaderLinesData { + /** + * Represents the formatting of leader lines of data labels in a series. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + format?: Excel.Interfaces.ChartLeaderLinesFormatData; + } + /** An interface describing the data returned by calling `chartLeaderLinesFormat.toJSON()`. */ + export interface ChartLeaderLinesFormatData { + /** + * Gets an object that represents the line formatting of chart leader lines. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + line?: Excel.Interfaces.ChartLineFormatData; + } + /** An interface describing the data returned by calling `tableSort.toJSON()`. */ + export interface TableSortData { + /** + * Specifies the current conditions used to last sort the table. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + fields?: Excel.SortField[]; + /** + * Specifies if the casing impacts the last sort of the table. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + matchCase?: boolean; + /** + * Represents the Chinese character ordering method last used to sort the table. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + method?: Excel.SortMethod | "PinYin" | "StrokeCount"; + } + /** An interface describing the data returned by calling `filter.toJSON()`. */ + export interface FilterData { + /** + * The currently applied filter on the given column. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + criteria?: Excel.FilterCriteria; + } + /** An interface describing the data returned by calling `autoFilter.toJSON()`. */ + export interface AutoFilterData { + /** + * An array that holds all the filter criteria in the autofiltered range. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + criteria?: Excel.FilterCriteria[]; + /** + * Specifies if the AutoFilter is enabled. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enabled?: boolean; + /** + * Specifies if the AutoFilter has filter criteria. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + isDataFiltered?: boolean; + } + /** An interface describing the data returned by calling `cultureInfo.toJSON()`. */ + export interface CultureInfoData { + /** + * Defines the culturally appropriate format of displaying date and time. This is based on current system culture settings. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + datetimeFormat?: Excel.Interfaces.DatetimeFormatInfoData; + /** + * Defines the culturally appropriate format of displaying numbers. This is based on current system culture settings. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + numberFormat?: Excel.Interfaces.NumberFormatInfoData; + /** + * Gets the culture name in the format languagecode2-country/regioncode2 (e.g., "zh-cn" or "en-us"). This is based on current system settings. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + name?: string; + } + /** An interface describing the data returned by calling `numberFormatInfo.toJSON()`. */ + export interface NumberFormatInfoData { + /** + * Gets the currency symbol for currency values. This is based on current system settings. + * + * @remarks + * [Api set: ExcelApi 1.17] + */ + currencySymbol?: string; + /** + * Gets the string used as the decimal separator for numeric values. This is based on current system settings. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + numberDecimalSeparator?: string; + /** + * Gets the string used to separate groups of digits to the left of the decimal for numeric values. This is based on current system settings. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + numberGroupSeparator?: string; + } + /** An interface describing the data returned by calling `datetimeFormatInfo.toJSON()`. */ + export interface DatetimeFormatInfoData { + /** + * Gets the string used as the date separator. This is based on current system settings. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + dateSeparator?: string; + /** + * Gets the format string for a long date value. This is based on current system settings. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + longDatePattern?: string; + /** + * Gets the format string for a long time value. This is based on current system settings. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + longTimePattern?: string; + /** + * Gets the format string for a short date value. This is based on current system settings. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + shortDatePattern?: string; + /** + * Gets the string used as the time separator. This is based on current system settings. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + timeSeparator?: string; + } + /** An interface describing the data returned by calling `customXmlPartScopedCollection.toJSON()`. */ + export interface CustomXmlPartScopedCollectionData { + items?: Excel.Interfaces.CustomXmlPartData[]; + } + /** An interface describing the data returned by calling `customXmlPartCollection.toJSON()`. */ + export interface CustomXmlPartCollectionData { + items?: Excel.Interfaces.CustomXmlPartData[]; + } + /** An interface describing the data returned by calling `customXmlPart.toJSON()`. */ + export interface CustomXmlPartData { + /** + * The custom XML part's ID. + * + * @remarks + * [Api set: ExcelApi 1.5] + */ + id?: string; + /** + * The custom XML part's namespace URI. + * + * @remarks + * [Api set: ExcelApi 1.5] + */ + namespaceUri?: string; + } + /** An interface describing the data returned by calling `pivotTableScopedCollection.toJSON()`. */ + export interface PivotTableScopedCollectionData { + items?: Excel.Interfaces.PivotTableData[]; + } + /** An interface describing the data returned by calling `pivotTableCollection.toJSON()`. */ + export interface PivotTableCollectionData { + items?: Excel.Interfaces.PivotTableData[]; + } + /** An interface describing the data returned by calling `pivotTable.toJSON()`. */ + export interface PivotTableData { + /** + * The Column Pivot Hierarchies of the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + columnHierarchies?: Excel.Interfaces.RowColumnPivotHierarchyData[]; + /** + * The Data Pivot Hierarchies of the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + dataHierarchies?: Excel.Interfaces.DataPivotHierarchyData[]; + /** + * The Filter Pivot Hierarchies of the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + filterHierarchies?: Excel.Interfaces.FilterPivotHierarchyData[]; + /** + * The Pivot Hierarchies of the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + hierarchies?: Excel.Interfaces.PivotHierarchyData[]; + /** + * The Row Pivot Hierarchies of the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + rowHierarchies?: Excel.Interfaces.RowColumnPivotHierarchyData[]; + /** + * Specifies if the PivotTable allows the application of multiple PivotFilters on a given PivotField in the table. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + allowMultipleFiltersPerField?: boolean; + /** + * Specifies if the PivotTable allows values in the data body to be edited by the user. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enableDataValueEditing?: boolean; + /** + * ID of the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.5] + */ + id?: string; + /** + * Name of the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + name?: string; + /** + * Specifies whether the PivotTable refreshes when the workbook opens. Corresponds to "Refresh on load" setting in the UI. + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + refreshOnOpen?: boolean; + /** + * Specifies if the PivotTable uses custom lists when sorting. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + useCustomSortLists?: boolean; + } + /** An interface describing the data returned by calling `pivotLayout.toJSON()`. */ + export interface PivotLayoutData { + /** + * The alt text description of the PivotTable. + + Alt text provides alternative, text-based representations of the information contained in the PivotTable. + This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table. + A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content. + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + altTextDescription?: string; + /** + * The alt text title of the PivotTable. + + Alt text provides alternative, text-based representations of the information contained in the PivotTable. + This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table. + A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content. + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + altTextTitle?: string; + /** + * Specifies if formatting will be automatically formatted when it's refreshed or when fields are moved. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + autoFormat?: boolean; + /** + * The text that is automatically filled into any empty cell in the PivotTable if `fillEmptyCells == true`. + Note that this value persists if `fillEmptyCells` is set to `false`, and that setting this value does not set that property to `true`. + By default, this is an empty string. + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + emptyCellText?: string; + /** + * Specifies if the field list can be shown in the UI. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + enableFieldList?: boolean; + /** + * Specifies whether empty cells in the PivotTable should be populated with the `emptyCellText`. Default is `false`. + Note that the value of `emptyCellText` persists when this property is set to `false`. + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + fillEmptyCells?: boolean; + /** + * This property indicates the PivotLayoutType of all fields on the PivotTable. + If fields have different states, this will be null. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + layoutType?: Excel.PivotLayoutType | "Compact" | "Tabular" | "Outline"; + /** + * Specifies if formatting is preserved when the report is refreshed or recalculated by operations such as pivoting, sorting, or changing page field items. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + preserveFormatting?: boolean; + /** + * Specifies if the PivotTable report shows grand totals for columns. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showColumnGrandTotals?: boolean; + /** + * Specifies whether the PivotTable displays field headers (field captions and filter drop-downs). + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + showFieldHeaders?: boolean; + /** + * Specifies if the PivotTable report shows grand totals for rows. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showRowGrandTotals?: boolean; + /** + * This property indicates the `SubtotalLocationType` of all fields on the PivotTable. + If fields have different states, this will be `null`. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + subtotalLocation?: Excel.SubtotalLocationType | "AtTop" | "AtBottom" | "Off"; + } + /** An interface describing the data returned by calling `pivotHierarchyCollection.toJSON()`. */ + export interface PivotHierarchyCollectionData { + items?: Excel.Interfaces.PivotHierarchyData[]; + } + /** An interface describing the data returned by calling `pivotHierarchy.toJSON()`. */ + export interface PivotHierarchyData { + /** + * Returns the PivotFields associated with the PivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + fields?: Excel.Interfaces.PivotFieldData[]; + /** + * ID of the PivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + id?: string; + /** + * Name of the PivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + name?: string; + } + /** An interface describing the data returned by calling `rowColumnPivotHierarchyCollection.toJSON()`. */ + export interface RowColumnPivotHierarchyCollectionData { + items?: Excel.Interfaces.RowColumnPivotHierarchyData[]; + } + /** An interface describing the data returned by calling `rowColumnPivotHierarchy.toJSON()`. */ + export interface RowColumnPivotHierarchyData { + /** + * Returns the PivotFields associated with the RowColumnPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + fields?: Excel.Interfaces.PivotFieldData[]; + /** + * ID of the RowColumnPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + id?: string; + /** + * Name of the RowColumnPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + name?: string; + /** + * Position of the RowColumnPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + position?: number; + } + /** An interface describing the data returned by calling `filterPivotHierarchyCollection.toJSON()`. */ + export interface FilterPivotHierarchyCollectionData { + items?: Excel.Interfaces.FilterPivotHierarchyData[]; + } + /** An interface describing the data returned by calling `filterPivotHierarchy.toJSON()`. */ + export interface FilterPivotHierarchyData { + /** + * Returns the PivotFields associated with the FilterPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + fields?: Excel.Interfaces.PivotFieldData[]; + /** + * Determines whether to allow multiple filter items. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + enableMultipleFilterItems?: boolean; + /** + * ID of the FilterPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + id?: string; + /** + * Name of the FilterPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + name?: string; + /** + * Position of the FilterPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + position?: number; + } + /** An interface describing the data returned by calling `dataPivotHierarchyCollection.toJSON()`. */ + export interface DataPivotHierarchyCollectionData { + items?: Excel.Interfaces.DataPivotHierarchyData[]; + } + /** An interface describing the data returned by calling `dataPivotHierarchy.toJSON()`. */ + export interface DataPivotHierarchyData { + /** + * Returns the PivotFields associated with the DataPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + field?: Excel.Interfaces.PivotFieldData; + /** + * ID of the DataPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + id?: string; + /** + * Name of the DataPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + name?: string; + /** + * Number format of the DataPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + numberFormat?: string; + /** + * Position of the DataPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + position?: number; + /** + * Specifies if the data should be shown as a specific summary calculation. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showAs?: Excel.ShowAsRule; + /** + * Specifies if all items of the DataPivotHierarchy are shown. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + summarizeBy?: Excel.AggregationFunction | "Unknown" | "Automatic" | "Sum" | "Count" | "Average" | "Max" | "Min" | "Product" | "CountNumbers" | "StandardDeviation" | "StandardDeviationP" | "Variance" | "VarianceP"; + } + /** An interface describing the data returned by calling `pivotFieldCollection.toJSON()`. */ + export interface PivotFieldCollectionData { + items?: Excel.Interfaces.PivotFieldData[]; + } + /** An interface describing the data returned by calling `pivotField.toJSON()`. */ + export interface PivotFieldData { + /** + * Returns the PivotItems associated with the PivotField. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + items?: Excel.Interfaces.PivotItemData[]; + /** + * ID of the PivotField. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + id?: string; + /** + * Name of the PivotField. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + name?: string; + /** + * Determines whether to show all items of the PivotField. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showAllItems?: boolean; + /** + * Subtotals of the PivotField. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + subtotals?: Excel.Subtotals; + } + /** An interface describing the data returned by calling `pivotItemCollection.toJSON()`. */ + export interface PivotItemCollectionData { + items?: Excel.Interfaces.PivotItemData[]; + } + /** An interface describing the data returned by calling `pivotItem.toJSON()`. */ + export interface PivotItemData { + /** + * ID of the PivotItem. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + id?: string; + /** + * Determines whether the item is expanded to show child items or if it's collapsed and child items are hidden. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + isExpanded?: boolean; + /** + * Name of the PivotItem. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + name?: string; + /** + * Specifies if the PivotItem is visible. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + visible?: boolean; + } + /** An interface describing the data returned by calling `worksheetCustomProperty.toJSON()`. */ + export interface WorksheetCustomPropertyData { + /** + * Gets the key of the custom property. Custom property keys are case-insensitive. The key is limited to 255 characters (larger values will cause an `InvalidArgument` error to be thrown.) + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + key?: string; + /** + * Gets or sets the value of the custom property. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + value?: string; + } + /** An interface describing the data returned by calling `worksheetCustomPropertyCollection.toJSON()`. */ + export interface WorksheetCustomPropertyCollectionData { + items?: Excel.Interfaces.WorksheetCustomPropertyData[]; + } + /** An interface describing the data returned by calling `documentProperties.toJSON()`. */ + export interface DocumentPropertiesData { + /** + * Gets the collection of custom properties of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + custom?: Excel.Interfaces.CustomPropertyData[]; + /** + * The author of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + author?: string; + /** + * The category of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + category?: string; + /** + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + comments?: string; + /** + * The company of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + company?: string; + /** + * Gets the creation date of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + creationDate?: Date; + /** + * The keywords of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + keywords?: string; + /** + * Gets the last author of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + lastAuthor?: string; + /** + * The manager of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + manager?: string; + /** + * Gets the revision number of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + revisionNumber?: number; + /** + * The subject of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + subject?: string; + /** + * The title of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + title?: string; + } + /** An interface describing the data returned by calling `customProperty.toJSON()`. */ + export interface CustomPropertyData { + /** + * The key of the custom property. The key is limited to 255 characters outside of Excel on the web (larger keys are automatically trimmed to 255 characters on other platforms). + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + key?: string; + /** + * The type of the value used for the custom property. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + type?: Excel.DocumentPropertyType | "Number" | "Boolean" | "Date" | "String" | "Float"; + /** + * The value of the custom property. The value is limited to 255 characters outside of Excel on the web (larger values are automatically trimmed to 255 characters on other platforms). + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + value?: any; + } + /** An interface describing the data returned by calling `customPropertyCollection.toJSON()`. */ + export interface CustomPropertyCollectionData { + items?: Excel.Interfaces.CustomPropertyData[]; + } + /** An interface describing the data returned by calling `conditionalFormatCollection.toJSON()`. */ + export interface ConditionalFormatCollectionData { + items?: Excel.Interfaces.ConditionalFormatData[]; + } + /** An interface describing the data returned by calling `conditionalFormat.toJSON()`. */ + export interface ConditionalFormatData { + /** + * Returns the cell value conditional format properties if the current conditional format is a `CellValue` type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + cellValue?: Excel.Interfaces.CellValueConditionalFormatData; + /** + * Returns the cell value conditional format properties if the current conditional format is a `CellValue` type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + cellValueOrNullObject?: Excel.Interfaces.CellValueConditionalFormatData; + /** + * Returns the color scale conditional format properties if the current conditional format is a `ColorScale` type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + colorScale?: Excel.Interfaces.ColorScaleConditionalFormatData; + /** + * Returns the color scale conditional format properties if the current conditional format is a `ColorScale` type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + colorScaleOrNullObject?: Excel.Interfaces.ColorScaleConditionalFormatData; + /** + * Returns the custom conditional format properties if the current conditional format is a custom type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + custom?: Excel.Interfaces.CustomConditionalFormatData; + /** + * Returns the custom conditional format properties if the current conditional format is a custom type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + customOrNullObject?: Excel.Interfaces.CustomConditionalFormatData; + /** + * Returns the data bar properties if the current conditional format is a data bar. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + dataBar?: Excel.Interfaces.DataBarConditionalFormatData; + /** + * Returns the data bar properties if the current conditional format is a data bar. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + dataBarOrNullObject?: Excel.Interfaces.DataBarConditionalFormatData; + /** + * Returns the icon set conditional format properties if the current conditional format is an `IconSet` type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + iconSet?: Excel.Interfaces.IconSetConditionalFormatData; + /** + * Returns the icon set conditional format properties if the current conditional format is an `IconSet` type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + iconSetOrNullObject?: Excel.Interfaces.IconSetConditionalFormatData; + /** + * Returns the preset criteria conditional format. See `Excel.PresetCriteriaConditionalFormat` for more details. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + preset?: Excel.Interfaces.PresetCriteriaConditionalFormatData; + /** + * Returns the preset criteria conditional format. See `Excel.PresetCriteriaConditionalFormat` for more details. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + presetOrNullObject?: Excel.Interfaces.PresetCriteriaConditionalFormatData; + /** + * Returns the specific text conditional format properties if the current conditional format is a text type. + For example, to format cells matching the word "Text". + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + textComparison?: Excel.Interfaces.TextConditionalFormatData; + /** + * Returns the specific text conditional format properties if the current conditional format is a text type. + For example, to format cells matching the word "Text". + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + textComparisonOrNullObject?: Excel.Interfaces.TextConditionalFormatData; + /** + * Returns the top/bottom conditional format properties if the current conditional format is a `TopBottom` type. + For example, to format the top 10% or bottom 10 items. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + topBottom?: Excel.Interfaces.TopBottomConditionalFormatData; + /** + * Returns the top/bottom conditional format properties if the current conditional format is a `TopBottom` type. + For example, to format the top 10% or bottom 10 items. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + topBottomOrNullObject?: Excel.Interfaces.TopBottomConditionalFormatData; + /** + * The priority of the conditional format in the current `ConditionalFormatCollection`. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + id?: string; + /** + * The priority (or index) within the conditional format collection that this conditional format currently exists in. Changing this also + changes other conditional formats' priorities, to allow for a contiguous priority order. + Use a negative priority to begin from the back. + Priorities greater than the bounds will get and set to the maximum (or minimum if negative) priority. + Also note that if you change the priority, you have to re-fetch a new copy of the object at that new priority location if you want to make further changes to it. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + priority?: number; + /** + * If the conditions of this conditional format are met, no lower-priority formats shall take effect on that cell. + Value is `null` on data bars, icon sets, and color scales as there's no concept of `StopIfTrue` for these. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + stopIfTrue?: boolean; + /** + * A type of conditional format. Only one can be set at a time. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + type?: Excel.ConditionalFormatType | "Custom" | "DataBar" | "ColorScale" | "IconSet" | "TopBottom" | "PresetCriteria" | "ContainsText" | "CellValue"; + } + /** An interface describing the data returned by calling `dataBarConditionalFormat.toJSON()`. */ + export interface DataBarConditionalFormatData { + /** + * Representation of all values to the left of the axis in an Excel data bar. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + negativeFormat?: Excel.Interfaces.ConditionalDataBarNegativeFormatData; + /** + * Representation of all values to the right of the axis in an Excel data bar. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + positiveFormat?: Excel.Interfaces.ConditionalDataBarPositiveFormatData; + /** + * HTML color code representing the color of the Axis line, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + Value is "" (an empty string) if no axis is present or set. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + axisColor?: string; + /** + * Representation of how the axis is determined for an Excel data bar. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + axisFormat?: Excel.ConditionalDataBarAxisFormat | "Automatic" | "None" | "CellMidPoint"; + /** + * Specifies the direction that the data bar graphic should be based on. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + barDirection?: Excel.ConditionalDataBarDirection | "Context" | "LeftToRight" | "RightToLeft"; + /** + * The rule for what constitutes the lower bound (and how to calculate it, if applicable) for a data bar. + The `ConditionalDataBarRule` object must be set as a JSON object (use `x.lowerBoundRule = {...}` instead of `x.lowerBoundRule.formula = ...`). + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + lowerBoundRule?: Excel.ConditionalDataBarRule; + /** + * If `true`, hides the values from the cells where the data bar is applied. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + showDataBarOnly?: boolean; + /** + * The rule for what constitutes the upper bound (and how to calculate it, if applicable) for a data bar. + The `ConditionalDataBarRule` object must be set as a JSON object (use `x.upperBoundRule = {...}` instead of `x.upperBoundRule.formula = ...`). + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + upperBoundRule?: Excel.ConditionalDataBarRule; + } + /** An interface describing the data returned by calling `conditionalDataBarPositiveFormat.toJSON()`. */ + export interface ConditionalDataBarPositiveFormatData { + /** + * HTML color code representing the color of the border line, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + Value is "" (an empty string) if no border is present or set. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + borderColor?: string; + /** + * HTML color code representing the fill color, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + fillColor?: string; + /** + * Specifies if the data bar has a gradient. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + gradientFill?: boolean; + } + /** An interface describing the data returned by calling `conditionalDataBarNegativeFormat.toJSON()`. */ + export interface ConditionalDataBarNegativeFormatData { + /** + * HTML color code representing the color of the border line, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + Value is "" (an empty string) if no border is present or set. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + borderColor?: string; + /** + * HTML color code representing the fill color, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + fillColor?: string; + /** + * Specifies if the negative data bar has the same border color as the positive data bar. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + matchPositiveBorderColor?: boolean; + /** + * Specifies if the negative data bar has the same fill color as the positive data bar. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + matchPositiveFillColor?: boolean; + } + /** An interface describing the data returned by calling `customConditionalFormat.toJSON()`. */ + export interface CustomConditionalFormatData { + /** + * Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + format?: Excel.Interfaces.ConditionalRangeFormatData; + /** + * Specifies the `Rule` object on this conditional format. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + rule?: Excel.Interfaces.ConditionalFormatRuleData; + } + /** An interface describing the data returned by calling `conditionalFormatRule.toJSON()`. */ + export interface ConditionalFormatRuleData { + /** + * The formula, if required, on which to evaluate the conditional format rule. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + formula?: string; + /** + * The formula, if required, on which to evaluate the conditional format rule in the user's language. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + formulaLocal?: string; + /** + * The formula, if required, on which to evaluate the conditional format rule in R1C1-style notation. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + formulaR1C1?: string; + } + /** An interface describing the data returned by calling `iconSetConditionalFormat.toJSON()`. */ + export interface IconSetConditionalFormatData { + /** + * An array of criteria and icon sets for the rules and potential custom icons for conditional icons. Note that for the first criterion only the custom icon can be modified, while type, formula, and operator will be ignored when set. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + criteria?: Excel.ConditionalIconCriterion[]; + /** + * If `true`, reverses the icon orders for the icon set. Note that this cannot be set if custom icons are used. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + reverseIconOrder?: boolean; + /** + * If `true`, hides the values and only shows icons. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + showIconOnly?: boolean; + /** + * If set, displays the icon set option for the conditional format. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + style?: Excel.IconSet | "Invalid" | "ThreeArrows" | "ThreeArrowsGray" | "ThreeFlags" | "ThreeTrafficLights1" | "ThreeTrafficLights2" | "ThreeSigns" | "ThreeSymbols" | "ThreeSymbols2" | "FourArrows" | "FourArrowsGray" | "FourRedToBlack" | "FourRating" | "FourTrafficLights" | "FiveArrows" | "FiveArrowsGray" | "FiveRating" | "FiveQuarters" | "ThreeStars" | "ThreeTriangles" | "FiveBoxes"; + } + /** An interface describing the data returned by calling `colorScaleConditionalFormat.toJSON()`. */ + export interface ColorScaleConditionalFormatData { + /** + * The criteria of the color scale. Midpoint is optional when using a two point color scale. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + criteria?: Excel.ConditionalColorScaleCriteria; + /** + * If `true`, the color scale will have three points (minimum, midpoint, maximum), otherwise it will have two (minimum, maximum). + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + threeColorScale?: boolean; + } + /** An interface describing the data returned by calling `topBottomConditionalFormat.toJSON()`. */ + export interface TopBottomConditionalFormatData { + /** + * Returns a format object, encapsulating the conditional format's font, fill, borders, and other properties. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + format?: Excel.Interfaces.ConditionalRangeFormatData; + /** + * The criteria of the top/bottom conditional format. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + rule?: Excel.ConditionalTopBottomRule; + } + /** An interface describing the data returned by calling `presetCriteriaConditionalFormat.toJSON()`. */ + export interface PresetCriteriaConditionalFormatData { + /** + * Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + format?: Excel.Interfaces.ConditionalRangeFormatData; + /** + * The rule of the conditional format. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + rule?: Excel.ConditionalPresetCriteriaRule; + } + /** An interface describing the data returned by calling `textConditionalFormat.toJSON()`. */ + export interface TextConditionalFormatData { + /** + * Returns a format object, encapsulating the conditional format's font, fill, borders, and other properties. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + format?: Excel.Interfaces.ConditionalRangeFormatData; + /** + * The rule of the conditional format. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + rule?: Excel.ConditionalTextComparisonRule; + } + /** An interface describing the data returned by calling `cellValueConditionalFormat.toJSON()`. */ + export interface CellValueConditionalFormatData { + /** + * Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + format?: Excel.Interfaces.ConditionalRangeFormatData; + /** + * Specifies the rule object on this conditional format. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + rule?: Excel.ConditionalCellValueRule; + } + /** An interface describing the data returned by calling `conditionalRangeFormat.toJSON()`. */ + export interface ConditionalRangeFormatData { + /** + * Collection of border objects that apply to the overall conditional format range. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + borders?: Excel.Interfaces.ConditionalRangeBorderData[]; + /** + * Returns the fill object defined on the overall conditional format range. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + fill?: Excel.Interfaces.ConditionalRangeFillData; + /** + * Returns the font object defined on the overall conditional format range. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + font?: Excel.Interfaces.ConditionalRangeFontData; + /** + * Represents Excel's number format code for the given range. For more information about Excel number formatting, see {@link https://support.microsoft.com/office/5026bbd6-04bc-48cd-bf33-80f18b4eae68 | Number format codes}. + Cleared if `null` is passed in. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + numberFormat?: any; + } + /** An interface describing the data returned by calling `conditionalRangeFont.toJSON()`. */ + export interface ConditionalRangeFontData { + /** + * Specifies if the font is bold. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + bold?: boolean; + /** + * HTML color code representation of the text color (e.g., #FF0000 represents Red). + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + color?: string; + /** + * Specifies if the font is italic. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + italic?: boolean; + /** + * Specifies the strikethrough status of the font. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + strikethrough?: boolean; + /** + * The type of underline applied to the font. See `Excel.ConditionalRangeFontUnderlineStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + underline?: Excel.ConditionalRangeFontUnderlineStyle | "None" | "Single" | "Double"; + } + /** An interface describing the data returned by calling `conditionalRangeFill.toJSON()`. */ + export interface ConditionalRangeFillData { + /** + * HTML color code representing the color of the fill, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + color?: string; + } + /** An interface describing the data returned by calling `conditionalRangeBorder.toJSON()`. */ + export interface ConditionalRangeBorderData { + /** + * HTML color code representing the color of the border line, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + color?: string; + /** + * Constant value that indicates the specific side of the border. See `Excel.ConditionalRangeBorderIndex` for details. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + sideIndex?: Excel.ConditionalRangeBorderIndex | "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight"; + /** + * One of the constants of line style specifying the line style for the border. See `Excel.BorderLineStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + style?: Excel.ConditionalRangeBorderLineStyle | "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot"; + } + /** An interface describing the data returned by calling `conditionalRangeBorderCollection.toJSON()`. */ + export interface ConditionalRangeBorderCollectionData { + items?: Excel.Interfaces.ConditionalRangeBorderData[]; + } + /** An interface describing the data returned by calling `customFunctionManager.toJSON()`. */ + export interface CustomFunctionManagerData { + } + /** An interface describing the data returned by calling `style.toJSON()`. */ + export interface StyleData { + /** + * A collection of four border objects that represent the style of the four borders. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + borders?: Excel.Interfaces.RangeBorderData[]; + /** + * The fill of the style. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + fill?: Excel.Interfaces.RangeFillData; + /** + * A `Font` object that represents the font of the style. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + font?: Excel.Interfaces.RangeFontData; + /** + * Specifies if text is automatically indented when the text alignment in a cell is set to equal distribution. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + autoIndent?: boolean; + /** + * Specifies if the style is a built-in style. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + builtIn?: boolean; + /** + * Specifies if the formula will be hidden when the worksheet is protected. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + formulaHidden?: boolean; + /** + * Represents the horizontal alignment for the style. See `Excel.HorizontalAlignment` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + horizontalAlignment?: Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed"; + /** + * Specifies if the style includes the auto indent, horizontal alignment, vertical alignment, wrap text, indent level, and text orientation properties. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + includeAlignment?: boolean; + /** + * Specifies if the style includes the color, color index, line style, and weight border properties. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + includeBorder?: boolean; + /** + * Specifies if the style includes the background, bold, color, color index, font style, italic, name, size, strikethrough, subscript, superscript, and underline font properties. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + includeFont?: boolean; + /** + * Specifies if the style includes the number format property. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + includeNumber?: boolean; + /** + * Specifies if the style includes the color, color index, invert if negative, pattern, pattern color, and pattern color index interior properties. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + includePatterns?: boolean; + /** + * Specifies if the style includes the formula hidden and locked protection properties. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + includeProtection?: boolean; + /** + * An integer from 0 to 250 that indicates the indent level for the style. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + indentLevel?: number; + /** + * Specifies if the object is locked when the worksheet is protected. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + locked?: boolean; + /** + * The name of the style. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + name?: string; + /** + * The format code of the number format for the style. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + numberFormat?: string; + /** + * The localized format code of the number format for the style. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + numberFormatLocal?: string; + /** + * The reading order for the style. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readingOrder?: Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft"; + /** + * Specifies if text automatically shrinks to fit in the available column width. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + shrinkToFit?: boolean; + /** + * The text orientation for the style. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + textOrientation?: number; + /** + * Specifies the vertical alignment for the style. See `Excel.VerticalAlignment` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + verticalAlignment?: Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed"; + /** + * Specifies if Excel wraps the text in the object. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + wrapText?: boolean; + } + /** An interface describing the data returned by calling `styleCollection.toJSON()`. */ + export interface StyleCollectionData { + items?: Excel.Interfaces.StyleData[]; + } + /** An interface describing the data returned by calling `tableStyleCollection.toJSON()`. */ + export interface TableStyleCollectionData { + items?: Excel.Interfaces.TableStyleData[]; + } + /** An interface describing the data returned by calling `tableStyle.toJSON()`. */ + export interface TableStyleData { + /** + * Specifies the name of the table style. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + name?: string; + /** + * Specifies if this `TableStyle` object is read-only. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readOnly?: boolean; + } + /** An interface describing the data returned by calling `pivotTableStyleCollection.toJSON()`. */ + export interface PivotTableStyleCollectionData { + items?: Excel.Interfaces.PivotTableStyleData[]; + } + /** An interface describing the data returned by calling `pivotTableStyle.toJSON()`. */ + export interface PivotTableStyleData { + /** + * Specifies the name of the PivotTable style. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + name?: string; + /** + * Specifies if this `PivotTableStyle` object is read-only. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readOnly?: boolean; + } + /** An interface describing the data returned by calling `slicerStyleCollection.toJSON()`. */ + export interface SlicerStyleCollectionData { + items?: Excel.Interfaces.SlicerStyleData[]; + } + /** An interface describing the data returned by calling `slicerStyle.toJSON()`. */ + export interface SlicerStyleData { + /** + * Specifies the name of the slicer style. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + name?: string; + /** + * Specifies if this `SlicerStyle` object is read-only. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readOnly?: boolean; + } + /** An interface describing the data returned by calling `timelineStyleCollection.toJSON()`. */ + export interface TimelineStyleCollectionData { + items?: Excel.Interfaces.TimelineStyleData[]; + } + /** An interface describing the data returned by calling `timelineStyle.toJSON()`. */ + export interface TimelineStyleData { + /** + * Specifies the name of the timeline style. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + name?: string; + /** + * Specifies if this `TimelineStyle` object is read-only. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readOnly?: boolean; + } + /** An interface describing the data returned by calling `pageLayout.toJSON()`. */ + export interface PageLayoutData { + /** + * Header and footer configuration for the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + headersFooters?: Excel.Interfaces.HeaderFooterGroupData; + /** + * The worksheet's black and white print option. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + blackAndWhite?: boolean; + /** + * The worksheet's bottom page margin to use for printing in points. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + bottomMargin?: number; + /** + * The worksheet's center horizontally flag. This flag determines whether the worksheet will be centered horizontally when it's printed. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + centerHorizontally?: boolean; + /** + * The worksheet's center vertically flag. This flag determines whether the worksheet will be centered vertically when it's printed. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + centerVertically?: boolean; + /** + * The worksheet's draft mode option. If `true`, the sheet will be printed without graphics. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + draftMode?: boolean; + /** + * The worksheet's first page number to print. A `null` value represents "auto" page numbering. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + firstPageNumber?: number | ""; + /** + * The worksheet's footer margin, in points, for use when printing. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + footerMargin?: number; + /** + * The worksheet's header margin, in points, for use when printing. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + headerMargin?: number; + /** + * The worksheet's left margin, in points, for use when printing. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + leftMargin?: number; + /** + * The worksheet's orientation of the page. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + orientation?: Excel.PageOrientation | "Portrait" | "Landscape"; + /** + * The worksheet's paper size of the page. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + paperSize?: Excel.PaperType | "Letter" | "LetterSmall" | "Tabloid" | "Ledger" | "Legal" | "Statement" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "Folio" | "Quatro" | "Paper10x14" | "Paper11x17" | "Note" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "Csheet" | "Dsheet" | "Esheet" | "EnvelopeDL" | "EnvelopeC5" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "FanfoldUS" | "FanfoldStdGerman" | "FanfoldLegalGerman"; + /** + * Specifies if the worksheet's comments should be displayed when printing. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + printComments?: Excel.PrintComments | "NoComments" | "EndSheet" | "InPlace"; + /** + * The worksheet's print errors option. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + printErrors?: Excel.PrintErrorType | "AsDisplayed" | "Blank" | "Dash" | "NotAvailable"; + /** + * Specifies if the worksheet's gridlines will be printed. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + printGridlines?: boolean; + /** + * Specifies if the worksheet's headings will be printed. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + printHeadings?: boolean; + /** + * The worksheet's page print order option. This specifies the order to use for processing the page number printed. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + printOrder?: Excel.PrintOrder | "DownThenOver" | "OverThenDown"; + /** + * The worksheet's right margin, in points, for use when printing. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + rightMargin?: number; + /** + * The worksheet's top margin, in points, for use when printing. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + topMargin?: number; + /** + * The worksheet's print zoom options. + The `PageLayoutZoomOptions` object must be set as a JSON object (use `x.zoom = {...}` instead of `x.zoom.scale = ...`). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + zoom?: Excel.PageLayoutZoomOptions; + } + /** An interface describing the data returned by calling `headerFooter.toJSON()`. */ + export interface HeaderFooterData { + /** + * The center footer of the worksheet. + To apply font formatting or insert a variable value, use format codes specified here: https://msdn.microsoft.com/library/bb225426.aspx. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + centerFooter?: string; + /** + * The center header of the worksheet. + To apply font formatting or insert a variable value, use format codes specified here: https://msdn.microsoft.com/library/bb225426.aspx. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + centerHeader?: string; + /** + * The left footer of the worksheet. + To apply font formatting or insert a variable value, use format codes specified here: https://msdn.microsoft.com/library/bb225426.aspx. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + leftFooter?: string; + /** + * The left header of the worksheet. + To apply font formatting or insert a variable value, use format codes specified here: https://msdn.microsoft.com/library/bb225426.aspx. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + leftHeader?: string; + /** + * The right footer of the worksheet. + To apply font formatting or insert a variable value, use format codes specified here: https://msdn.microsoft.com/library/bb225426.aspx. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + rightFooter?: string; + /** + * The right header of the worksheet. + To apply font formatting or insert a variable value, use format codes specified here: https://msdn.microsoft.com/library/bb225426.aspx. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + rightHeader?: string; + } + /** An interface describing the data returned by calling `headerFooterGroup.toJSON()`. */ + export interface HeaderFooterGroupData { + /** + * The general header/footer, used for all pages unless even/odd or first page is specified. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + defaultForAllPages?: Excel.Interfaces.HeaderFooterData; + /** + * The header/footer to use for even pages, odd header/footer needs to be specified for odd pages. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + evenPages?: Excel.Interfaces.HeaderFooterData; + /** + * The first page header/footer, for all other pages general or even/odd is used. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + firstPage?: Excel.Interfaces.HeaderFooterData; + /** + * The header/footer to use for odd pages, even header/footer needs to be specified for even pages. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + oddPages?: Excel.Interfaces.HeaderFooterData; + /** + * The state by which headers/footers are set. See `Excel.HeaderFooterState` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + state?: Excel.HeaderFooterState | "Default" | "FirstAndDefault" | "OddAndEven" | "FirstOddAndEven"; + /** + * Gets or sets a flag indicating if headers/footers are aligned with the page margins set in the page layout options for the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + useSheetMargins?: boolean; + /** + * Gets or sets a flag indicating if headers/footers should be scaled by the page percentage scale set in the page layout options for the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + useSheetScale?: boolean; + } + /** An interface describing the data returned by calling `pageBreak.toJSON()`. */ + export interface PageBreakData { + /** + * Specifies the column index for the page break. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + columnIndex?: number; + /** + * Specifies the row index for the page break. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + rowIndex?: number; + } + /** An interface describing the data returned by calling `pageBreakCollection.toJSON()`. */ + export interface PageBreakCollectionData { + items?: Excel.Interfaces.PageBreakData[]; + } + /** An interface describing the data returned by calling `rangeCollection.toJSON()`. */ + export interface RangeCollectionData { + items?: Excel.Interfaces.RangeData[]; + } + /** An interface describing the data returned by calling `rangeAreasCollection.toJSON()`. */ + export interface RangeAreasCollectionData { + items?: Excel.Interfaces.RangeAreasData[]; + } + /** An interface describing the data returned by calling `commentCollection.toJSON()`. */ + export interface CommentCollectionData { + items?: Excel.Interfaces.CommentData[]; + } + /** An interface describing the data returned by calling `comment.toJSON()`. */ + export interface CommentData { + /** + * Represents a collection of reply objects associated with the comment. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + replies?: Excel.Interfaces.CommentReplyData[]; + /** + * Gets the email of the comment's author. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + authorEmail?: string; + /** + * Gets the name of the comment's author. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + authorName?: string; + /** + * The comment's content. The string is plain text. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + content?: string; + /** + * Gets the content type of the comment. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + contentType?: Excel.ContentType | "Plain" | "Mention"; + /** + * Gets the creation time of the comment. Returns `null` if the comment was converted from a note, since the comment does not have a creation date. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + creationDate?: Date; + /** + * Specifies the comment identifier. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + id?: string; + /** + * Gets the entities (e.g., people) that are mentioned in comments. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + mentions?: Excel.CommentMention[]; + /** + * The comment thread status. A value of `true` means that the comment thread is resolved. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + resolved?: boolean; + /** + * Gets the rich comment content (e.g., mentions in comments). This string is not meant to be displayed to end-users. Your add-in should only use this to parse rich comment content. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + richContent?: string; + } + /** An interface describing the data returned by calling `commentReplyCollection.toJSON()`. */ + export interface CommentReplyCollectionData { + items?: Excel.Interfaces.CommentReplyData[]; + } + /** An interface describing the data returned by calling `commentReply.toJSON()`. */ + export interface CommentReplyData { + /** + * Gets the email of the comment reply's author. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + authorEmail?: string; + /** + * Gets the name of the comment reply's author. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + authorName?: string; + /** + * The comment reply's content. The string is plain text. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + content?: string; + /** + * The content type of the reply. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + contentType?: Excel.ContentType | "Plain" | "Mention"; + /** + * Gets the creation time of the comment reply. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + creationDate?: Date; + /** + * Specifies the comment reply identifier. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + id?: string; + /** + * The entities (e.g., people) that are mentioned in comments. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + mentions?: Excel.CommentMention[]; + /** + * The comment reply status. A value of `true` means the reply is in the resolved state. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + resolved?: boolean; + /** + * The rich comment content (e.g., mentions in comments). This string is not meant to be displayed to end-users. Your add-in should only use this to parse rich comment content. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + richContent?: string; + } + /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */ + export interface ShapeCollectionData { + items?: Excel.Interfaces.ShapeData[]; + } + /** An interface describing the data returned by calling `shape.toJSON()`. */ + export interface ShapeData { + /** + * Returns the fill formatting of this shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + fill?: Excel.Interfaces.ShapeFillData; + /** + * Returns the line formatting of this shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + lineFormat?: Excel.Interfaces.ShapeLineFormatData; + /** + * Specifies the alternative description text for a `Shape` object. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + altTextDescription?: string; + /** + * Specifies the alternative title text for a `Shape` object. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + altTextTitle?: string; + /** + * Returns the number of connection sites on this shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + connectionSiteCount?: number; + /** + * Gets the display name of the shape. + A newly created shape has a generated name that is localized and may not match its `name`. + In this scenario, you can use this API to get the name that is displayed in the UI. + * + * @remarks + * [Api set: ExcelApi 1.15] + */ + displayName?: string; + /** + * Specifies the geometric shape type of this geometric shape. See `Excel.GeometricShapeType` for details. Returns `null` if the shape type is not "GeometricShape". + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + geometricShapeType?: Excel.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"; + /** + * Specifies the height, in points, of the shape. + Throws an `InvalidArgument` exception when set with a negative value or zero as an input. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + height?: number; + /** + * Specifies the shape identifier. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + id?: string; + /** + * The distance, in points, from the left side of the shape to the left side of the worksheet. + Throws an `InvalidArgument` exception when set with a negative value as an input. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + left?: number; + /** + * Specifies the level of the specified shape. For example, a level of 0 means that the shape is not part of any groups, a level of 1 means the shape is part of a top-level group, and a level of 2 means the shape is part of a sub-group of the top level. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + level?: number; + /** + * Specifies if the aspect ratio of this shape is locked. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + lockAspectRatio?: boolean; + /** + * Specifies the name of the shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + name?: string; + /** + * Represents how the object is attached to the cells below it. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + placement?: Excel.Placement | "TwoCell" | "OneCell" | "Absolute"; + /** + * Specifies the rotation, in degrees, of the shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + rotation?: number; + /** + * The distance, in points, from the top edge of the shape to the top edge of the worksheet. + Throws an `InvalidArgument` exception when set with a negative value as an input. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + top?: number; + /** + * Returns the type of this shape. See `Excel.ShapeType` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + type?: Excel.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line"; + /** + * Specifies if the shape is visible. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + visible?: boolean; + /** + * Specifies the width, in points, of the shape. + Throws an `InvalidArgument` exception when set with a negative value or zero as an input. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + width?: number; + /** + * Returns the position of the specified shape in the z-order, with 0 representing the bottom of the order stack. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + zOrderPosition?: number; + } + /** An interface describing the data returned by calling `geometricShape.toJSON()`. */ + export interface GeometricShapeData { + /** + * Returns the shape identifier. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + id?: string; + } + /** An interface describing the data returned by calling `image.toJSON()`. */ + export interface ImageData { + /** + * Specifies the shape identifier for the image object. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + id?: string; + /** + * Returns the format of the image. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + format?: Excel.PictureFormat | "UNKNOWN" | "BMP" | "JPEG" | "GIF" | "PNG" | "SVG"; + } + /** An interface describing the data returned by calling `shapeGroup.toJSON()`. */ + export interface ShapeGroupData { + /** + * Returns the collection of `Shape` objects. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + shapes?: Excel.Interfaces.ShapeData[]; + /** + * Specifies the shape identifier. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + id?: string; + } + /** An interface describing the data returned by calling `groupShapeCollection.toJSON()`. */ + export interface GroupShapeCollectionData { + items?: Excel.Interfaces.ShapeData[]; + } + /** An interface describing the data returned by calling `line.toJSON()`. */ + export interface LineData { + /** + * Represents the length of the arrowhead at the beginning of the specified line. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + beginArrowheadLength?: Excel.ArrowheadLength | "Short" | "Medium" | "Long"; + /** + * Represents the style of the arrowhead at the beginning of the specified line. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + beginArrowheadStyle?: Excel.ArrowheadStyle | "None" | "Triangle" | "Stealth" | "Diamond" | "Oval" | "Open"; + /** + * Represents the width of the arrowhead at the beginning of the specified line. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + beginArrowheadWidth?: Excel.ArrowheadWidth | "Narrow" | "Medium" | "Wide"; + /** + * Represents the connection site to which the beginning of a connector is connected. Returns `null` when the beginning of the line is not attached to any shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + beginConnectedSite?: number; + /** + * Represents the length of the arrowhead at the end of the specified line. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + endArrowheadLength?: Excel.ArrowheadLength | "Short" | "Medium" | "Long"; + /** + * Represents the style of the arrowhead at the end of the specified line. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + endArrowheadStyle?: Excel.ArrowheadStyle | "None" | "Triangle" | "Stealth" | "Diamond" | "Oval" | "Open"; + /** + * Represents the width of the arrowhead at the end of the specified line. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + endArrowheadWidth?: Excel.ArrowheadWidth | "Narrow" | "Medium" | "Wide"; + /** + * Represents the connection site to which the end of a connector is connected. Returns `null` when the end of the line is not attached to any shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + endConnectedSite?: number; + /** + * Specifies the shape identifier. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + id?: string; + /** + * Specifies if the beginning of the specified line is connected to a shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + isBeginConnected?: boolean; + /** + * Specifies if the end of the specified line is connected to a shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + isEndConnected?: boolean; + /** + * Represents the connector type for the line. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + connectorType?: Excel.ConnectorType | "Straight" | "Elbow" | "Curve"; + } + /** An interface describing the data returned by calling `shapeFill.toJSON()`. */ + export interface ShapeFillData { + /** + * Represents the shape fill foreground color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange") + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + foregroundColor?: string; + /** + * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + transparency?: number; + /** + * Returns the fill type of the shape. See `Excel.ShapeFillType` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + type?: Excel.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "Mixed"; + } + /** An interface describing the data returned by calling `shapeLineFormat.toJSON()`. */ + export interface ShapeLineFormatData { + /** + * Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + color?: string; + /** + * Represents the line style of the shape. Returns `null` when the line is not visible or there are inconsistent dash styles. See `Excel.ShapeLineDashStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + dashStyle?: Excel.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot"; + /** + * Represents the line style of the shape. Returns `null` when the line is not visible or there are inconsistent styles. See `Excel.ShapeLineStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + style?: Excel.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin"; + /** + * Represents the degree of transparency of the specified line as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` when the shape has inconsistent transparencies. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + transparency?: number; + /** + * Specifies if the line formatting of a shape element is visible. Returns `null` when the shape has inconsistent visibilities. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + visible?: boolean; + /** + * Represents the weight of the line, in points. Returns `null` when the line is not visible or there are inconsistent line weights. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + weight?: number; + } + /** An interface describing the data returned by calling `textFrame.toJSON()`. */ + export interface TextFrameData { + /** + * The automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + autoSizeSetting?: Excel.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed"; + /** + * Represents the bottom margin, in points, of the text frame. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + bottomMargin?: number; + /** + * Specifies if the text frame contains text. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + hasText?: boolean; + /** + * Represents the horizontal alignment of the text frame. See `Excel.ShapeTextHorizontalAlignment` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + horizontalAlignment?: Excel.ShapeTextHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed"; + /** + * Represents the horizontal overflow behavior of the text frame. See `Excel.ShapeTextHorizontalOverflow` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + horizontalOverflow?: Excel.ShapeTextHorizontalOverflow | "Overflow" | "Clip"; + /** + * Represents the left margin, in points, of the text frame. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + leftMargin?: number; + /** + * Represents the angle to which the text is oriented for the text frame. See `Excel.ShapeTextOrientation` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + orientation?: Excel.ShapeTextOrientation | "Horizontal" | "Vertical" | "Vertical270" | "WordArtVertical" | "EastAsianVertical" | "MongolianVertical" | "WordArtVerticalRTL"; + /** + * Represents the reading order of the text frame, either left-to-right or right-to-left. See `Excel.ShapeTextReadingOrder` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readingOrder?: Excel.ShapeTextReadingOrder | "LeftToRight" | "RightToLeft"; + /** + * Represents the right margin, in points, of the text frame. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + rightMargin?: number; + /** + * Represents the top margin, in points, of the text frame. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + topMargin?: number; + /** + * Represents the vertical alignment of the text frame. See `Excel.ShapeTextVerticalAlignment` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + verticalAlignment?: Excel.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom" | "Justified" | "Distributed"; + /** + * Represents the vertical overflow behavior of the text frame. See `Excel.ShapeTextVerticalOverflow` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + verticalOverflow?: Excel.ShapeTextVerticalOverflow | "Overflow" | "Ellipsis" | "Clip"; + } + /** An interface describing the data returned by calling `textRange.toJSON()`. */ + export interface TextRangeData { + /** + * Returns a `ShapeFont` object that represents the font attributes for the text range. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + font?: Excel.Interfaces.ShapeFontData; + /** + * Represents the plain text content of the text range. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + text?: string; + } + /** An interface describing the data returned by calling `shapeFont.toJSON()`. */ + export interface ShapeFontData { + /** + * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + bold?: boolean; + /** + * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + color?: string; + /** + * Represents the italic status of font. Returns `null` if the `TextRange` includes both italic and non-italic text fragments. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + italic?: boolean; + /** + * Represents font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + name?: string; + /** + * Represents font size in points (e.g., 11). Returns `null` if the `TextRange` includes text fragments with different font sizes. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + size?: number; + /** + * Type of underline applied to the font. Returns `null` if the `TextRange` includes text fragments with different underline styles. See `Excel.ShapeFontUnderlineStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + underline?: Excel.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble"; + } + /** An interface describing the data returned by calling `slicer.toJSON()`. */ + export interface SlicerData { + /** + * Represents the collection of slicer items that are part of the slicer. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + slicerItems?: Excel.Interfaces.SlicerItemData[]; + /** + * Represents the worksheet containing the slicer. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + worksheet?: Excel.Interfaces.WorksheetData; + /** + * Represents the caption of the slicer. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + caption?: string; + /** + * Specifies the height, in points, of the slicer. + Throws an `InvalidArgument` exception when set with a negative value or zero as an input. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + height?: number; + /** + * Represents the unique ID of the slicer. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + id?: string; + /** + * Value is `true` if all filters currently applied on the slicer are cleared. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + isFilterCleared?: boolean; + /** + * Represents the distance, in points, from the left side of the slicer to the left of the worksheet. + Throws an `InvalidArgument` error when set with a negative value as an input. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + left?: number; + /** + * Represents the name of the slicer. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + name?: string; + /** + * Specifies the sort order of the items in the slicer. + Possible values are: "DataSourceOrder", "Ascending", "Descending". + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + sortBy?: Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | "Descending"; + /** + * Constant value that represents the slicer style. + Possible values are: "SlicerStyleLight1" through "SlicerStyleLight6", "TableStyleOther1" through "TableStyleOther2", "SlicerStyleDark1" through "SlicerStyleDark6". A custom user-defined style present in the workbook can also be specified. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + style?: string; + /** + * Represents the distance, in points, from the top edge of the slicer to the top of the worksheet. + Throws an `InvalidArgument` error when set with a negative value as an input. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + top?: number; + /** + * Represents the width, in points, of the slicer. + Throws an `InvalidArgument` error when set with a negative value or zero as an input. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + width?: number; + } + /** An interface describing the data returned by calling `slicerCollection.toJSON()`. */ + export interface SlicerCollectionData { + items?: Excel.Interfaces.SlicerData[]; + } + /** An interface describing the data returned by calling `slicerItem.toJSON()`. */ + export interface SlicerItemData { + /** + * Value is `true` if the slicer item has data. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + hasData?: boolean; + /** + * Value is `true` if the slicer item is selected. + Setting this value will not clear the selected state of other slicer items. + By default, if the slicer item is the only one selected, when it is deselected, all items will be selected. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + isSelected?: boolean; + /** + * Represents the unique value representing the slicer item. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + key?: string; + /** + * Represents the title displayed in the Excel UI. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + name?: string; + } + /** An interface describing the data returned by calling `slicerItemCollection.toJSON()`. */ + export interface SlicerItemCollectionData { + items?: Excel.Interfaces.SlicerItemData[]; + } + /** An interface describing the data returned by calling `linkedEntityDataDomain.toJSON()`. */ + export interface LinkedEntityDataDomainData { + /** + * Gets the name of the data provider for the linked entity data domain. + This name can change based on the information provided by the data provider. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + dataProvider?: string; + /** + * Gets the ID of the linked entity data domain defined by Office Add-ins. + This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + id?: string; + /** + * Gets the date and time (in the local time zone) since the workbook was opened and the `LinkedEntityCellValue` objects of this linked entity data domain were last refreshed. + Returns `undefined` if `LinkedEntityCellValue` objects have not been refreshed since the workbook was opened. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + lastRefreshed?: Date; + /** + * Gets the ID of the custom function that is called on demand to resolve or refresh the `LinkedEntityCellValue` objects of the linked entity data domain defined by Office Add-ins. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/excel/custom-functions-json-autogeneration#id | Autogenerate JSON metadata for custom functions: ID}. + This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + loadFunctionId?: string; + /** + * Gets the name of the linked entity data domain. + This name can change based on the information provided by the data provider. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + name?: string; + /** + * Gets the frequency, in seconds, at which `LinkedEntityCellValue` objects of this linked entity data domain are refreshed automatically. + The refresh interval only applies if the `refreshMode` is set to "Periodic". + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + periodicRefreshInterval?: number; + /** + * Specifies the refresh mode that defines how and when the `LinkedEntityCellValue` objects of this linked entity data domain are refreshed. + If the refresh mode being set is not supported by this linked entity data domain, then the current refresh mode is not changed. + If the refresh mode is set to "Periodic", the refresh interval is set to the `periodicRefreshInterval` of this linked entity data domain. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + refreshMode?: Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic"; + /** + * Gets the service ID of the linked entity data domain. + This ID is a permanently reserved value for all linked entity data domains which are defined by service data providers, such as Bing or Power BI, or defined by Office Add-ins. + This ID never changes across user sessions. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + serviceId?: number; + /** + * Gets all the refresh modes supported by the linked entity data domain. + This array can change based on the information provided by the data provider. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + supportedRefreshModes?: Excel.LinkedEntityDataDomainRefreshMode[]; + } + /** An interface describing the data returned by calling `linkedEntityDataDomainCollection.toJSON()`. */ + export interface LinkedEntityDataDomainCollectionData { + items?: Excel.Interfaces.LinkedEntityDataDomainData[]; + } + /** An interface describing the data returned by calling `namedSheetView.toJSON()`. */ + export interface NamedSheetViewData { + + } + /** An interface describing the data returned by calling `namedSheetViewCollection.toJSON()`. */ + export interface NamedSheetViewCollectionData { + items?: Excel.Interfaces.NamedSheetViewData[]; + } + /** An interface describing the data returned by calling `noteCollection.toJSON()`. */ + export interface NoteCollectionData { + items?: Excel.Interfaces.NoteData[]; + } + /** An interface describing the data returned by calling `note.toJSON()`. */ + export interface NoteData { + /** + * Gets the author of the note. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + authorName?: string; + /** + * Specifies the text of the note. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + content?: string; + /** + * Specifies the height of the note. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + height?: number; + /** + * Specifies the visibility of the note. A value of `true` means the note is shown. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + visible?: boolean; + /** + * Specifies the width of the note. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + width?: number; + } + /** An interface describing the data returned by calling `functionResult.toJSON()`. */ + export interface FunctionResultData { + /** + * Error value (such as "#DIV/0") representing the error. If the error string is not set, then the function succeeded, and its result is written to the Value field. The error is always in the English locale. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + error?: string; + /** + * The value of function evaluation. The value field will be populated only if no error has occurred (i.e., the Error property is not set). + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + value?: T; + } + + + /** + * Represents a Power Query query. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + export interface QueryLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Gets the query error message from when the query was last refreshed. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + error?: boolean; + /** + * Gets the query loaded to object type. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + loadedTo?: boolean; + /** + * Specifies if the query loaded to the data model. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + loadedToDataModel?: boolean; + /** + * Gets the name of the query. + Query names cannot contain periods or quotation marks. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + name?: boolean; + /** + * Gets the date and time when the query was last refreshed. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + refreshDate?: boolean; + /** + * Gets the number of rows that were loaded when the query was last refreshed. + If last refresh has errors the value will be -1. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + rowsLoadedCount?: boolean; + } + /** + * Represents the collection of queries in the workbook. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + export interface QueryCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Gets the query error message from when the query was last refreshed. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + error?: boolean; + /** + * For EACH ITEM in the collection: Gets the query loaded to object type. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + loadedTo?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the query loaded to the data model. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + loadedToDataModel?: boolean; + /** + * For EACH ITEM in the collection: Gets the name of the query. + Query names cannot contain periods or quotation marks. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + name?: boolean; + /** + * For EACH ITEM in the collection: Gets the date and time when the query was last refreshed. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + refreshDate?: boolean; + /** + * For EACH ITEM in the collection: Gets the number of rows that were loaded when the query was last refreshed. + If last refresh has errors the value will be -1. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + rowsLoadedCount?: boolean; + } + + + /** + * Represents the Excel Runtime class. + * + * @remarks + * [Api set: ExcelApi 1.5] + */ + export interface RuntimeLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Toggle JavaScript events in the current task pane or content add-in. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + enableEvents?: boolean; + } + /** + * Represents the Excel application that manages the workbook. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface ApplicationLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Provides information based on current system culture settings. This includes the culture names, number formatting, and other culturally dependent settings. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + cultureInfo?: Excel.Interfaces.CultureInfoLoadOptions; + /** + * Returns the iterative calculation settings. + In Excel on Windows and Mac, the settings will apply to the Excel Application. + In Excel on the web and other platforms, the settings will apply to the active workbook. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + iterativeCalculation?: Excel.Interfaces.IterativeCalculationLoadOptions; + /** + * Returns the Excel calculation engine version used for the last full recalculation. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + calculationEngineVersion?: boolean; + /** + * Returns the calculation mode used in the workbook, as defined by the constants in `Excel.CalculationMode`. Possible values are: `Automatic`, where Excel controls recalculation; `AutomaticExceptTables`, where Excel controls recalculation but ignores changes in tables; `Manual`, where calculation is done when the user requests it. + * + * @remarks + * [Api set: ExcelApi 1.1 for get, 1.8 for set] + */ + calculationMode?: boolean; + /** + * Returns the calculation state of the application. See `Excel.CalculationState` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + calculationState?: boolean; + /** + * Gets the string used as the decimal separator for numeric values. This is based on the local Excel settings. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + decimalSeparator?: boolean; + /** + * Gets the string used to separate groups of digits to the left of the decimal for numeric values. This is based on the local Excel settings. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + thousandsSeparator?: boolean; + /** + * Specifies if the system separators of Excel are enabled. + System separators include the decimal separator and thousands separator. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + useSystemSeparators?: boolean; + } + /** + * Represents the iterative calculation settings. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface IterativeCalculationLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * True if Excel will use iteration to resolve circular references. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enabled?: boolean; + /** + * Specifies the maximum amount of change between each iteration as Excel resolves circular references. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + maxChange?: boolean; + /** + * Specifies the maximum number of iterations that Excel can use to resolve a circular reference. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + maxIteration?: boolean; + } + /** + * Workbook is the top level object which contains related workbook objects such as worksheets, tables, and ranges. + To learn more about the workbook object model, read {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-workbooks | Work with workbooks using the Excel JavaScript API}. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface WorkbookLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents the Excel application instance that contains this workbook. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + application?: Excel.Interfaces.ApplicationLoadOptions; + /** + * Represents a collection of bindings that are part of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + bindings?: Excel.Interfaces.BindingCollectionLoadOptions; + + /** + * Gets the workbook properties. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + properties?: Excel.Interfaces.DocumentPropertiesLoadOptions; + /** + * Returns the protection object for a workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + protection?: Excel.Interfaces.WorkbookProtectionLoadOptions; + /** + * Represents a collection of tables associated with the workbook. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + tables?: Excel.Interfaces.TableCollectionLoadOptions; + /** + * Specifies if the workbook is in AutoSave mode. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + autoSave?: boolean; + /** + * Returns a number about the version of Excel Calculation Engine. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + calculationEngineVersion?: boolean; + /** + * True if all charts in the workbook are tracking the actual data points to which they are attached. + False if the charts track the index of the data points. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + chartDataPointTrack?: boolean; + /** + * Specifies if changes have been made since the workbook was last saved. + You can set this property to `true` if you want to close a modified workbook without either saving it or being prompted to save it. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + isDirty?: boolean; + /** + * Gets the workbook name. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + name?: boolean; + /** + * Specifies if the workbook has ever been saved locally or online. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + previouslySaved?: boolean; + /** + * Returns `true` if the workbook is open in read-only mode. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + readOnly?: boolean; + /** + * True if calculations in this workbook will be done using only the precision of the numbers as they're displayed. + Data will permanently lose accuracy when switching this property from `false` to `true`. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + usePrecisionAsDisplayed?: boolean; + } + /** + * Represents the protection of a workbook object. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + export interface WorkbookProtectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Specifies if the workbook is protected. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + protected?: boolean; + } + /** + * An Excel worksheet is a grid of cells. It can contain data, tables, charts, etc. + To learn more about the worksheet object model, read {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-worksheets | Work with worksheets using the Excel JavaScript API}. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface WorksheetLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents the `AutoFilter` object of the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + autoFilter?: Excel.Interfaces.AutoFilterLoadOptions; + /** + * Returns a collection of charts that are part of the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + charts?: Excel.Interfaces.ChartCollectionLoadOptions; + /** + * Gets the `PageLayout` object of the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + pageLayout?: Excel.Interfaces.PageLayoutLoadOptions; + /** + * Returns the sheet protection object for a worksheet. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + protection?: Excel.Interfaces.WorksheetProtectionLoadOptions; + /** + * Collection of tables that are part of the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + tables?: Excel.Interfaces.TableCollectionLoadOptions; + /** + * Determines if Excel should recalculate the worksheet when necessary. + True if Excel recalculates the worksheet when necessary. False if Excel doesn't recalculate the sheet. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enableCalculation?: boolean; + /** + * Returns a value that uniquely identifies the worksheet in a given workbook. The value of the identifier remains the same even when the worksheet is renamed or moved. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + id?: boolean; + /** + * The display name of the worksheet. The name must be fewer than 32 characters. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + name?: boolean; + /** + * The zero-based position of the worksheet within the workbook. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + position?: boolean; + /** + * Specifies if data type icons are visible on the worksheet. By default, data type icons are visible. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + showDataTypeIcons?: boolean; + /** + * Specifies if gridlines are visible to the user. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showGridlines?: boolean; + /** + * Specifies if headings are visible to the user. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showHeadings?: boolean; + /** + * Returns the standard (default) height of all the rows in the worksheet, in points. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + standardHeight?: boolean; + /** + * Specifies the standard (default) width of all the columns in the worksheet. + One unit of column width is equal to the width of one character in the Normal style. For proportional fonts, the width of the character 0 (zero) is used. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + standardWidth?: boolean; + /** + * The tab color of the worksheet. + When retrieving the tab color, if the worksheet is invisible, the value will be `null`. If the worksheet is visible but the tab color is set to auto, an empty string will be returned. Otherwise, the property will be set to a color, in the form #RRGGBB (e.g., "FFA500"). + When setting the color, use an empty-string to set an "auto" color, or a real color otherwise. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + tabColor?: boolean; + /** + * Returns a value representing this worksheet that can be read by Open Office XML. This is an integer value, which is different from `worksheet.id` (which returns a globally unique identifier) and `worksheet.name` (which returns a value such as "Sheet1"). + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + tabId?: boolean; + /** + * The visibility of the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.1 for reading visibility; 1.2 for setting it.] + */ + visibility?: boolean; + } + /** + * Represents a collection of worksheet objects that are part of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface WorksheetCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Represents the `AutoFilter` object of the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + autoFilter?: Excel.Interfaces.AutoFilterLoadOptions; + /** + * For EACH ITEM in the collection: Returns a collection of charts that are part of the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + charts?: Excel.Interfaces.ChartCollectionLoadOptions; + /** + * For EACH ITEM in the collection: Gets the `PageLayout` object of the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + pageLayout?: Excel.Interfaces.PageLayoutLoadOptions; + /** + * For EACH ITEM in the collection: Returns the sheet protection object for a worksheet. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + protection?: Excel.Interfaces.WorksheetProtectionLoadOptions; + /** + * For EACH ITEM in the collection: Collection of tables that are part of the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + tables?: Excel.Interfaces.TableCollectionLoadOptions; + /** + * For EACH ITEM in the collection: Determines if Excel should recalculate the worksheet when necessary. + True if Excel recalculates the worksheet when necessary. False if Excel doesn't recalculate the sheet. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enableCalculation?: boolean; + /** + * For EACH ITEM in the collection: Returns a value that uniquely identifies the worksheet in a given workbook. The value of the identifier remains the same even when the worksheet is renamed or moved. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + id?: boolean; + /** + * For EACH ITEM in the collection: The display name of the worksheet. The name must be fewer than 32 characters. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + name?: boolean; + /** + * For EACH ITEM in the collection: The zero-based position of the worksheet within the workbook. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + position?: boolean; + /** + * For EACH ITEM in the collection: Specifies if data type icons are visible on the worksheet. By default, data type icons are visible. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + showDataTypeIcons?: boolean; + /** + * For EACH ITEM in the collection: Specifies if gridlines are visible to the user. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showGridlines?: boolean; + /** + * For EACH ITEM in the collection: Specifies if headings are visible to the user. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showHeadings?: boolean; + /** + * For EACH ITEM in the collection: Returns the standard (default) height of all the rows in the worksheet, in points. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + standardHeight?: boolean; + /** + * For EACH ITEM in the collection: Specifies the standard (default) width of all the columns in the worksheet. + One unit of column width is equal to the width of one character in the Normal style. For proportional fonts, the width of the character 0 (zero) is used. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + standardWidth?: boolean; + /** + * For EACH ITEM in the collection: The tab color of the worksheet. + When retrieving the tab color, if the worksheet is invisible, the value will be `null`. If the worksheet is visible but the tab color is set to auto, an empty string will be returned. Otherwise, the property will be set to a color, in the form #RRGGBB (e.g., "FFA500"). + When setting the color, use an empty-string to set an "auto" color, or a real color otherwise. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + tabColor?: boolean; + /** + * For EACH ITEM in the collection: Returns a value representing this worksheet that can be read by Open Office XML. This is an integer value, which is different from `worksheet.id` (which returns a globally unique identifier) and `worksheet.name` (which returns a value such as "Sheet1"). + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + tabId?: boolean; + /** + * For EACH ITEM in the collection: The visibility of the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.1 for reading visibility; 1.2 for setting it.] + */ + visibility?: boolean; + } + /** + * Represents the protection of a worksheet object. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + export interface WorksheetProtectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + + + + /** + * Specifies the protection options for the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + options?: boolean; + /** + * Specifies if the worksheet is protected. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + protected?: boolean; + + } + /** + * Range represents a set of one or more contiguous cells such as a cell, a row, a column, or a block of cells. + To learn more about how ranges are used throughout the API, start with {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-core-concepts#ranges | Ranges in the Excel JavaScript API}. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface RangeLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Returns a data validation object. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + dataValidation?: Excel.Interfaces.DataValidationLoadOptions; + /** + * Returns a format object, encapsulating the range's font, fill, borders, alignment, and other properties. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + format?: Excel.Interfaces.RangeFormatLoadOptions; + /** + * The worksheet containing the current range. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + worksheet?: Excel.Interfaces.WorksheetLoadOptions; + /** + * Specifies the range reference in A1-style. Address value contains the sheet reference (e.g., "Sheet1!A1:B4"). + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + address?: boolean; + /** + * Represents the range reference for the specified range in the language of the user. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + addressLocal?: boolean; + /** + * Specifies the number of cells in the range. This API will return -1 if the cell count exceeds 2^31-1 (2,147,483,647). + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + cellCount?: boolean; + /** + * Specifies the total number of columns in the range. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + columnCount?: boolean; + /** + * Represents if all columns in the current range are hidden. Value is `true` when all columns in a range are hidden. Value is `false` when no columns in the range are hidden. Value is `null` when some columns in a range are hidden and other columns in the same range are not hidden. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + columnHidden?: boolean; + /** + * Specifies the column number of the first cell in the range. Zero-indexed. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + columnIndex?: boolean; + /** + * Accesses the cell control applied to this range. + If the range has multiple cell controls, this returns `EmptyCellControl`. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + control?: boolean; + /** + * Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + formulas?: boolean; + /** + * Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. If a cell has no formula, its value is returned instead. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + formulasLocal?: boolean; + /** + * Represents the formula in R1C1-style notation. If a cell has no formula, its value is returned instead. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + formulasR1C1?: boolean; + /** + * Represents if all cells have a spill border. + Returns `true` if all cells have a spill border, or `false` if all cells do not have a spill border. + Returns `null` if there are cells both with and without spill borders within the range. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + hasSpill?: boolean; + /** + * Returns the distance in points, for 100% zoom, from the top edge of the range to the bottom edge of the range. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + height?: boolean; + /** + * Represents if all cells in the current range are hidden. Value is `true` when all cells in a range are hidden. Value is `false` when no cells in the range are hidden. Value is `null` when some cells in a range are hidden and other cells in the same range are not hidden. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + hidden?: boolean; + /** + * Represents the hyperlink for the current range. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + hyperlink?: boolean; + /** + * Represents if the current range is an entire column. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + isEntireColumn?: boolean; + /** + * Represents if the current range is an entire row. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + isEntireRow?: boolean; + /** + * Returns the distance in points, for 100% zoom, from the left edge of the worksheet to the left edge of the range. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + left?: boolean; + /** + * Represents the data type state of each cell. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + linkedDataTypeState?: boolean; + /** + * Represents Excel's number format code for the given range. For more information about Excel number formatting, see {@link https://support.microsoft.com/office/5026bbd6-04bc-48cd-bf33-80f18b4eae68 | Number format codes}. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + numberFormat?: boolean; + /** + * Represents the category of number format of each cell. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + numberFormatCategories?: boolean; + /** + * Represents Excel's number format code for the given range, based on the language settings of the user. + Excel does not perform any language or format coercion when getting or setting the `numberFormatLocal` property. + Any returned text uses the locally-formatted strings based on the language specified in the system settings. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + numberFormatLocal?: boolean; + /** + * Returns the total number of rows in the range. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + rowCount?: boolean; + /** + * Represents if all rows in the current range are hidden. Value is `true` when all rows in a range are hidden. Value is `false` when no rows in the range are hidden. Value is `null` when some rows in a range are hidden and other rows in the same range are not hidden. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + rowHidden?: boolean; + /** + * Returns the row number of the first cell in the range. Zero-indexed. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + rowIndex?: boolean; + /** + * Represents if all the cells would be saved as an array formula. + Returns `true` if all cells would be saved as an array formula, or `false` if all cells would not be saved as an array formula. + Returns `null` if some cells would be saved as an array formula and some would not be. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + savedAsArray?: boolean; + /** + * Represents the style of the current range. + If the styles of the cells are inconsistent, `null` will be returned. + For custom styles, the style name will be returned. For built-in styles, a string representing a value in the `BuiltInStyle` enum will be returned. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + style?: boolean; + /** + * Text values of the specified range. The text value will not depend on the cell width. The number sign (#) substitution that happens in the Excel UI will not affect the text value returned by the API. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + text?: boolean; + /** + * Returns the distance in points, for 100% zoom, from the top edge of the worksheet to the top edge of the range. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + top?: boolean; + /** + * Specifies the type of data in each cell. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + valueTypes?: boolean; + /** + * Represents the raw values of the specified range. The data returned could be a string, number, or boolean. Cells that contain an error will return the error string. + If the returned value starts with a plus ("+"), minus ("-"), or equal sign ("="), Excel interprets this value as a formula. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + values?: boolean; + /** + * A JSON representation of the values in the cells in this range. + Unlike `Range.values`, `Range.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `Range.valuesAsJsonLocal`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJson?: boolean; + /** + * A JSON representation of the values in the cells in this range. + Unlike `Range.values`, `Range.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `Range.valuesAsJson`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJsonLocal?: boolean; + /** + * Returns the distance in points, for 100% zoom, from the left edge of the range to the right edge of the range. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + width?: boolean; + } + /** + * `RangeAreas` represents a collection of one or more rectangular ranges in the same worksheet. + To learn how to use discontiguous ranges, read {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-multiple-ranges | Work with multiple ranges simultaneously in Excel add-ins}. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface RangeAreasLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Returns a data validation object for all ranges in the `RangeAreas`. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + dataValidation?: Excel.Interfaces.DataValidationLoadOptions; + /** + * Returns a `RangeFormat` object, encapsulating the font, fill, borders, alignment, and other properties for all ranges in the `RangeAreas` object. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + format?: Excel.Interfaces.RangeFormatLoadOptions; + /** + * Returns the worksheet for the current `RangeAreas`. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + worksheet?: Excel.Interfaces.WorksheetLoadOptions; + /** + * Returns the `RangeAreas` reference in A1-style. Address value will contain the worksheet name for each rectangular block of cells (e.g., "Sheet1!A1:B4, Sheet1!D1:D4"). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + address?: boolean; + /** + * Returns the `RangeAreas` reference in the user locale. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + addressLocal?: boolean; + /** + * Returns the number of rectangular ranges that comprise this `RangeAreas` object. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + areaCount?: boolean; + /** + * Returns the number of cells in the `RangeAreas` object, summing up the cell counts of all of the individual rectangular ranges. Returns -1 if the cell count exceeds 2^31-1 (2,147,483,647). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + cellCount?: boolean; + /** + * Specifies if all the ranges on this `RangeAreas` object represent entire columns (e.g., "A:C, Q:Z"). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + isEntireColumn?: boolean; + /** + * Specifies if all the ranges on this `RangeAreas` object represent entire rows (e.g., "1:3, 5:7"). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + isEntireRow?: boolean; + /** + * Represents the style for all ranges in this `RangeAreas` object. + If the styles of the cells are inconsistent, `null` will be returned. + For custom styles, the style name will be returned. For built-in styles, a string representing a value in the `BuiltInStyle` enum will be returned. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + style?: boolean; + } + /** + * Represents a collection of one or more rectangular ranges in multiple worksheets. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + export interface WorkbookRangeAreasLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Returns an array of addresses in A1-style. Address values contain the worksheet name for each rectangular block of cells (e.g., "Sheet1!A1:B4, Sheet1!D1:D4"). Read-only. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + addresses?: boolean; + } + /** + * RangeView represents a set of visible cells of the parent range. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + export interface RangeViewLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents the cell addresses of the `RangeView`. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + cellAddresses?: boolean; + /** + * The number of visible columns. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + columnCount?: boolean; + /** + * Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + formulas?: boolean; + /** + * Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. If a cell has no formula, its value is returned instead. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + formulasLocal?: boolean; + /** + * Represents the formula in R1C1-style notation. If a cell has no formula, its value is returned instead. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + formulasR1C1?: boolean; + /** + * Returns a value that represents the index of the `RangeView`. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + index?: boolean; + /** + * Represents Excel's number format code for the given cell. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + numberFormat?: boolean; + /** + * The number of visible rows. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + rowCount?: boolean; + /** + * Text values of the specified range. The text value will not depend on the cell width. The # sign substitution that happens in Excel UI will not affect the text value returned by the API. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + text?: boolean; + /** + * Represents the type of data of each cell. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + valueTypes?: boolean; + /** + * Represents the raw values of the specified range view. The data returned could be of type string, number, or a boolean. Cells that contain an error will return the error string. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + values?: boolean; + /** + * A JSON representation of the values in the cells in this range. + Unlike `RangeView.values`, `RangeView.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `RangeView.valuesAsJsonLocal`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJson?: boolean; + /** + * A JSON representation of the values in the cells in this range. + Unlike `RangeView.values`, `RangeView.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `RangeView.valuesAsJson`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJsonLocal?: boolean; + } + /** + * Represents a collection of `RangeView` objects. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + export interface RangeViewCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Represents the cell addresses of the `RangeView`. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + cellAddresses?: boolean; + /** + * For EACH ITEM in the collection: The number of visible columns. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + columnCount?: boolean; + /** + * For EACH ITEM in the collection: Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + formulas?: boolean; + /** + * For EACH ITEM in the collection: Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. If a cell has no formula, its value is returned instead. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + formulasLocal?: boolean; + /** + * For EACH ITEM in the collection: Represents the formula in R1C1-style notation. If a cell has no formula, its value is returned instead. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + formulasR1C1?: boolean; + /** + * For EACH ITEM in the collection: Returns a value that represents the index of the `RangeView`. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + index?: boolean; + /** + * For EACH ITEM in the collection: Represents Excel's number format code for the given cell. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + numberFormat?: boolean; + /** + * For EACH ITEM in the collection: The number of visible rows. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + rowCount?: boolean; + /** + * For EACH ITEM in the collection: Text values of the specified range. The text value will not depend on the cell width. The # sign substitution that happens in Excel UI will not affect the text value returned by the API. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + text?: boolean; + /** + * For EACH ITEM in the collection: Represents the type of data of each cell. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + valueTypes?: boolean; + /** + * For EACH ITEM in the collection: Represents the raw values of the specified range view. The data returned could be of type string, number, or a boolean. Cells that contain an error will return the error string. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + values?: boolean; + /** + * For EACH ITEM in the collection: A JSON representation of the values in the cells in this range. + Unlike `RangeView.values`, `RangeView.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `RangeView.valuesAsJsonLocal`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJson?: boolean; + /** + * For EACH ITEM in the collection: A JSON representation of the values in the cells in this range. + Unlike `RangeView.values`, `RangeView.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `RangeView.valuesAsJson`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJsonLocal?: boolean; + } + /** + * Represents a collection of key-value pair setting objects that are part of the workbook. The scope is limited to per file and add-in (task-pane or content) combination. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + export interface SettingCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: The key that represents the ID of the setting. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + key?: boolean; + /** + * For EACH ITEM in the collection: Represents the value stored for this setting. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + value?: boolean; + } + /** + * Setting represents a key-value pair of a setting persisted to the document (per file, per add-in). These custom key-value pair can be used to store state or lifecycle information needed by the content or task-pane add-in. Note that settings are persisted in the document and hence it is not a place to store any sensitive or protected information such as user information and password. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + export interface SettingLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * The key that represents the ID of the setting. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + key?: boolean; + /** + * Represents the value stored for this setting. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + value?: boolean; + } + /** + * A collection of all the `NamedItem` objects that are part of the workbook or worksheet, depending on how it was reached. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface NamedItemCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Returns an object containing values and types of the named item. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + arrayValues?: Excel.Interfaces.NamedItemArrayValuesLoadOptions; + /** + * For EACH ITEM in the collection: Returns the worksheet on which the named item is scoped to. Throws an error if the item is scoped to the workbook instead. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + worksheet?: Excel.Interfaces.WorksheetLoadOptions; + /** + * For EACH ITEM in the collection: Returns the worksheet to which the named item is scoped. + If the item is scoped to the workbook instead, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + worksheetOrNullObject?: Excel.Interfaces.WorksheetLoadOptions; + /** + * For EACH ITEM in the collection: Specifies the comment associated with this name. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + comment?: boolean; + /** + * For EACH ITEM in the collection: The formula of the named item. Formulas always start with an equal sign ("="). + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + formula?: boolean; + /** + * For EACH ITEM in the collection: The name of the object. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + name?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the name is scoped to the workbook or to a specific worksheet. Possible values are: Worksheet, Workbook. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + scope?: boolean; + /** + * For EACH ITEM in the collection: Specifies the type of the value returned by the name's formula. See `Excel.NamedItemType` for details. + * + * @remarks + * [Api set: ExcelApi 1.1 for String,Integer,Double,Boolean,Range,Error; 1.7 for Array] + */ + type?: boolean; + /** + * For EACH ITEM in the collection: 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 + * [Api set: ExcelApi 1.1] + */ + value?: boolean; + /** + * For EACH ITEM in the collection: A JSON representation of the values in this named item. + Unlike `NamedItem.value`, `NamedItem.valueAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `NamedItem.valueAsJsonLocal`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valueAsJson?: boolean; + /** + * For EACH ITEM in the collection: A JSON representation of the values in this named item. + Unlike `NamedItem.value`, `NamedItem.valueAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `NamedItem.valueAsJson`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valueAsJsonLocal?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the object is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + visible?: boolean; + } + /** + * Represents a defined name for a range of cells or value. Names can be primitive named objects (as seen in the type below), range object, or a reference to a range. This object can be used to obtain range object associated with names. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface NamedItemLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Returns an object containing values and types of the named item. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + arrayValues?: Excel.Interfaces.NamedItemArrayValuesLoadOptions; + /** + * Returns the worksheet on which the named item is scoped to. Throws an error if the item is scoped to the workbook instead. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + worksheet?: Excel.Interfaces.WorksheetLoadOptions; + /** + * Returns the worksheet to which the named item is scoped. + If the item is scoped to the workbook instead, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + worksheetOrNullObject?: Excel.Interfaces.WorksheetLoadOptions; + /** + * Specifies the comment associated with this name. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + comment?: boolean; + /** + * The formula of the named item. Formulas always start with an equal sign ("="). + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + formula?: boolean; + /** + * The name of the object. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + name?: boolean; + /** + * Specifies if the name is scoped to the workbook or to a specific worksheet. Possible values are: Worksheet, Workbook. + * + * @remarks + * [Api set: ExcelApi 1.4] + */ + scope?: boolean; + /** + * Specifies the type of the value returned by the name's formula. See `Excel.NamedItemType` for details. + * + * @remarks + * [Api set: ExcelApi 1.1 for String,Integer,Double,Boolean,Range,Error; 1.7 for Array] + */ + type?: boolean; + /** + * 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 + * [Api set: ExcelApi 1.1] + */ + value?: boolean; + /** + * A JSON representation of the values in this named item. + Unlike `NamedItem.value`, `NamedItem.valueAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `NamedItem.valueAsJsonLocal`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valueAsJson?: boolean; + /** + * A JSON representation of the values in this named item. + Unlike `NamedItem.value`, `NamedItem.valueAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `NamedItem.valueAsJson`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valueAsJsonLocal?: boolean; + /** + * Specifies if the object is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + visible?: boolean; + } + /** + * Represents an object containing values and types of a named item. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + export interface NamedItemArrayValuesLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents the types for each item in the named item array + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + types?: boolean; + /** + * Represents the values of each item in the named item array. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + values?: boolean; + /** + * A JSON representation of the values in this named item array. + Unlike `NamedItemArrayValues.values`, `NamedItemArrayValues.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `NamedItemArrayValues.valuesAsJsonLocal`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJson?: boolean; + /** + * A JSON representation of the values in this named item array. + Unlike `NamedItemArrayValues.values`, `NamedItemArrayValues.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `NamedItemArrayValues.valuesAsJson`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJsonLocal?: boolean; + } + /** + * Represents an Office.js binding that is defined in the workbook. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface BindingLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents the binding identifier. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + id?: boolean; + /** + * Returns the type of the binding. See `Excel.BindingType` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + type?: boolean; + } + /** + * Represents the collection of all the binding objects that are part of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface BindingCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Represents the binding identifier. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + id?: boolean; + /** + * For EACH ITEM in the collection: Returns the type of the binding. See `Excel.BindingType` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + type?: boolean; + } + /** + * Represents a collection of all the tables that are part of the workbook or worksheet, depending on how it was reached. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface TableCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Represents the `AutoFilter` object of the table. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + autoFilter?: Excel.Interfaces.AutoFilterLoadOptions; + /** + * For EACH ITEM in the collection: Represents a collection of all the columns in the table. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + columns?: Excel.Interfaces.TableColumnCollectionLoadOptions; + /** + * For EACH ITEM in the collection: Represents a collection of all the rows in the table. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + rows?: Excel.Interfaces.TableRowCollectionLoadOptions; + /** + * For EACH ITEM in the collection: Represents the sorting for the table. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + sort?: Excel.Interfaces.TableSortLoadOptions; + /** + * For EACH ITEM in the collection: The worksheet containing the current table. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + worksheet?: Excel.Interfaces.WorksheetLoadOptions; + /** + * For EACH ITEM in the collection: Specifies if the first column contains special formatting. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + highlightFirstColumn?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the last column contains special formatting. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + highlightLastColumn?: boolean; + /** + * For EACH ITEM in the collection: Returns a value that uniquely identifies the table in a given workbook. The value of the identifier remains the same even when the table is renamed. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + id?: boolean; + /** + * For EACH ITEM in the collection: Returns a numeric ID. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + legacyId?: boolean; + /** + * For EACH ITEM in the collection: Name of the table. + + The set name of the table must follow the guidelines specified in the {@link https://support.microsoft.com/office/fbf49a4f-82a3-43eb-8ba2-44d21233b114 | Rename an Excel table} article. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + name?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the columns show banded formatting in which odd columns are highlighted differently from even ones, to make reading the table easier. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + showBandedColumns?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the rows show banded formatting in which odd rows are highlighted differently from even ones, to make reading the table easier. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + showBandedRows?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the filter buttons are visible at the top of each column header. Setting this is only allowed if the table contains a header row. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + showFilterButton?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the header row is visible. This value can be set to show or remove the header row. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + showHeaders?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the total row is visible. This value can be set to show or remove the total row. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + showTotals?: boolean; + /** + * For EACH ITEM in the collection: Constant value that represents the table style. Possible values are: "TableStyleLight1" through "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", "TableStyleDark1" through "TableStyleDark11". A custom user-defined style present in the workbook can also be specified. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + style?: boolean; + } + /** + * Represents a scoped collection of tables. For each table its top-left corner is considered its anchor location, and the tables are sorted top-to-bottom and then left-to-right. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface TableScopedCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Represents the `AutoFilter` object of the table. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + autoFilter?: Excel.Interfaces.AutoFilterLoadOptions; + /** + * For EACH ITEM in the collection: Represents a collection of all the columns in the table. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + columns?: Excel.Interfaces.TableColumnCollectionLoadOptions; + /** + * For EACH ITEM in the collection: Represents a collection of all the rows in the table. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + rows?: Excel.Interfaces.TableRowCollectionLoadOptions; + /** + * For EACH ITEM in the collection: Represents the sorting for the table. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + sort?: Excel.Interfaces.TableSortLoadOptions; + /** + * For EACH ITEM in the collection: The worksheet containing the current table. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + worksheet?: Excel.Interfaces.WorksheetLoadOptions; + /** + * For EACH ITEM in the collection: Specifies if the first column contains special formatting. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + highlightFirstColumn?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the last column contains special formatting. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + highlightLastColumn?: boolean; + /** + * For EACH ITEM in the collection: Returns a value that uniquely identifies the table in a given workbook. The value of the identifier remains the same even when the table is renamed. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + id?: boolean; + /** + * For EACH ITEM in the collection: Returns a numeric ID. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + legacyId?: boolean; + /** + * For EACH ITEM in the collection: Name of the table. + + The set name of the table must follow the guidelines specified in the {@link https://support.microsoft.com/office/fbf49a4f-82a3-43eb-8ba2-44d21233b114 | Rename an Excel table} article. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + name?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the columns show banded formatting in which odd columns are highlighted differently from even ones, to make reading the table easier. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + showBandedColumns?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the rows show banded formatting in which odd rows are highlighted differently from even ones, to make reading the table easier. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + showBandedRows?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the filter buttons are visible at the top of each column header. Setting this is only allowed if the table contains a header row. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + showFilterButton?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the header row is visible. This value can be set to show or remove the header row. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + showHeaders?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the total row is visible. This value can be set to show or remove the total row. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + showTotals?: boolean; + /** + * For EACH ITEM in the collection: Constant value that represents the table style. Possible values are: "TableStyleLight1" through "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", "TableStyleDark1" through "TableStyleDark11". A custom user-defined style present in the workbook can also be specified. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + style?: boolean; + } + /** + * Represents an Excel table. + To learn more about the table object model, read {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-tables | Work with tables using the Excel JavaScript API}. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface TableLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents the `AutoFilter` object of the table. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + autoFilter?: Excel.Interfaces.AutoFilterLoadOptions; + /** + * Represents a collection of all the columns in the table. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + columns?: Excel.Interfaces.TableColumnCollectionLoadOptions; + /** + * Represents a collection of all the rows in the table. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + rows?: Excel.Interfaces.TableRowCollectionLoadOptions; + /** + * Represents the sorting for the table. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + sort?: Excel.Interfaces.TableSortLoadOptions; + /** + * The worksheet containing the current table. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + worksheet?: Excel.Interfaces.WorksheetLoadOptions; + /** + * Specifies if the first column contains special formatting. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + highlightFirstColumn?: boolean; + /** + * Specifies if the last column contains special formatting. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + highlightLastColumn?: boolean; + /** + * Returns a value that uniquely identifies the table in a given workbook. The value of the identifier remains the same even when the table is renamed. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + id?: boolean; + /** + * Returns a numeric ID. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + legacyId?: boolean; + /** + * Name of the table. + + The set name of the table must follow the guidelines specified in the {@link https://support.microsoft.com/office/fbf49a4f-82a3-43eb-8ba2-44d21233b114 | Rename an Excel table} article. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + name?: boolean; + /** + * Specifies if the columns show banded formatting in which odd columns are highlighted differently from even ones, to make reading the table easier. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + showBandedColumns?: boolean; + /** + * Specifies if the rows show banded formatting in which odd rows are highlighted differently from even ones, to make reading the table easier. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + showBandedRows?: boolean; + /** + * Specifies if the filter buttons are visible at the top of each column header. Setting this is only allowed if the table contains a header row. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + showFilterButton?: boolean; + /** + * Specifies if the header row is visible. This value can be set to show or remove the header row. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + showHeaders?: boolean; + /** + * Specifies if the total row is visible. This value can be set to show or remove the total row. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + showTotals?: boolean; + /** + * Constant value that represents the table style. Possible values are: "TableStyleLight1" through "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", "TableStyleDark1" through "TableStyleDark11". A custom user-defined style present in the workbook can also be specified. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + style?: boolean; + } + /** + * Represents a collection of all the columns that are part of the table. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface TableColumnCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Retrieves the filter applied to the column. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + filter?: Excel.Interfaces.FilterLoadOptions; + /** + * For EACH ITEM in the collection: Returns a unique key that identifies the column within the table. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + id?: boolean; + /** + * For EACH ITEM in the collection: Returns the index number of the column within the columns collection of the table. Zero-indexed. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + index?: boolean; + /** + * For EACH ITEM in the collection: Specifies the name of the table column. + * + * @remarks + * [Api set: ExcelApi 1.1 for getting the name; 1.4 for setting it.] + */ + name?: boolean; + /** + * For EACH ITEM in the collection: Represents the raw values of the specified range. The data returned could be a string, number, or boolean. Cells that contain an error will return the error string. + If the returned value starts with a plus ("+"), minus ("-"), or equal sign ("="), Excel interprets this value as a formula. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + values?: boolean; + /** + * For EACH ITEM in the collection: A JSON representation of the values in the cells in this table column. + Unlike `TableColumn.values`, `TableColumn.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `TableColumn.valuesAsJsonLocal`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJson?: boolean; + /** + * For EACH ITEM in the collection: A JSON representation of the values in the cells in this table column. + Unlike `TableColumn.values`, `TableColumn.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `TableColumn.valuesAsJson`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJsonLocal?: boolean; + } + /** + * Represents a column in a table. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface TableColumnLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Retrieves the filter applied to the column. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + filter?: Excel.Interfaces.FilterLoadOptions; + /** + * Returns a unique key that identifies the column within the table. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + id?: boolean; + /** + * Returns the index number of the column within the columns collection of the table. Zero-indexed. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + index?: boolean; + /** + * Specifies the name of the table column. + * + * @remarks + * [Api set: ExcelApi 1.1 for getting the name; 1.4 for setting it.] + */ + name?: boolean; + /** + * Represents the raw values of the specified range. The data returned could be a string, number, or boolean. Cells that contain an error will return the error string. + If the returned value starts with a plus ("+"), minus ("-"), or equal sign ("="), Excel interprets this value as a formula. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + values?: boolean; + /** + * A JSON representation of the values in the cells in this table column. + Unlike `TableColumn.values`, `TableColumn.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `TableColumn.valuesAsJsonLocal`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJson?: boolean; + /** + * A JSON representation of the values in the cells in this table column. + Unlike `TableColumn.values`, `TableColumn.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `TableColumn.valuesAsJson`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJsonLocal?: boolean; + } + /** + * Represents a collection of all the rows that are part of the table. + + Note that unlike ranges or columns, which will adjust if new rows or columns are added before them, + a `TableRow` object represents the physical location of the table row, but not the data. + That is, if the data is sorted or if new rows are added, a table row will continue + to point at the index for which it was created. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface TableRowCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Returns the index number of the row within the rows collection of the table. Zero-indexed. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + index?: boolean; + /** + * For EACH ITEM in the collection: Represents the raw values of the specified range. The data returned could be a string, number, or boolean. Cells that contain an error will return the error string. + If the returned value starts with a plus ("+"), minus ("-"), or equal sign ("="), Excel interprets this value as a formula. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + values?: boolean; + /** + * For EACH ITEM in the collection: A JSON representation of the values in the cells in this table row. + Unlike `TableRow.values`, `TableRow.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `TableRow.valuesAsJsonLocal`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJson?: boolean; + /** + * For EACH ITEM in the collection: A JSON representation of the values in the cells in this table row. + Unlike `TableRow.values`, `TableRow.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `TableRow.valuesAsJson`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJsonLocal?: boolean; + } + /** + * Represents a row in a table. + + Note that unlike ranges or columns, which will adjust if new rows or columns are added before them, + a `TableRow` object represents the physical location of the table row, but not the data. + That is, if the data is sorted or if new rows are added, a table row will continue + to point at the index for which it was created. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface TableRowLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Returns the index number of the row within the rows collection of the table. Zero-indexed. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + index?: boolean; + /** + * Represents the raw values of the specified range. The data returned could be a string, number, or boolean. Cells that contain an error will return the error string. + If the returned value starts with a plus ("+"), minus ("-"), or equal sign ("="), Excel interprets this value as a formula. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + values?: boolean; + /** + * A JSON representation of the values in the cells in this table row. + Unlike `TableRow.values`, `TableRow.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `TableRow.valuesAsJsonLocal`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJson?: boolean; + /** + * A JSON representation of the values in the cells in this table row. + Unlike `TableRow.values`, `TableRow.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `TableRow.valuesAsJson`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJsonLocal?: boolean; + } + /** + * Represents the data validation applied to the current range. + To learn more about the data validation object model, read {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-data-validation | Add data validation to Excel ranges}. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export interface DataValidationLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Error alert when user enters invalid data. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + errorAlert?: boolean; + /** + * Specifies if data validation will be performed on blank cells. Default is `true`. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + ignoreBlanks?: boolean; + /** + * Prompt when users select a cell. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + prompt?: boolean; + /** + * Data validation rule that contains different type of data validation criteria. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + rule?: boolean; + /** + * Type of the data validation, see `Excel.DataValidationType` for details. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + type?: boolean; + /** + * Represents if all cell values are valid according to the data validation rules. + Returns `true` if all cell values are valid, or `false` if all cell values are invalid. + Returns `null` if there are both valid and invalid cell values within the range. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + valid?: boolean; + } + /** + * Represents the results from `Range.removeDuplicates`. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface RemoveDuplicatesResultLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Number of duplicated rows removed by the operation. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + removed?: boolean; + /** + * Number of remaining unique rows present in the resulting range. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + uniqueRemaining?: boolean; + } + /** + * A format object encapsulating the range's font, fill, borders, alignment, and other properties. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface RangeFormatLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Collection of border objects that apply to the overall range. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + borders?: Excel.Interfaces.RangeBorderCollectionLoadOptions; + /** + * Returns the fill object defined on the overall range. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + fill?: Excel.Interfaces.RangeFillLoadOptions; + /** + * Returns the font object defined on the overall range. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + font?: Excel.Interfaces.RangeFontLoadOptions; + /** + * Returns the format protection object for a range. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + protection?: Excel.Interfaces.FormatProtectionLoadOptions; + /** + * Specifies if text is automatically indented when text alignment is set to equal distribution. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + autoIndent?: boolean; + /** + * Specifies the width of all columns within the range. If the column widths are not uniform, `null` will be returned. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + columnWidth?: boolean; + /** + * Represents the horizontal alignment for the specified object. See `Excel.HorizontalAlignment` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + horizontalAlignment?: boolean; + /** + * An integer from 0 to 250 that indicates the indent level. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + indentLevel?: boolean; + /** + * The reading order for the range. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readingOrder?: boolean; + /** + * The height of all rows in the range. If the row heights are not uniform, `null` will be returned. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + rowHeight?: boolean; + /** + * Specifies if text automatically shrinks to fit in the available column width. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + shrinkToFit?: boolean; + /** + * The text orientation of all the cells within the range. + The text orientation should be an integer either from -90 to 90, or 180 for vertically-oriented text. + If the orientation within a range are not uniform, then `null` will be returned. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + textOrientation?: boolean; + /** + * Determines if the row height of the `Range` object equals the standard height of the sheet. + Returns `true` if the row height of the `Range` object equals the standard height of the sheet. + Returns `null` if the range contains more than one row and the rows aren't all the same height. + Returns `false` otherwise. + Note: This property is only intended to be set to `true`. Setting it to `false` has no effect. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + useStandardHeight?: boolean; + /** + * Specifies if the column width of the `Range` object equals the standard width of the sheet. + Returns `true` if the column width of the `Range` object equals the standard width of the sheet. + Returns `null` if the range contains more than one column and the columns aren't all the same height. + Returns `false` otherwise. + Note: This property is only intended to be set to `true`. Setting it to `false` has no effect. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + useStandardWidth?: boolean; + /** + * Represents the vertical alignment for the specified object. See `Excel.VerticalAlignment` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + verticalAlignment?: boolean; + /** + * Specifies if Excel wraps the text in the object. A `null` value indicates that the entire range doesn't have a uniform wrap setting + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + wrapText?: boolean; + } + /** + * Represents the format protection of a range object. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + export interface FormatProtectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Specifies if Excel hides the formula for the cells in the range. A `null` value indicates that the entire range doesn't have a uniform formula hidden setting. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + formulaHidden?: boolean; + /** + * Specifies if Excel locks the cells in the object. A `null` value indicates that the entire range doesn't have a uniform lock setting. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + locked?: boolean; + } + /** + * Represents the background of a range object. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface RangeFillLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * HTML color code representing the color of the background, in the form #RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange") + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + color?: boolean; + /** + * The pattern of a range. See `Excel.FillPattern` for details. LinearGradient and RectangularGradient are not supported. + A `null` value indicates that the entire range doesn't have a uniform pattern setting. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + pattern?: boolean; + /** + * The HTML color code representing the color of the range pattern, in the form #RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange"). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + patternColor?: boolean; + /** + * Specifies a double that lightens or darkens a pattern color for the range fill. The value is between -1 (darkest) and 1 (brightest), with 0 for the original color. + A `null` value indicates that the range doesn't have uniform `patternTintAndShade` settings. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + patternTintAndShade?: boolean; + /** + * Specifies a double that lightens or darkens a color for the range fill. The value is between -1 (darkest) and 1 (brightest), with 0 for the original color. + A `null` value indicates that the range doesn't have uniform `tintAndShade` settings. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + tintAndShade?: boolean; + } + /** + * Represents the border of an object. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface RangeBorderLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * HTML color code representing the color of the border line, in the form #RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange"). + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + color?: boolean; + /** + * Constant value that indicates the specific side of the border. See `Excel.BorderIndex` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + sideIndex?: boolean; + /** + * One of the constants of line style specifying the line style for the border. See `Excel.BorderLineStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + style?: boolean; + /** + * Specifies a double that lightens or darkens a color for the range border, the value is between -1 (darkest) and 1 (brightest), with 0 for the original color. + A `null` value indicates that the border doesn't have a uniform `tintAndShade` setting. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + tintAndShade?: boolean; + /** + * Specifies the weight of the border around a range. See `Excel.BorderWeight` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + weight?: boolean; + } + /** + * Represents the border objects that make up the range border. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface RangeBorderCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: HTML color code representing the color of the border line, in the form #RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange"). + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + color?: boolean; + /** + * For EACH ITEM in the collection: Constant value that indicates the specific side of the border. See `Excel.BorderIndex` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + sideIndex?: boolean; + /** + * For EACH ITEM in the collection: One of the constants of line style specifying the line style for the border. See `Excel.BorderLineStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + style?: boolean; + /** + * For EACH ITEM in the collection: Specifies a double that lightens or darkens a color for the range border, the value is between -1 (darkest) and 1 (brightest), with 0 for the original color. + A `null` value indicates that the border doesn't have a uniform `tintAndShade` setting. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + tintAndShade?: boolean; + /** + * For EACH ITEM in the collection: Specifies the weight of the border around a range. See `Excel.BorderWeight` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + weight?: boolean; + } + /** + * This object represents the font attributes (font name, font size, color, etc.) for an object. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface RangeFontLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents the bold status of the font. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + bold?: boolean; + /** + * HTML color code representation of the text color (e.g., #FF0000 represents Red). + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + color?: boolean; + /** + * Specifies the italic status of the font. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + italic?: boolean; + /** + * Font name (e.g., "Calibri"). The name's length should not be greater than 31 characters. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + name?: boolean; + /** + * Font size. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + size?: boolean; + /** + * Specifies the strikethrough status of font. A `null` value indicates that the entire range doesn't have a uniform strikethrough setting. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + strikethrough?: boolean; + /** + * Specifies the subscript status of font. + Returns `true` if all the fonts of the range are subscript. + Returns `false` if all the fonts of the range are superscript or normal (neither superscript, nor subscript). + Returns `null` otherwise. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + subscript?: boolean; + /** + * Specifies the superscript status of font. + Returns `true` if all the fonts of the range are superscript. + Returns `false` if all the fonts of the range are subscript or normal (neither superscript, nor subscript). + Returns `null` otherwise. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + superscript?: boolean; + /** + * Specifies a double that lightens or darkens a color for the range font. The value is between -1 (darkest) and 1 (brightest), with 0 for the original color. + A `null` value indicates that the entire range doesn't have a uniform font `tintAndShade` setting. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + tintAndShade?: boolean; + /** + * Type of underline applied to the font. See `Excel.RangeUnderlineStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + underline?: boolean; + } + /** + * A collection of all the chart objects on a worksheet. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface ChartCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Represents chart axes. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + axes?: Excel.Interfaces.ChartAxesLoadOptions; + /** + * For EACH ITEM in the collection: Represents the data labels on the chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + dataLabels?: Excel.Interfaces.ChartDataLabelsLoadOptions; + /** + * For EACH ITEM in the collection: Encapsulates the format properties for the chart area. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + format?: Excel.Interfaces.ChartAreaFormatLoadOptions; + /** + * For EACH ITEM in the collection: Represents the legend for the chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + legend?: Excel.Interfaces.ChartLegendLoadOptions; + /** + * For EACH ITEM in the collection: Encapsulates the options for a pivot chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + pivotOptions?: Excel.Interfaces.ChartPivotOptionsLoadOptions; + /** + * For EACH ITEM in the collection: Represents the plot area for the chart. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + plotArea?: Excel.Interfaces.ChartPlotAreaLoadOptions; + /** + * For EACH ITEM in the collection: Represents either a single series or collection of series in the chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + series?: Excel.Interfaces.ChartSeriesCollectionLoadOptions; + /** + * For EACH ITEM in the collection: Represents the title of the specified chart, including the text, visibility, position, and formatting of the title. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + title?: Excel.Interfaces.ChartTitleLoadOptions; + /** + * For EACH ITEM in the collection: The worksheet containing the current chart. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + worksheet?: Excel.Interfaces.WorksheetLoadOptions; + /** + * For EACH ITEM in the collection: Specifies a chart category label level enumeration constant, referring to the level of the source category labels. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + categoryLabelLevel?: boolean; + /** + * For EACH ITEM in the collection: Specifies the type of the chart. See `Excel.ChartType` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + chartType?: boolean; + /** + * For EACH ITEM in the collection: Specifies the way that blank cells are plotted on a chart. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + displayBlanksAs?: boolean; + /** + * For EACH ITEM in the collection: Specifies the height, in points, of the chart object. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + height?: boolean; + /** + * For EACH ITEM in the collection: The unique ID of chart. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + id?: boolean; + /** + * For EACH ITEM in the collection: The distance, in points, from the left side of the chart to the worksheet origin. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + left?: boolean; + /** + * For EACH ITEM in the collection: Specifies the name of a chart object. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + name?: boolean; + /** + * For EACH ITEM in the collection: Specifies the way columns or rows are used as data series on the chart. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + plotBy?: boolean; + /** + * For EACH ITEM in the collection: True if only visible cells are plotted. False if both visible and hidden cells are plotted. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + plotVisibleOnly?: boolean; + /** + * For EACH ITEM in the collection: Specifies a chart series name level enumeration constant, referring to the level of the source series names. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + seriesNameLevel?: boolean; + /** + * For EACH ITEM in the collection: Specifies whether to display all field buttons on a PivotChart. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showAllFieldButtons?: boolean; + /** + * For EACH ITEM in the collection: Specifies whether to show the data labels when the value is greater than the maximum value on the value axis. + If the value axis becomes smaller than the size of the data points, you can use this property to set whether to show the data labels. + This property applies to 2-D charts only. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showDataLabelsOverMaximum?: boolean; + /** + * For EACH ITEM in the collection: Specifies the chart style for the chart. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + style?: boolean; + /** + * For EACH ITEM in the collection: Specifies the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart). + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + top?: boolean; + /** + * For EACH ITEM in the collection: Specifies the width, in points, of the chart object. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + width?: boolean; + } + /** + * Represents a chart object in a workbook. + To learn more about the chart object model, see {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-charts | Work with charts using the Excel JavaScript API}. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface ChartLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents chart axes. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + axes?: Excel.Interfaces.ChartAxesLoadOptions; + /** + * Represents the data labels on the chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + dataLabels?: Excel.Interfaces.ChartDataLabelsLoadOptions; + /** + * Encapsulates the format properties for the chart area. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + format?: Excel.Interfaces.ChartAreaFormatLoadOptions; + /** + * Represents the legend for the chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + legend?: Excel.Interfaces.ChartLegendLoadOptions; + /** + * Encapsulates the options for a pivot chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + pivotOptions?: Excel.Interfaces.ChartPivotOptionsLoadOptions; + /** + * Represents the plot area for the chart. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + plotArea?: Excel.Interfaces.ChartPlotAreaLoadOptions; + /** + * Represents either a single series or collection of series in the chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + series?: Excel.Interfaces.ChartSeriesCollectionLoadOptions; + /** + * Represents the title of the specified chart, including the text, visibility, position, and formatting of the title. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + title?: Excel.Interfaces.ChartTitleLoadOptions; + /** + * The worksheet containing the current chart. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + worksheet?: Excel.Interfaces.WorksheetLoadOptions; + /** + * Specifies a chart category label level enumeration constant, referring to the level of the source category labels. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + categoryLabelLevel?: boolean; + /** + * Specifies the type of the chart. See `Excel.ChartType` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + chartType?: boolean; + /** + * Specifies the way that blank cells are plotted on a chart. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + displayBlanksAs?: boolean; + /** + * Specifies the height, in points, of the chart object. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + height?: boolean; + /** + * The unique ID of chart. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + id?: boolean; + /** + * The distance, in points, from the left side of the chart to the worksheet origin. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + left?: boolean; + /** + * Specifies the name of a chart object. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + name?: boolean; + /** + * Specifies the way columns or rows are used as data series on the chart. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + plotBy?: boolean; + /** + * True if only visible cells are plotted. False if both visible and hidden cells are plotted. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + plotVisibleOnly?: boolean; + /** + * Specifies a chart series name level enumeration constant, referring to the level of the source series names. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + seriesNameLevel?: boolean; + /** + * Specifies whether to display all field buttons on a PivotChart. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showAllFieldButtons?: boolean; + /** + * Specifies whether to show the data labels when the value is greater than the maximum value on the value axis. + If the value axis becomes smaller than the size of the data points, you can use this property to set whether to show the data labels. + This property applies to 2-D charts only. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showDataLabelsOverMaximum?: boolean; + /** + * Specifies the chart style for the chart. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + style?: boolean; + /** + * Specifies the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart). + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + top?: boolean; + /** + * Specifies the width, in points, of the chart object. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + width?: boolean; + } + /** + * Encapsulates the options for the pivot chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface ChartPivotOptionsLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Specifies whether to display the axis field buttons on a PivotChart. The `showAxisFieldButtons` property corresponds to the "Show Axis Field Buttons" command on the "Field Buttons" drop-down list of the "Analyze" tab, which is available when a PivotChart is selected. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showAxisFieldButtons?: boolean; + /** + * Specifies whether to display the legend field buttons on a PivotChart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showLegendFieldButtons?: boolean; + /** + * Specifies whether to display the report filter field buttons on a PivotChart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showReportFilterFieldButtons?: boolean; + /** + * Specifies whether to display the show value field buttons on a PivotChart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showValueFieldButtons?: boolean; + } + /** + * Encapsulates the format properties for the overall chart area. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface ChartAreaFormatLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents the border format of chart area, which includes color, linestyle, and weight. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + border?: Excel.Interfaces.ChartBorderLoadOptions; + /** + * Represents the font attributes (font name, font size, color, etc.) for the current object. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + font?: Excel.Interfaces.ChartFontLoadOptions; + /** + * Specifies the color scheme of the chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + colorScheme?: boolean; + /** + * Specifies if the chart area of the chart has rounded corners. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + roundedCorners?: boolean; + } + /** + * Represents a collection of chart series. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface ChartSeriesCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Encapsulates the bin options for histogram charts and pareto charts. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + binOptions?: Excel.Interfaces.ChartBinOptionsLoadOptions; + /** + * For EACH ITEM in the collection: Encapsulates the options for the box and whisker charts. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + boxwhiskerOptions?: Excel.Interfaces.ChartBoxwhiskerOptionsLoadOptions; + /** + * For EACH ITEM in the collection: Represents a collection of all data labels in the series. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + dataLabels?: Excel.Interfaces.ChartDataLabelsLoadOptions; + /** + * For EACH ITEM in the collection: Represents the formatting of a chart series, which includes fill and line formatting. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + format?: Excel.Interfaces.ChartSeriesFormatLoadOptions; + /** + * For EACH ITEM in the collection: Encapsulates the options for a region map chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + mapOptions?: Excel.Interfaces.ChartMapOptionsLoadOptions; + /** + * For EACH ITEM in the collection: Returns a collection of all points in the series. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + points?: Excel.Interfaces.ChartPointsCollectionLoadOptions; + /** + * For EACH ITEM in the collection: Represents the error bar object of a chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + xErrorBars?: Excel.Interfaces.ChartErrorBarsLoadOptions; + /** + * For EACH ITEM in the collection: Represents the error bar object of a chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + yErrorBars?: Excel.Interfaces.ChartErrorBarsLoadOptions; + /** + * For EACH ITEM in the collection: Specifies the group for the specified series. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + axisGroup?: boolean; + /** + * For EACH ITEM in the collection: This can be an integer value from 0 (zero) to 300, representing the percentage of the default size. This property only applies to bubble charts. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + bubbleScale?: boolean; + /** + * For EACH ITEM in the collection: Represents the chart type of a series. See `Excel.ChartType` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + chartType?: boolean; + /** + * For EACH ITEM in the collection: Represents the doughnut hole size of a chart series. Only valid on doughnut and doughnut exploded charts. + Throws an `InvalidArgument` error on invalid charts. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + doughnutHoleSize?: boolean; + /** + * For EACH ITEM in the collection: Specifies the explosion value for a pie-chart or doughnut-chart slice. Returns 0 (zero) if there's no explosion (the tip of the slice is in the center of the pie). + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + explosion?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the series is filtered. Not applicable for surface charts. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + filtered?: boolean; + /** + * For EACH ITEM in the collection: Specifies the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical). Applies only to pie, 3-D pie, and doughnut charts. Can be a value from 0 through 360. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + firstSliceAngle?: boolean; + /** + * For EACH ITEM in the collection: Represents the gap width of a chart series. Only valid on bar and column charts, as well as + specific classes of line and pie charts. Throws an invalid argument exception on invalid charts. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + gapWidth?: boolean; + /** + * For EACH ITEM in the collection: Specifies the color for maximum value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMaximumColor?: boolean; + /** + * For EACH ITEM in the collection: Specifies the type for maximum value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMaximumType?: boolean; + /** + * For EACH ITEM in the collection: Specifies the maximum value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMaximumValue?: boolean; + /** + * For EACH ITEM in the collection: Specifies the color for the midpoint value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMidpointColor?: boolean; + /** + * For EACH ITEM in the collection: Specifies the type for the midpoint value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMidpointType?: boolean; + /** + * For EACH ITEM in the collection: Specifies the midpoint value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMidpointValue?: boolean; + /** + * For EACH ITEM in the collection: Specifies the color for the minimum value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMinimumColor?: boolean; + /** + * For EACH ITEM in the collection: Specifies the type for the minimum value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMinimumType?: boolean; + /** + * For EACH ITEM in the collection: Specifies the minimum value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMinimumValue?: boolean; + /** + * For EACH ITEM in the collection: Specifies the series gradient style of a region map chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientStyle?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the series has data labels. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + hasDataLabels?: boolean; + /** + * For EACH ITEM in the collection: Specifies the fill color for negative data points in a series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + invertColor?: boolean; + /** + * For EACH ITEM in the collection: True if Excel inverts the pattern in the item when it corresponds to a negative number. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + invertIfNegative?: boolean; + /** + * For EACH ITEM in the collection: Specifies the marker background color of a chart series. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + markerBackgroundColor?: boolean; + /** + * For EACH ITEM in the collection: Specifies the marker foreground color of a chart series. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + markerForegroundColor?: boolean; + /** + * For EACH ITEM in the collection: Specifies the marker size of a chart series. + The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + markerSize?: boolean; + /** + * For EACH ITEM in the collection: Specifies the marker style of a chart series. See `Excel.ChartMarkerStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + markerStyle?: boolean; + /** + * For EACH ITEM in the collection: Specifies the name of a series in a chart. The name's length should not be greater than 255 characters. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + name?: boolean; + /** + * For EACH ITEM in the collection: Specifies how bars and columns are positioned. Can be a value between -100 and 100. Applies only to 2-D bar and 2-D column charts. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + overlap?: boolean; + /** + * For EACH ITEM in the collection: Specifies the series parent label strategy area for a treemap chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + parentLabelStrategy?: boolean; + /** + * For EACH ITEM in the collection: Specifies the plot order of a chart series within the chart group. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + plotOrder?: boolean; + /** + * For EACH ITEM in the collection: Specifies the size of the secondary section of either a pie-of-pie chart or a bar-of-pie chart, as a percentage of the size of the primary pie. Can be a value from 5 to 200. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + secondPlotSize?: boolean; + /** + * For EACH ITEM in the collection: Specifies whether connector lines are shown in waterfall charts. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showConnectorLines?: boolean; + /** + * For EACH ITEM in the collection: Specifies whether leader lines are displayed for each data label in the series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showLeaderLines?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the series has a shadow. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showShadow?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the series is smooth. Only applicable to line and scatter charts. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + smooth?: boolean; + /** + * For EACH ITEM in the collection: Specifies the way the two sections of either a pie-of-pie chart or a bar-of-pie chart are split. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + splitType?: boolean; + /** + * For EACH ITEM in the collection: Specifies the threshold value that separates two sections of either a pie-of-pie chart or a bar-of-pie chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + splitValue?: boolean; + /** + * For EACH ITEM in the collection: True if Excel assigns a different color or pattern to each data marker. The chart must contain only one series. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + varyByCategories?: boolean; + } + /** + * Represents a series in a chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface ChartSeriesLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Encapsulates the bin options for histogram charts and pareto charts. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + binOptions?: Excel.Interfaces.ChartBinOptionsLoadOptions; + /** + * Encapsulates the options for the box and whisker charts. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + boxwhiskerOptions?: Excel.Interfaces.ChartBoxwhiskerOptionsLoadOptions; + /** + * Represents a collection of all data labels in the series. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + dataLabels?: Excel.Interfaces.ChartDataLabelsLoadOptions; + /** + * Represents the formatting of a chart series, which includes fill and line formatting. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + format?: Excel.Interfaces.ChartSeriesFormatLoadOptions; + /** + * Encapsulates the options for a region map chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + mapOptions?: Excel.Interfaces.ChartMapOptionsLoadOptions; + /** + * Returns a collection of all points in the series. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + points?: Excel.Interfaces.ChartPointsCollectionLoadOptions; + /** + * Represents the error bar object of a chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + xErrorBars?: Excel.Interfaces.ChartErrorBarsLoadOptions; + /** + * Represents the error bar object of a chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + yErrorBars?: Excel.Interfaces.ChartErrorBarsLoadOptions; + /** + * Specifies the group for the specified series. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + axisGroup?: boolean; + /** + * This can be an integer value from 0 (zero) to 300, representing the percentage of the default size. This property only applies to bubble charts. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + bubbleScale?: boolean; + /** + * Represents the chart type of a series. See `Excel.ChartType` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + chartType?: boolean; + /** + * Represents the doughnut hole size of a chart series. Only valid on doughnut and doughnut exploded charts. + Throws an `InvalidArgument` error on invalid charts. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + doughnutHoleSize?: boolean; + /** + * Specifies the explosion value for a pie-chart or doughnut-chart slice. Returns 0 (zero) if there's no explosion (the tip of the slice is in the center of the pie). + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + explosion?: boolean; + /** + * Specifies if the series is filtered. Not applicable for surface charts. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + filtered?: boolean; + /** + * Specifies the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical). Applies only to pie, 3-D pie, and doughnut charts. Can be a value from 0 through 360. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + firstSliceAngle?: boolean; + /** + * Represents the gap width of a chart series. Only valid on bar and column charts, as well as + specific classes of line and pie charts. Throws an invalid argument exception on invalid charts. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + gapWidth?: boolean; + /** + * Specifies the color for maximum value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMaximumColor?: boolean; + /** + * Specifies the type for maximum value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMaximumType?: boolean; + /** + * Specifies the maximum value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMaximumValue?: boolean; + /** + * Specifies the color for the midpoint value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMidpointColor?: boolean; + /** + * Specifies the type for the midpoint value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMidpointType?: boolean; + /** + * Specifies the midpoint value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMidpointValue?: boolean; + /** + * Specifies the color for the minimum value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMinimumColor?: boolean; + /** + * Specifies the type for the minimum value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMinimumType?: boolean; + /** + * Specifies the minimum value of a region map chart series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientMinimumValue?: boolean; + /** + * Specifies the series gradient style of a region map chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + gradientStyle?: boolean; + /** + * Specifies if the series has data labels. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + hasDataLabels?: boolean; + /** + * Specifies the fill color for negative data points in a series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + invertColor?: boolean; + /** + * True if Excel inverts the pattern in the item when it corresponds to a negative number. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + invertIfNegative?: boolean; + /** + * Specifies the marker background color of a chart series. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + markerBackgroundColor?: boolean; + /** + * Specifies the marker foreground color of a chart series. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + markerForegroundColor?: boolean; + /** + * Specifies the marker size of a chart series. + The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + markerSize?: boolean; + /** + * Specifies the marker style of a chart series. See `Excel.ChartMarkerStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + markerStyle?: boolean; + /** + * Specifies the name of a series in a chart. The name's length should not be greater than 255 characters. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + name?: boolean; + /** + * Specifies how bars and columns are positioned. Can be a value between -100 and 100. Applies only to 2-D bar and 2-D column charts. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + overlap?: boolean; + /** + * Specifies the series parent label strategy area for a treemap chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + parentLabelStrategy?: boolean; + /** + * Specifies the plot order of a chart series within the chart group. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + plotOrder?: boolean; + /** + * Specifies the size of the secondary section of either a pie-of-pie chart or a bar-of-pie chart, as a percentage of the size of the primary pie. Can be a value from 5 to 200. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + secondPlotSize?: boolean; + /** + * Specifies whether connector lines are shown in waterfall charts. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showConnectorLines?: boolean; + /** + * Specifies whether leader lines are displayed for each data label in the series. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showLeaderLines?: boolean; + /** + * Specifies if the series has a shadow. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showShadow?: boolean; + /** + * Specifies if the series is smooth. Only applicable to line and scatter charts. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + smooth?: boolean; + /** + * Specifies the way the two sections of either a pie-of-pie chart or a bar-of-pie chart are split. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + splitType?: boolean; + /** + * Specifies the threshold value that separates two sections of either a pie-of-pie chart or a bar-of-pie chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + splitValue?: boolean; + /** + * True if Excel assigns a different color or pattern to each data marker. The chart must contain only one series. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + varyByCategories?: boolean; + } + /** + * Encapsulates the format properties for the chart series + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface ChartSeriesFormatLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents line formatting. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + line?: Excel.Interfaces.ChartLineFormatLoadOptions; + } + /** + * A collection of all the chart points within a series inside a chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface ChartPointsCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Returns the data label of a chart point. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + dataLabel?: Excel.Interfaces.ChartDataLabelLoadOptions; + /** + * For EACH ITEM in the collection: Encapsulates the format properties chart point. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + format?: Excel.Interfaces.ChartPointFormatLoadOptions; + /** + * For EACH ITEM in the collection: Represents whether a data point has a data label. Not applicable for surface charts. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + hasDataLabel?: boolean; + /** + * For EACH ITEM in the collection: HTML color code representation of the marker background color of a data point (e.g., #FF0000 represents Red). + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + markerBackgroundColor?: boolean; + /** + * For EACH ITEM in the collection: HTML color code representation of the marker foreground color of a data point (e.g., #FF0000 represents Red). + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + markerForegroundColor?: boolean; + /** + * For EACH ITEM in the collection: Represents marker size of a data point. + The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + markerSize?: boolean; + /** + * For EACH ITEM in the collection: Represents marker style of a chart data point. See `Excel.ChartMarkerStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + markerStyle?: boolean; + /** + * For EACH ITEM in the collection: Returns the value of a chart point. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + value?: boolean; + } + /** + * Represents a point of a series in a chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface ChartPointLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Returns the data label of a chart point. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + dataLabel?: Excel.Interfaces.ChartDataLabelLoadOptions; + /** + * Encapsulates the format properties chart point. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + format?: Excel.Interfaces.ChartPointFormatLoadOptions; + /** + * Represents whether a data point has a data label. Not applicable for surface charts. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + hasDataLabel?: boolean; + /** + * HTML color code representation of the marker background color of a data point (e.g., #FF0000 represents Red). + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + markerBackgroundColor?: boolean; + /** + * HTML color code representation of the marker foreground color of a data point (e.g., #FF0000 represents Red). + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + markerForegroundColor?: boolean; + /** + * Represents marker size of a data point. + The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + markerSize?: boolean; + /** + * Represents marker style of a chart data point. See `Excel.ChartMarkerStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + markerStyle?: boolean; + /** + * Returns the value of a chart point. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + value?: boolean; + } + /** + * Represents the formatting object for chart points. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface ChartPointFormatLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents the border format of a chart data point, which includes color, style, and weight information. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + border?: Excel.Interfaces.ChartBorderLoadOptions; + } + /** + * Represents the chart axes. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface ChartAxesLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents the category axis in a chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + categoryAxis?: Excel.Interfaces.ChartAxisLoadOptions; + /** + * Represents the series axis of a 3-D chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + seriesAxis?: Excel.Interfaces.ChartAxisLoadOptions; + /** + * Represents the value axis in an axis. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + valueAxis?: Excel.Interfaces.ChartAxisLoadOptions; + } + /** + * Represents a single axis in a chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface ChartAxisLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents the formatting of a chart object, which includes line and font formatting. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + format?: Excel.Interfaces.ChartAxisFormatLoadOptions; + /** + * Returns an object that represents the major gridlines for the specified axis. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + majorGridlines?: Excel.Interfaces.ChartGridlinesLoadOptions; + /** + * Returns an object that represents the minor gridlines for the specified axis. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + minorGridlines?: Excel.Interfaces.ChartGridlinesLoadOptions; + /** + * Represents the axis title. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + title?: Excel.Interfaces.ChartAxisTitleLoadOptions; + /** + * Specifies the alignment for the specified axis tick label. See `Excel.ChartTextHorizontalAlignment` for detail. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + alignment?: boolean; + /** + * Specifies the group for the specified axis. See `Excel.ChartAxisGroup` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + axisGroup?: boolean; + /** + * Specifies the base unit for the specified category axis. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + baseTimeUnit?: boolean; + /** + * Specifies the category axis type. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + categoryType?: boolean; + /** + * Specifies the custom axis display unit value. To set this property, please use the `SetCustomDisplayUnit(double)` method. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + customDisplayUnit?: boolean; + /** + * Represents the axis display unit. See `Excel.ChartAxisDisplayUnit` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + displayUnit?: boolean; + /** + * Specifies the height, in points, of the chart axis. Returns `null` if the axis is not visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + height?: boolean; + /** + * Specifies if the value axis crosses the category axis between categories. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + isBetweenCategories?: boolean; + /** + * Specifies the distance, in points, from the left edge of the axis to the left of chart area. Returns `null` if the axis is not visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + left?: boolean; + /** + * Specifies if the number format is linked to the cells. If `true`, the number format will change in the labels when it changes in the cells. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + linkNumberFormat?: boolean; + /** + * Specifies the base of the logarithm when using logarithmic scales. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + logBase?: boolean; + /** + * Specifies the type of major tick mark for the specified axis. See `Excel.ChartAxisTickMark` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + majorTickMark?: boolean; + /** + * Specifies the major unit scale value for the category axis when the `categoryType` property is set to `dateAxis`. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + majorTimeUnitScale?: boolean; + /** + * Represents the interval between two major tick marks. Can be set to a numeric value or an empty string. The returned value is always a number. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + majorUnit?: boolean; + /** + * Represents the maximum value on the value axis. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + maximum?: boolean; + /** + * Represents the minimum value on the value axis. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + minimum?: boolean; + /** + * Specifies the type of minor tick mark for the specified axis. See `Excel.ChartAxisTickMark` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + minorTickMark?: boolean; + /** + * Specifies the minor unit scale value for the category axis when the `categoryType` property is set to `dateAxis`. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + minorTimeUnitScale?: boolean; + /** + * Represents the interval between two minor tick marks. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + minorUnit?: boolean; + /** + * Specifies if an axis is multilevel. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + multiLevel?: boolean; + /** + * Specifies the format code for the axis tick label. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + numberFormat?: boolean; + /** + * Specifies the distance between the levels of labels, and the distance between the first level and the axis line. The value should be an integer from 0 to 1000. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + offset?: boolean; + /** + * Specifies the specified axis position where the other axis crosses. See `Excel.ChartAxisPosition` for details. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + position?: boolean; + /** + * Specifies the axis position where the other axis crosses. You should use the `SetPositionAt(double)` method to set this property. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + positionAt?: boolean; + /** + * Specifies if Excel plots data points from last to first. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + reversePlotOrder?: boolean; + /** + * Specifies the value axis scale type. See `Excel.ChartAxisScaleType` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + scaleType?: boolean; + /** + * Specifies if the axis display unit label is visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showDisplayUnitLabel?: boolean; + /** + * Specifies the angle to which the text is oriented for the chart axis tick label. The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + textOrientation?: boolean; + /** + * Specifies the position of tick-mark labels on the specified axis. See `Excel.ChartAxisTickLabelPosition` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + tickLabelPosition?: boolean; + /** + * Specifies the number of categories or series between tick-mark labels. Can be a value from 1 through 31999 or an empty string for automatic setting. The returned value is always a number. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + tickLabelSpacing?: boolean; + /** + * Specifies the number of categories or series between tick marks. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + tickMarkSpacing?: boolean; + /** + * Specifies the distance, in points, from the top edge of the axis to the top of chart area. Returns `null` if the axis is not visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + top?: boolean; + /** + * Specifies the axis type. See `Excel.ChartAxisType` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + type?: boolean; + /** + * Specifies if the axis is visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + visible?: boolean; + /** + * Specifies the width, in points, of the chart axis. Returns `null` if the axis is not visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + width?: boolean; + } + /** + * Encapsulates the format properties for the chart axis. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface ChartAxisFormatLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Specifies the font attributes (font name, font size, color, etc.) for a chart axis element. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + font?: Excel.Interfaces.ChartFontLoadOptions; + /** + * Specifies chart line formatting. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + line?: Excel.Interfaces.ChartLineFormatLoadOptions; + } + /** + * Represents the title of a chart axis. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface ChartAxisTitleLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Specifies the formatting of the chart axis title. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + format?: Excel.Interfaces.ChartAxisTitleFormatLoadOptions; + /** + * Specifies the axis title. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + text?: boolean; + /** + * Specifies the angle to which the text is oriented for the chart axis title. The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + textOrientation?: boolean; + /** + * Specifies if the axis title is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + visible?: boolean; + } + /** + * Represents the chart axis title formatting. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface ChartAxisTitleFormatLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Specifies the chart axis title's border format, which includes color, linestyle, and weight. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + border?: Excel.Interfaces.ChartBorderLoadOptions; + /** + * Specifies the chart axis title's font attributes, such as font name, font size, or color, of the chart axis title object. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + font?: Excel.Interfaces.ChartFontLoadOptions; + } + /** + * Represents a collection of all the data labels on a chart point. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface ChartDataLabelsLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Specifies the format of chart data labels, which includes fill and font formatting. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + format?: Excel.Interfaces.ChartDataLabelFormatLoadOptions; + /** + * Gets an object that represents the leader lines of the data labels. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + leaderLines?: Excel.Interfaces.ChartLeaderLinesLoadOptions; + /** + * Specifies if data labels automatically generate appropriate text based on context. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + autoText?: boolean; + /** + * Specifies the geometric shape type of the data labels. See `Excel.GeometricShapeType` for more details. + Value is `null` if the data labels are not geometric shapes. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + geometricShapeType?: boolean; + /** + * Specifies the horizontal alignment for chart data label. See `Excel.ChartTextHorizontalAlignment` for details. + This property is valid only when the `TextOrientation` of data label is 0. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + horizontalAlignment?: boolean; + /** + * Specifies if the number format is linked to the cells. If `true`, the number format will change in the labels when it changes in the cells. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + linkNumberFormat?: boolean; + /** + * Specifies the format code for data labels. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + numberFormat?: boolean; + /** + * Value that represents the position of the data label. See `Excel.ChartDataLabelPosition` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + position?: boolean; + /** + * String representing the separator used for the data labels on a chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + separator?: boolean; + /** + * Specifies if the data labels are shown as a callout with the tail anchor attached to the data point. + If `true`, the callout is one of the following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or "WedgeEllipseCallout". + See {@link Excel.GeometricShapeType | GeometricShapeType} for more details. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + showAsStickyCallout?: boolean; + /** + * Specifies if the data label bubble size is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + showBubbleSize?: boolean; + /** + * Specifies if the data label category name is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + showCategoryName?: boolean; + /** + * Specifies if leader lines are displayed for the data labels. `true` if leader lines are shown; otherwise, `false`. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + showLeaderLines?: boolean; + /** + * Specifies if the data label legend key is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + showLegendKey?: boolean; + /** + * Specifies if the data label percentage is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + showPercentage?: boolean; + /** + * Specifies if the data label series name is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + showSeriesName?: boolean; + /** + * Specifies if the data label value is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + showValue?: boolean; + /** + * Represents the angle to which the text is oriented for data labels. The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + textOrientation?: boolean; + /** + * Represents the vertical alignment of chart data label. See `Excel.ChartTextVerticalAlignment` for details. + This property is valid only when `TextOrientation` of the data label is -90, 90, or 180. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + verticalAlignment?: boolean; + } + /** + * Represents the data label of a chart point. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + export interface ChartDataLabelLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents the format of chart data label. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + format?: Excel.Interfaces.ChartDataLabelFormatLoadOptions; + /** + * Specifies if the data label automatically generates appropriate text based on context. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + autoText?: boolean; + /** + * String value that represents the formula of chart data label using A1-style notation. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + formula?: boolean; + /** + * Specifies the geometric shape type of the data label. See `Excel.GeometricShapeType` for more details. + Value is `null` if the data label is not a geometric shape. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + geometricShapeType?: boolean; + /** + * Returns the height, in points, of the chart data label. + Value is `null` if the chart data label is not visible. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + height?: boolean; + /** + * Represents the horizontal alignment for chart data label. + See `Excel.ChartTextHorizontalAlignment` for details. + This property is valid only when `TextOrientation` of data label is -90, 90, or 180. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + horizontalAlignment?: boolean; + /** + * Represents the distance, in points, from the left edge of chart data label to the left edge of chart area. Value is `null` if the chart data label is not visible. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + left?: boolean; + /** + * Specifies if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + linkNumberFormat?: boolean; + /** + * Specifies the format code for data label. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + numberFormat?: boolean; + /** + * Value that represents the position of the data label. + See `Excel.ChartDataLabelPosition` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + position?: boolean; + /** + * String representing the separator used for the data label on a chart. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + separator?: boolean; + /** + * Specifies if the data label is shown as a callout with the tail anchor attached to the data point. + If `true`, the callout is one of the following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or "WedgeEllipseCallout". + See {@link Excel.GeometricShapeType | GeometricShapeType} for more details. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + showAsStickyCallout?: boolean; + /** + * Specifies if the data label bubble size is visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showBubbleSize?: boolean; + /** + * Specifies if the data label category name is visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showCategoryName?: boolean; + /** + * Specifies if the data label legend key is visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showLegendKey?: boolean; + /** + * Specifies if the data label percentage is visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showPercentage?: boolean; + /** + * Specifies if the data label series name is visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showSeriesName?: boolean; + /** + * Specifies if the data label value is visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showValue?: boolean; + /** + * String representing the text of the data label on a chart. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + text?: boolean; + /** + * Represents the angle to which the text is oriented for the chart data label. + The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + textOrientation?: boolean; + /** + * Represents the distance, in points, from the top edge of chart data label to the top of chart area. Value is `null` if the chart data label is not visible. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + top?: boolean; + /** + * Represents the vertical alignment of chart data label. + See `Excel.ChartTextVerticalAlignment` for details. + This property is valid only when `TextOrientation` of data label is 0. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + verticalAlignment?: boolean; + /** + * Returns the width, in points, of the chart data label. + Value is `null` if the chart data label is not visible. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + width?: boolean; + } + /** + * Encapsulates the format properties for the chart data labels. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface ChartDataLabelFormatLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents the border format, which includes color, linestyle, and weight. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + border?: Excel.Interfaces.ChartBorderLoadOptions; + /** + * Represents the font attributes (such as font name, font size, and color) for a chart data label. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + font?: Excel.Interfaces.ChartFontLoadOptions; + } + /** + * Represents the chart data label anchor. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + export interface ChartDataLabelAnchorLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Specifies the distance, in points, from the anchor to the left edge of the chart data label. + Note that when getting the value, it may differ slightly from the set value. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + left?: boolean; + /** + * Specifies the distance, in points, from the anchor to the top edge of the chart data label. + Note that when getting the value, it may differ slightly from the set value. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + top?: boolean; + } + /** + * Represents the data table object of a chart. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + export interface ChartDataTableLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents the format of a chart data table, which includes fill, font, and border format. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + format?: Excel.Interfaces.ChartDataTableFormatLoadOptions; + /** + * Specifies whether to display the horizontal border of the data table. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + showHorizontalBorder?: boolean; + /** + * Specifies whether to show the legend key of the data table. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + showLegendKey?: boolean; + /** + * Specifies whether to display the outline border of the data table. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + showOutlineBorder?: boolean; + /** + * Specifies whether to display the vertical border of the data table. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + showVerticalBorder?: boolean; + /** + * Specifies whether to show the data table of the chart. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + visible?: boolean; + } + /** + * Represents the format of a chart data table. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + export interface ChartDataTableFormatLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents the border format of chart data table, which includes color, line style, and weight. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + border?: Excel.Interfaces.ChartBorderLoadOptions; + /** + * Represents the font attributes (such as font name, font size, and color) for the current object. + * + * @remarks + * [Api set: ExcelApi 1.14] + */ + font?: Excel.Interfaces.ChartFontLoadOptions; + } + /** + * This object represents the attributes for a chart's error bars. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface ChartErrorBarsLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Specifies the formatting type of the error bars. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + format?: Excel.Interfaces.ChartErrorBarsFormatLoadOptions; + /** + * Specifies if error bars have an end style cap. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + endStyleCap?: boolean; + /** + * Specifies which parts of the error bars to include. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + include?: boolean; + /** + * The type of range marked by the error bars. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + type?: boolean; + /** + * Specifies whether the error bars are displayed. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + visible?: boolean; + } + /** + * Encapsulates the format properties for chart error bars. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface ChartErrorBarsFormatLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents the chart line formatting. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + line?: Excel.Interfaces.ChartLineFormatLoadOptions; + } + /** + * Represents major or minor gridlines on a chart axis. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface ChartGridlinesLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents the formatting of chart gridlines. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + format?: Excel.Interfaces.ChartGridlinesFormatLoadOptions; + /** + * Specifies if the axis gridlines are visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + visible?: boolean; + } + /** + * Encapsulates the format properties for chart gridlines. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface ChartGridlinesFormatLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents chart line formatting. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + line?: Excel.Interfaces.ChartLineFormatLoadOptions; + } + /** + * Represents the legend in a chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface ChartLegendLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents the formatting of a chart legend, which includes fill and font formatting. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + format?: Excel.Interfaces.ChartLegendFormatLoadOptions; + /** + * Specifies the height, in points, of the legend on the chart. Value is `null` if the legend is not visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + height?: boolean; + /** + * Specifies the left value, in points, of the legend on the chart. Value is `null` if the legend is not visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + left?: boolean; + /** + * Specifies if the chart legend should overlap with the main body of the chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + overlay?: boolean; + /** + * Specifies the position of the legend on the chart. See `Excel.ChartLegendPosition` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + position?: boolean; + /** + * Specifies if the legend has a shadow on the chart. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showShadow?: boolean; + /** + * Specifies the top of a chart legend. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + top?: boolean; + /** + * Specifies if the chart legend is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + visible?: boolean; + /** + * Specifies the width, in points, of the legend on the chart. Value is `null` if the legend is not visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + width?: boolean; + } + /** + * Represents the legend entry in `legendEntryCollection`. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + export interface ChartLegendEntryLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Specifies the height of the legend entry on the chart legend. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + height?: boolean; + /** + * Specifies the index of the legend entry in the chart legend. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + index?: boolean; + /** + * Specifies the left value of a chart legend entry. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + left?: boolean; + /** + * Specifies the top of a chart legend entry. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + top?: boolean; + /** + * Represents the visibility of a chart legend entry. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + visible?: boolean; + /** + * Represents the width of the legend entry on the chart Legend. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + width?: boolean; + } + /** + * Represents a collection of legend entries. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + export interface ChartLegendEntryCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Specifies the height of the legend entry on the chart legend. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + height?: boolean; + /** + * For EACH ITEM in the collection: Specifies the index of the legend entry in the chart legend. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + index?: boolean; + /** + * For EACH ITEM in the collection: Specifies the left value of a chart legend entry. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + left?: boolean; + /** + * For EACH ITEM in the collection: Specifies the top of a chart legend entry. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + top?: boolean; + /** + * For EACH ITEM in the collection: Represents the visibility of a chart legend entry. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + visible?: boolean; + /** + * For EACH ITEM in the collection: Represents the width of the legend entry on the chart Legend. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + width?: boolean; + } + /** + * Encapsulates the format properties of a chart legend. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface ChartLegendFormatLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents the border format, which includes color, linestyle, and weight. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + border?: Excel.Interfaces.ChartBorderLoadOptions; + /** + * Represents the font attributes such as font name, font size, and color of a chart legend. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + font?: Excel.Interfaces.ChartFontLoadOptions; + } + /** + * Encapsulates the properties for a region map chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface ChartMapOptionsLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Specifies the series map labels strategy of a region map chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + labelStrategy?: boolean; + /** + * Specifies the series mapping level of a region map chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + level?: boolean; + /** + * Specifies the series projection type of a region map chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + projectionType?: boolean; + } + /** + * Represents a chart title object of a chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface ChartTitleLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents the formatting of a chart title, which includes fill and font formatting. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + format?: Excel.Interfaces.ChartTitleFormatLoadOptions; + /** + * Returns the height, in points, of the chart title. Value is `null` if the chart title is not visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + height?: boolean; + /** + * Specifies the horizontal alignment for chart title. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + horizontalAlignment?: boolean; + /** + * Specifies the distance, in points, from the left edge of chart title to the left edge of chart area. Value is `null` if the chart title is not visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + left?: boolean; + /** + * Specifies if the chart title will overlay the chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + overlay?: boolean; + /** + * Represents the position of chart title. See `Excel.ChartTitlePosition` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + position?: boolean; + /** + * Represents a boolean value that determines if the chart title has a shadow. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + showShadow?: boolean; + /** + * Specifies the chart's title text. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + text?: boolean; + /** + * Specifies the angle to which the text is oriented for the chart title. The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + textOrientation?: boolean; + /** + * Specifies the distance, in points, from the top edge of chart title to the top of chart area. Value is `null` if the chart title is not visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + top?: boolean; + /** + * Specifies the vertical alignment of chart title. See `Excel.ChartTextVerticalAlignment` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + verticalAlignment?: boolean; + /** + * Specifies if the chart title is visible. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + visible?: boolean; + /** + * Specifies the width, in points, of the chart title. Value is `null` if the chart title is not visible. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + width?: boolean; + } + /** + * Represents the substring in chart related objects that contain text, like a `ChartTitle` object or `ChartAxisTitle` object. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + export interface ChartFormatStringLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents the font attributes, such as font name, font size, and color of a chart characters object. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + font?: Excel.Interfaces.ChartFontLoadOptions; + } + /** + * Provides access to the formatting options for a chart title. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface ChartTitleFormatLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents the border format of chart title, which includes color, linestyle, and weight. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + border?: Excel.Interfaces.ChartBorderLoadOptions; + /** + * Represents the font attributes (such as font name, font size, and color) for an object. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + font?: Excel.Interfaces.ChartFontLoadOptions; + } + /** + * Represents the border formatting of a chart element. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + export interface ChartBorderLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * HTML color code representing the color of borders in the chart. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + color?: boolean; + /** + * Represents the line style of the border. See `Excel.ChartLineStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + lineStyle?: boolean; + /** + * Represents weight of the border, in points. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + weight?: boolean; + } + /** + * Encapsulates the bin options for histogram charts and pareto charts. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface ChartBinOptionsLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Specifies if bin overflow is enabled in a histogram chart or pareto chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + allowOverflow?: boolean; + /** + * Specifies if bin underflow is enabled in a histogram chart or pareto chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + allowUnderflow?: boolean; + /** + * Specifies the bin count of a histogram chart or pareto chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + count?: boolean; + /** + * Specifies the bin overflow value of a histogram chart or pareto chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + overflowValue?: boolean; + /** + * Specifies the bin's type for a histogram chart or pareto chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + type?: boolean; + /** + * Specifies the bin underflow value of a histogram chart or pareto chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + underflowValue?: boolean; + /** + * Specifies the bin width value of a histogram chart or pareto chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + width?: boolean; + } + /** + * Represents the properties of a box and whisker chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface ChartBoxwhiskerOptionsLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Specifies if the quartile calculation type of a box and whisker chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + quartileCalculation?: boolean; + /** + * Specifies if inner points are shown in a box and whisker chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showInnerPoints?: boolean; + /** + * Specifies if the mean line is shown in a box and whisker chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showMeanLine?: boolean; + /** + * Specifies if the mean marker is shown in a box and whisker chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showMeanMarker?: boolean; + /** + * Specifies if outlier points are shown in a box and whisker chart. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + showOutlierPoints?: boolean; + } + /** + * Encapsulates the formatting options for line elements. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface ChartLineFormatLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * HTML color code representing the color of lines in the chart. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + color?: boolean; + /** + * Represents the line style. See `Excel.ChartLineStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + lineStyle?: boolean; + /** + * Represents weight of the line, in points. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + weight?: boolean; + } + /** + * This object represents the font attributes (such as font name, font size, and color) for a chart object. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + export interface ChartFontLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents the bold status of font. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + bold?: boolean; + /** + * HTML color code representation of the text color (e.g., #FF0000 represents Red). + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + color?: boolean; + /** + * Represents the italic status of the font. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + italic?: boolean; + /** + * Font name (e.g., "Calibri") + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + name?: boolean; + /** + * Size of the font (e.g., 11) + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + size?: boolean; + /** + * Type of underline applied to the font. See `Excel.ChartUnderlineStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + underline?: boolean; + } + /** + * This object represents the attributes for a chart trendline object. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + export interface ChartTrendlineLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents the formatting of a chart trendline. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + format?: Excel.Interfaces.ChartTrendlineFormatLoadOptions; + /** + * Represents the label of a chart trendline. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + label?: Excel.Interfaces.ChartTrendlineLabelLoadOptions; + /** + * Represents the number of periods that the trendline extends backward. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + backwardPeriod?: boolean; + /** + * Represents the number of periods that the trendline extends forward. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + forwardPeriod?: boolean; + /** + * Represents the intercept value of the trendline. Can be set to a numeric value or an empty string (for automatic values). The returned value is always a number. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + intercept?: boolean; + /** + * Represents the period of a chart trendline. Only applicable to trendlines with the type `MovingAverage`. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + movingAveragePeriod?: boolean; + /** + * Represents the name of the trendline. Can be set to a string value, a `null` value represents automatic values. The returned value is always a string + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + name?: boolean; + /** + * Represents the order of a chart trendline. Only applicable to trendlines with the type `Polynomial`. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + polynomialOrder?: boolean; + /** + * True if the equation for the trendline is displayed on the chart. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showEquation?: boolean; + /** + * True if the r-squared value for the trendline is displayed on the chart. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showRSquared?: boolean; + /** + * Represents the type of a chart trendline. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + type?: boolean; + } + /** + * Represents a collection of chart trendlines. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + export interface ChartTrendlineCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Represents the formatting of a chart trendline. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + format?: Excel.Interfaces.ChartTrendlineFormatLoadOptions; + /** + * For EACH ITEM in the collection: Represents the label of a chart trendline. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + label?: Excel.Interfaces.ChartTrendlineLabelLoadOptions; + /** + * For EACH ITEM in the collection: Represents the number of periods that the trendline extends backward. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + backwardPeriod?: boolean; + /** + * For EACH ITEM in the collection: Represents the number of periods that the trendline extends forward. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + forwardPeriod?: boolean; + /** + * For EACH ITEM in the collection: Represents the intercept value of the trendline. Can be set to a numeric value or an empty string (for automatic values). The returned value is always a number. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + intercept?: boolean; + /** + * For EACH ITEM in the collection: Represents the period of a chart trendline. Only applicable to trendlines with the type `MovingAverage`. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + movingAveragePeriod?: boolean; + /** + * For EACH ITEM in the collection: Represents the name of the trendline. Can be set to a string value, a `null` value represents automatic values. The returned value is always a string + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + name?: boolean; + /** + * For EACH ITEM in the collection: Represents the order of a chart trendline. Only applicable to trendlines with the type `Polynomial`. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + polynomialOrder?: boolean; + /** + * For EACH ITEM in the collection: True if the equation for the trendline is displayed on the chart. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showEquation?: boolean; + /** + * For EACH ITEM in the collection: True if the r-squared value for the trendline is displayed on the chart. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showRSquared?: boolean; + /** + * For EACH ITEM in the collection: Represents the type of a chart trendline. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + type?: boolean; + } + /** + * Represents the format properties for the chart trendline. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + export interface ChartTrendlineFormatLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents chart line formatting. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + line?: Excel.Interfaces.ChartLineFormatLoadOptions; + } + /** + * This object represents the attributes for a chart trendline label object. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export interface ChartTrendlineLabelLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * The format of the chart trendline label. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + format?: Excel.Interfaces.ChartTrendlineLabelFormatLoadOptions; + /** + * Specifies if the trendline label automatically generates appropriate text based on context. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + autoText?: boolean; + /** + * String value that represents the formula of the chart trendline label using A1-style notation. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + formula?: boolean; + /** + * Returns the height, in points, of the chart trendline label. Value is `null` if the chart trendline label is not visible. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + height?: boolean; + /** + * Represents the horizontal alignment of the chart trendline label. See `Excel.ChartTextHorizontalAlignment` for details. + This property is valid only when `TextOrientation` of a trendline label is -90, 90, or 180. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + horizontalAlignment?: boolean; + /** + * Represents the distance, in points, from the left edge of the chart trendline label to the left edge of the chart area. Value is `null` if the chart trendline label is not visible. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + left?: boolean; + /** + * Specifies if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + linkNumberFormat?: boolean; + /** + * String value that represents the format code for the trendline label. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + numberFormat?: boolean; + /** + * String representing the text of the trendline label on a chart. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + text?: boolean; + /** + * Represents the angle to which the text is oriented for the chart trendline label. The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + textOrientation?: boolean; + /** + * Represents the distance, in points, from the top edge of the chart trendline label to the top of the chart area. Value is `null` if the chart trendline label is not visible. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + top?: boolean; + /** + * Represents the vertical alignment of the chart trendline label. See `Excel.ChartTextVerticalAlignment` for details. + This property is valid only when `TextOrientation` of a trendline label is 0. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + verticalAlignment?: boolean; + /** + * Returns the width, in points, of the chart trendline label. Value is `null` if the chart trendline label is not visible. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + width?: boolean; + } + /** + * Encapsulates the format properties for the chart trendline label. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export interface ChartTrendlineLabelFormatLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Specifies the border format, which includes color, linestyle, and weight. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + border?: Excel.Interfaces.ChartBorderLoadOptions; + /** + * Specifies the font attributes (such as font name, font size, and color) for a chart trendline label. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + font?: Excel.Interfaces.ChartFontLoadOptions; + } + /** + * This object represents the attributes for a chart plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export interface ChartPlotAreaLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Specifies the formatting of a chart plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + format?: Excel.Interfaces.ChartPlotAreaFormatLoadOptions; + /** + * Specifies the height value of a plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + height?: boolean; + /** + * Specifies the inside height value of a plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + insideHeight?: boolean; + /** + * Specifies the inside left value of a plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + insideLeft?: boolean; + /** + * Specifies the inside top value of a plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + insideTop?: boolean; + /** + * Specifies the inside width value of a plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + insideWidth?: boolean; + /** + * Specifies the left value of a plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + left?: boolean; + /** + * Specifies the position of a plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + position?: boolean; + /** + * Specifies the top value of a plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + top?: boolean; + /** + * Specifies the width value of a plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + width?: boolean; + } + /** + * Represents the format properties for a chart plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export interface ChartPlotAreaFormatLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Specifies the border attributes of a chart plot area. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + border?: Excel.Interfaces.ChartBorderLoadOptions; + } + /** + * Gets an object that represents the formatting of chart leader lines. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + export interface ChartLeaderLinesLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents the formatting of leader lines of data labels in a series. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + format?: Excel.Interfaces.ChartLeaderLinesFormatLoadOptions; + } + /** + * Encapsulates the format properties for leader lines. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + export interface ChartLeaderLinesFormatLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Gets an object that represents the line formatting of chart leader lines. + * + * @remarks + * [Api set: ExcelApi 1.19] + */ + line?: Excel.Interfaces.ChartLineFormatLoadOptions; + } + /** + * Manages sorting operations on `Table` objects. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + export interface TableSortLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Specifies the current conditions used to last sort the table. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + fields?: boolean; + /** + * Specifies if the casing impacts the last sort of the table. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + matchCase?: boolean; + /** + * Represents the Chinese character ordering method last used to sort the table. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + method?: boolean; + } + /** + * Manages the filtering of a table's column. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + export interface FilterLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * The currently applied filter on the given column. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + criteria?: boolean; + } + /** + * Represents the `AutoFilter` object. + AutoFilter turns the values in Excel column into specific filters based on the cell contents. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface AutoFilterLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * An array that holds all the filter criteria in the autofiltered range. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + criteria?: boolean; + /** + * Specifies if the AutoFilter is enabled. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enabled?: boolean; + /** + * Specifies if the AutoFilter has filter criteria. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + isDataFiltered?: boolean; + } + /** + * Provides information based on current system culture settings. This includes the culture names, number formatting, and other culturally dependent settings. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + export interface CultureInfoLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Defines the culturally appropriate format of displaying date and time. This is based on current system culture settings. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + datetimeFormat?: Excel.Interfaces.DatetimeFormatInfoLoadOptions; + /** + * Defines the culturally appropriate format of displaying numbers. This is based on current system culture settings. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + numberFormat?: Excel.Interfaces.NumberFormatInfoLoadOptions; + /** + * Gets the culture name in the format languagecode2-country/regioncode2 (e.g., "zh-cn" or "en-us"). This is based on current system settings. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + name?: boolean; + } + /** + * Defines the culturally appropriate format of displaying numbers. This is based on current system culture settings. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + export interface NumberFormatInfoLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Gets the currency symbol for currency values. This is based on current system settings. + * + * @remarks + * [Api set: ExcelApi 1.17] + */ + currencySymbol?: boolean; + /** + * Gets the string used as the decimal separator for numeric values. This is based on current system settings. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + numberDecimalSeparator?: boolean; + /** + * Gets the string used to separate groups of digits to the left of the decimal for numeric values. This is based on current system settings. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + numberGroupSeparator?: boolean; + } + /** + * Defines the culturally appropriate format of displaying numbers. This is based on current system culture settings. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + export interface DatetimeFormatInfoLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Gets the string used as the date separator. This is based on current system settings. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + dateSeparator?: boolean; + /** + * Gets the format string for a long date value. This is based on current system settings. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + longDatePattern?: boolean; + /** + * Gets the format string for a long time value. This is based on current system settings. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + longTimePattern?: boolean; + /** + * Gets the format string for a short date value. This is based on current system settings. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + shortDatePattern?: boolean; + /** + * Gets the string used as the time separator. This is based on current system settings. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + timeSeparator?: boolean; + } + /** + * A scoped collection of custom XML parts. + A scoped collection is the result of some operation (e.g., filtering by namespace). + A scoped collection cannot be scoped any further. + * + * @remarks + * [Api set: ExcelApi 1.5] + */ + export interface CustomXmlPartScopedCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: The custom XML part's ID. + * + * @remarks + * [Api set: ExcelApi 1.5] + */ + id?: boolean; + /** + * For EACH ITEM in the collection: The custom XML part's namespace URI. + * + * @remarks + * [Api set: ExcelApi 1.5] + */ + namespaceUri?: boolean; + } + /** + * A collection of custom XML parts. + * + * @remarks + * [Api set: ExcelApi 1.5] + */ + export interface CustomXmlPartCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: The custom XML part's ID. + * + * @remarks + * [Api set: ExcelApi 1.5] + */ + id?: boolean; + /** + * For EACH ITEM in the collection: The custom XML part's namespace URI. + * + * @remarks + * [Api set: ExcelApi 1.5] + */ + namespaceUri?: boolean; + } + /** + * Represents a custom XML part object in a workbook. + * + * @remarks + * [Api set: ExcelApi 1.5] + */ + export interface CustomXmlPartLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * The custom XML part's ID. + * + * @remarks + * [Api set: ExcelApi 1.5] + */ + id?: boolean; + /** + * The custom XML part's namespace URI. + * + * @remarks + * [Api set: ExcelApi 1.5] + */ + namespaceUri?: boolean; + } + /** + * Represents a scoped collection of PivotTables. The PivotTables are sorted based on the location of the PivotTable's top-left corner. They are ordered top-to-bottom and then left-to-right. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + export interface PivotTableScopedCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: The PivotLayout describing the layout and visual structure of the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + layout?: Excel.Interfaces.PivotLayoutLoadOptions; + /** + * For EACH ITEM in the collection: The worksheet containing the current PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + worksheet?: Excel.Interfaces.WorksheetLoadOptions; + /** + * For EACH ITEM in the collection: Specifies if the PivotTable allows the application of multiple PivotFilters on a given PivotField in the table. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + allowMultipleFiltersPerField?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the PivotTable allows values in the data body to be edited by the user. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enableDataValueEditing?: boolean; + /** + * For EACH ITEM in the collection: ID of the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.5] + */ + id?: boolean; + /** + * For EACH ITEM in the collection: Name of the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + name?: boolean; + /** + * For EACH ITEM in the collection: Specifies whether the PivotTable refreshes when the workbook opens. Corresponds to "Refresh on load" setting in the UI. + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + refreshOnOpen?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the PivotTable uses custom lists when sorting. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + useCustomSortLists?: boolean; + } + /** + * Represents a collection of all the PivotTables that are part of the workbook or worksheet. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + export interface PivotTableCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: The PivotLayout describing the layout and visual structure of the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + layout?: Excel.Interfaces.PivotLayoutLoadOptions; + /** + * For EACH ITEM in the collection: The worksheet containing the current PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + worksheet?: Excel.Interfaces.WorksheetLoadOptions; + /** + * For EACH ITEM in the collection: Specifies if the PivotTable allows the application of multiple PivotFilters on a given PivotField in the table. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + allowMultipleFiltersPerField?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the PivotTable allows values in the data body to be edited by the user. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enableDataValueEditing?: boolean; + /** + * For EACH ITEM in the collection: ID of the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.5] + */ + id?: boolean; + /** + * For EACH ITEM in the collection: Name of the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + name?: boolean; + /** + * For EACH ITEM in the collection: Specifies whether the PivotTable refreshes when the workbook opens. Corresponds to "Refresh on load" setting in the UI. + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + refreshOnOpen?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the PivotTable uses custom lists when sorting. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + useCustomSortLists?: boolean; + } + /** + * Represents an Excel PivotTable. + To learn more about the PivotTable object model, read {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-pivottables | Work with PivotTables using the Excel JavaScript API}. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + export interface PivotTableLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * The PivotLayout describing the layout and visual structure of the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + layout?: Excel.Interfaces.PivotLayoutLoadOptions; + /** + * The worksheet containing the current PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + worksheet?: Excel.Interfaces.WorksheetLoadOptions; + /** + * Specifies if the PivotTable allows the application of multiple PivotFilters on a given PivotField in the table. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + allowMultipleFiltersPerField?: boolean; + /** + * Specifies if the PivotTable allows values in the data body to be edited by the user. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + enableDataValueEditing?: boolean; + /** + * ID of the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.5] + */ + id?: boolean; + /** + * Name of the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.3] + */ + name?: boolean; + /** + * Specifies whether the PivotTable refreshes when the workbook opens. Corresponds to "Refresh on load" setting in the UI. + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + refreshOnOpen?: boolean; + /** + * Specifies if the PivotTable uses custom lists when sorting. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + useCustomSortLists?: boolean; + } + /** + * Represents the visual layout of the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export interface PivotLayoutLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * The alt text description of the PivotTable. + + Alt text provides alternative, text-based representations of the information contained in the PivotTable. + This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table. + A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content. + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + altTextDescription?: boolean; + /** + * The alt text title of the PivotTable. + + Alt text provides alternative, text-based representations of the information contained in the PivotTable. + This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table. + A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content. + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + altTextTitle?: boolean; + /** + * Specifies if formatting will be automatically formatted when it's refreshed or when fields are moved. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + autoFormat?: boolean; + /** + * The text that is automatically filled into any empty cell in the PivotTable if `fillEmptyCells == true`. + Note that this value persists if `fillEmptyCells` is set to `false`, and that setting this value does not set that property to `true`. + By default, this is an empty string. + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + emptyCellText?: boolean; + /** + * Specifies if the field list can be shown in the UI. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + enableFieldList?: boolean; + /** + * Specifies whether empty cells in the PivotTable should be populated with the `emptyCellText`. Default is `false`. + Note that the value of `emptyCellText` persists when this property is set to `false`. + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + fillEmptyCells?: boolean; + /** + * This property indicates the PivotLayoutType of all fields on the PivotTable. + If fields have different states, this will be null. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + layoutType?: boolean; + /** + * Specifies if formatting is preserved when the report is refreshed or recalculated by operations such as pivoting, sorting, or changing page field items. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + preserveFormatting?: boolean; + /** + * Specifies if the PivotTable report shows grand totals for columns. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showColumnGrandTotals?: boolean; + /** + * Specifies whether the PivotTable displays field headers (field captions and filter drop-downs). + * + * @remarks + * [Api set: ExcelApi 1.13] + */ + showFieldHeaders?: boolean; + /** + * Specifies if the PivotTable report shows grand totals for rows. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showRowGrandTotals?: boolean; + /** + * This property indicates the `SubtotalLocationType` of all fields on the PivotTable. + If fields have different states, this will be `null`. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + subtotalLocation?: boolean; + } + /** + * Represents a collection of all the PivotHierarchies that are part of the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export interface PivotHierarchyCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: ID of the PivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + id?: boolean; + /** + * For EACH ITEM in the collection: Name of the PivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + name?: boolean; + } + /** + * Represents the Excel PivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export interface PivotHierarchyLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * ID of the PivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + id?: boolean; + /** + * Name of the PivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + name?: boolean; + } + /** + * Represents a collection of RowColumnPivotHierarchy items associated with the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export interface RowColumnPivotHierarchyCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: ID of the RowColumnPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + id?: boolean; + /** + * For EACH ITEM in the collection: Name of the RowColumnPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + name?: boolean; + /** + * For EACH ITEM in the collection: Position of the RowColumnPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + position?: boolean; + } + /** + * Represents the Excel RowColumnPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export interface RowColumnPivotHierarchyLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * ID of the RowColumnPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + id?: boolean; + /** + * Name of the RowColumnPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + name?: boolean; + /** + * Position of the RowColumnPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + position?: boolean; + } + /** + * Represents a collection of FilterPivotHierarchy items associated with the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export interface FilterPivotHierarchyCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Determines whether to allow multiple filter items. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + enableMultipleFilterItems?: boolean; + /** + * For EACH ITEM in the collection: ID of the FilterPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + id?: boolean; + /** + * For EACH ITEM in the collection: Name of the FilterPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + name?: boolean; + /** + * For EACH ITEM in the collection: Position of the FilterPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + position?: boolean; + } + /** + * Represents the Excel FilterPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export interface FilterPivotHierarchyLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Determines whether to allow multiple filter items. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + enableMultipleFilterItems?: boolean; + /** + * ID of the FilterPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + id?: boolean; + /** + * Name of the FilterPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + name?: boolean; + /** + * Position of the FilterPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + position?: boolean; + } + /** + * Represents a collection of DataPivotHierarchy items associated with the PivotTable. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export interface DataPivotHierarchyCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Returns the PivotFields associated with the DataPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + field?: Excel.Interfaces.PivotFieldLoadOptions; + /** + * For EACH ITEM in the collection: ID of the DataPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + id?: boolean; + /** + * For EACH ITEM in the collection: Name of the DataPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + name?: boolean; + /** + * For EACH ITEM in the collection: Number format of the DataPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + numberFormat?: boolean; + /** + * For EACH ITEM in the collection: Position of the DataPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + position?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the data should be shown as a specific summary calculation. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showAs?: boolean; + /** + * For EACH ITEM in the collection: Specifies if all items of the DataPivotHierarchy are shown. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + summarizeBy?: boolean; + } + /** + * Represents the Excel DataPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export interface DataPivotHierarchyLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Returns the PivotFields associated with the DataPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + field?: Excel.Interfaces.PivotFieldLoadOptions; + /** + * ID of the DataPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + id?: boolean; + /** + * Name of the DataPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + name?: boolean; + /** + * Number format of the DataPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + numberFormat?: boolean; + /** + * Position of the DataPivotHierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + position?: boolean; + /** + * Specifies if the data should be shown as a specific summary calculation. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showAs?: boolean; + /** + * Specifies if all items of the DataPivotHierarchy are shown. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + summarizeBy?: boolean; + } + /** + * Represents a collection of all the PivotFields that are part of a PivotTable's hierarchy. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export interface PivotFieldCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: ID of the PivotField. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + id?: boolean; + /** + * For EACH ITEM in the collection: Name of the PivotField. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + name?: boolean; + /** + * For EACH ITEM in the collection: Determines whether to show all items of the PivotField. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showAllItems?: boolean; + /** + * For EACH ITEM in the collection: Subtotals of the PivotField. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + subtotals?: boolean; + } + /** + * Represents the Excel PivotField. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export interface PivotFieldLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * ID of the PivotField. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + id?: boolean; + /** + * Name of the PivotField. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + name?: boolean; + /** + * Determines whether to show all items of the PivotField. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + showAllItems?: boolean; + /** + * Subtotals of the PivotField. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + subtotals?: boolean; + } + /** + * Represents a collection of all the PivotItems related to their parent PivotField. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export interface PivotItemCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: ID of the PivotItem. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + id?: boolean; + /** + * For EACH ITEM in the collection: Determines whether the item is expanded to show child items or if it's collapsed and child items are hidden. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + isExpanded?: boolean; + /** + * For EACH ITEM in the collection: Name of the PivotItem. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + name?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the PivotItem is visible. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + visible?: boolean; + } + /** + * Represents the Excel PivotItem. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + export interface PivotItemLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * ID of the PivotItem. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + id?: boolean; + /** + * Determines whether the item is expanded to show child items or if it's collapsed and child items are hidden. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + isExpanded?: boolean; + /** + * Name of the PivotItem. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + name?: boolean; + /** + * Specifies if the PivotItem is visible. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + visible?: boolean; + } + /** + * Represents a worksheet-level custom property. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + export interface WorksheetCustomPropertyLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Gets the key of the custom property. Custom property keys are case-insensitive. The key is limited to 255 characters (larger values will cause an `InvalidArgument` error to be thrown.) + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + key?: boolean; + /** + * Gets or sets the value of the custom property. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + value?: boolean; + } + /** + * Contains the collection of worksheet-level custom property. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + export interface WorksheetCustomPropertyCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Gets the key of the custom property. Custom property keys are case-insensitive. The key is limited to 255 characters (larger values will cause an `InvalidArgument` error to be thrown.) + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + key?: boolean; + /** + * For EACH ITEM in the collection: Gets or sets the value of the custom property. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + value?: boolean; + } + /** + * Represents workbook properties. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + export interface DocumentPropertiesLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * The author of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + author?: boolean; + /** + * The category of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + category?: boolean; + /** + * The Comments field in the metadata of the workbook. These have no connection to comments by users made in the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + comments?: boolean; + /** + * The company of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + company?: boolean; + /** + * Gets the creation date of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + creationDate?: boolean; + /** + * The keywords of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + keywords?: boolean; + /** + * Gets the last author of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + lastAuthor?: boolean; + /** + * The manager of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + manager?: boolean; + /** + * Gets the revision number of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + revisionNumber?: boolean; + /** + * The subject of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + subject?: boolean; + /** + * The title of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + title?: boolean; + } + /** + * Represents a custom property. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + export interface CustomPropertyLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * The key of the custom property. The key is limited to 255 characters outside of Excel on the web (larger keys are automatically trimmed to 255 characters on other platforms). + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + key?: boolean; + /** + * The type of the value used for the custom property. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + type?: boolean; + /** + * The value of the custom property. The value is limited to 255 characters outside of Excel on the web (larger values are automatically trimmed to 255 characters on other platforms). + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + value?: boolean; + } + /** + * Contains the collection of custom properties. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + export interface CustomPropertyCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: The key of the custom property. The key is limited to 255 characters outside of Excel on the web (larger keys are automatically trimmed to 255 characters on other platforms). + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + key?: boolean; + /** + * For EACH ITEM in the collection: The type of the value used for the custom property. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + type?: boolean; + /** + * For EACH ITEM in the collection: The value of the custom property. The value is limited to 255 characters outside of Excel on the web (larger values are automatically trimmed to 255 characters on other platforms). + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + value?: boolean; + } + /** + * Represents a collection of all the conditional formats that are overlap the range. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export interface ConditionalFormatCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Returns the cell value conditional format properties if the current conditional format is a `CellValue` type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + cellValue?: Excel.Interfaces.CellValueConditionalFormatLoadOptions; + /** + * For EACH ITEM in the collection: Returns the cell value conditional format properties if the current conditional format is a `CellValue` type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + cellValueOrNullObject?: Excel.Interfaces.CellValueConditionalFormatLoadOptions; + /** + * For EACH ITEM in the collection: Returns the color scale conditional format properties if the current conditional format is a `ColorScale` type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + colorScale?: Excel.Interfaces.ColorScaleConditionalFormatLoadOptions; + /** + * For EACH ITEM in the collection: Returns the color scale conditional format properties if the current conditional format is a `ColorScale` type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + colorScaleOrNullObject?: Excel.Interfaces.ColorScaleConditionalFormatLoadOptions; + /** + * For EACH ITEM in the collection: Returns the custom conditional format properties if the current conditional format is a custom type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + custom?: Excel.Interfaces.CustomConditionalFormatLoadOptions; + /** + * For EACH ITEM in the collection: Returns the custom conditional format properties if the current conditional format is a custom type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + customOrNullObject?: Excel.Interfaces.CustomConditionalFormatLoadOptions; + /** + * For EACH ITEM in the collection: Returns the data bar properties if the current conditional format is a data bar. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + dataBar?: Excel.Interfaces.DataBarConditionalFormatLoadOptions; + /** + * For EACH ITEM in the collection: Returns the data bar properties if the current conditional format is a data bar. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + dataBarOrNullObject?: Excel.Interfaces.DataBarConditionalFormatLoadOptions; + /** + * For EACH ITEM in the collection: Returns the icon set conditional format properties if the current conditional format is an `IconSet` type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + iconSet?: Excel.Interfaces.IconSetConditionalFormatLoadOptions; + /** + * For EACH ITEM in the collection: Returns the icon set conditional format properties if the current conditional format is an `IconSet` type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + iconSetOrNullObject?: Excel.Interfaces.IconSetConditionalFormatLoadOptions; + /** + * For EACH ITEM in the collection: Returns the preset criteria conditional format. See `Excel.PresetCriteriaConditionalFormat` for more details. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + preset?: Excel.Interfaces.PresetCriteriaConditionalFormatLoadOptions; + /** + * For EACH ITEM in the collection: Returns the preset criteria conditional format. See `Excel.PresetCriteriaConditionalFormat` for more details. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + presetOrNullObject?: Excel.Interfaces.PresetCriteriaConditionalFormatLoadOptions; + /** + * For EACH ITEM in the collection: Returns the specific text conditional format properties if the current conditional format is a text type. + For example, to format cells matching the word "Text". + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + textComparison?: Excel.Interfaces.TextConditionalFormatLoadOptions; + /** + * For EACH ITEM in the collection: Returns the specific text conditional format properties if the current conditional format is a text type. + For example, to format cells matching the word "Text". + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + textComparisonOrNullObject?: Excel.Interfaces.TextConditionalFormatLoadOptions; + /** + * For EACH ITEM in the collection: Returns the top/bottom conditional format properties if the current conditional format is a `TopBottom` type. + For example, to format the top 10% or bottom 10 items. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + topBottom?: Excel.Interfaces.TopBottomConditionalFormatLoadOptions; + /** + * For EACH ITEM in the collection: Returns the top/bottom conditional format properties if the current conditional format is a `TopBottom` type. + For example, to format the top 10% or bottom 10 items. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + topBottomOrNullObject?: Excel.Interfaces.TopBottomConditionalFormatLoadOptions; + /** + * For EACH ITEM in the collection: The priority of the conditional format in the current `ConditionalFormatCollection`. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + id?: boolean; + /** + * For EACH ITEM in the collection: The priority (or index) within the conditional format collection that this conditional format currently exists in. Changing this also + changes other conditional formats' priorities, to allow for a contiguous priority order. + Use a negative priority to begin from the back. + Priorities greater than the bounds will get and set to the maximum (or minimum if negative) priority. + Also note that if you change the priority, you have to re-fetch a new copy of the object at that new priority location if you want to make further changes to it. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + priority?: boolean; + /** + * For EACH ITEM in the collection: If the conditions of this conditional format are met, no lower-priority formats shall take effect on that cell. + Value is `null` on data bars, icon sets, and color scales as there's no concept of `StopIfTrue` for these. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + stopIfTrue?: boolean; + /** + * For EACH ITEM in the collection: A type of conditional format. Only one can be set at a time. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + type?: boolean; + } + /** + * An object encapsulating a conditional format's range, format, rule, and other properties. + To learn more about the conditional formatting object model, read {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-conditional-formatting | Apply conditional formatting to Excel ranges}. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export interface ConditionalFormatLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Returns the cell value conditional format properties if the current conditional format is a `CellValue` type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + cellValue?: Excel.Interfaces.CellValueConditionalFormatLoadOptions; + /** + * Returns the cell value conditional format properties if the current conditional format is a `CellValue` type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + cellValueOrNullObject?: Excel.Interfaces.CellValueConditionalFormatLoadOptions; + /** + * Returns the color scale conditional format properties if the current conditional format is a `ColorScale` type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + colorScale?: Excel.Interfaces.ColorScaleConditionalFormatLoadOptions; + /** + * Returns the color scale conditional format properties if the current conditional format is a `ColorScale` type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + colorScaleOrNullObject?: Excel.Interfaces.ColorScaleConditionalFormatLoadOptions; + /** + * Returns the custom conditional format properties if the current conditional format is a custom type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + custom?: Excel.Interfaces.CustomConditionalFormatLoadOptions; + /** + * Returns the custom conditional format properties if the current conditional format is a custom type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + customOrNullObject?: Excel.Interfaces.CustomConditionalFormatLoadOptions; + /** + * Returns the data bar properties if the current conditional format is a data bar. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + dataBar?: Excel.Interfaces.DataBarConditionalFormatLoadOptions; + /** + * Returns the data bar properties if the current conditional format is a data bar. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + dataBarOrNullObject?: Excel.Interfaces.DataBarConditionalFormatLoadOptions; + /** + * Returns the icon set conditional format properties if the current conditional format is an `IconSet` type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + iconSet?: Excel.Interfaces.IconSetConditionalFormatLoadOptions; + /** + * Returns the icon set conditional format properties if the current conditional format is an `IconSet` type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + iconSetOrNullObject?: Excel.Interfaces.IconSetConditionalFormatLoadOptions; + /** + * Returns the preset criteria conditional format. See `Excel.PresetCriteriaConditionalFormat` for more details. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + preset?: Excel.Interfaces.PresetCriteriaConditionalFormatLoadOptions; + /** + * Returns the preset criteria conditional format. See `Excel.PresetCriteriaConditionalFormat` for more details. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + presetOrNullObject?: Excel.Interfaces.PresetCriteriaConditionalFormatLoadOptions; + /** + * Returns the specific text conditional format properties if the current conditional format is a text type. + For example, to format cells matching the word "Text". + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + textComparison?: Excel.Interfaces.TextConditionalFormatLoadOptions; + /** + * Returns the specific text conditional format properties if the current conditional format is a text type. + For example, to format cells matching the word "Text". + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + textComparisonOrNullObject?: Excel.Interfaces.TextConditionalFormatLoadOptions; + /** + * Returns the top/bottom conditional format properties if the current conditional format is a `TopBottom` type. + For example, to format the top 10% or bottom 10 items. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + topBottom?: Excel.Interfaces.TopBottomConditionalFormatLoadOptions; + /** + * Returns the top/bottom conditional format properties if the current conditional format is a `TopBottom` type. + For example, to format the top 10% or bottom 10 items. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + topBottomOrNullObject?: Excel.Interfaces.TopBottomConditionalFormatLoadOptions; + /** + * The priority of the conditional format in the current `ConditionalFormatCollection`. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + id?: boolean; + /** + * The priority (or index) within the conditional format collection that this conditional format currently exists in. Changing this also + changes other conditional formats' priorities, to allow for a contiguous priority order. + Use a negative priority to begin from the back. + Priorities greater than the bounds will get and set to the maximum (or minimum if negative) priority. + Also note that if you change the priority, you have to re-fetch a new copy of the object at that new priority location if you want to make further changes to it. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + priority?: boolean; + /** + * If the conditions of this conditional format are met, no lower-priority formats shall take effect on that cell. + Value is `null` on data bars, icon sets, and color scales as there's no concept of `StopIfTrue` for these. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + stopIfTrue?: boolean; + /** + * A type of conditional format. Only one can be set at a time. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + type?: boolean; + } + /** + * Represents an Excel conditional data bar type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export interface DataBarConditionalFormatLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Representation of all values to the left of the axis in an Excel data bar. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + negativeFormat?: Excel.Interfaces.ConditionalDataBarNegativeFormatLoadOptions; + /** + * Representation of all values to the right of the axis in an Excel data bar. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + positiveFormat?: Excel.Interfaces.ConditionalDataBarPositiveFormatLoadOptions; + /** + * HTML color code representing the color of the Axis line, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + Value is "" (an empty string) if no axis is present or set. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + axisColor?: boolean; + /** + * Representation of how the axis is determined for an Excel data bar. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + axisFormat?: boolean; + /** + * Specifies the direction that the data bar graphic should be based on. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + barDirection?: boolean; + /** + * The rule for what constitutes the lower bound (and how to calculate it, if applicable) for a data bar. + The `ConditionalDataBarRule` object must be set as a JSON object (use `x.lowerBoundRule = {...}` instead of `x.lowerBoundRule.formula = ...`). + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + lowerBoundRule?: boolean; + /** + * If `true`, hides the values from the cells where the data bar is applied. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + showDataBarOnly?: boolean; + /** + * The rule for what constitutes the upper bound (and how to calculate it, if applicable) for a data bar. + The `ConditionalDataBarRule` object must be set as a JSON object (use `x.upperBoundRule = {...}` instead of `x.upperBoundRule.formula = ...`). + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + upperBoundRule?: boolean; + } + /** + * Represents a conditional format for the positive side of the data bar. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export interface ConditionalDataBarPositiveFormatLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * HTML color code representing the color of the border line, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + Value is "" (an empty string) if no border is present or set. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + borderColor?: boolean; + /** + * HTML color code representing the fill color, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + fillColor?: boolean; + /** + * Specifies if the data bar has a gradient. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + gradientFill?: boolean; + } + /** + * Represents a conditional format for the negative side of the data bar. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export interface ConditionalDataBarNegativeFormatLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * HTML color code representing the color of the border line, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + Value is "" (an empty string) if no border is present or set. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + borderColor?: boolean; + /** + * HTML color code representing the fill color, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + fillColor?: boolean; + /** + * Specifies if the negative data bar has the same border color as the positive data bar. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + matchPositiveBorderColor?: boolean; + /** + * Specifies if the negative data bar has the same fill color as the positive data bar. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + matchPositiveFillColor?: boolean; + } + /** + * Represents a custom conditional format type. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export interface CustomConditionalFormatLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + format?: Excel.Interfaces.ConditionalRangeFormatLoadOptions; + /** + * Specifies the `Rule` object on this conditional format. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + rule?: Excel.Interfaces.ConditionalFormatRuleLoadOptions; + } + /** + * Represents a rule, for all traditional rule/format pairings. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export interface ConditionalFormatRuleLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * The formula, if required, on which to evaluate the conditional format rule. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + formula?: boolean; + /** + * The formula, if required, on which to evaluate the conditional format rule in the user's language. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + formulaLocal?: boolean; + /** + * The formula, if required, on which to evaluate the conditional format rule in R1C1-style notation. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + formulaR1C1?: boolean; + } + /** + * Represents an icon set criteria for conditional formatting. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export interface IconSetConditionalFormatLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * An array of criteria and icon sets for the rules and potential custom icons for conditional icons. Note that for the first criterion only the custom icon can be modified, while type, formula, and operator will be ignored when set. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + criteria?: boolean; + /** + * If `true`, reverses the icon orders for the icon set. Note that this cannot be set if custom icons are used. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + reverseIconOrder?: boolean; + /** + * If `true`, hides the values and only shows icons. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + showIconOnly?: boolean; + /** + * If set, displays the icon set option for the conditional format. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + style?: boolean; + } + /** + * Represents the color scale criteria for conditional formatting. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export interface ColorScaleConditionalFormatLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * The criteria of the color scale. Midpoint is optional when using a two point color scale. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + criteria?: boolean; + /** + * If `true`, the color scale will have three points (minimum, midpoint, maximum), otherwise it will have two (minimum, maximum). + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + threeColorScale?: boolean; + } + /** + * Represents a top/bottom conditional format. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export interface TopBottomConditionalFormatLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Returns a format object, encapsulating the conditional format's font, fill, borders, and other properties. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + format?: Excel.Interfaces.ConditionalRangeFormatLoadOptions; + /** + * The criteria of the top/bottom conditional format. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + rule?: boolean; + } + /** + * Represents the preset criteria conditional format such as above average, below average, unique values, contains blank, nonblank, error, and noerror. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export interface PresetCriteriaConditionalFormatLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + format?: Excel.Interfaces.ConditionalRangeFormatLoadOptions; + /** + * The rule of the conditional format. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + rule?: boolean; + } + /** + * Represents a specific text conditional format. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export interface TextConditionalFormatLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Returns a format object, encapsulating the conditional format's font, fill, borders, and other properties. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + format?: Excel.Interfaces.ConditionalRangeFormatLoadOptions; + /** + * The rule of the conditional format. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + rule?: boolean; + } + /** + * Represents a cell value conditional format. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export interface CellValueConditionalFormatLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + format?: Excel.Interfaces.ConditionalRangeFormatLoadOptions; + /** + * Specifies the rule object on this conditional format. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + rule?: boolean; + } + /** + * A format object encapsulating the conditional formats range's font, fill, borders, and other properties. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export interface ConditionalRangeFormatLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Collection of border objects that apply to the overall conditional format range. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + borders?: Excel.Interfaces.ConditionalRangeBorderCollectionLoadOptions; + /** + * Returns the fill object defined on the overall conditional format range. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + fill?: Excel.Interfaces.ConditionalRangeFillLoadOptions; + /** + * Returns the font object defined on the overall conditional format range. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + font?: Excel.Interfaces.ConditionalRangeFontLoadOptions; + /** + * Represents Excel's number format code for the given range. For more information about Excel number formatting, see {@link https://support.microsoft.com/office/5026bbd6-04bc-48cd-bf33-80f18b4eae68 | Number format codes}. + Cleared if `null` is passed in. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + numberFormat?: boolean; + } + /** + * This object represents the font attributes (font style, color, etc.) for an object. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export interface ConditionalRangeFontLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Specifies if the font is bold. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + bold?: boolean; + /** + * HTML color code representation of the text color (e.g., #FF0000 represents Red). + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + color?: boolean; + /** + * Specifies if the font is italic. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + italic?: boolean; + /** + * Specifies the strikethrough status of the font. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + strikethrough?: boolean; + /** + * The type of underline applied to the font. See `Excel.ConditionalRangeFontUnderlineStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + underline?: boolean; + } + /** + * Represents the background of a conditional range object. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export interface ConditionalRangeFillLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * HTML color code representing the color of the fill, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + color?: boolean; + } + /** + * Represents the border of an object. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export interface ConditionalRangeBorderLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * HTML color code representing the color of the border line, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + color?: boolean; + /** + * Constant value that indicates the specific side of the border. See `Excel.ConditionalRangeBorderIndex` for details. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + sideIndex?: boolean; + /** + * One of the constants of line style specifying the line style for the border. See `Excel.BorderLineStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + style?: boolean; + } + /** + * Represents the border objects that make up range border. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + export interface ConditionalRangeBorderCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: HTML color code representing the color of the border line, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + color?: boolean; + /** + * For EACH ITEM in the collection: Constant value that indicates the specific side of the border. See `Excel.ConditionalRangeBorderIndex` for details. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + sideIndex?: boolean; + /** + * For EACH ITEM in the collection: One of the constants of line style specifying the line style for the border. See `Excel.BorderLineStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.6] + */ + style?: boolean; + } + /** + * An object encapsulating a style's format and other properties. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + export interface StyleLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * A collection of four border objects that represent the style of the four borders. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + borders?: Excel.Interfaces.RangeBorderCollectionLoadOptions; + /** + * The fill of the style. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + fill?: Excel.Interfaces.RangeFillLoadOptions; + /** + * A `Font` object that represents the font of the style. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + font?: Excel.Interfaces.RangeFontLoadOptions; + /** + * Specifies if text is automatically indented when the text alignment in a cell is set to equal distribution. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + autoIndent?: boolean; + /** + * Specifies if the style is a built-in style. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + builtIn?: boolean; + /** + * Specifies if the formula will be hidden when the worksheet is protected. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + formulaHidden?: boolean; + /** + * Represents the horizontal alignment for the style. See `Excel.HorizontalAlignment` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + horizontalAlignment?: boolean; + /** + * Specifies if the style includes the auto indent, horizontal alignment, vertical alignment, wrap text, indent level, and text orientation properties. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + includeAlignment?: boolean; + /** + * Specifies if the style includes the color, color index, line style, and weight border properties. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + includeBorder?: boolean; + /** + * Specifies if the style includes the background, bold, color, color index, font style, italic, name, size, strikethrough, subscript, superscript, and underline font properties. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + includeFont?: boolean; + /** + * Specifies if the style includes the number format property. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + includeNumber?: boolean; + /** + * Specifies if the style includes the color, color index, invert if negative, pattern, pattern color, and pattern color index interior properties. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + includePatterns?: boolean; + /** + * Specifies if the style includes the formula hidden and locked protection properties. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + includeProtection?: boolean; + /** + * An integer from 0 to 250 that indicates the indent level for the style. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + indentLevel?: boolean; + /** + * Specifies if the object is locked when the worksheet is protected. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + locked?: boolean; + /** + * The name of the style. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + name?: boolean; + /** + * The format code of the number format for the style. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + numberFormat?: boolean; + /** + * The localized format code of the number format for the style. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + numberFormatLocal?: boolean; + /** + * The reading order for the style. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readingOrder?: boolean; + /** + * Specifies if text automatically shrinks to fit in the available column width. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + shrinkToFit?: boolean; + /** + * The text orientation for the style. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + textOrientation?: boolean; + /** + * Specifies the vertical alignment for the style. See `Excel.VerticalAlignment` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + verticalAlignment?: boolean; + /** + * Specifies if Excel wraps the text in the object. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + wrapText?: boolean; + } + /** + * Represents a collection of all the styles. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + export interface StyleCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: A collection of four border objects that represent the style of the four borders. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + borders?: Excel.Interfaces.RangeBorderCollectionLoadOptions; + /** + * For EACH ITEM in the collection: The fill of the style. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + fill?: Excel.Interfaces.RangeFillLoadOptions; + /** + * For EACH ITEM in the collection: A `Font` object that represents the font of the style. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + font?: Excel.Interfaces.RangeFontLoadOptions; + /** + * For EACH ITEM in the collection: Specifies if text is automatically indented when the text alignment in a cell is set to equal distribution. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + autoIndent?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the style is a built-in style. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + builtIn?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the formula will be hidden when the worksheet is protected. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + formulaHidden?: boolean; + /** + * For EACH ITEM in the collection: Represents the horizontal alignment for the style. See `Excel.HorizontalAlignment` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + horizontalAlignment?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the style includes the auto indent, horizontal alignment, vertical alignment, wrap text, indent level, and text orientation properties. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + includeAlignment?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the style includes the color, color index, line style, and weight border properties. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + includeBorder?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the style includes the background, bold, color, color index, font style, italic, name, size, strikethrough, subscript, superscript, and underline font properties. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + includeFont?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the style includes the number format property. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + includeNumber?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the style includes the color, color index, invert if negative, pattern, pattern color, and pattern color index interior properties. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + includePatterns?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the style includes the formula hidden and locked protection properties. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + includeProtection?: boolean; + /** + * For EACH ITEM in the collection: An integer from 0 to 250 that indicates the indent level for the style. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + indentLevel?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the object is locked when the worksheet is protected. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + locked?: boolean; + /** + * For EACH ITEM in the collection: The name of the style. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + name?: boolean; + /** + * For EACH ITEM in the collection: The format code of the number format for the style. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + numberFormat?: boolean; + /** + * For EACH ITEM in the collection: The localized format code of the number format for the style. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + numberFormatLocal?: boolean; + /** + * For EACH ITEM in the collection: The reading order for the style. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + readingOrder?: boolean; + /** + * For EACH ITEM in the collection: Specifies if text automatically shrinks to fit in the available column width. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + shrinkToFit?: boolean; + /** + * For EACH ITEM in the collection: The text orientation for the style. + * + * @remarks + * [Api set: ExcelApi 1.8] + */ + textOrientation?: boolean; + /** + * For EACH ITEM in the collection: Specifies the vertical alignment for the style. See `Excel.VerticalAlignment` for details. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + verticalAlignment?: boolean; + /** + * For EACH ITEM in the collection: Specifies if Excel wraps the text in the object. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + wrapText?: boolean; + } + /** + * Represents a collection of table styles. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + export interface TableStyleCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Specifies the name of the table style. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + name?: boolean; + /** + * For EACH ITEM in the collection: Specifies if this `TableStyle` object is read-only. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readOnly?: boolean; + } + /** + * Represents a table style, which defines the style elements by region of the table. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + export interface TableStyleLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Specifies the name of the table style. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + name?: boolean; + /** + * Specifies if this `TableStyle` object is read-only. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readOnly?: boolean; + } + /** + * Represents a collection of PivotTable styles. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + export interface PivotTableStyleCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Specifies the name of the PivotTable style. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + name?: boolean; + /** + * For EACH ITEM in the collection: Specifies if this `PivotTableStyle` object is read-only. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readOnly?: boolean; + } + /** + * Represents a PivotTable style, which defines style elements by PivotTable region. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + export interface PivotTableStyleLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Specifies the name of the PivotTable style. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + name?: boolean; + /** + * Specifies if this `PivotTableStyle` object is read-only. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readOnly?: boolean; + } + /** + * Represents a collection of `SlicerStyle` objects. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + export interface SlicerStyleCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Specifies the name of the slicer style. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + name?: boolean; + /** + * For EACH ITEM in the collection: Specifies if this `SlicerStyle` object is read-only. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readOnly?: boolean; + } + /** + * Represents a slicer style, which defines style elements by region of the slicer. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + export interface SlicerStyleLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Specifies the name of the slicer style. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + name?: boolean; + /** + * Specifies if this `SlicerStyle` object is read-only. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readOnly?: boolean; + } + /** + * Represents a collection of timeline styles. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + export interface TimelineStyleCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Specifies the name of the timeline style. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + name?: boolean; + /** + * For EACH ITEM in the collection: Specifies if this `TimelineStyle` object is read-only. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readOnly?: boolean; + } + /** + * Represents a `TimelineStyle`, which defines style elements by region in the timeline. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + export interface TimelineStyleLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Specifies the name of the timeline style. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + name?: boolean; + /** + * Specifies if this `TimelineStyle` object is read-only. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + readOnly?: boolean; + } + /** + * Represents layout and print settings that are not dependent on any printer-specific implementation. These settings include margins, orientation, page numbering, title rows, and print area. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface PageLayoutLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Header and footer configuration for the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + headersFooters?: Excel.Interfaces.HeaderFooterGroupLoadOptions; + /** + * The worksheet's black and white print option. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + blackAndWhite?: boolean; + /** + * The worksheet's bottom page margin to use for printing in points. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + bottomMargin?: boolean; + /** + * The worksheet's center horizontally flag. This flag determines whether the worksheet will be centered horizontally when it's printed. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + centerHorizontally?: boolean; + /** + * The worksheet's center vertically flag. This flag determines whether the worksheet will be centered vertically when it's printed. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + centerVertically?: boolean; + /** + * The worksheet's draft mode option. If `true`, the sheet will be printed without graphics. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + draftMode?: boolean; + /** + * The worksheet's first page number to print. A `null` value represents "auto" page numbering. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + firstPageNumber?: boolean; + /** + * The worksheet's footer margin, in points, for use when printing. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + footerMargin?: boolean; + /** + * The worksheet's header margin, in points, for use when printing. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + headerMargin?: boolean; + /** + * The worksheet's left margin, in points, for use when printing. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + leftMargin?: boolean; + /** + * The worksheet's orientation of the page. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + orientation?: boolean; + /** + * The worksheet's paper size of the page. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + paperSize?: boolean; + /** + * Specifies if the worksheet's comments should be displayed when printing. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + printComments?: boolean; + /** + * The worksheet's print errors option. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + printErrors?: boolean; + /** + * Specifies if the worksheet's gridlines will be printed. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + printGridlines?: boolean; + /** + * Specifies if the worksheet's headings will be printed. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + printHeadings?: boolean; + /** + * The worksheet's page print order option. This specifies the order to use for processing the page number printed. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + printOrder?: boolean; + /** + * The worksheet's right margin, in points, for use when printing. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + rightMargin?: boolean; + /** + * The worksheet's top margin, in points, for use when printing. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + topMargin?: boolean; + /** + * The worksheet's print zoom options. + The `PageLayoutZoomOptions` object must be set as a JSON object (use `x.zoom = {...}` instead of `x.zoom.scale = ...`). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + zoom?: boolean; + } + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface HeaderFooterLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * The center footer of the worksheet. + To apply font formatting or insert a variable value, use format codes specified here: https://msdn.microsoft.com/library/bb225426.aspx. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + centerFooter?: boolean; + /** + * The center header of the worksheet. + To apply font formatting or insert a variable value, use format codes specified here: https://msdn.microsoft.com/library/bb225426.aspx. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + centerHeader?: boolean; + /** + * The left footer of the worksheet. + To apply font formatting or insert a variable value, use format codes specified here: https://msdn.microsoft.com/library/bb225426.aspx. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + leftFooter?: boolean; + /** + * The left header of the worksheet. + To apply font formatting or insert a variable value, use format codes specified here: https://msdn.microsoft.com/library/bb225426.aspx. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + leftHeader?: boolean; + /** + * The right footer of the worksheet. + To apply font formatting or insert a variable value, use format codes specified here: https://msdn.microsoft.com/library/bb225426.aspx. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + rightFooter?: boolean; + /** + * The right header of the worksheet. + To apply font formatting or insert a variable value, use format codes specified here: https://msdn.microsoft.com/library/bb225426.aspx. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + rightHeader?: boolean; + } + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface HeaderFooterGroupLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * The general header/footer, used for all pages unless even/odd or first page is specified. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + defaultForAllPages?: Excel.Interfaces.HeaderFooterLoadOptions; + /** + * The header/footer to use for even pages, odd header/footer needs to be specified for odd pages. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + evenPages?: Excel.Interfaces.HeaderFooterLoadOptions; + /** + * The first page header/footer, for all other pages general or even/odd is used. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + firstPage?: Excel.Interfaces.HeaderFooterLoadOptions; + /** + * The header/footer to use for odd pages, even header/footer needs to be specified for even pages. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + oddPages?: Excel.Interfaces.HeaderFooterLoadOptions; + /** + * The state by which headers/footers are set. See `Excel.HeaderFooterState` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + state?: boolean; + /** + * Gets or sets a flag indicating if headers/footers are aligned with the page margins set in the page layout options for the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + useSheetMargins?: boolean; + /** + * Gets or sets a flag indicating if headers/footers should be scaled by the page percentage scale set in the page layout options for the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + useSheetScale?: boolean; + } + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface PageBreakLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Specifies the column index for the page break. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + columnIndex?: boolean; + /** + * Specifies the row index for the page break. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + rowIndex?: boolean; + } + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface PageBreakCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Specifies the column index for the page break. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + columnIndex?: boolean; + /** + * For EACH ITEM in the collection: Specifies the row index for the page break. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + rowIndex?: boolean; + } + /** + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface RangeCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Returns a data validation object. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + dataValidation?: Excel.Interfaces.DataValidationLoadOptions; + /** + * For EACH ITEM in the collection: Returns a format object, encapsulating the range's font, fill, borders, alignment, and other properties. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + format?: Excel.Interfaces.RangeFormatLoadOptions; + /** + * For EACH ITEM in the collection: The worksheet containing the current range. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + worksheet?: Excel.Interfaces.WorksheetLoadOptions; + /** + * For EACH ITEM in the collection: Specifies the range reference in A1-style. Address value contains the sheet reference (e.g., "Sheet1!A1:B4"). + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + address?: boolean; + /** + * For EACH ITEM in the collection: Represents the range reference for the specified range in the language of the user. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + addressLocal?: boolean; + /** + * For EACH ITEM in the collection: Specifies the number of cells in the range. This API will return -1 if the cell count exceeds 2^31-1 (2,147,483,647). + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + cellCount?: boolean; + /** + * For EACH ITEM in the collection: Specifies the total number of columns in the range. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + columnCount?: boolean; + /** + * For EACH ITEM in the collection: Represents if all columns in the current range are hidden. Value is `true` when all columns in a range are hidden. Value is `false` when no columns in the range are hidden. Value is `null` when some columns in a range are hidden and other columns in the same range are not hidden. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + columnHidden?: boolean; + /** + * For EACH ITEM in the collection: Specifies the column number of the first cell in the range. Zero-indexed. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + columnIndex?: boolean; + /** + * For EACH ITEM in the collection: Accesses the cell control applied to this range. + If the range has multiple cell controls, this returns `EmptyCellControl`. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + control?: boolean; + /** + * For EACH ITEM in the collection: Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + formulas?: boolean; + /** + * For EACH ITEM in the collection: Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. If a cell has no formula, its value is returned instead. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + formulasLocal?: boolean; + /** + * For EACH ITEM in the collection: Represents the formula in R1C1-style notation. If a cell has no formula, its value is returned instead. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + formulasR1C1?: boolean; + /** + * For EACH ITEM in the collection: Represents if all cells have a spill border. + Returns `true` if all cells have a spill border, or `false` if all cells do not have a spill border. + Returns `null` if there are cells both with and without spill borders within the range. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + hasSpill?: boolean; + /** + * For EACH ITEM in the collection: Returns the distance in points, for 100% zoom, from the top edge of the range to the bottom edge of the range. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + height?: boolean; + /** + * For EACH ITEM in the collection: Represents if all cells in the current range are hidden. Value is `true` when all cells in a range are hidden. Value is `false` when no cells in the range are hidden. Value is `null` when some cells in a range are hidden and other cells in the same range are not hidden. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + hidden?: boolean; + /** + * For EACH ITEM in the collection: Represents the hyperlink for the current range. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + hyperlink?: boolean; + /** + * For EACH ITEM in the collection: Represents if the current range is an entire column. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + isEntireColumn?: boolean; + /** + * For EACH ITEM in the collection: Represents if the current range is an entire row. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + isEntireRow?: boolean; + /** + * For EACH ITEM in the collection: Returns the distance in points, for 100% zoom, from the left edge of the worksheet to the left edge of the range. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + left?: boolean; + /** + * For EACH ITEM in the collection: Represents the data type state of each cell. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + linkedDataTypeState?: boolean; + /** + * For EACH ITEM in the collection: Represents Excel's number format code for the given range. For more information about Excel number formatting, see {@link https://support.microsoft.com/office/5026bbd6-04bc-48cd-bf33-80f18b4eae68 | Number format codes}. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + numberFormat?: boolean; + /** + * For EACH ITEM in the collection: Represents the category of number format of each cell. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + numberFormatCategories?: boolean; + /** + * For EACH ITEM in the collection: Represents Excel's number format code for the given range, based on the language settings of the user. + Excel does not perform any language or format coercion when getting or setting the `numberFormatLocal` property. + Any returned text uses the locally-formatted strings based on the language specified in the system settings. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + numberFormatLocal?: boolean; + /** + * For EACH ITEM in the collection: Returns the total number of rows in the range. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + rowCount?: boolean; + /** + * For EACH ITEM in the collection: Represents if all rows in the current range are hidden. Value is `true` when all rows in a range are hidden. Value is `false` when no rows in the range are hidden. Value is `null` when some rows in a range are hidden and other rows in the same range are not hidden. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + rowHidden?: boolean; + /** + * For EACH ITEM in the collection: Returns the row number of the first cell in the range. Zero-indexed. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + rowIndex?: boolean; + /** + * For EACH ITEM in the collection: Represents if all the cells would be saved as an array formula. + Returns `true` if all cells would be saved as an array formula, or `false` if all cells would not be saved as an array formula. + Returns `null` if some cells would be saved as an array formula and some would not be. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + savedAsArray?: boolean; + /** + * For EACH ITEM in the collection: Represents the style of the current range. + If the styles of the cells are inconsistent, `null` will be returned. + For custom styles, the style name will be returned. For built-in styles, a string representing a value in the `BuiltInStyle` enum will be returned. + * + * @remarks + * [Api set: ExcelApi 1.7] + */ + style?: boolean; + /** + * For EACH ITEM in the collection: Text values of the specified range. The text value will not depend on the cell width. The number sign (#) substitution that happens in the Excel UI will not affect the text value returned by the API. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + text?: boolean; + /** + * For EACH ITEM in the collection: Returns the distance in points, for 100% zoom, from the top edge of the worksheet to the top edge of the range. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + top?: boolean; + /** + * For EACH ITEM in the collection: Specifies the type of data in each cell. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + valueTypes?: boolean; + /** + * For EACH ITEM in the collection: Represents the raw values of the specified range. The data returned could be a string, number, or boolean. Cells that contain an error will return the error string. + If the returned value starts with a plus ("+"), minus ("-"), or equal sign ("="), Excel interprets this value as a formula. + * + * @remarks + * [Api set: ExcelApi 1.1] + */ + values?: boolean; + /** + * For EACH ITEM in the collection: A JSON representation of the values in the cells in this range. + Unlike `Range.values`, `Range.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use `Range.valuesAsJsonLocal`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJson?: boolean; + /** + * For EACH ITEM in the collection: A JSON representation of the values in the cells in this range. + Unlike `Range.values`, `Range.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. + Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use `Range.valuesAsJson`. + * + * @remarks + * [Api set: ExcelApi 1.16] + */ + valuesAsJsonLocal?: boolean; + /** + * For EACH ITEM in the collection: Returns the distance in points, for 100% zoom, from the left edge of the range to the right edge of the range. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + width?: boolean; + } + /** + * Contains the collection of cross-workbook level ranges. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + export interface RangeAreasCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Returns a data validation object for all ranges in the `RangeAreas`. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + dataValidation?: Excel.Interfaces.DataValidationLoadOptions; + /** + * For EACH ITEM in the collection: Returns a `RangeFormat` object, encapsulating the font, fill, borders, alignment, and other properties for all ranges in the `RangeAreas` object. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + format?: Excel.Interfaces.RangeFormatLoadOptions; + /** + * For EACH ITEM in the collection: Returns the worksheet for the current `RangeAreas`. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + worksheet?: Excel.Interfaces.WorksheetLoadOptions; + /** + * For EACH ITEM in the collection: Returns the `RangeAreas` reference in A1-style. Address value will contain the worksheet name for each rectangular block of cells (e.g., "Sheet1!A1:B4, Sheet1!D1:D4"). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + address?: boolean; + /** + * For EACH ITEM in the collection: Returns the `RangeAreas` reference in the user locale. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + addressLocal?: boolean; + /** + * For EACH ITEM in the collection: Returns the number of rectangular ranges that comprise this `RangeAreas` object. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + areaCount?: boolean; + /** + * For EACH ITEM in the collection: Returns the number of cells in the `RangeAreas` object, summing up the cell counts of all of the individual rectangular ranges. Returns -1 if the cell count exceeds 2^31-1 (2,147,483,647). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + cellCount?: boolean; + /** + * For EACH ITEM in the collection: Specifies if all the ranges on this `RangeAreas` object represent entire columns (e.g., "A:C, Q:Z"). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + isEntireColumn?: boolean; + /** + * For EACH ITEM in the collection: Specifies if all the ranges on this `RangeAreas` object represent entire rows (e.g., "1:3, 5:7"). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + isEntireRow?: boolean; + /** + * For EACH ITEM in the collection: Represents the style for all ranges in this `RangeAreas` object. + If the styles of the cells are inconsistent, `null` will be returned. + For custom styles, the style name will be returned. For built-in styles, a string representing a value in the `BuiltInStyle` enum will be returned. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + style?: boolean; + } + /** + * Represents a collection of comment objects that are part of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + export interface CommentCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Gets the email of the comment's author. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + authorEmail?: boolean; + /** + * For EACH ITEM in the collection: Gets the name of the comment's author. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + authorName?: boolean; + /** + * For EACH ITEM in the collection: The comment's content. The string is plain text. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + content?: boolean; + /** + * For EACH ITEM in the collection: Gets the content type of the comment. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + contentType?: boolean; + /** + * For EACH ITEM in the collection: Gets the creation time of the comment. Returns `null` if the comment was converted from a note, since the comment does not have a creation date. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + creationDate?: boolean; + /** + * For EACH ITEM in the collection: Specifies the comment identifier. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + id?: boolean; + /** + * For EACH ITEM in the collection: Gets the entities (e.g., people) that are mentioned in comments. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + mentions?: boolean; + /** + * For EACH ITEM in the collection: The comment thread status. A value of `true` means that the comment thread is resolved. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + resolved?: boolean; + /** + * For EACH ITEM in the collection: Gets the rich comment content (e.g., mentions in comments). This string is not meant to be displayed to end-users. Your add-in should only use this to parse rich comment content. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + richContent?: boolean; + } + /** + * Represents a comment in the workbook. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + export interface CommentLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Gets the email of the comment's author. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + authorEmail?: boolean; + /** + * Gets the name of the comment's author. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + authorName?: boolean; + /** + * The comment's content. The string is plain text. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + content?: boolean; + /** + * Gets the content type of the comment. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + contentType?: boolean; + /** + * Gets the creation time of the comment. Returns `null` if the comment was converted from a note, since the comment does not have a creation date. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + creationDate?: boolean; + /** + * Specifies the comment identifier. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + id?: boolean; + /** + * Gets the entities (e.g., people) that are mentioned in comments. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + mentions?: boolean; + /** + * The comment thread status. A value of `true` means that the comment thread is resolved. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + resolved?: boolean; + /** + * Gets the rich comment content (e.g., mentions in comments). This string is not meant to be displayed to end-users. Your add-in should only use this to parse rich comment content. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + richContent?: boolean; + } + /** + * Represents a collection of comment reply objects that are part of the comment. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + export interface CommentReplyCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Gets the email of the comment reply's author. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + authorEmail?: boolean; + /** + * For EACH ITEM in the collection: Gets the name of the comment reply's author. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + authorName?: boolean; + /** + * For EACH ITEM in the collection: The comment reply's content. The string is plain text. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + content?: boolean; + /** + * For EACH ITEM in the collection: The content type of the reply. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + contentType?: boolean; + /** + * For EACH ITEM in the collection: Gets the creation time of the comment reply. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + creationDate?: boolean; + /** + * For EACH ITEM in the collection: Specifies the comment reply identifier. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + id?: boolean; + /** + * For EACH ITEM in the collection: The entities (e.g., people) that are mentioned in comments. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + mentions?: boolean; + /** + * For EACH ITEM in the collection: The comment reply status. A value of `true` means the reply is in the resolved state. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + resolved?: boolean; + /** + * For EACH ITEM in the collection: The rich comment content (e.g., mentions in comments). This string is not meant to be displayed to end-users. Your add-in should only use this to parse rich comment content. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + richContent?: boolean; + } + /** + * Represents a comment reply in the workbook. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + export interface CommentReplyLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Gets the email of the comment reply's author. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + authorEmail?: boolean; + /** + * Gets the name of the comment reply's author. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + authorName?: boolean; + /** + * The comment reply's content. The string is plain text. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + content?: boolean; + /** + * The content type of the reply. + * + * @remarks + * [Api set: ExcelApi 1.12] + */ + contentType?: boolean; + /** + * Gets the creation time of the comment reply. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + creationDate?: boolean; + /** + * Specifies the comment reply identifier. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + id?: boolean; + /** + * The entities (e.g., people) that are mentioned in comments. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + mentions?: boolean; + /** + * The comment reply status. A value of `true` means the reply is in the resolved state. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + resolved?: boolean; + /** + * The rich comment content (e.g., mentions in comments). This string is not meant to be displayed to end-users. Your add-in should only use this to parse rich comment content. + * + * @remarks + * [Api set: ExcelApi 1.11] + */ + richContent?: boolean; + } + /** + * Represents a collection of all the shapes in the worksheet. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface ShapeCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Returns the fill formatting of this shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + fill?: Excel.Interfaces.ShapeFillLoadOptions; + /** + * For EACH ITEM in the collection: Returns the geometric shape associated with the shape. An error will be thrown if the shape type is not "GeometricShape". + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + geometricShape?: Excel.Interfaces.GeometricShapeLoadOptions; + /** + * For EACH ITEM in the collection: Returns the shape group associated with the shape. An error will be thrown if the shape type is not "GroupShape". + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + group?: Excel.Interfaces.ShapeGroupLoadOptions; + /** + * For EACH ITEM in the collection: Returns the image associated with the shape. An error will be thrown if the shape type is not "Image". + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + image?: Excel.Interfaces.ImageLoadOptions; + /** + * For EACH ITEM in the collection: Returns the line associated with the shape. An error will be thrown if the shape type is not "Line". + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + line?: Excel.Interfaces.LineLoadOptions; + /** + * For EACH ITEM in the collection: Returns the line formatting of this shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + lineFormat?: Excel.Interfaces.ShapeLineFormatLoadOptions; + /** + * For EACH ITEM in the collection: Specifies the parent group of this shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + parentGroup?: Excel.Interfaces.ShapeLoadOptions; + /** + * For EACH ITEM in the collection: Returns the text frame object of this shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + textFrame?: Excel.Interfaces.TextFrameLoadOptions; + /** + * For EACH ITEM in the collection: Specifies the alternative description text for a `Shape` object. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + altTextDescription?: boolean; + /** + * For EACH ITEM in the collection: Specifies the alternative title text for a `Shape` object. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + altTextTitle?: boolean; + /** + * For EACH ITEM in the collection: Returns the number of connection sites on this shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + connectionSiteCount?: boolean; + /** + * For EACH ITEM in the collection: Gets the display name of the shape. + A newly created shape has a generated name that is localized and may not match its `name`. + In this scenario, you can use this API to get the name that is displayed in the UI. + * + * @remarks + * [Api set: ExcelApi 1.15] + */ + displayName?: boolean; + /** + * For EACH ITEM in the collection: Specifies the geometric shape type of this geometric shape. See `Excel.GeometricShapeType` for details. Returns `null` if the shape type is not "GeometricShape". + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + geometricShapeType?: boolean; + /** + * For EACH ITEM in the collection: Specifies the height, in points, of the shape. + Throws an `InvalidArgument` exception when set with a negative value or zero as an input. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + height?: boolean; + /** + * For EACH ITEM in the collection: Specifies the shape identifier. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + id?: boolean; + /** + * For EACH ITEM in the collection: The distance, in points, from the left side of the shape to the left side of the worksheet. + Throws an `InvalidArgument` exception when set with a negative value as an input. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + left?: boolean; + /** + * For EACH ITEM in the collection: Specifies the level of the specified shape. For example, a level of 0 means that the shape is not part of any groups, a level of 1 means the shape is part of a top-level group, and a level of 2 means the shape is part of a sub-group of the top level. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + level?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the aspect ratio of this shape is locked. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + lockAspectRatio?: boolean; + /** + * For EACH ITEM in the collection: Specifies the name of the shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + name?: boolean; + /** + * For EACH ITEM in the collection: Represents how the object is attached to the cells below it. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + placement?: boolean; + /** + * For EACH ITEM in the collection: Specifies the rotation, in degrees, of the shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + rotation?: boolean; + /** + * For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the top edge of the worksheet. + Throws an `InvalidArgument` exception when set with a negative value as an input. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + top?: boolean; + /** + * For EACH ITEM in the collection: Returns the type of this shape. See `Excel.ShapeType` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + type?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the shape is visible. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + visible?: boolean; + /** + * For EACH ITEM in the collection: Specifies the width, in points, of the shape. + Throws an `InvalidArgument` exception when set with a negative value or zero as an input. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + width?: boolean; + /** + * For EACH ITEM in the collection: Returns the position of the specified shape in the z-order, with 0 representing the bottom of the order stack. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + zOrderPosition?: boolean; + } + /** + * Represents a generic shape object in the worksheet. A shape could be a geometric shape, a line, a group of shapes, etc. + To learn more about the shape object model, read {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-shapes | Work with shapes using the Excel JavaScript API}. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface ShapeLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Returns the fill formatting of this shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + fill?: Excel.Interfaces.ShapeFillLoadOptions; + /** + * Returns the geometric shape associated with the shape. An error will be thrown if the shape type is not "GeometricShape". + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + geometricShape?: Excel.Interfaces.GeometricShapeLoadOptions; + /** + * Returns the shape group associated with the shape. An error will be thrown if the shape type is not "GroupShape". + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + group?: Excel.Interfaces.ShapeGroupLoadOptions; + /** + * Returns the image associated with the shape. An error will be thrown if the shape type is not "Image". + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + image?: Excel.Interfaces.ImageLoadOptions; + /** + * Returns the line associated with the shape. An error will be thrown if the shape type is not "Line". + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + line?: Excel.Interfaces.LineLoadOptions; + /** + * Returns the line formatting of this shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + lineFormat?: Excel.Interfaces.ShapeLineFormatLoadOptions; + /** + * Specifies the parent group of this shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + parentGroup?: Excel.Interfaces.ShapeLoadOptions; + /** + * Returns the text frame object of this shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + textFrame?: Excel.Interfaces.TextFrameLoadOptions; + /** + * Specifies the alternative description text for a `Shape` object. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + altTextDescription?: boolean; + /** + * Specifies the alternative title text for a `Shape` object. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + altTextTitle?: boolean; + /** + * Returns the number of connection sites on this shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + connectionSiteCount?: boolean; + /** + * Gets the display name of the shape. + A newly created shape has a generated name that is localized and may not match its `name`. + In this scenario, you can use this API to get the name that is displayed in the UI. + * + * @remarks + * [Api set: ExcelApi 1.15] + */ + displayName?: boolean; + /** + * Specifies the geometric shape type of this geometric shape. See `Excel.GeometricShapeType` for details. Returns `null` if the shape type is not "GeometricShape". + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + geometricShapeType?: boolean; + /** + * Specifies the height, in points, of the shape. + Throws an `InvalidArgument` exception when set with a negative value or zero as an input. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + height?: boolean; + /** + * Specifies the shape identifier. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + id?: boolean; + /** + * The distance, in points, from the left side of the shape to the left side of the worksheet. + Throws an `InvalidArgument` exception when set with a negative value as an input. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + left?: boolean; + /** + * Specifies the level of the specified shape. For example, a level of 0 means that the shape is not part of any groups, a level of 1 means the shape is part of a top-level group, and a level of 2 means the shape is part of a sub-group of the top level. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + level?: boolean; + /** + * Specifies if the aspect ratio of this shape is locked. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + lockAspectRatio?: boolean; + /** + * Specifies the name of the shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + name?: boolean; + /** + * Represents how the object is attached to the cells below it. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + placement?: boolean; + /** + * Specifies the rotation, in degrees, of the shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + rotation?: boolean; + /** + * The distance, in points, from the top edge of the shape to the top edge of the worksheet. + Throws an `InvalidArgument` exception when set with a negative value as an input. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + top?: boolean; + /** + * Returns the type of this shape. See `Excel.ShapeType` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + type?: boolean; + /** + * Specifies if the shape is visible. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + visible?: boolean; + /** + * Specifies the width, in points, of the shape. + Throws an `InvalidArgument` exception when set with a negative value or zero as an input. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + width?: boolean; + /** + * Returns the position of the specified shape in the z-order, with 0 representing the bottom of the order stack. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + zOrderPosition?: boolean; + } + /** + * Represents a geometric shape inside a worksheet. A geometric shape can be a rectangle, block arrow, equation symbol, flowchart item, star, banner, callout, or any other basic shape in Excel. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface GeometricShapeLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Returns the `Shape` object for the geometric shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + shape?: Excel.Interfaces.ShapeLoadOptions; + /** + * Returns the shape identifier. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + id?: boolean; + } + /** + * Represents an image in the worksheet. To get the corresponding `Shape` object, use `Image.shape`. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface ImageLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Returns the `Shape` object associated with the image. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + shape?: Excel.Interfaces.ShapeLoadOptions; + /** + * Specifies the shape identifier for the image object. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + id?: boolean; + /** + * Returns the format of the image. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + format?: boolean; + } + /** + * Represents a shape group inside a worksheet. To get the corresponding `Shape` object, use `ShapeGroup.shape`. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface ShapeGroupLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Returns the `Shape` object associated with the group. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + shape?: Excel.Interfaces.ShapeLoadOptions; + /** + * Specifies the shape identifier. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + id?: boolean; + } + /** + * Represents the shape collection inside a shape group. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface GroupShapeCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Returns the fill formatting of this shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + fill?: Excel.Interfaces.ShapeFillLoadOptions; + /** + * For EACH ITEM in the collection: Returns the geometric shape associated with the shape. An error will be thrown if the shape type is not "GeometricShape". + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + geometricShape?: Excel.Interfaces.GeometricShapeLoadOptions; + /** + * For EACH ITEM in the collection: Returns the shape group associated with the shape. An error will be thrown if the shape type is not "GroupShape". + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + group?: Excel.Interfaces.ShapeGroupLoadOptions; + /** + * For EACH ITEM in the collection: Returns the image associated with the shape. An error will be thrown if the shape type is not "Image". + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + image?: Excel.Interfaces.ImageLoadOptions; + /** + * For EACH ITEM in the collection: Returns the line associated with the shape. An error will be thrown if the shape type is not "Line". + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + line?: Excel.Interfaces.LineLoadOptions; + /** + * For EACH ITEM in the collection: Returns the line formatting of this shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + lineFormat?: Excel.Interfaces.ShapeLineFormatLoadOptions; + /** + * For EACH ITEM in the collection: Specifies the parent group of this shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + parentGroup?: Excel.Interfaces.ShapeLoadOptions; + /** + * For EACH ITEM in the collection: Returns the text frame object of this shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + textFrame?: Excel.Interfaces.TextFrameLoadOptions; + /** + * For EACH ITEM in the collection: Specifies the alternative description text for a `Shape` object. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + altTextDescription?: boolean; + /** + * For EACH ITEM in the collection: Specifies the alternative title text for a `Shape` object. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + altTextTitle?: boolean; + /** + * For EACH ITEM in the collection: Returns the number of connection sites on this shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + connectionSiteCount?: boolean; + /** + * For EACH ITEM in the collection: Gets the display name of the shape. + A newly created shape has a generated name that is localized and may not match its `name`. + In this scenario, you can use this API to get the name that is displayed in the UI. + * + * @remarks + * [Api set: ExcelApi 1.15] + */ + displayName?: boolean; + /** + * For EACH ITEM in the collection: Specifies the geometric shape type of this geometric shape. See `Excel.GeometricShapeType` for details. Returns `null` if the shape type is not "GeometricShape". + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + geometricShapeType?: boolean; + /** + * For EACH ITEM in the collection: Specifies the height, in points, of the shape. + Throws an `InvalidArgument` exception when set with a negative value or zero as an input. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + height?: boolean; + /** + * For EACH ITEM in the collection: Specifies the shape identifier. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + id?: boolean; + /** + * For EACH ITEM in the collection: The distance, in points, from the left side of the shape to the left side of the worksheet. + Throws an `InvalidArgument` exception when set with a negative value as an input. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + left?: boolean; + /** + * For EACH ITEM in the collection: Specifies the level of the specified shape. For example, a level of 0 means that the shape is not part of any groups, a level of 1 means the shape is part of a top-level group, and a level of 2 means the shape is part of a sub-group of the top level. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + level?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the aspect ratio of this shape is locked. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + lockAspectRatio?: boolean; + /** + * For EACH ITEM in the collection: Specifies the name of the shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + name?: boolean; + /** + * For EACH ITEM in the collection: Represents how the object is attached to the cells below it. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + placement?: boolean; + /** + * For EACH ITEM in the collection: Specifies the rotation, in degrees, of the shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + rotation?: boolean; + /** + * For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the top edge of the worksheet. + Throws an `InvalidArgument` exception when set with a negative value as an input. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + top?: boolean; + /** + * For EACH ITEM in the collection: Returns the type of this shape. See `Excel.ShapeType` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + type?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the shape is visible. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + visible?: boolean; + /** + * For EACH ITEM in the collection: Specifies the width, in points, of the shape. + Throws an `InvalidArgument` exception when set with a negative value or zero as an input. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + width?: boolean; + /** + * For EACH ITEM in the collection: Returns the position of the specified shape in the z-order, with 0 representing the bottom of the order stack. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + zOrderPosition?: boolean; + } + /** + * Represents a line inside a worksheet. To get the corresponding `Shape` object, use `Line.shape`. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface LineLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents the shape to which the beginning of the specified line is attached. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + beginConnectedShape?: Excel.Interfaces.ShapeLoadOptions; + /** + * Represents the shape to which the end of the specified line is attached. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + endConnectedShape?: Excel.Interfaces.ShapeLoadOptions; + /** + * Returns the `Shape` object associated with the line. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + shape?: Excel.Interfaces.ShapeLoadOptions; + /** + * Represents the length of the arrowhead at the beginning of the specified line. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + beginArrowheadLength?: boolean; + /** + * Represents the style of the arrowhead at the beginning of the specified line. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + beginArrowheadStyle?: boolean; + /** + * Represents the width of the arrowhead at the beginning of the specified line. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + beginArrowheadWidth?: boolean; + /** + * Represents the connection site to which the beginning of a connector is connected. Returns `null` when the beginning of the line is not attached to any shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + beginConnectedSite?: boolean; + /** + * Represents the length of the arrowhead at the end of the specified line. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + endArrowheadLength?: boolean; + /** + * Represents the style of the arrowhead at the end of the specified line. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + endArrowheadStyle?: boolean; + /** + * Represents the width of the arrowhead at the end of the specified line. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + endArrowheadWidth?: boolean; + /** + * Represents the connection site to which the end of a connector is connected. Returns `null` when the end of the line is not attached to any shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + endConnectedSite?: boolean; + /** + * Specifies the shape identifier. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + id?: boolean; + /** + * Specifies if the beginning of the specified line is connected to a shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + isBeginConnected?: boolean; + /** + * Specifies if the end of the specified line is connected to a shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + isEndConnected?: boolean; + /** + * Represents the connector type for the line. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + connectorType?: boolean; + } + /** + * Represents the fill formatting of a shape object. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface ShapeFillLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents the shape fill foreground color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange") + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + foregroundColor?: boolean; + /** + * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + transparency?: boolean; + /** + * Returns the fill type of the shape. See `Excel.ShapeFillType` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + type?: boolean; + } + /** + * Represents the line formatting for the shape object. For images and geometric shapes, line formatting represents the border of the shape. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface ShapeLineFormatLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + color?: boolean; + /** + * Represents the line style of the shape. Returns `null` when the line is not visible or there are inconsistent dash styles. See `Excel.ShapeLineDashStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + dashStyle?: boolean; + /** + * Represents the line style of the shape. Returns `null` when the line is not visible or there are inconsistent styles. See `Excel.ShapeLineStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + style?: boolean; + /** + * Represents the degree of transparency of the specified line as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` when the shape has inconsistent transparencies. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + transparency?: boolean; + /** + * Specifies if the line formatting of a shape element is visible. Returns `null` when the shape has inconsistent visibilities. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + visible?: boolean; + /** + * Represents the weight of the line, in points. Returns `null` when the line is not visible or there are inconsistent line weights. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + weight?: boolean; + } + /** + * Represents the text frame of a shape object. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface TextFrameLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents the text that is attached to a shape in the text frame, and properties and methods for manipulating the text. See `Excel.TextRange` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + textRange?: Excel.Interfaces.TextRangeLoadOptions; + /** + * The automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + autoSizeSetting?: boolean; + /** + * Represents the bottom margin, in points, of the text frame. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + bottomMargin?: boolean; + /** + * Specifies if the text frame contains text. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + hasText?: boolean; + /** + * Represents the horizontal alignment of the text frame. See `Excel.ShapeTextHorizontalAlignment` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + horizontalAlignment?: boolean; + /** + * Represents the horizontal overflow behavior of the text frame. See `Excel.ShapeTextHorizontalOverflow` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + horizontalOverflow?: boolean; + /** + * Represents the left margin, in points, of the text frame. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + leftMargin?: boolean; + /** + * Represents the angle to which the text is oriented for the text frame. See `Excel.ShapeTextOrientation` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + orientation?: boolean; + /** + * Represents the reading order of the text frame, either left-to-right or right-to-left. See `Excel.ShapeTextReadingOrder` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + readingOrder?: boolean; + /** + * Represents the right margin, in points, of the text frame. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + rightMargin?: boolean; + /** + * Represents the top margin, in points, of the text frame. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + topMargin?: boolean; + /** + * Represents the vertical alignment of the text frame. See `Excel.ShapeTextVerticalAlignment` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + verticalAlignment?: boolean; + /** + * Represents the vertical overflow behavior of the text frame. See `Excel.ShapeTextVerticalOverflow` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + verticalOverflow?: boolean; + } + /** + * Contains the text that is attached to a shape, in addition to properties and methods for manipulating the text. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface TextRangeLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Returns a `ShapeFont` object that represents the font attributes for the text range. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + font?: Excel.Interfaces.ShapeFontLoadOptions; + /** + * Represents the plain text content of the text range. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + text?: boolean; + } + /** + * Represents the font attributes, such as font name, font size, and color, for a shape's `TextRange` object. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + export interface ShapeFontLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + bold?: boolean; + /** + * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + color?: boolean; + /** + * Represents the italic status of font. Returns `null` if the `TextRange` includes both italic and non-italic text fragments. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + italic?: boolean; + /** + * Represents font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + name?: boolean; + /** + * Represents font size in points (e.g., 11). Returns `null` if the `TextRange` includes text fragments with different font sizes. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + size?: boolean; + /** + * Type of underline applied to the font. Returns `null` if the `TextRange` includes text fragments with different underline styles. See `Excel.ShapeFontUnderlineStyle` for details. + * + * @remarks + * [Api set: ExcelApi 1.9] + */ + underline?: boolean; + } + /** + * Represents a `Slicer` object in the workbook. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + export interface SlicerLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Represents the worksheet containing the slicer. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + worksheet?: Excel.Interfaces.WorksheetLoadOptions; + /** + * Represents the caption of the slicer. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + caption?: boolean; + /** + * Specifies the height, in points, of the slicer. + Throws an `InvalidArgument` exception when set with a negative value or zero as an input. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + height?: boolean; + /** + * Represents the unique ID of the slicer. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + id?: boolean; + /** + * Value is `true` if all filters currently applied on the slicer are cleared. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + isFilterCleared?: boolean; + /** + * Represents the distance, in points, from the left side of the slicer to the left of the worksheet. + Throws an `InvalidArgument` error when set with a negative value as an input. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + left?: boolean; + /** + * Represents the name of the slicer. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + name?: boolean; + /** + * Specifies the sort order of the items in the slicer. + Possible values are: "DataSourceOrder", "Ascending", "Descending". + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + sortBy?: boolean; + /** + * Constant value that represents the slicer style. + Possible values are: "SlicerStyleLight1" through "SlicerStyleLight6", "TableStyleOther1" through "TableStyleOther2", "SlicerStyleDark1" through "SlicerStyleDark6". A custom user-defined style present in the workbook can also be specified. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + style?: boolean; + /** + * Represents the distance, in points, from the top edge of the slicer to the top of the worksheet. + Throws an `InvalidArgument` error when set with a negative value as an input. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + top?: boolean; + /** + * Represents the width, in points, of the slicer. + Throws an `InvalidArgument` error when set with a negative value or zero as an input. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + width?: boolean; + } + /** + * Represents a collection of all the slicer objects in the workbook or a worksheet. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + export interface SlicerCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Represents the worksheet containing the slicer. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + worksheet?: Excel.Interfaces.WorksheetLoadOptions; + /** + * For EACH ITEM in the collection: Represents the caption of the slicer. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + caption?: boolean; + /** + * For EACH ITEM in the collection: Specifies the height, in points, of the slicer. + Throws an `InvalidArgument` exception when set with a negative value or zero as an input. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + height?: boolean; + /** + * For EACH ITEM in the collection: Represents the unique ID of the slicer. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + id?: boolean; + /** + * For EACH ITEM in the collection: Value is `true` if all filters currently applied on the slicer are cleared. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + isFilterCleared?: boolean; + /** + * For EACH ITEM in the collection: Represents the distance, in points, from the left side of the slicer to the left of the worksheet. + Throws an `InvalidArgument` error when set with a negative value as an input. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + left?: boolean; + /** + * For EACH ITEM in the collection: Represents the name of the slicer. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + name?: boolean; + /** + * For EACH ITEM in the collection: Specifies the sort order of the items in the slicer. + Possible values are: "DataSourceOrder", "Ascending", "Descending". + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + sortBy?: boolean; + /** + * For EACH ITEM in the collection: Constant value that represents the slicer style. + Possible values are: "SlicerStyleLight1" through "SlicerStyleLight6", "TableStyleOther1" through "TableStyleOther2", "SlicerStyleDark1" through "SlicerStyleDark6". A custom user-defined style present in the workbook can also be specified. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + style?: boolean; + /** + * For EACH ITEM in the collection: Represents the distance, in points, from the top edge of the slicer to the top of the worksheet. + Throws an `InvalidArgument` error when set with a negative value as an input. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + top?: boolean; + /** + * For EACH ITEM in the collection: Represents the width, in points, of the slicer. + Throws an `InvalidArgument` error when set with a negative value or zero as an input. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + width?: boolean; + } + /** + * Represents a slicer item in a slicer. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + export interface SlicerItemLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Value is `true` if the slicer item has data. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + hasData?: boolean; + /** + * Value is `true` if the slicer item is selected. + Setting this value will not clear the selected state of other slicer items. + By default, if the slicer item is the only one selected, when it is deselected, all items will be selected. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + isSelected?: boolean; + /** + * Represents the unique value representing the slicer item. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + key?: boolean; + /** + * Represents the title displayed in the Excel UI. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + name?: boolean; + } + /** + * Represents a collection of all the slicer item objects in the slicer. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + export interface SlicerItemCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Value is `true` if the slicer item has data. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + hasData?: boolean; + /** + * For EACH ITEM in the collection: Value is `true` if the slicer item is selected. + Setting this value will not clear the selected state of other slicer items. + By default, if the slicer item is the only one selected, when it is deselected, all items will be selected. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + isSelected?: boolean; + /** + * For EACH ITEM in the collection: Represents the unique value representing the slicer item. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + key?: boolean; + /** + * For EACH ITEM in the collection: Represents the title displayed in the Excel UI. + * + * @remarks + * [Api set: ExcelApi 1.10] + */ + name?: boolean; + } + /** + * Represents a specific category or field of information that shares some common characteristics or attributes. + A data domain is linked to a data provider, that acts as the data source for `LinkedEntityCellValue` objects in the workbook. + A data domain is a category of data, such as stocks, geography, or currencies. A data provider is a service, such as Bing, Power BI, or an Office Add-in. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This interface isn't supported in Excel on the web. + */ + export interface LinkedEntityDataDomainLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Gets the name of the data provider for the linked entity data domain. + This name can change based on the information provided by the data provider. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + dataProvider?: boolean; + /** + * Gets the ID of the linked entity data domain defined by Office Add-ins. + This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + id?: boolean; + /** + * Gets the date and time (in the local time zone) since the workbook was opened and the `LinkedEntityCellValue` objects of this linked entity data domain were last refreshed. + Returns `undefined` if `LinkedEntityCellValue` objects have not been refreshed since the workbook was opened. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + lastRefreshed?: boolean; + /** + * Gets the ID of the custom function that is called on demand to resolve or refresh the `LinkedEntityCellValue` objects of the linked entity data domain defined by Office Add-ins. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/excel/custom-functions-json-autogeneration#id | Autogenerate JSON metadata for custom functions: ID}. + This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + loadFunctionId?: boolean; + /** + * Gets the name of the linked entity data domain. + This name can change based on the information provided by the data provider. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + name?: boolean; + /** + * Gets the frequency, in seconds, at which `LinkedEntityCellValue` objects of this linked entity data domain are refreshed automatically. + The refresh interval only applies if the `refreshMode` is set to "Periodic". + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + periodicRefreshInterval?: boolean; + /** + * Specifies the refresh mode that defines how and when the `LinkedEntityCellValue` objects of this linked entity data domain are refreshed. + If the refresh mode being set is not supported by this linked entity data domain, then the current refresh mode is not changed. + If the refresh mode is set to "Periodic", the refresh interval is set to the `periodicRefreshInterval` of this linked entity data domain. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + refreshMode?: boolean; + /** + * Gets the service ID of the linked entity data domain. + This ID is a permanently reserved value for all linked entity data domains which are defined by service data providers, such as Bing or Power BI, or defined by Office Add-ins. + This ID never changes across user sessions. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + serviceId?: boolean; + /** + * Gets all the refresh modes supported by the linked entity data domain. + This array can change based on the information provided by the data provider. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + supportedRefreshModes?: boolean; + } + /** + * Represents a collection of `LinkedEntityDataDomain` objects. + The collection can contain linked entity data domains such as stocks, geography, or currencies defined by service data providers, such as Bing or Power BI, or linked entity data domains defined by Office Add-ins. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This interface isn't supported in Excel on the web. + */ + export interface LinkedEntityDataDomainCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Gets the name of the data provider for the linked entity data domain. + This name can change based on the information provided by the data provider. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + dataProvider?: boolean; + /** + * For EACH ITEM in the collection: Gets the ID of the linked entity data domain defined by Office Add-ins. + This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + id?: boolean; + /** + * For EACH ITEM in the collection: Gets the date and time (in the local time zone) since the workbook was opened and the `LinkedEntityCellValue` objects of this linked entity data domain were last refreshed. + Returns `undefined` if `LinkedEntityCellValue` objects have not been refreshed since the workbook was opened. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + lastRefreshed?: boolean; + /** + * For EACH ITEM in the collection: Gets the ID of the custom function that is called on demand to resolve or refresh the `LinkedEntityCellValue` objects of the linked entity data domain defined by Office Add-ins. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/excel/custom-functions-json-autogeneration#id | Autogenerate JSON metadata for custom functions: ID}. + This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + loadFunctionId?: boolean; + /** + * For EACH ITEM in the collection: Gets the name of the linked entity data domain. + This name can change based on the information provided by the data provider. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + name?: boolean; + /** + * For EACH ITEM in the collection: Gets the frequency, in seconds, at which `LinkedEntityCellValue` objects of this linked entity data domain are refreshed automatically. + The refresh interval only applies if the `refreshMode` is set to "Periodic". + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + periodicRefreshInterval?: boolean; + /** + * For EACH ITEM in the collection: Specifies the refresh mode that defines how and when the `LinkedEntityCellValue` objects of this linked entity data domain are refreshed. + If the refresh mode being set is not supported by this linked entity data domain, then the current refresh mode is not changed. + If the refresh mode is set to "Periodic", the refresh interval is set to the `periodicRefreshInterval` of this linked entity data domain. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + refreshMode?: boolean; + /** + * For EACH ITEM in the collection: Gets the service ID of the linked entity data domain. + This ID is a permanently reserved value for all linked entity data domains which are defined by service data providers, such as Bing or Power BI, or defined by Office Add-ins. + This ID never changes across user sessions. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + serviceId?: boolean; + /** + * For EACH ITEM in the collection: Gets all the refresh modes supported by the linked entity data domain. + This array can change based on the information provided by the data provider. + * + * @remarks + * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. + */ + supportedRefreshModes?: boolean; + } + + + /** + * Represents a collection of note objects that are part of the workbook. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + export interface NoteCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Gets the author of the note. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + authorName?: boolean; + /** + * For EACH ITEM in the collection: Specifies the text of the note. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + content?: boolean; + /** + * For EACH ITEM in the collection: Specifies the height of the note. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + height?: boolean; + /** + * For EACH ITEM in the collection: Specifies the visibility of the note. A value of `true` means the note is shown. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + visible?: boolean; + /** + * For EACH ITEM in the collection: Specifies the width of the note. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + width?: boolean; + } + /** + * Represents a note in the workbook or worksheet. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + export interface NoteLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Gets the author of the note. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + authorName?: boolean; + /** + * Specifies the text of the note. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + content?: boolean; + /** + * Specifies the height of the note. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + height?: boolean; + /** + * Specifies the visibility of the note. A value of `true` means the note is shown. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + visible?: boolean; + /** + * Specifies the width of the note. + * + * @remarks + * [Api set: ExcelApi 1.18] + */ + width?: boolean; + } + /** + * An object containing the result of a function-evaluation operation + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + export interface FunctionResultLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Error value (such as "#DIV/0") representing the error. If the error string is not set, then the function succeeded, and its result is written to the Value field. The error is always in the English locale. + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + error?: boolean; + /** + * The value of function evaluation. The value field will be populated only if no error has occurred (i.e., the Error property is not set). + * + * @remarks + * [Api set: ExcelApi 1.2] + */ + value?: boolean; + } + } +} + + +//////////////////////////////////////////////////////////////// +//////////////////////// End Excel APIs //////////////////////// +//////////////////////////////////////////////////////////////// \ No newline at end of file diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_20/package.json b/generate-docs/api-extractor-inputs-excel-release/Excel_1_20/package.json new file mode 100644 index 0000000000..ac5870069d --- /dev/null +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_20/package.json @@ -0,0 +1,4 @@ +{ + "name": "excel", + "version": "1.20.0" +} \ No newline at end of file diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_20/tsconfig.json b/generate-docs/api-extractor-inputs-excel-release/Excel_1_20/tsconfig.json new file mode 100644 index 0000000000..3e88ed21c0 --- /dev/null +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_20/tsconfig.json @@ -0,0 +1,22 @@ +{ + "compilerOptions": { + "target": "es6", + "forceConsistentCasingInFileNames": true, + "module": "commonjs", + "declaration": true, + "sourceMap": true, + "experimentalDecorators": true, + "types": [ + "node" + ], + "lib": [ + "es5", + "scripthost", + "es2015.collection", + "es2015.promise", + "es2015.iterable", + "dom" + ] + }, + "include": [ "excel.d.ts" ] +} diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_20/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-excel-release/Excel_1_20/tsdoc-metadata.json new file mode 100644 index 0000000000..5b39d9101b --- /dev/null +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_20/tsdoc-metadata.json @@ -0,0 +1,11 @@ +// This file is read by tools that parse documentation comments conforming to the TSDoc standard. +// It should be published with your NPM package. It should not be tracked by Git. +{ + "tsdocVersion": "0.12", + "toolPackages": [ + { + "packageName": "@microsoft/api-extractor", + "packageVersion": "7.52.11" + } + ] +} diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_3/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_3/excel.d.ts index 97f6638c45..c55b6eb582 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_3/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_3/excel.d.ts @@ -300,6 +300,7 @@ export declare namespace Excel { * The default behavior with no `delayForCellEdit` property specified is equivalent to when it is `false`. */ delayForCellEdit?: boolean; + } /** * Executes a batch script that performs actions on the Excel object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. @@ -5959,6 +5960,8 @@ export declare namespace Excel { + + diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_4/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_4/excel.d.ts index ab89ae859e..41a98ac631 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_4/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_4/excel.d.ts @@ -300,6 +300,7 @@ export declare namespace Excel { * The default behavior with no `delayForCellEdit` property specified is equivalent to when it is `false`. */ delayForCellEdit?: boolean; + } /** * Executes a batch script that performs actions on the Excel object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. @@ -6359,6 +6360,8 @@ export declare namespace Excel { + + diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_5/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_5/excel.d.ts index 318a81713f..28f35d069c 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_5/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_5/excel.d.ts @@ -303,6 +303,7 @@ export declare namespace Excel { * The default behavior with no `delayForCellEdit` property specified is equivalent to when it is `false`. */ delayForCellEdit?: boolean; + } /** * Executes a batch script that performs actions on the Excel object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. @@ -6700,6 +6701,8 @@ export declare namespace Excel { + + diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_6/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_6/excel.d.ts index df0700d280..b3c3e0aef4 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_6/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_6/excel.d.ts @@ -303,6 +303,7 @@ export declare namespace Excel { * The default behavior with no `delayForCellEdit` property specified is equivalent to when it is `false`. */ delayForCellEdit?: boolean; + } /** * Executes a batch script that performs actions on the Excel object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. @@ -8325,6 +8326,8 @@ export declare namespace Excel { + + diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_7/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_7/excel.d.ts index 1a9de7aad5..4f2e844e3b 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_7/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_7/excel.d.ts @@ -303,6 +303,7 @@ export declare namespace Excel { * The default behavior with no `delayForCellEdit` property specified is equivalent to when it is `false`. */ delayForCellEdit?: boolean; + } /** * Executes a batch script that performs actions on the Excel object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. @@ -10363,6 +10364,8 @@ export declare namespace Excel { */ toJSON(): Excel.Interfaces.ConditionalRangeBorderCollectionData; } + + /** * An object encapsulating a style's format and other properties. * diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_8/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_8/excel.d.ts index 68fd8681cd..69ad477cc0 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_8/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_8/excel.d.ts @@ -313,6 +313,7 @@ export declare namespace Excel { * The default behavior with no `delayForCellEdit` property specified is equivalent to when it is `false`. */ delayForCellEdit?: boolean; + } /** * Executes a batch script that performs actions on the Excel object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. @@ -13068,6 +13069,8 @@ export declare namespace Excel { */ toJSON(): Excel.Interfaces.ConditionalRangeBorderCollectionData; } + + /** * An object encapsulating a style's format and other properties. * diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_9/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_9/excel.d.ts index f4b82d910d..37720f2368 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_9/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_9/excel.d.ts @@ -792,6 +792,7 @@ export declare namespace Excel { * The default behavior with no `delayForCellEdit` property specified is equivalent to when it is `false`. */ delayForCellEdit?: boolean; + } /** * Executes a batch script that performs actions on the Excel object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. @@ -16244,6 +16245,8 @@ export declare namespace Excel { */ toJSON(): Excel.Interfaces.ConditionalRangeBorderCollectionData; } + + /** * An object encapsulating a style's format and other properties. * diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_online/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_online/excel.d.ts index 216103776f..be044945eb 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_online/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_online/excel.d.ts @@ -7505,6 +7505,16 @@ export declare namespace Excel { * The default behavior with no `delayForCellEdit` property specified is equivalent to when it is `false`. */ delayForCellEdit?: boolean; + /** + * Determines whether the batch requests should be merged to one undo group. + * + * When false, each `context.sync()` call creates an undo record. + * When true, all `context.sync()` calls in a single `Excel.run` are merged into one `undo` group. + * + * @remarks + * [Api set: ExcelApi 1.20] + */ + mergeUndoGroup?: boolean; } /** * Executes a batch script that performs actions on the Excel object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. @@ -27067,6 +27077,76 @@ export declare namespace Excel { */ toJSON(): Excel.Interfaces.ConditionalRangeBorderCollectionData; } + /** + * Manages settings on custom functions. + * + * @remarks + * [Api set: ExcelApi 1.20] + */ + export class CustomFunctionManager extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Show or hide custom functions in Excel AutoComplete. + * + * @remarks + * [Api set: ExcelApi 1.20] + * + * @param customFunctionVisibilityOptions - Specifies which custom functions to show or hide. + */ + static setVisibility(customFunctionVisibilityOptions: Excel.CustomFunctionVisibilityOptions): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.CustomFunctionManager; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * + * @remarks + * [Api set: ExcelApi 1.20] + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.CustomFunctionManager; + /** + * Create a new instance of the `Excel.CustomFunctionManager` object. + * @remarks + * [Api set: ExcelApi 1.20] + */ + static newObject(context: OfficeExtension.ClientRequestContext): Excel.CustomFunctionManager; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.CustomFunctionManager` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.CustomFunctionManagerData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.CustomFunctionManagerData; + } + /** + * Represents which custom functions to show or hide in Excel AutoComplete. + * + * @remarks + * [Api set: ExcelApi 1.20] + */ + export interface CustomFunctionVisibilityOptions { + /** + * A list of custom functions to hide from Excel AutoComplete. + * + * @remarks + * [Api set: ExcelApi 1.20] + */ + hide?: string[]; + /** + * A list of custom functions to show in Excel AutoComplete. + * + * @remarks + * [Api set: ExcelApi 1.20] + */ + show?: string[]; + } /** * An object encapsulating a style's format and other properties. * diff --git a/generate-docs/api-extractor-inputs-excel/excel.d.ts b/generate-docs/api-extractor-inputs-excel/excel.d.ts index f751a4db02..57c6c99c30 100644 --- a/generate-docs/api-extractor-inputs-excel/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel/excel.d.ts @@ -9167,6 +9167,16 @@ export declare namespace Excel { * The default behavior with no `delayForCellEdit` property specified is equivalent to when it is `false`. */ delayForCellEdit?: boolean; + /** + * Determines whether the batch requests should be merged to one undo group. + * + * When false, each `context.sync()` call creates an undo record. + * When true, all `context.sync()` calls in a single `Excel.run` are merged into one `undo` group. + * + * @remarks + * [Api set: ExcelApi 1.20] + */ + mergeUndoGroup?: boolean; } /** * Executes a batch script that performs actions on the Excel object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. @@ -30916,8 +30926,7 @@ export declare namespace Excel { * Manages settings on custom functions. * * @remarks - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.20] */ export class CustomFunctionManager extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -30926,8 +30935,7 @@ export declare namespace Excel { * Show or hide custom functions in Excel AutoComplete. * * @remarks - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.20] * * @param customFunctionVisibilityOptions - Specifies which custom functions to show or hide. */ @@ -30944,8 +30952,7 @@ export declare namespace Excel { * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. * * @remarks - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.20] */ load(propertyNamesAndPaths?: { select?: string; @@ -30954,8 +30961,7 @@ export declare namespace Excel { /** * Create a new instance of the `Excel.CustomFunctionManager` object. * @remarks - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.20] */ static newObject(context: OfficeExtension.ClientRequestContext): Excel.CustomFunctionManager; /** @@ -30968,24 +30974,21 @@ export declare namespace Excel { * Represents which custom functions to show or hide in Excel AutoComplete. * * @remarks - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.20] */ export interface CustomFunctionVisibilityOptions { /** * A list of custom functions to hide from Excel AutoComplete. * * @remarks - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.20] */ hide?: string[]; /** * A list of custom functions to show in Excel AutoComplete. * * @remarks - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.20] */ show?: string[]; } diff --git a/generate-docs/script-inputs/office.d.ts b/generate-docs/script-inputs/office.d.ts index ddc4072e31..b900dd7e04 100644 --- a/generate-docs/script-inputs/office.d.ts +++ b/generate-docs/script-inputs/office.d.ts @@ -32236,6 +32236,16 @@ declare namespace Excel { * The default behavior with no `delayForCellEdit` property specified is equivalent to when it is `false`. */ delayForCellEdit?: boolean; + /** + * Determines whether the batch requests should be merged to one undo group. + * + * When false, each `context.sync()` call creates an undo record. + * When true, all `context.sync()` calls in a single `Excel.run` are merged into one `undo` group. + * + * @remarks + * [Api set: ExcelApi 1.20] + */ + mergeUndoGroup?: boolean; } /** * Executes a batch script that performs actions on the Excel object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. @@ -51798,6 +51808,76 @@ declare namespace Excel { */ toJSON(): Excel.Interfaces.ConditionalRangeBorderCollectionData; } + /** + * Manages settings on custom functions. + * + * @remarks + * [Api set: ExcelApi 1.20] + */ + class CustomFunctionManager extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Show or hide custom functions in Excel AutoComplete. + * + * @remarks + * [Api set: ExcelApi 1.20] + * + * @param customFunctionVisibilityOptions Specifies which custom functions to show or hide. + */ + static setVisibility(customFunctionVisibilityOptions: Excel.CustomFunctionVisibilityOptions): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.CustomFunctionManager; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * + * @remarks + * [Api set: ExcelApi 1.20] + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.CustomFunctionManager; + /** + * Create a new instance of the `Excel.CustomFunctionManager` object. + * @remarks + * [Api set: ExcelApi 1.20] + */ + static newObject(context: OfficeExtension.ClientRequestContext): Excel.CustomFunctionManager; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Excel.CustomFunctionManager` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.CustomFunctionManagerData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.CustomFunctionManagerData; + } + /** + * Represents which custom functions to show or hide in Excel AutoComplete. + * + * @remarks + * [Api set: ExcelApi 1.20] + */ + interface CustomFunctionVisibilityOptions { + /** + * A list of custom functions to hide from Excel AutoComplete. + * + * @remarks + * [Api set: ExcelApi 1.20] + */ + hide?: string[]; + /** + * A list of custom functions to show in Excel AutoComplete. + * + * @remarks + * [Api set: ExcelApi 1.20] + */ + show?: string[]; + } /** * An object encapsulating a style's format and other properties. * diff --git a/generate-docs/script-inputs/office_preview.d.ts b/generate-docs/script-inputs/office_preview.d.ts index 65b5bbaa36..82bede9637 100644 --- a/generate-docs/script-inputs/office_preview.d.ts +++ b/generate-docs/script-inputs/office_preview.d.ts @@ -34261,6 +34261,16 @@ declare namespace Excel { * The default behavior with no `delayForCellEdit` property specified is equivalent to when it is `false`. */ delayForCellEdit?: boolean; + /** + * Determines whether the batch requests should be merged to one undo group. + * + * When false, each `context.sync()` call creates an undo record. + * When true, all `context.sync()` calls in a single `Excel.run` are merged into one `undo` group. + * + * @remarks + * [Api set: ExcelApi 1.20] + */ + mergeUndoGroup?: boolean; } /** * Executes a batch script that performs actions on the Excel object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. @@ -56010,8 +56020,7 @@ declare namespace Excel { * Manages settings on custom functions. * * @remarks - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.20] */ class CustomFunctionManager extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -56020,8 +56029,7 @@ declare namespace Excel { * Show or hide custom functions in Excel AutoComplete. * * @remarks - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.20] * * @param customFunctionVisibilityOptions Specifies which custom functions to show or hide. */ @@ -56038,8 +56046,7 @@ declare namespace Excel { * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. * * @remarks - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.20] */ load(propertyNamesAndPaths?: { select?: string; @@ -56048,8 +56055,7 @@ declare namespace Excel { /** * Create a new instance of the `Excel.CustomFunctionManager` object. * @remarks - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.20] */ static newObject(context: OfficeExtension.ClientRequestContext): Excel.CustomFunctionManager; /** @@ -56062,24 +56068,21 @@ declare namespace Excel { * Represents which custom functions to show or hide in Excel AutoComplete. * * @remarks - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.20] */ interface CustomFunctionVisibilityOptions { /** * A list of custom functions to hide from Excel AutoComplete. * * @remarks - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.20] */ hide?: string[]; /** * A list of custom functions to show in Excel AutoComplete. * * @remarks - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.20] */ show?: string[]; } diff --git a/generate-docs/scripts/midprocessor.ts b/generate-docs/scripts/midprocessor.ts index 71ceb8f3d9..4beac70681 100644 --- a/generate-docs/scripts/midprocessor.ts +++ b/generate-docs/scripts/midprocessor.ts @@ -4,7 +4,7 @@ import * as path from "path"; import yaml = require('js-yaml'); import * as colors from 'colors'; -const CURRENT_EXCEL_RELEASE = 19; +const CURRENT_EXCEL_RELEASE = 20; const OLDEST_EXCEL_RELEASE_WITH_CUSTOM_FUNCTIONS = 9; const CURRENT_OUTLOOK_RELEASE = 15; const CURRENT_WORD_RELEASE = 9; diff --git a/generate-docs/scripts/postprocessor.ts b/generate-docs/scripts/postprocessor.ts index e80629b626..a5f3064c57 100644 --- a/generate-docs/scripts/postprocessor.ts +++ b/generate-docs/scripts/postprocessor.ts @@ -155,7 +155,7 @@ tryCatch(async () => { (globalToc.items[0].items[0] as ApplicationTocNode).href = "../overview/overview.md"; // Stay within a moniker const tocWithPreviewCommon = scrubAndWriteToc(docsDestination + "/office", globalToc); const tocWithReleaseCommon = scrubAndWriteToc(docsDestination + "/office_release", globalToc); - const hostVersionMap = [{host: "excel", versions: 20}, /*not including online*/ + const hostVersionMap = [{host: "excel", versions: 21}, /*not including online*/ {host: "onenote", versions: 1}, {host: "outlook", versions: 16}, {host: "powerpoint", versions: 10},